Commit | Line | Data |
---|---|---|
4009494e GM |
1 | \input texinfo |
2 | ||
7fbf7cae TZ |
3 | @include gnus-overrides.texi |
4 | ||
db78a8cb | 5 | @setfilename ../../info/gnus |
4009494e GM |
6 | @settitle Gnus Manual |
7 | @syncodeindex fn cp | |
8 | @syncodeindex vr cp | |
9 | @syncodeindex pg cp | |
10 | ||
89b163db | 11 | @documentencoding UTF-8 |
01c52d31 | 12 | |
4009494e | 13 | @copying |
acaf905b | 14 | Copyright @copyright{} 1995-2012 Free Software Foundation, Inc. |
4009494e GM |
15 | |
16 | @quotation | |
17 | Permission is granted to copy, distribute and/or modify this document | |
6a2c4aec | 18 | under the terms of the GNU Free Documentation License, Version 1.3 or |
4009494e | 19 | any later version published by the Free Software Foundation; with no |
debf4439 GM |
20 | Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', |
21 | and with the Back-Cover Texts as in (a) below. A copy of the license | |
22 | is included in the section entitled ``GNU Free Documentation License''. | |
4009494e | 23 | |
6f093307 GM |
24 | (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and |
25 | modify this GNU manual. Buying copies from the FSF supports it in | |
26 | developing GNU and promoting software freedom.'' | |
4009494e GM |
27 | @end quotation |
28 | @end copying | |
29 | ||
30 | @iftex | |
31 | @iflatex | |
32 | \documentclass[twoside,a4paper,openright,11pt]{book} | |
33 | \usepackage[latin1]{inputenc} | |
34 | \usepackage{pagestyle} | |
35 | \usepackage{epsfig} | |
36 | \usepackage{pixidx} | |
37 | \input{gnusconfig.tex} | |
38 | ||
39 | \ifx\pdfoutput\undefined | |
40 | \else | |
41 | \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref} | |
42 | \usepackage{thumbpdf} | |
43 | \pdfcompresslevel=9 | |
44 | \fi | |
45 | ||
46 | \makeindex | |
47 | \begin{document} | |
48 | ||
49 | % Adjust ../Makefile.in if you change the following line: | |
c7ff939a | 50 | \newcommand{\gnusversionname}{Gnus v5.13} |
4009494e GM |
51 | \newcommand{\gnuschaptername}{} |
52 | \newcommand{\gnussectionname}{} | |
53 | ||
54 | \newcommand{\gnusbackslash}{/} | |
55 | ||
56 | \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}} | |
57 | \ifx\pdfoutput\undefined | |
58 | \newcommand{\gnusuref}[1]{\gnustt{#1}} | |
59 | \else | |
60 | \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}} | |
61 | \fi | |
62 | \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}} | |
63 | \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}} | |
64 | ||
65 | \newcommand{\gnuskindex}[1]{\index{#1}} | |
66 | \newcommand{\gnusindex}[1]{\index{#1}} | |
67 | ||
68 | \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}} | |
69 | \newcommand{\gnuscode}[1]{\gnustt{#1}} | |
70 | \newcommand{\gnusasis}[1]{\gnustt{#1}} | |
71 | \newcommand{\gnusurl}[1]{\gnustt{#1}} | |
72 | \newcommand{\gnuscommand}[1]{\gnustt{#1}} | |
73 | \newcommand{\gnusenv}[1]{\gnustt{#1}} | |
74 | \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''} | |
75 | \newcommand{\gnuslisp}[1]{\gnustt{#1}} | |
76 | \newcommand{\gnuskbd}[1]{`\gnustt{#1}'} | |
77 | \newcommand{\gnuskey}[1]{`\gnustt{#1}'} | |
78 | \newcommand{\gnusfile}[1]{`\gnustt{#1}'} | |
79 | \newcommand{\gnusdfn}[1]{\textit{#1}} | |
80 | \newcommand{\gnusi}[1]{\textit{#1}} | |
81 | \newcommand{\gnusr}[1]{\textrm{#1}} | |
82 | \newcommand{\gnusstrong}[1]{\textbf{#1}} | |
83 | \newcommand{\gnusemph}[1]{\textit{#1}} | |
84 | \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}} | |
85 | \newcommand{\gnussc}[1]{\textsc{#1}} | |
86 | \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}} | |
87 | \newcommand{\gnusversion}[1]{{\small\textit{#1}}} | |
88 | \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}} | |
89 | \newcommand{\gnusresult}[1]{\gnustt{=> #1}} | |
90 | \newcommand{\gnusacronym}[1]{\textsc{#1}} | |
91 | \newcommand{\gnusemail}[1]{\textit{#1}} | |
92 | ||
93 | \newcommand{\gnusbullet}{{${\bullet}$}} | |
94 | \newcommand{\gnusdollar}{\$} | |
95 | \newcommand{\gnusampersand}{\&} | |
96 | \newcommand{\gnuspercent}{\%} | |
97 | \newcommand{\gnushash}{\#} | |
98 | \newcommand{\gnushat}{\symbol{"5E}} | |
99 | \newcommand{\gnusunderline}{\symbol{"5F}} | |
100 | \newcommand{\gnusnot}{$\neg$} | |
101 | \newcommand{\gnustilde}{\symbol{"7E}} | |
102 | \newcommand{\gnusless}{{$<$}} | |
103 | \newcommand{\gnusgreater}{{$>$}} | |
104 | \newcommand{\gnusbraceleft}{{$>$}} | |
105 | \newcommand{\gnusbraceright}{{$>$}} | |
106 | ||
107 | \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}} | |
108 | \newcommand{\gnusinteresting}{ | |
109 | \marginpar[\mbox{}\hfill\gnushead]{\gnushead} | |
110 | } | |
111 | ||
112 | \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi} | |
113 | ||
114 | \newcommand{\gnuspagechapter}[1]{ | |
115 | {\mbox{}} | |
116 | } | |
117 | ||
118 | \newdimen{\gnusdimen} | |
119 | \gnusdimen 0pt | |
120 | ||
121 | \newcommand{\gnuschapter}[2]{ | |
122 | \gnuscleardoublepage | |
123 | \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi | |
124 | \chapter{#2} | |
125 | \renewcommand{\gnussectionname}{} | |
126 | \renewcommand{\gnuschaptername}{#2} | |
127 | \thispagestyle{empty} | |
128 | \hspace*{-2cm} | |
129 | \begin{picture}(500,500)(0,0) | |
130 | \put(480,350){\makebox(0,0)[tr]{#1}} | |
131 | \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}} | |
132 | \end{picture} | |
133 | \clearpage | |
134 | } | |
135 | ||
136 | \newcommand{\gnusfigure}[3]{ | |
137 | \begin{figure} | |
138 | \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2) | |
139 | #3 | |
140 | \end{picture} | |
141 | \caption{#1} | |
142 | \end{figure} | |
143 | } | |
144 | ||
145 | \newcommand{\gnusicon}[1]{ | |
146 | \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}} | |
147 | } | |
148 | ||
149 | \newcommand{\gnuspicon}[1]{ | |
150 | \margindex{\epsfig{figure=#1,width=2cm}} | |
151 | } | |
152 | ||
153 | \newcommand{\gnusxface}[2]{ | |
154 | \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}} | |
155 | } | |
156 | ||
157 | \newcommand{\gnussmiley}[2]{ | |
158 | \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}} | |
159 | } | |
160 | ||
161 | \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1} | |
162 | ||
163 | \newcommand{\gnussection}[1]{ | |
164 | \renewcommand{\gnussectionname}{#1} | |
165 | \section{#1} | |
166 | } | |
167 | ||
168 | \newenvironment{codelist}% | |
169 | {\begin{list}{}{ | |
170 | } | |
171 | }{\end{list}} | |
172 | ||
173 | \newenvironment{asislist}% | |
174 | {\begin{list}{}{ | |
175 | } | |
176 | }{\end{list}} | |
177 | ||
178 | \newenvironment{kbdlist}% | |
179 | {\begin{list}{}{ | |
180 | \labelwidth=0cm | |
181 | } | |
182 | }{\end{list}} | |
183 | ||
184 | \newenvironment{dfnlist}% | |
185 | {\begin{list}{}{ | |
186 | } | |
187 | }{\end{list}} | |
188 | ||
189 | \newenvironment{stronglist}% | |
190 | {\begin{list}{}{ | |
191 | } | |
192 | }{\end{list}} | |
193 | ||
194 | \newenvironment{samplist}% | |
195 | {\begin{list}{}{ | |
196 | } | |
197 | }{\end{list}} | |
198 | ||
199 | \newenvironment{varlist}% | |
200 | {\begin{list}{}{ | |
201 | } | |
202 | }{\end{list}} | |
203 | ||
204 | \newenvironment{emphlist}% | |
205 | {\begin{list}{}{ | |
206 | } | |
207 | }{\end{list}} | |
208 | ||
209 | \newlength\gnusheadtextwidth | |
210 | \setlength{\gnusheadtextwidth}{\headtextwidth} | |
211 | \addtolength{\gnusheadtextwidth}{1cm} | |
212 | ||
213 | \newpagestyle{gnuspreamble}% | |
214 | { | |
215 | { | |
216 | \ifodd\count0 | |
217 | { | |
218 | \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}} | |
219 | } | |
220 | \else | |
221 | { | |
222 | \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}} | |
223 | } | |
224 | } | |
225 | \fi | |
226 | } | |
227 | } | |
228 | { | |
229 | \ifodd\count0 | |
230 | \mbox{} \hfill | |
231 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
232 | \else | |
233 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
234 | \hfill \mbox{} | |
235 | \fi | |
236 | } | |
237 | ||
238 | \newpagestyle{gnusindex}% | |
239 | { | |
240 | { | |
241 | \ifodd\count0 | |
242 | { | |
243 | \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}} | |
244 | } | |
245 | \else | |
246 | { | |
247 | \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}} | |
248 | } | |
249 | \fi | |
250 | } | |
251 | } | |
252 | { | |
253 | \ifodd\count0 | |
254 | \mbox{} \hfill | |
255 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
256 | \else | |
257 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
258 | \hfill \mbox{} | |
259 | \fi | |
260 | } | |
261 | ||
262 | \newpagestyle{gnus}% | |
263 | { | |
264 | { | |
265 | \ifodd\count0 | |
266 | { | |
267 | \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}} | |
268 | } | |
269 | \else | |
270 | { | |
271 | \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}} | |
272 | } | |
273 | \fi | |
274 | } | |
275 | } | |
276 | { | |
277 | \ifodd\count0 | |
278 | \mbox{} \hfill | |
279 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
280 | \else | |
281 | \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}} | |
282 | \hfill \mbox{} | |
283 | \fi | |
284 | } | |
285 | ||
286 | \pagenumbering{roman} | |
287 | \pagestyle{gnuspreamble} | |
288 | ||
289 | @end iflatex | |
290 | @end iftex | |
291 | ||
292 | @iftex | |
293 | @iflatex | |
294 | ||
295 | \begin{titlepage} | |
296 | { | |
297 | ||
298 | %\addtolength{\oddsidemargin}{-5cm} | |
299 | %\addtolength{\evensidemargin}{-5cm} | |
300 | \parindent=0cm | |
301 | \addtolength{\textheight}{2cm} | |
302 | ||
303 | \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\ | |
304 | \rule{15cm}{1mm}\\ | |
305 | \vfill | |
306 | \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm} | |
307 | \vfill | |
308 | \rule{15cm}{1mm}\\ | |
309 | \gnusauthor{by Lars Magne Ingebrigtsen} | |
310 | \newpage | |
311 | } | |
312 | ||
313 | \mbox{} | |
314 | \vfill | |
315 | ||
316 | \thispagestyle{empty} | |
317 | ||
318 | @c @insertcopying | |
319 | \newpage | |
320 | \end{titlepage} | |
321 | @end iflatex | |
322 | @end iftex | |
323 | ||
0c973505 | 324 | @dircategory Emacs network features |
4009494e | 325 | @direntry |
62e034c2 | 326 | * Gnus: (gnus). The newsreader Gnus. |
4009494e GM |
327 | @end direntry |
328 | @iftex | |
329 | @finalout | |
330 | @end iftex | |
4009494e GM |
331 | |
332 | ||
333 | @titlepage | |
7fbf7cae TZ |
334 | @ifset WEBHACKDEVEL |
335 | @title Gnus Manual (DEVELOPMENT VERSION) | |
336 | @end ifset | |
337 | @ifclear WEBHACKDEVEL | |
4009494e | 338 | @title Gnus Manual |
7fbf7cae | 339 | @end ifclear |
4009494e GM |
340 | |
341 | @author by Lars Magne Ingebrigtsen | |
342 | @page | |
343 | @vskip 0pt plus 1filll | |
344 | @insertcopying | |
345 | @end titlepage | |
346 | ||
5dc584b5 KB |
347 | @summarycontents |
348 | @contents | |
4009494e GM |
349 | |
350 | @node Top | |
351 | @top The Gnus Newsreader | |
352 | ||
353 | @ifinfo | |
354 | ||
355 | You can read news (and mail) from within Emacs by using Gnus. The news | |
356 | can be gotten by any nefarious means you can think of---@acronym{NNTP}, local | |
357 | spool or your mbox file. All at the same time, if you want to push your | |
358 | luck. | |
359 | ||
360 | @c Adjust ../Makefile.in if you change the following line: | |
c7ff939a | 361 | This manual corresponds to Gnus v5.13 |
4009494e | 362 | |
5dc584b5 KB |
363 | @ifnottex |
364 | @insertcopying | |
365 | @end ifnottex | |
366 | ||
4009494e GM |
367 | @end ifinfo |
368 | ||
369 | @iftex | |
370 | ||
371 | @iflatex | |
372 | \tableofcontents | |
373 | \gnuscleardoublepage | |
374 | @end iflatex | |
375 | ||
376 | Gnus is the advanced, self-documenting, customizable, extensible | |
377 | unreal-time newsreader for GNU Emacs. | |
378 | ||
379 | Oops. That sounds oddly familiar, so let's start over again to avoid | |
380 | being accused of plagiarism: | |
381 | ||
382 | Gnus is a message-reading laboratory. It will let you look at just | |
383 | about anything as if it were a newsgroup. You can read mail with it, | |
384 | you can browse directories with it, you can @code{ftp} with it---you | |
385 | can even read news with it! | |
386 | ||
387 | Gnus tries to empower people who read news the same way Emacs empowers | |
388 | people who edit text. Gnus sets no limits to what the user should be | |
389 | allowed to do. Users are encouraged to extend Gnus to make it behave | |
390 | like they want it to behave. A program should not control people; | |
391 | people should be empowered to do what they want by using (or abusing) | |
392 | the program. | |
393 | ||
9b3ebcb6 | 394 | @c Adjust ../Makefile.in if you change the following line: |
2e4089ab | 395 | This manual corresponds to Gnus v5.13 |
9b3ebcb6 MB |
396 | |
397 | @heading Other related manuals | |
398 | @itemize | |
399 | @item Message manual: Composing messages | |
400 | @item Emacs-MIME: Composing messages; @acronym{MIME}-specific parts. | |
401 | @item Sieve: Managing Sieve scripts in Emacs. | |
3d439cd1 | 402 | @item EasyPG: @acronym{PGP/MIME} with Gnus. |
2e4089ab | 403 | @item SASL: @acronym{SASL} authentication in Emacs. |
9b3ebcb6 MB |
404 | @end itemize |
405 | ||
4009494e GM |
406 | @end iftex |
407 | ||
408 | @menu | |
409 | * Starting Up:: Finding news can be a pain. | |
410 | * Group Buffer:: Selecting, subscribing and killing groups. | |
411 | * Summary Buffer:: Reading, saving and posting articles. | |
412 | * Article Buffer:: Displaying and handling articles. | |
413 | * Composing Messages:: Information on sending mail and news. | |
414 | * Select Methods:: Gnus reads all messages from various select methods. | |
415 | * Scoring:: Assigning values to articles. | |
8a1cdce5 | 416 | * Searching:: Mail and News search engines. |
4009494e GM |
417 | * Various:: General purpose settings. |
418 | * The End:: Farewell and goodbye. | |
419 | * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals. | |
420 | * GNU Free Documentation License:: The license for this documentation. | |
421 | * Index:: Variable, function and concept index. | |
422 | * Key Index:: Key Index. | |
423 | ||
424 | Other related manuals | |
425 | ||
426 | * Message:(message). Composing messages. | |
427 | * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts. | |
428 | * Sieve:(sieve). Managing Sieve scripts in Emacs. | |
3d439cd1 | 429 | * EasyPG:(epa). @acronym{PGP/MIME} with Gnus. |
01c52d31 | 430 | * SASL:(sasl). @acronym{SASL} authentication in Emacs. |
4009494e GM |
431 | |
432 | @detailmenu | |
433 | --- The Detailed Node Listing --- | |
434 | ||
435 | Starting Gnus | |
436 | ||
437 | * Finding the News:: Choosing a method for getting news. | |
4009494e GM |
438 | * The Server is Down:: How can I read my mail then? |
439 | * Slave Gnusae:: You can have more than one Gnus active at a time. | |
440 | * Fetching a Group:: Starting Gnus just to read a group. | |
441 | * New Groups:: What is Gnus supposed to do with new groups? | |
442 | * Changing Servers:: You may want to move from one server to another. | |
443 | * Startup Files:: Those pesky startup files---@file{.newsrc}. | |
444 | * Auto Save:: Recovering from a crash. | |
445 | * The Active File:: Reading the active file over a slow line Takes Time. | |
446 | * Startup Variables:: Other variables you might change. | |
447 | ||
448 | New Groups | |
449 | ||
450 | * Checking New Groups:: Determining what groups are new. | |
451 | * Subscription Methods:: What Gnus should do with new groups. | |
452 | * Filtering New Groups:: Making Gnus ignore certain new groups. | |
453 | ||
454 | Group Buffer | |
455 | ||
456 | * Group Buffer Format:: Information listed and how you can change it. | |
457 | * Group Maneuvering:: Commands for moving in the group buffer. | |
458 | * Selecting a Group:: Actually reading news. | |
459 | * Subscription Commands:: Unsubscribing, killing, subscribing. | |
460 | * Group Data:: Changing the info for a group. | |
461 | * Group Levels:: Levels? What are those, then? | |
462 | * Group Score:: A mechanism for finding out what groups you like. | |
463 | * Marking Groups:: You can mark groups for later processing. | |
464 | * Foreign Groups:: Creating and editing groups. | |
465 | * Group Parameters:: Each group may have different parameters set. | |
466 | * Listing Groups:: Gnus can list various subsets of the groups. | |
467 | * Sorting Groups:: Re-arrange the group order. | |
468 | * Group Maintenance:: Maintaining a tidy @file{.newsrc} file. | |
469 | * Browse Foreign Server:: You can browse a server. See what it has to offer. | |
470 | * Exiting Gnus:: Stop reading news and get some work done. | |
471 | * Group Topics:: A folding group mode divided into topics. | |
01c52d31 | 472 | * Non-ASCII Group Names:: Accessing groups of non-English names. |
4009494e GM |
473 | * Misc Group Stuff:: Other stuff that you can to do. |
474 | ||
475 | Group Buffer Format | |
476 | ||
477 | * Group Line Specification:: Deciding how the group buffer is to look. | |
478 | * Group Mode Line Specification:: The group buffer mode line. | |
479 | * Group Highlighting:: Having nice colors in the group buffer. | |
480 | ||
481 | Group Topics | |
482 | ||
483 | * Topic Commands:: Interactive E-Z commands. | |
484 | * Topic Variables:: How to customize the topics the Lisp Way. | |
485 | * Topic Sorting:: Sorting each topic individually. | |
486 | * Topic Topology:: A map of the world. | |
487 | * Topic Parameters:: Parameters that apply to all groups in a topic. | |
488 | ||
489 | Misc Group Stuff | |
490 | ||
491 | * Scanning New Messages:: Asking Gnus to see whether new messages have arrived. | |
492 | * Group Information:: Information and help on groups and Gnus. | |
493 | * Group Timestamp:: Making Gnus keep track of when you last read a group. | |
494 | * File Commands:: Reading and writing the Gnus files. | |
495 | * Sieve Commands:: Managing Sieve scripts. | |
496 | ||
497 | Summary Buffer | |
498 | ||
499 | * Summary Buffer Format:: Deciding how the summary buffer is to look. | |
500 | * Summary Maneuvering:: Moving around the summary buffer. | |
501 | * Choosing Articles:: Reading articles. | |
502 | * Paging the Article:: Scrolling the current article. | |
503 | * Reply Followup and Post:: Posting articles. | |
504 | * Delayed Articles:: Send articles at a later time. | |
505 | * Marking Articles:: Marking articles as read, expirable, etc. | |
506 | * Limiting:: You can limit the summary buffer. | |
507 | * Threading:: How threads are made. | |
508 | * Sorting the Summary Buffer:: How articles and threads are sorted. | |
509 | * Asynchronous Fetching:: Gnus might be able to pre-fetch articles. | |
510 | * Article Caching:: You may store articles in a cache. | |
511 | * Persistent Articles:: Making articles expiry-resistant. | |
01c52d31 | 512 | * Sticky Articles:: Article buffers that are not reused. |
4009494e GM |
513 | * Article Backlog:: Having already read articles hang around. |
514 | * Saving Articles:: Ways of customizing article saving. | |
515 | * Decoding Articles:: Gnus can treat series of (uu)encoded articles. | |
516 | * Article Treatment:: The article buffer can be mangled at will. | |
517 | * MIME Commands:: Doing MIMEy things with the articles. | |
518 | * Charsets:: Character set issues. | |
519 | * Article Commands:: Doing various things with the article buffer. | |
520 | * Summary Sorting:: Sorting the summary buffer in various ways. | |
521 | * Finding the Parent:: No child support? Get the parent. | |
522 | * Alternative Approaches:: Reading using non-default summaries. | |
523 | * Tree Display:: A more visual display of threads. | |
524 | * Mail Group Commands:: Some commands can only be used in mail groups. | |
525 | * Various Summary Stuff:: What didn't fit anywhere else. | |
526 | * Exiting the Summary Buffer:: Returning to the Group buffer, | |
527 | or reselecting the current group. | |
528 | * Crosspost Handling:: How crossposted articles are dealt with. | |
529 | * Duplicate Suppression:: An alternative when crosspost handling fails. | |
530 | * Security:: Decrypt and Verify. | |
531 | * Mailing List:: Mailing list minor mode. | |
532 | ||
533 | Summary Buffer Format | |
534 | ||
535 | * Summary Buffer Lines:: You can specify how summary lines should look. | |
536 | * To From Newsgroups:: How to not display your own name. | |
537 | * Summary Buffer Mode Line:: You can say how the mode line should look. | |
538 | * Summary Highlighting:: Making the summary buffer all pretty and nice. | |
539 | ||
540 | Choosing Articles | |
541 | ||
542 | * Choosing Commands:: Commands for choosing articles. | |
543 | * Choosing Variables:: Variables that influence these commands. | |
544 | ||
545 | Reply, Followup and Post | |
546 | ||
547 | * Summary Mail Commands:: Sending mail. | |
548 | * Summary Post Commands:: Sending news. | |
549 | * Summary Message Commands:: Other Message-related commands. | |
550 | * Canceling and Superseding:: | |
551 | ||
552 | Marking Articles | |
553 | ||
554 | * Unread Articles:: Marks for unread articles. | |
555 | * Read Articles:: Marks for read articles. | |
556 | * Other Marks:: Marks that do not affect readedness. | |
557 | * Setting Marks:: How to set and remove marks. | |
558 | * Generic Marking Commands:: How to customize the marking. | |
559 | * Setting Process Marks:: How to mark articles for later processing. | |
560 | ||
561 | Threading | |
562 | ||
563 | * Customizing Threading:: Variables you can change to affect the threading. | |
564 | * Thread Commands:: Thread based commands in the summary buffer. | |
565 | ||
566 | Customizing Threading | |
567 | ||
568 | * Loose Threads:: How Gnus gathers loose threads into bigger threads. | |
569 | * Filling In Threads:: Making the threads displayed look fuller. | |
570 | * More Threading:: Even more variables for fiddling with threads. | |
571 | * Low-Level Threading:: You thought it was over@dots{} but you were wrong! | |
572 | ||
573 | Decoding Articles | |
574 | ||
575 | * Uuencoded Articles:: Uudecode articles. | |
576 | * Shell Archives:: Unshar articles. | |
577 | * PostScript Files:: Split PostScript. | |
578 | * Other Files:: Plain save and binhex. | |
579 | * Decoding Variables:: Variables for a happy decoding. | |
580 | * Viewing Files:: You want to look at the result of the decoding? | |
581 | ||
582 | Decoding Variables | |
583 | ||
584 | * Rule Variables:: Variables that say how a file is to be viewed. | |
585 | * Other Decode Variables:: Other decode variables. | |
586 | * Uuencoding and Posting:: Variables for customizing uuencoding. | |
587 | ||
588 | Article Treatment | |
589 | ||
590 | * Article Highlighting:: You want to make the article look like fruit salad. | |
591 | * Article Fontisizing:: Making emphasized text look nice. | |
592 | * Article Hiding:: You also want to make certain info go away. | |
593 | * Article Washing:: Lots of way-neat functions to make life better. | |
594 | * Article Header:: Doing various header transformations. | |
595 | * Article Buttons:: Click on URLs, Message-IDs, addresses and the like. | |
596 | * Article Button Levels:: Controlling appearance of buttons. | |
597 | * Article Date:: Grumble, UT! | |
61b1af82 | 598 | * Article Display:: Display various stuff---X-Face, Picons, Smileys, Gravatars |
4009494e GM |
599 | * Article Signature:: What is a signature? |
600 | * Article Miscellanea:: Various other stuff. | |
601 | ||
602 | Alternative Approaches | |
603 | ||
604 | * Pick and Read:: First mark articles and then read them. | |
605 | * Binary Groups:: Auto-decode all articles. | |
606 | ||
607 | Various Summary Stuff | |
608 | ||
609 | * Summary Group Information:: Information oriented commands. | |
610 | * Searching for Articles:: Multiple article commands. | |
611 | * Summary Generation Commands:: | |
612 | * Really Various Summary Commands:: Those pesky non-conformant commands. | |
613 | ||
614 | Article Buffer | |
615 | ||
616 | * Hiding Headers:: Deciding what headers should be displayed. | |
617 | * Using MIME:: Pushing articles through @acronym{MIME} before reading them. | |
618 | * Customizing Articles:: Tailoring the look of the articles. | |
619 | * Article Keymap:: Keystrokes available in the article buffer. | |
620 | * Misc Article:: Other stuff. | |
621 | ||
622 | Composing Messages | |
623 | ||
624 | * Mail:: Mailing and replying. | |
625 | * Posting Server:: What server should you post and mail via? | |
626 | * POP before SMTP:: You cannot send a mail unless you read a mail. | |
627 | * Mail and Post:: Mailing and posting at the same time. | |
628 | * Archived Messages:: Where Gnus stores the messages you've sent. | |
629 | * Posting Styles:: An easier way to specify who you are. | |
630 | * Drafts:: Postponing messages and rejected messages. | |
631 | * Rejected Articles:: What happens if the server doesn't like your article? | |
632 | * Signing and encrypting:: How to compose secure messages. | |
633 | ||
634 | Select Methods | |
635 | ||
636 | * Server Buffer:: Making and editing virtual servers. | |
637 | * Getting News:: Reading USENET news with Gnus. | |
229b59da | 638 | * Using IMAP:: Reading mail from @acronym{IMAP}. |
4009494e GM |
639 | * Getting Mail:: Reading your personal mail with Gnus. |
640 | * Browsing the Web:: Getting messages from a plethora of Web sources. | |
c4d82de8 | 641 | * Other Sources:: Reading directories, files. |
4009494e GM |
642 | * Combined Groups:: Combining groups into one group. |
643 | * Email Based Diary:: Using mails to manage diary events in Gnus. | |
644 | * Gnus Unplugged:: Reading news and mail offline. | |
645 | ||
646 | Server Buffer | |
647 | ||
648 | * Server Buffer Format:: You can customize the look of this buffer. | |
649 | * Server Commands:: Commands to manipulate servers. | |
650 | * Example Methods:: Examples server specifications. | |
651 | * Creating a Virtual Server:: An example session. | |
652 | * Server Variables:: Which variables to set. | |
653 | * Servers and Methods:: You can use server names as select methods. | |
654 | * Unavailable Servers:: Some servers you try to contact may be down. | |
655 | ||
656 | Getting News | |
657 | ||
658 | * NNTP:: Reading news from an @acronym{NNTP} server. | |
659 | * News Spool:: Reading news from the local spool. | |
660 | ||
661 | @acronym{NNTP} | |
662 | ||
663 | * Direct Functions:: Connecting directly to the server. | |
664 | * Indirect Functions:: Connecting indirectly to the server. | |
665 | * Common Variables:: Understood by several connection functions. | |
666 | ||
667 | Getting Mail | |
668 | ||
669 | * Mail in a Newsreader:: Important introductory notes. | |
670 | * Getting Started Reading Mail:: A simple cookbook example. | |
671 | * Splitting Mail:: How to create mail groups. | |
672 | * Mail Sources:: How to tell Gnus where to get mail from. | |
673 | * Mail Back End Variables:: Variables for customizing mail handling. | |
674 | * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. | |
675 | * Group Mail Splitting:: Use group customize to drive mail splitting. | |
676 | * Incorporating Old Mail:: What about the old mail you have? | |
677 | * Expiring Mail:: Getting rid of unwanted mail. | |
678 | * Washing Mail:: Removing cruft from the mail you get. | |
679 | * Duplicates:: Dealing with duplicated mail. | |
680 | * Not Reading Mail:: Using mail back ends for reading other files. | |
681 | * Choosing a Mail Back End:: Gnus can read a variety of mail formats. | |
682 | ||
683 | Mail Sources | |
684 | ||
685 | * Mail Source Specifiers:: How to specify what a mail source is. | |
686 | * Mail Source Customization:: Some variables that influence things. | |
687 | * Fetching Mail:: Using the mail source specifiers. | |
688 | ||
689 | Choosing a Mail Back End | |
690 | ||
691 | * Unix Mail Box:: Using the (quite) standard Un*x mbox. | |
bc79f9ab | 692 | * Babyl:: Babyl was used by older versions of Rmail. |
4009494e GM |
693 | * Mail Spool:: Store your mail in a private spool? |
694 | * MH Spool:: An mhspool-like back end. | |
695 | * Maildir:: Another one-file-per-message format. | |
696 | * Mail Folders:: Having one file for each group. | |
697 | * Comparing Mail Back Ends:: An in-depth looks at pros and cons. | |
698 | ||
699 | Browsing the Web | |
700 | ||
701 | * Archiving Mail:: | |
702 | * Web Searches:: Creating groups from articles that match a string. | |
4009494e GM |
703 | * RSS:: Reading RDF site summary. |
704 | * Customizing W3:: Doing stuff to Emacs/W3 from Gnus. | |
705 | ||
4009494e GM |
706 | Other Sources |
707 | ||
708 | * Directory Groups:: You can read a directory as if it was a newsgroup. | |
709 | * Anything Groups:: Dired? Who needs dired? | |
710 | * Document Groups:: Single files can be the basis of a group. | |
4009494e | 711 | * Mail-To-News Gateways:: Posting articles via mail-to-news gateways. |
c5ecc769 | 712 | * The Empty Backend:: The backend that never has any news. |
4009494e GM |
713 | |
714 | Document Groups | |
715 | ||
716 | * Document Server Internals:: How to add your own document types. | |
717 | ||
4009494e GM |
718 | Combined Groups |
719 | ||
720 | * Virtual Groups:: Combining articles from many groups. | |
4009494e GM |
721 | |
722 | Email Based Diary | |
723 | ||
724 | * The NNDiary Back End:: Basic setup and usage. | |
725 | * The Gnus Diary Library:: Utility toolkit on top of nndiary. | |
726 | * Sending or Not Sending:: A final note on sending diary messages. | |
727 | ||
728 | The NNDiary Back End | |
729 | ||
730 | * Diary Messages:: What makes a message valid for nndiary. | |
731 | * Running NNDiary:: NNDiary has two modes of operation. | |
732 | * Customizing NNDiary:: Bells and whistles. | |
733 | ||
734 | The Gnus Diary Library | |
735 | ||
736 | * Diary Summary Line Format:: A nicer summary buffer line format. | |
737 | * Diary Articles Sorting:: A nicer way to sort messages. | |
738 | * Diary Headers Generation:: Not doing it manually. | |
739 | * Diary Group Parameters:: Not handling them manually. | |
740 | ||
741 | Gnus Unplugged | |
742 | ||
743 | * Agent Basics:: How it all is supposed to work. | |
744 | * Agent Categories:: How to tell the Gnus Agent what to download. | |
745 | * Agent Commands:: New commands for all the buffers. | |
746 | * Agent Visuals:: Ways that the agent may effect your summary buffer. | |
747 | * Agent as Cache:: The Agent is a big cache too. | |
748 | * Agent Expiry:: How to make old articles go away. | |
749 | * Agent Regeneration:: How to recover from lost connections and other accidents. | |
01c52d31 | 750 | * Agent and flags:: How the Agent maintains flags. |
4009494e GM |
751 | * Agent and IMAP:: How to use the Agent with @acronym{IMAP}. |
752 | * Outgoing Messages:: What happens when you post/mail something? | |
753 | * Agent Variables:: Customizing is fun. | |
754 | * Example Setup:: An example @file{~/.gnus.el} file for offline people. | |
755 | * Batching Agents:: How to fetch news from a @code{cron} job. | |
756 | * Agent Caveats:: What you think it'll do and what it does. | |
757 | ||
758 | Agent Categories | |
759 | ||
760 | * Category Syntax:: What a category looks like. | |
761 | * Category Buffer:: A buffer for maintaining categories. | |
762 | * Category Variables:: Customize'r'Us. | |
763 | ||
764 | Agent Commands | |
765 | ||
766 | * Group Agent Commands:: Configure groups and fetch their contents. | |
767 | * Summary Agent Commands:: Manually select then fetch specific articles. | |
768 | * Server Agent Commands:: Select the servers that are supported by the agent. | |
769 | ||
770 | Scoring | |
771 | ||
772 | * Summary Score Commands:: Adding score entries for the current group. | |
773 | * Group Score Commands:: General score commands. | |
774 | * Score Variables:: Customize your scoring. (My, what terminology). | |
775 | * Score File Format:: What a score file may contain. | |
776 | * Score File Editing:: You can edit score files by hand as well. | |
777 | * Adaptive Scoring:: Big Sister Gnus knows what you read. | |
778 | * Home Score File:: How to say where new score entries are to go. | |
779 | * Followups To Yourself:: Having Gnus notice when people answer you. | |
780 | * Scoring On Other Headers:: Scoring on non-standard headers. | |
781 | * Scoring Tips:: How to score effectively. | |
782 | * Reverse Scoring:: That problem child of old is not problem. | |
783 | * Global Score Files:: Earth-spanning, ear-splitting score files. | |
784 | * Kill Files:: They are still here, but they can be ignored. | |
785 | * Converting Kill Files:: Translating kill files to score files. | |
4009494e GM |
786 | * Advanced Scoring:: Using logical expressions to build score rules. |
787 | * Score Decays:: It can be useful to let scores wither away. | |
788 | ||
4009494e GM |
789 | Advanced Scoring |
790 | ||
791 | * Advanced Scoring Syntax:: A definition. | |
792 | * Advanced Scoring Examples:: What they look like. | |
793 | * Advanced Scoring Tips:: Getting the most out of it. | |
794 | ||
8a1cdce5 AC |
795 | Searching |
796 | ||
797 | * nnir:: Searching with various engines. | |
798 | * nnmairix:: Searching with Mairix. | |
799 | ||
800 | nnir | |
801 | ||
156e3f9c | 802 | * What is nnir?:: What does nnir do. |
8a1cdce5 AC |
803 | * Basic Usage:: How to perform simple searches. |
804 | * Setting up nnir:: How to set up nnir. | |
805 | ||
806 | Setting up nnir | |
807 | ||
808 | * Associating Engines:: How to associate engines. | |
809 | ||
4009494e GM |
810 | Various |
811 | ||
812 | * Process/Prefix:: A convention used by many treatment commands. | |
813 | * Interactive:: Making Gnus ask you many questions. | |
814 | * Symbolic Prefixes:: How to supply some Gnus functions with options. | |
815 | * Formatting Variables:: You can specify what buffers should look like. | |
816 | * Window Layout:: Configuring the Gnus buffer windows. | |
817 | * Faces and Fonts:: How to change how faces look. | |
4009494e GM |
818 | * Mode Lines:: Displaying information in the mode lines. |
819 | * Highlighting and Menus:: Making buffers look all nice and cozy. | |
4009494e | 820 | * Daemons:: Gnus can do things behind your back. |
4009494e GM |
821 | * Undo:: Some actions can be undone. |
822 | * Predicate Specifiers:: Specifying predicates. | |
823 | * Moderation:: What to do if you're a moderator. | |
824 | * Image Enhancements:: Modern versions of Emacs/XEmacs can display images. | |
825 | * Fuzzy Matching:: What's the big fuzz? | |
826 | * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email. | |
827 | * Spam Package:: A package for filtering and processing spam. | |
64763fe3 | 828 | * The Gnus Registry:: A package for tracking messages by Message-ID. |
4009494e GM |
829 | * Other modes:: Interaction with other modes. |
830 | * Various Various:: Things that are really various. | |
831 | ||
832 | Formatting Variables | |
833 | ||
834 | * Formatting Basics:: A formatting variable is basically a format string. | |
835 | * Mode Line Formatting:: Some rules about mode line formatting variables. | |
836 | * Advanced Formatting:: Modifying output in various ways. | |
837 | * User-Defined Specs:: Having Gnus call your own functions. | |
838 | * Formatting Fonts:: Making the formatting look colorful and nice. | |
839 | * Positioning Point:: Moving point to a position after an operation. | |
840 | * Tabulation:: Tabulating your output. | |
841 | * Wide Characters:: Dealing with wide characters. | |
842 | ||
843 | Image Enhancements | |
844 | ||
845 | * X-Face:: Display a funky, teensy black-and-white image. | |
846 | * Face:: Display a funkier, teensier colored image. | |
847 | * Smileys:: Show all those happy faces the way they were | |
848 | meant to be shown. | |
849 | * Picons:: How to display pictures of what you're reading. | |
fcf2d385 | 850 | * Gravatars:: Display the avatar of people you read. |
4009494e GM |
851 | * XVarious:: Other XEmacsy Gnusey variables. |
852 | ||
853 | Thwarting Email Spam | |
854 | ||
855 | * The problem of spam:: Some background, and some solutions | |
856 | * Anti-Spam Basics:: Simple steps to reduce the amount of spam. | |
857 | * SpamAssassin:: How to use external anti-spam tools. | |
858 | * Hashcash:: Reduce spam by burning CPU time. | |
859 | ||
860 | Spam Package | |
861 | ||
862 | * Spam Package Introduction:: | |
863 | * Filtering Incoming Mail:: | |
864 | * Detecting Spam in Groups:: | |
865 | * Spam and Ham Processors:: | |
866 | * Spam Package Configuration Examples:: | |
867 | * Spam Back Ends:: | |
868 | * Extending the Spam package:: | |
869 | * Spam Statistics Package:: | |
870 | ||
871 | Spam Statistics Package | |
872 | ||
873 | * Creating a spam-stat dictionary:: | |
874 | * Splitting mail using spam-stat:: | |
875 | * Low-level interface to the spam-stat dictionary:: | |
876 | ||
877 | Appendices | |
878 | ||
879 | * XEmacs:: Requirements for installing under XEmacs. | |
880 | * History:: How Gnus got where it is today. | |
881 | * On Writing Manuals:: Why this is not a beginner's guide. | |
882 | * Terminology:: We use really difficult, like, words here. | |
883 | * Customization:: Tailoring Gnus to your needs. | |
884 | * Troubleshooting:: What you might try if things do not work. | |
885 | * Gnus Reference Guide:: Rilly, rilly technical stuff. | |
886 | * Emacs for Heathens:: A short introduction to Emacsian terms. | |
887 | * Frequently Asked Questions:: The Gnus FAQ | |
888 | ||
889 | History | |
890 | ||
891 | * Gnus Versions:: What Gnus versions have been released. | |
4009494e GM |
892 | * Why?:: What's the point of Gnus? |
893 | * Compatibility:: Just how compatible is Gnus with @sc{gnus}? | |
894 | * Conformity:: Gnus tries to conform to all standards. | |
895 | * Emacsen:: Gnus can be run on a few modern Emacsen. | |
896 | * Gnus Development:: How Gnus is developed. | |
897 | * Contributors:: Oodles of people. | |
898 | * New Features:: Pointers to some of the new stuff in Gnus. | |
899 | ||
900 | New Features | |
901 | ||
902 | * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. | |
903 | * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. | |
904 | * Red Gnus:: Third time best---Gnus 5.4/5.5. | |
905 | * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. | |
906 | * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. | |
907 | * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11. | |
89b163db G |
908 | * No Gnus:: Very punny. Gnus 5.12/5.13 |
909 | * Ma Gnus:: Celebrating 25 years of Gnus. | |
4009494e GM |
910 | |
911 | Customization | |
912 | ||
913 | * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. | |
914 | * Slow Terminal Connection:: You run a remote Emacs. | |
915 | * Little Disk Space:: You feel that having large setup files is icky. | |
916 | * Slow Machine:: You feel like buying a faster machine. | |
917 | ||
918 | Gnus Reference Guide | |
919 | ||
920 | * Gnus Utility Functions:: Common functions and variable to use. | |
921 | * Back End Interface:: How Gnus communicates with the servers. | |
922 | * Score File Syntax:: A BNF definition of the score file standard. | |
923 | * Headers:: How Gnus stores headers internally. | |
924 | * Ranges:: A handy format for storing mucho numbers. | |
925 | * Group Info:: The group info format. | |
926 | * Extended Interactive:: Symbolic prefixes and stuff. | |
927 | * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. | |
928 | * Various File Formats:: Formats of files that Gnus use. | |
929 | ||
930 | Back End Interface | |
931 | ||
932 | * Required Back End Functions:: Functions that must be implemented. | |
933 | * Optional Back End Functions:: Functions that need not be implemented. | |
934 | * Error Messaging:: How to get messages and report errors. | |
935 | * Writing New Back Ends:: Extending old back ends. | |
936 | * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. | |
937 | * Mail-like Back Ends:: Some tips on mail back ends. | |
938 | ||
939 | Various File Formats | |
940 | ||
941 | * Active File Format:: Information on articles and groups available. | |
942 | * Newsgroups File Format:: Group descriptions. | |
943 | ||
944 | Emacs for Heathens | |
945 | ||
946 | * Keystrokes:: Entering text and executing commands. | |
947 | * Emacs Lisp:: The built-in Emacs programming language. | |
948 | ||
949 | @end detailmenu | |
950 | @end menu | |
951 | ||
952 | @node Starting Up | |
953 | @chapter Starting Gnus | |
954 | @cindex starting up | |
955 | ||
956 | If you haven't used Emacs much before using Gnus, read @ref{Emacs for | |
957 | Heathens} first. | |
958 | ||
959 | @kindex M-x gnus | |
960 | @findex gnus | |
961 | If your system administrator has set things up properly, starting Gnus | |
962 | and reading news is extremely easy---you just type @kbd{M-x gnus} in | |
963 | your Emacs. If not, you should customize the variable | |
964 | @code{gnus-select-method} as described in @ref{Finding the News}. For a | |
965 | minimal setup for posting should also customize the variables | |
966 | @code{user-full-name} and @code{user-mail-address}. | |
967 | ||
968 | @findex gnus-other-frame | |
969 | @kindex M-x gnus-other-frame | |
970 | If you want to start Gnus in a different frame, you can use the command | |
971 | @kbd{M-x gnus-other-frame} instead. | |
972 | ||
973 | If things do not go smoothly at startup, you have to twiddle some | |
974 | variables in your @file{~/.gnus.el} file. This file is similar to | |
975 | @file{~/.emacs}, but is read when Gnus starts. | |
976 | ||
977 | If you puzzle at any terms used in this manual, please refer to the | |
978 | terminology section (@pxref{Terminology}). | |
979 | ||
980 | @menu | |
981 | * Finding the News:: Choosing a method for getting news. | |
4009494e GM |
982 | * The Server is Down:: How can I read my mail then? |
983 | * Slave Gnusae:: You can have more than one Gnus active at a time. | |
984 | * New Groups:: What is Gnus supposed to do with new groups? | |
985 | * Changing Servers:: You may want to move from one server to another. | |
986 | * Startup Files:: Those pesky startup files---@file{.newsrc}. | |
987 | * Auto Save:: Recovering from a crash. | |
988 | * The Active File:: Reading the active file over a slow line Takes Time. | |
989 | * Startup Variables:: Other variables you might change. | |
990 | @end menu | |
991 | ||
992 | ||
993 | @node Finding the News | |
994 | @section Finding the News | |
995 | @cindex finding news | |
996 | ||
357e2d8e KY |
997 | First of all, you should know that there is a special buffer called |
998 | @code{*Server*} that lists all the servers Gnus knows about. You can | |
999 | press @kbd{^} from the Group buffer to see it. In the Server buffer, | |
1000 | you can press @kbd{RET} on a defined server to see all the groups it | |
1001 | serves (subscribed or not!). You can also add or delete servers, edit | |
1002 | a foreign server's definition, agentize or de-agentize a server, and | |
fe3c5669 | 1003 | do many other neat things. @xref{Server Buffer}. |
357e2d8e KY |
1004 | @xref{Foreign Groups}. @xref{Agent Basics}. |
1005 | ||
4009494e GM |
1006 | @vindex gnus-select-method |
1007 | @c @head | |
1008 | The @code{gnus-select-method} variable says where Gnus should look for | |
1009 | news. This variable should be a list where the first element says | |
1010 | @dfn{how} and the second element says @dfn{where}. This method is your | |
1011 | native method. All groups not fetched with this method are | |
0afb49a1 | 1012 | secondary or foreign groups. |
4009494e GM |
1013 | |
1014 | For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where | |
1015 | you want to get your daily dosage of news from, you'd say: | |
1016 | ||
1017 | @lisp | |
1018 | (setq gnus-select-method '(nntp "news.somewhere.edu")) | |
1019 | @end lisp | |
1020 | ||
1021 | If you want to read directly from the local spool, say: | |
1022 | ||
1023 | @lisp | |
1024 | (setq gnus-select-method '(nnspool "")) | |
1025 | @end lisp | |
1026 | ||
1027 | If you can use a local spool, you probably should, as it will almost | |
1028 | certainly be much faster. But do not use the local spool if your | |
1029 | server is running Leafnode (which is a simple, standalone private news | |
1030 | server); in this case, use @code{(nntp "localhost")}. | |
1031 | ||
1032 | @vindex gnus-nntpserver-file | |
1033 | @cindex NNTPSERVER | |
1034 | @cindex @acronym{NNTP} server | |
1035 | If this variable is not set, Gnus will take a look at the | |
1036 | @env{NNTPSERVER} environment variable. If that variable isn't set, | |
1037 | Gnus will see whether @code{gnus-nntpserver-file} | |
1038 | (@file{/etc/nntpserver} by default) has any opinions on the matter. | |
1039 | If that fails as well, Gnus will try to use the machine running Emacs | |
1040 | as an @acronym{NNTP} server. That's a long shot, though. | |
1041 | ||
4009494e GM |
1042 | @findex gnus-group-browse-foreign-server |
1043 | @kindex B (Group) | |
1044 | However, if you use one @acronym{NNTP} server regularly and are just | |
1045 | interested in a couple of groups from a different server, you would be | |
1046 | better served by using the @kbd{B} command in the group buffer. It will | |
1047 | let you have a look at what groups are available, and you can subscribe | |
1048 | to any of the groups you want to. This also makes @file{.newsrc} | |
1049 | maintenance much tidier. @xref{Foreign Groups}. | |
1050 | ||
1051 | @vindex gnus-secondary-select-methods | |
1052 | @c @head | |
1053 | A slightly different approach to foreign groups is to set the | |
1054 | @code{gnus-secondary-select-methods} variable. The select methods | |
1055 | listed in this variable are in many ways just as native as the | |
1056 | @code{gnus-select-method} server. They will also be queried for active | |
1057 | files during startup (if that's required), and new newsgroups that | |
1058 | appear on these servers will be subscribed (or not) just as native | |
1059 | groups are. | |
1060 | ||
1061 | For instance, if you use the @code{nnmbox} back end to read your mail, | |
1062 | you would typically set this variable to | |
1063 | ||
1064 | @lisp | |
1065 | (setq gnus-secondary-select-methods '((nnmbox ""))) | |
1066 | @end lisp | |
1067 | ||
01c52d31 | 1068 | |
4009494e | 1069 | |
4009494e GM |
1070 | @node The Server is Down |
1071 | @section The Server is Down | |
1072 | @cindex server errors | |
1073 | ||
1074 | If the default server is down, Gnus will understandably have some | |
1075 | problems starting. However, if you have some mail groups in addition to | |
1076 | the news groups, you may want to start Gnus anyway. | |
1077 | ||
1078 | Gnus, being the trusting sort of program, will ask whether to proceed | |
1079 | without a native select method if that server can't be contacted. This | |
1080 | will happen whether the server doesn't actually exist (i.e., you have | |
1081 | given the wrong address) or the server has just momentarily taken ill | |
1082 | for some reason or other. If you decide to continue and have no foreign | |
1083 | groups, you'll find it difficult to actually do anything in the group | |
1084 | buffer. But, hey, that's your problem. Blllrph! | |
1085 | ||
1086 | @findex gnus-no-server | |
1087 | @kindex M-x gnus-no-server | |
1088 | @c @head | |
1089 | If you know that the server is definitely down, or you just want to read | |
1090 | your mail without bothering with the server at all, you can use the | |
1091 | @code{gnus-no-server} command to start Gnus. That might come in handy | |
1092 | if you're in a hurry as well. This command will not attempt to contact | |
1093 | your primary server---instead, it will just activate all groups on level | |
1094 | 1 and 2. (You should preferably keep no native groups on those two | |
1095 | levels.) Also @pxref{Group Levels}. | |
1096 | ||
1097 | ||
1098 | @node Slave Gnusae | |
1099 | @section Slave Gnusae | |
1100 | @cindex slave | |
1101 | ||
1102 | You might want to run more than one Emacs with more than one Gnus at the | |
1103 | same time. If you are using different @file{.newsrc} files (e.g., if you | |
1104 | are using the two different Gnusae to read from two different servers), | |
1105 | that is no problem whatsoever. You just do it. | |
1106 | ||
1107 | The problem appears when you want to run two Gnusae that use the same | |
1108 | @file{.newsrc} file. | |
1109 | ||
1110 | To work around that problem some, we here at the Think-Tank at the Gnus | |
1111 | Towers have come up with a new concept: @dfn{Masters} and | |
1112 | @dfn{slaves}. (We have applied for a patent on this concept, and have | |
1113 | taken out a copyright on those words. If you wish to use those words in | |
1114 | conjunction with each other, you have to send $1 per usage instance to | |
1115 | me. Usage of the patent (@dfn{Master/Slave Relationships In Computer | |
1116 | Applications}) will be much more expensive, of course.) | |
1117 | ||
1118 | @findex gnus-slave | |
1119 | Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or | |
1120 | however you do it). Each subsequent slave Gnusae should be started with | |
1121 | @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc} | |
1122 | files, but instead save @dfn{slave files} that contain information only | |
1123 | on what groups have been read in the slave session. When a master Gnus | |
1124 | starts, it will read (and delete) these slave files, incorporating all | |
1125 | information from them. (The slave files will be read in the sequence | |
1126 | they were created, so the latest changes will have precedence.) | |
1127 | ||
1128 | Information from the slave files has, of course, precedence over the | |
1129 | information in the normal (i.e., master) @file{.newsrc} file. | |
1130 | ||
1131 | If the @file{.newsrc*} files have not been saved in the master when the | |
1132 | slave starts, you may be prompted as to whether to read an auto-save | |
1133 | file. If you answer ``yes'', the unsaved changes to the master will be | |
1134 | incorporated into the slave. If you answer ``no'', the slave may see some | |
1135 | messages as unread that have been read in the master. | |
1136 | ||
1137 | ||
1138 | ||
1139 | @node New Groups | |
1140 | @section New Groups | |
1141 | @cindex new groups | |
1142 | @cindex subscription | |
1143 | ||
1144 | @vindex gnus-check-new-newsgroups | |
1145 | If you are satisfied that you really never want to see any new groups, | |
1146 | you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will | |
1147 | also save you some time at startup. Even if this variable is | |
1148 | @code{nil}, you can always subscribe to the new groups just by pressing | |
1149 | @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable | |
1150 | is @code{ask-server} by default. If you set this variable to | |
1151 | @code{always}, then Gnus will query the back ends for new groups even | |
1152 | when you do the @kbd{g} command (@pxref{Scanning New Messages}). | |
1153 | ||
1154 | @menu | |
1155 | * Checking New Groups:: Determining what groups are new. | |
1156 | * Subscription Methods:: What Gnus should do with new groups. | |
1157 | * Filtering New Groups:: Making Gnus ignore certain new groups. | |
1158 | @end menu | |
1159 | ||
1160 | ||
1161 | @node Checking New Groups | |
1162 | @subsection Checking New Groups | |
1163 | ||
cd865a33 | 1164 | Gnus normally determines whether a group is new or not by comparing |
7d1738f1 LMI |
1165 | the list of groups from the active file(s) with the lists of |
1166 | subscribed and dead groups. This isn't a particularly fast method. | |
1167 | If @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will | |
1168 | ask the server for new groups since the last time. This is both | |
1169 | faster and cheaper. This also means that you can get rid of the list | |
1170 | of killed groups (@pxref{Group Levels}) altogether, so you may set | |
cd865a33 G |
1171 | @code{gnus-save-killed-list} to @code{nil}, which will save time both |
1172 | at startup, at exit, and all over. Saves disk space, too. Why isn't | |
1173 | this the default, then? Unfortunately, not all servers support this | |
1174 | command. | |
4009494e GM |
1175 | |
1176 | I bet I know what you're thinking now: How do I find out whether my | |
1177 | server supports @code{ask-server}? No? Good, because I don't have a | |
1178 | fail-safe answer. I would suggest just setting this variable to | |
1179 | @code{ask-server} and see whether any new groups appear within the next | |
1180 | few days. If any do, then it works. If none do, then it doesn't | |
1181 | work. I could write a function to make Gnus guess whether the server | |
1182 | supports @code{ask-server}, but it would just be a guess. So I won't. | |
1183 | You could @code{telnet} to the server and say @code{HELP} and see | |
1184 | whether it lists @samp{NEWGROUPS} among the commands it understands. If | |
1185 | it does, then it might work. (But there are servers that lists | |
1186 | @samp{NEWGROUPS} without supporting the function properly.) | |
1187 | ||
1188 | This variable can also be a list of select methods. If so, Gnus will | |
1189 | issue an @code{ask-server} command to each of the select methods, and | |
1190 | subscribe them (or not) using the normal methods. This might be handy | |
1191 | if you are monitoring a few servers for new groups. A side effect is | |
1192 | that startup will take much longer, so you can meditate while waiting. | |
1193 | Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss. | |
1194 | ||
1195 | ||
1196 | @node Subscription Methods | |
1197 | @subsection Subscription Methods | |
1198 | ||
1199 | @vindex gnus-subscribe-newsgroup-method | |
1200 | What Gnus does when it encounters a new group is determined by the | |
1201 | @code{gnus-subscribe-newsgroup-method} variable. | |
1202 | ||
1203 | This variable should contain a function. This function will be called | |
1204 | with the name of the new group as the only parameter. | |
1205 | ||
1206 | Some handy pre-fab functions are: | |
1207 | ||
1208 | @table @code | |
1209 | ||
1210 | @item gnus-subscribe-zombies | |
1211 | @vindex gnus-subscribe-zombies | |
cd865a33 G |
1212 | Make all new groups zombies (@pxref{Group Levels}). This is the |
1213 | default. You can browse the zombies later (with @kbd{A z}) and either | |
1214 | kill them all off properly (with @kbd{S z}), or subscribe to them | |
1215 | (with @kbd{u}). | |
4009494e GM |
1216 | |
1217 | @item gnus-subscribe-randomly | |
1218 | @vindex gnus-subscribe-randomly | |
1219 | Subscribe all new groups in arbitrary order. This really means that all | |
1220 | new groups will be added at ``the top'' of the group buffer. | |
1221 | ||
1222 | @item gnus-subscribe-alphabetically | |
1223 | @vindex gnus-subscribe-alphabetically | |
1224 | Subscribe all new groups in alphabetical order. | |
1225 | ||
1226 | @item gnus-subscribe-hierarchically | |
1227 | @vindex gnus-subscribe-hierarchically | |
1228 | Subscribe all new groups hierarchically. The difference between this | |
1229 | function and @code{gnus-subscribe-alphabetically} is slight. | |
1230 | @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly | |
1231 | alphabetical fashion, while this function will enter groups into its | |
1232 | hierarchy. So if you want to have the @samp{rec} hierarchy before the | |
1233 | @samp{comp} hierarchy, this function will not mess that configuration | |
1234 | up. Or something like that. | |
1235 | ||
1236 | @item gnus-subscribe-interactively | |
1237 | @vindex gnus-subscribe-interactively | |
1238 | Subscribe new groups interactively. This means that Gnus will ask | |
1239 | you about @strong{all} new groups. The groups you choose to subscribe | |
1240 | to will be subscribed hierarchically. | |
1241 | ||
1242 | @item gnus-subscribe-killed | |
1243 | @vindex gnus-subscribe-killed | |
1244 | Kill all new groups. | |
1245 | ||
1246 | @item gnus-subscribe-topics | |
1247 | @vindex gnus-subscribe-topics | |
1248 | Put the groups into the topic that has a matching @code{subscribe} topic | |
1249 | parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe} | |
1250 | topic parameter that looks like | |
1251 | ||
1252 | @example | |
77ae8989 | 1253 | "nnml" |
4009494e GM |
1254 | @end example |
1255 | ||
1256 | will mean that all groups that match that regex will be subscribed under | |
1257 | that topic. | |
1258 | ||
1259 | If no topics match the groups, the groups will be subscribed in the | |
1260 | top-level topic. | |
1261 | ||
1262 | @end table | |
1263 | ||
1264 | @vindex gnus-subscribe-hierarchical-interactive | |
1265 | A closely related variable is | |
1266 | @code{gnus-subscribe-hierarchical-interactive}. (That's quite a | |
1267 | mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a | |
1268 | hierarchical fashion whether to subscribe to new groups or not. Gnus | |
1269 | will ask you for each sub-hierarchy whether you want to descend the | |
1270 | hierarchy or not. | |
1271 | ||
1272 | One common mistake is to set the variable a few paragraphs above | |
1273 | (@code{gnus-subscribe-newsgroup-method}) to | |
1274 | @code{gnus-subscribe-hierarchical-interactive}. This is an error. This | |
1275 | will not work. This is ga-ga. So don't do it. | |
1276 | ||
1277 | ||
1278 | @node Filtering New Groups | |
1279 | @subsection Filtering New Groups | |
1280 | ||
1281 | A nice and portable way to control which new newsgroups should be | |
1282 | subscribed (or ignored) is to put an @dfn{options} line at the start of | |
1283 | the @file{.newsrc} file. Here's an example: | |
1284 | ||
1285 | @example | |
1286 | options -n !alt.all !rec.all sci.all | |
1287 | @end example | |
1288 | ||
1289 | @vindex gnus-subscribe-options-newsgroup-method | |
1290 | This line obviously belongs to a serious-minded intellectual scientific | |
1291 | person (or she may just be plain old boring), because it says that all | |
1292 | groups that have names beginning with @samp{alt} and @samp{rec} should | |
1293 | be ignored, and all groups with names beginning with @samp{sci} should | |
1294 | be subscribed. Gnus will not use the normal subscription method for | |
1295 | subscribing these groups. | |
1296 | @code{gnus-subscribe-options-newsgroup-method} is used instead. This | |
1297 | variable defaults to @code{gnus-subscribe-alphabetically}. | |
1298 | ||
0c502747 LMI |
1299 | The ``options -n'' format is very simplistic. The syntax above is all |
1300 | that is supports -- you can force-subscribe hierarchies, or you can | |
1301 | deny hierarchies, and that's it. | |
1302 | ||
4009494e GM |
1303 | @vindex gnus-options-not-subscribe |
1304 | @vindex gnus-options-subscribe | |
1305 | If you don't want to mess with your @file{.newsrc} file, you can just | |
1306 | set the two variables @code{gnus-options-subscribe} and | |
1307 | @code{gnus-options-not-subscribe}. These two variables do exactly the | |
1308 | same as the @file{.newsrc} @samp{options -n} trick. Both are regexps, | |
1309 | and if the new group matches the former, it will be unconditionally | |
1310 | subscribed, and if it matches the latter, it will be ignored. | |
1311 | ||
1312 | @vindex gnus-auto-subscribed-groups | |
1313 | Yet another variable that meddles here is | |
1314 | @code{gnus-auto-subscribed-groups}. It works exactly like | |
1315 | @code{gnus-options-subscribe}, and is therefore really superfluous, | |
1316 | but I thought it would be nice to have two of these. This variable is | |
1317 | more meant for setting some ground rules, while the other variable is | |
1318 | used more for user fiddling. By default this variable makes all new | |
1319 | groups that come from mail back ends (@code{nnml}, @code{nnbabyl}, | |
7410c270 G |
1320 | @code{nnfolder}, @code{nnmbox}, @code{nnmh}, @code{nnimap}, and |
1321 | @code{nnmaildir}) subscribed. If you don't like that, just set this | |
1322 | variable to @code{nil}. | |
1323 | ||
1324 | @vindex gnus-auto-subscribed-categories | |
1325 | As if that wasn't enough, @code{gnus-auto-subscribed-categories} also | |
22bcf204 | 1326 | allows you to specify that new groups should be subscribed based on the |
7410c270 G |
1327 | category their select methods belong to. The default is @samp{(mail |
1328 | post-mail)}, meaning that all new groups from mail-like backends | |
1329 | should be subscribed automatically. | |
1330 | ||
1331 | New groups that match these variables are subscribed using | |
4009494e GM |
1332 | @code{gnus-subscribe-options-newsgroup-method}. |
1333 | ||
1334 | ||
1335 | @node Changing Servers | |
1336 | @section Changing Servers | |
1337 | @cindex changing servers | |
1338 | ||
1339 | Sometimes it is necessary to move from one @acronym{NNTP} server to another. | |
1340 | This happens very rarely, but perhaps you change jobs, or one server is | |
1341 | very flaky and you want to use another. | |
1342 | ||
1343 | Changing the server is pretty easy, right? You just change | |
1344 | @code{gnus-select-method} to point to the new server? | |
1345 | ||
1346 | @emph{Wrong!} | |
1347 | ||
1348 | Article numbers are not (in any way) kept synchronized between different | |
1349 | @acronym{NNTP} servers, and the only way Gnus keeps track of what articles | |
1350 | you have read is by keeping track of article numbers. So when you | |
1351 | change @code{gnus-select-method}, your @file{.newsrc} file becomes | |
1352 | worthless. | |
1353 | ||
4009494e GM |
1354 | @kindex M-x gnus-group-clear-data-on-native-groups |
1355 | @findex gnus-group-clear-data-on-native-groups | |
f02566ce KY |
1356 | You can use the @kbd{M-x gnus-group-clear-data-on-native-groups} |
1357 | command to clear out all data that you have on your native groups. | |
1358 | Use with caution. | |
4009494e GM |
1359 | |
1360 | @kindex M-x gnus-group-clear-data | |
1361 | @findex gnus-group-clear-data | |
1362 | Clear the data from the current group only---nix out marks and the | |
1363 | list of read articles (@code{gnus-group-clear-data}). | |
1364 | ||
1365 | After changing servers, you @strong{must} move the cache hierarchy away, | |
1366 | since the cached articles will have wrong article numbers, which will | |
1367 | affect which articles Gnus thinks are read. | |
1368 | @code{gnus-group-clear-data-on-native-groups} will ask you if you want | |
1369 | to have it done automatically; for @code{gnus-group-clear-data}, you | |
1370 | can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the | |
1371 | cache for all groups). | |
1372 | ||
1373 | ||
1374 | @node Startup Files | |
1375 | @section Startup Files | |
1376 | @cindex startup files | |
1377 | @cindex .newsrc | |
1378 | @cindex .newsrc.el | |
1379 | @cindex .newsrc.eld | |
1380 | ||
1381 | Most common Unix news readers use a shared startup file called | |
1382 | @file{.newsrc}. This file contains all the information about what | |
1383 | groups are subscribed, and which articles in these groups have been | |
1384 | read. | |
1385 | ||
1386 | Things got a bit more complicated with @sc{gnus}. In addition to | |
1387 | keeping the @file{.newsrc} file updated, it also used a file called | |
1388 | @file{.newsrc.el} for storing all the information that didn't fit into | |
1389 | the @file{.newsrc} file. (Actually, it also duplicated everything in | |
1390 | the @file{.newsrc} file.) @sc{gnus} would read whichever one of these | |
1391 | files was the most recently saved, which enabled people to swap between | |
1392 | @sc{gnus} and other newsreaders. | |
1393 | ||
1394 | That was kinda silly, so Gnus went one better: In addition to the | |
1395 | @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called | |
1396 | @file{.newsrc.eld}. It will read whichever of these files that are most | |
1397 | recent, but it will never write a @file{.newsrc.el} file. You should | |
1398 | never delete the @file{.newsrc.eld} file---it contains much information | |
1399 | not stored in the @file{.newsrc} file. | |
1400 | ||
1401 | @vindex gnus-save-newsrc-file | |
1402 | @vindex gnus-read-newsrc-file | |
1403 | You can turn off writing the @file{.newsrc} file by setting | |
1404 | @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete | |
1405 | the file and save some space, as well as exiting from Gnus faster. | |
1406 | However, this will make it impossible to use other newsreaders than | |
1407 | Gnus. But hey, who would want to, right? Similarly, setting | |
1408 | @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the | |
1409 | @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be | |
1410 | convenient if you use a different news reader occasionally, and you | |
1411 | want to read a different subset of the available groups with that | |
1412 | news reader. | |
1413 | ||
1414 | @vindex gnus-save-killed-list | |
1415 | If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus | |
1416 | will not save the list of killed groups to the startup file. This will | |
1417 | save both time (when starting and quitting) and space (on disk). It | |
1418 | will also mean that Gnus has no record of what groups are new or old, | |
1419 | so the automatic new groups subscription methods become meaningless. | |
1420 | You should always set @code{gnus-check-new-newsgroups} to @code{nil} or | |
1421 | @code{ask-server} if you set this variable to @code{nil} (@pxref{New | |
1422 | Groups}). This variable can also be a regular expression. If that's | |
1423 | the case, remove all groups that do not match this regexp before | |
1424 | saving. This can be useful in certain obscure situations that involve | |
1425 | several servers where not all servers support @code{ask-server}. | |
1426 | ||
1427 | @vindex gnus-startup-file | |
1428 | @vindex gnus-backup-startup-file | |
1429 | @vindex version-control | |
1430 | The @code{gnus-startup-file} variable says where the startup files are. | |
1431 | The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup | |
1432 | file being whatever that one is, with a @samp{.eld} appended. | |
cd865a33 | 1433 | If you want to keep multiple numbered backups of this file, set |
4009494e GM |
1434 | @code{gnus-backup-startup-file}. It respects the same values as the |
1435 | @code{version-control} variable. | |
1436 | ||
1437 | @vindex gnus-save-newsrc-hook | |
1438 | @vindex gnus-save-quick-newsrc-hook | |
1439 | @vindex gnus-save-standard-newsrc-hook | |
1440 | @code{gnus-save-newsrc-hook} is called before saving any of the newsrc | |
1441 | files, while @code{gnus-save-quick-newsrc-hook} is called just before | |
1442 | saving the @file{.newsrc.eld} file, and | |
1443 | @code{gnus-save-standard-newsrc-hook} is called just before saving the | |
1444 | @file{.newsrc} file. The latter two are commonly used to turn version | |
1445 | control on or off. Version control is on by default when saving the | |
1446 | startup files. If you want to turn backup creation off, say something like: | |
1447 | ||
1448 | @lisp | |
1449 | (defun turn-off-backup () | |
1450 | (set (make-local-variable 'backup-inhibited) t)) | |
1451 | ||
1452 | (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup) | |
1453 | (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup) | |
1454 | @end lisp | |
1455 | ||
1456 | @vindex gnus-init-file | |
1457 | @vindex gnus-site-init-file | |
1458 | When Gnus starts, it will read the @code{gnus-site-init-file} | |
1459 | (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file} | |
1460 | (@file{~/.gnus} by default) files. These are normal Emacs Lisp files | |
1461 | and can be used to avoid cluttering your @file{~/.emacs} and | |
1462 | @file{site-init} files with Gnus stuff. Gnus will also check for files | |
1463 | with the same names as these, but with @file{.elc} and @file{.el} | |
1464 | suffixes. In other words, if you have set @code{gnus-init-file} to | |
1465 | @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el}, | |
1466 | and finally @file{~/.gnus} (in this order). If Emacs was invoked with | |
1467 | the @option{-q} or @option{--no-init-file} options (@pxref{Initial | |
1468 | Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read | |
1469 | @code{gnus-init-file}. | |
1470 | ||
1471 | ||
1472 | @node Auto Save | |
1473 | @section Auto Save | |
1474 | @cindex dribble file | |
1475 | @cindex auto-save | |
1476 | ||
1477 | Whenever you do something that changes the Gnus data (reading articles, | |
1478 | catching up, killing/subscribing groups), the change is added to a | |
1479 | special @dfn{dribble buffer}. This buffer is auto-saved the normal | |
1480 | Emacs way. If your Emacs should crash before you have saved the | |
1481 | @file{.newsrc} files, all changes you have made can be recovered from | |
1482 | this file. | |
1483 | ||
1484 | If Gnus detects this file at startup, it will ask the user whether to | |
1485 | read it. The auto save file is deleted whenever the real startup file is | |
1486 | saved. | |
1487 | ||
1488 | @vindex gnus-use-dribble-file | |
1489 | If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and | |
1490 | maintain a dribble buffer. The default is @code{t}. | |
1491 | ||
1492 | @vindex gnus-dribble-directory | |
1493 | Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If | |
1494 | this variable is @code{nil}, which it is by default, Gnus will dribble | |
1495 | into the directory where the @file{.newsrc} file is located. (This is | |
1496 | normally the user's home directory.) The dribble file will get the same | |
1497 | file permissions as the @file{.newsrc} file. | |
1498 | ||
1499 | @vindex gnus-always-read-dribble-file | |
1500 | If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will | |
1501 | read the dribble file on startup without querying the user. | |
1502 | ||
1503 | ||
1504 | @node The Active File | |
1505 | @section The Active File | |
1506 | @cindex active file | |
1507 | @cindex ignored groups | |
1508 | ||
1509 | When Gnus starts, or indeed whenever it tries to determine whether new | |
1510 | articles have arrived, it reads the active file. This is a very large | |
1511 | file that lists all the active groups and articles on the server. | |
1512 | ||
1513 | @vindex gnus-ignored-newsgroups | |
1514 | Before examining the active file, Gnus deletes all lines that match the | |
1515 | regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject | |
1516 | any groups with bogus names, but you can use this variable to make Gnus | |
1517 | ignore hierarchies you aren't ever interested in. However, this is not | |
1518 | recommended. In fact, it's highly discouraged. Instead, @pxref{New | |
1519 | Groups} for an overview of other variables that can be used instead. | |
1520 | ||
1521 | @c This variable is | |
1522 | @c @code{nil} by default, and will slow down active file handling somewhat | |
1523 | @c if you set it to anything else. | |
1524 | ||
1525 | @vindex gnus-read-active-file | |
1526 | @c @head | |
1527 | The active file can be rather Huge, so if you have a slow network, you | |
1528 | can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from | |
1529 | reading the active file. This variable is @code{some} by default. | |
1530 | ||
1531 | Gnus will try to make do by getting information just on the groups that | |
1532 | you actually subscribe to. | |
1533 | ||
1534 | Note that if you subscribe to lots and lots of groups, setting this | |
1535 | variable to @code{nil} will probably make Gnus slower, not faster. At | |
1536 | present, having this variable @code{nil} will slow Gnus down | |
1537 | considerably, unless you read news over a 2400 baud modem. | |
1538 | ||
1539 | This variable can also have the value @code{some}. Gnus will then | |
1540 | attempt to read active info only on the subscribed groups. On some | |
1541 | servers this is quite fast (on sparkling, brand new INN servers that | |
1542 | support the @code{LIST ACTIVE group} command), on others this isn't fast | |
1543 | at all. In any case, @code{some} should be faster than @code{nil}, and | |
1544 | is certainly faster than @code{t} over slow lines. | |
1545 | ||
1546 | Some news servers (old versions of Leafnode and old versions of INN, for | |
1547 | instance) do not support the @code{LIST ACTIVE group}. For these | |
1548 | servers, @code{nil} is probably the most efficient value for this | |
1549 | variable. | |
1550 | ||
1551 | If this variable is @code{nil}, Gnus will ask for group info in total | |
1552 | lock-step, which isn't very fast. If it is @code{some} and you use an | |
1553 | @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and | |
1554 | read all the replies in one swoop. This will normally result in better | |
1555 | performance, but if the server does not support the aforementioned | |
1556 | @code{LIST ACTIVE group} command, this isn't very nice to the server. | |
1557 | ||
1558 | If you think that starting up Gnus takes too long, try all the three | |
1559 | different values for this variable and see what works best for you. | |
1560 | ||
1561 | In any case, if you use @code{some} or @code{nil}, you should definitely | |
1562 | kill all groups that you aren't interested in to speed things up. | |
1563 | ||
1564 | Note that this variable also affects active file retrieval from | |
1565 | secondary select methods. | |
1566 | ||
1567 | ||
1568 | @node Startup Variables | |
1569 | @section Startup Variables | |
1570 | ||
1571 | @table @code | |
1572 | ||
1573 | @item gnus-load-hook | |
1574 | @vindex gnus-load-hook | |
1575 | A hook run while Gnus is being loaded. Note that this hook will | |
1576 | normally be run just once in each Emacs session, no matter how many | |
1577 | times you start Gnus. | |
1578 | ||
1579 | @item gnus-before-startup-hook | |
1580 | @vindex gnus-before-startup-hook | |
e3e955fe | 1581 | A hook called as the first thing when Gnus is started. |
4009494e GM |
1582 | |
1583 | @item gnus-startup-hook | |
1584 | @vindex gnus-startup-hook | |
1585 | A hook run as the very last thing after starting up Gnus | |
1586 | ||
1587 | @item gnus-started-hook | |
1588 | @vindex gnus-started-hook | |
1589 | A hook that is run as the very last thing after starting up Gnus | |
1590 | successfully. | |
1591 | ||
1592 | @item gnus-setup-news-hook | |
1593 | @vindex gnus-setup-news-hook | |
1594 | A hook that is run after reading the @file{.newsrc} file(s), but before | |
1595 | generating the group buffer. | |
1596 | ||
1597 | @item gnus-check-bogus-newsgroups | |
1598 | @vindex gnus-check-bogus-newsgroups | |
1599 | If non-@code{nil}, Gnus will check for and delete all bogus groups at | |
1600 | startup. A @dfn{bogus group} is a group that you have in your | |
1601 | @file{.newsrc} file, but doesn't exist on the news server. Checking for | |
1602 | bogus groups can take quite a while, so to save time and resources it's | |
1603 | best to leave this option off, and do the checking for bogus groups once | |
1604 | in a while from the group buffer instead (@pxref{Group Maintenance}). | |
1605 | ||
1606 | @item gnus-inhibit-startup-message | |
1607 | @vindex gnus-inhibit-startup-message | |
1608 | If non-@code{nil}, the startup message won't be displayed. That way, | |
1609 | your boss might not notice as easily that you are reading news instead | |
1610 | of doing your job. Note that this variable is used before | |
1611 | @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead. | |
1612 | ||
1613 | @item gnus-no-groups-message | |
1614 | @vindex gnus-no-groups-message | |
1615 | Message displayed by Gnus when no groups are available. | |
1616 | ||
b1ae92ba G |
1617 | @item gnus-use-backend-marks |
1618 | @vindex gnus-use-backend-marks | |
1619 | If non-@code{nil}, Gnus will store article marks both in the | |
1620 | @file{.newsrc.eld} file and in the backends. This will slow down | |
1621 | group operation some. | |
1622 | ||
4009494e GM |
1623 | @end table |
1624 | ||
1625 | ||
1626 | @node Group Buffer | |
1627 | @chapter Group Buffer | |
1628 | @cindex group buffer | |
1629 | ||
1630 | @c Alex Schroeder suggests to rearrange this as follows: | |
1631 | @c | |
1632 | @c <kensanata> ok, just save it for reference. I'll go to bed in a minute. | |
1633 | @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels, | |
1634 | @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data, | |
1635 | @c 7. Group Score, 8. Group Buffer Format | |
1636 | @c <kensanata> Group Levels should have more information on levels 5 to 9. I | |
1637 | @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows: | |
1638 | @c <kensanata> First, "Gnus considers groups... (default 9)." | |
1639 | @c <kensanata> New, a table summarizing what levels 1 to 9 mean. | |
1640 | @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency" | |
1641 | @c <kensanata> Then expand the next paragraph or add some more to it. | |
1642 | @c This short one sentence explains levels 1 and 2, therefore I understand | |
1643 | @c that I should keep important news at 3 and boring news at 4. | |
1644 | @c Say so! Then go on to explain why I should bother with levels 6 to 9. | |
1645 | @c Maybe keep those that you don't want to read temporarily at 6, | |
1646 | @c those that you never want to read at 8, those that offend your | |
1647 | @c human rights at 9... | |
1648 | ||
1649 | ||
1650 | The @dfn{group buffer} lists all (or parts) of the available groups. It | |
1651 | is the first buffer shown when Gnus starts, and will never be killed as | |
1652 | long as Gnus is active. | |
1653 | ||
1654 | @iftex | |
1655 | @iflatex | |
1656 | \gnusfigure{The Group Buffer}{320}{ | |
1657 | \put(75,50){\epsfig{figure=ps/group,height=9cm}} | |
1658 | \put(120,37){\makebox(0,0)[t]{Buffer name}} | |
1659 | \put(120,38){\vector(1,2){10}} | |
1660 | \put(40,60){\makebox(0,0)[r]{Mode line}} | |
1661 | \put(40,58){\vector(1,0){30}} | |
1662 | \put(200,28){\makebox(0,0)[t]{Native select method}} | |
1663 | \put(200,26){\vector(-1,2){15}} | |
1664 | } | |
1665 | @end iflatex | |
1666 | @end iftex | |
1667 | ||
1668 | @menu | |
1669 | * Group Buffer Format:: Information listed and how you can change it. | |
1670 | * Group Maneuvering:: Commands for moving in the group buffer. | |
1671 | * Selecting a Group:: Actually reading news. | |
1672 | * Subscription Commands:: Unsubscribing, killing, subscribing. | |
1673 | * Group Data:: Changing the info for a group. | |
1674 | * Group Levels:: Levels? What are those, then? | |
1675 | * Group Score:: A mechanism for finding out what groups you like. | |
1676 | * Marking Groups:: You can mark groups for later processing. | |
1677 | * Foreign Groups:: Creating and editing groups. | |
1678 | * Group Parameters:: Each group may have different parameters set. | |
1679 | * Listing Groups:: Gnus can list various subsets of the groups. | |
1680 | * Sorting Groups:: Re-arrange the group order. | |
1681 | * Group Maintenance:: Maintaining a tidy @file{.newsrc} file. | |
1682 | * Browse Foreign Server:: You can browse a server. See what it has to offer. | |
1683 | * Exiting Gnus:: Stop reading news and get some work done. | |
1684 | * Group Topics:: A folding group mode divided into topics. | |
01c52d31 | 1685 | * Non-ASCII Group Names:: Accessing groups of non-English names. |
4009494e GM |
1686 | * Misc Group Stuff:: Other stuff that you can to do. |
1687 | @end menu | |
1688 | ||
1689 | ||
1690 | @node Group Buffer Format | |
1691 | @section Group Buffer Format | |
1692 | ||
1693 | @menu | |
1694 | * Group Line Specification:: Deciding how the group buffer is to look. | |
1695 | * Group Mode Line Specification:: The group buffer mode line. | |
1696 | * Group Highlighting:: Having nice colors in the group buffer. | |
1697 | @end menu | |
1698 | ||
1699 | You can customize the Group Mode tool bar, see @kbd{M-x | |
1700 | customize-apropos RET gnus-group-tool-bar}. This feature is only | |
1701 | available in Emacs. | |
1702 | ||
1703 | The tool bar icons are now (de)activated correctly depending on the | |
1704 | cursor position. Therefore, moving around in the Group Buffer is | |
1705 | slower. You can disable this via the variable | |
1706 | @code{gnus-group-update-tool-bar}. Its default value depends on your | |
1707 | Emacs version. | |
1708 | ||
1709 | @node Group Line Specification | |
1710 | @subsection Group Line Specification | |
1711 | @cindex group buffer format | |
1712 | ||
1713 | The default format of the group buffer is nice and dull, but you can | |
1714 | make it as exciting and ugly as you feel like. | |
1715 | ||
1716 | Here's a couple of example group lines: | |
1717 | ||
1718 | @example | |
1719 | 25: news.announce.newusers | |
1720 | * 0: alt.fan.andrea-dworkin | |
1721 | @end example | |
1722 | ||
1723 | Quite simple, huh? | |
1724 | ||
1725 | You can see that there are 25 unread articles in | |
1726 | @samp{news.announce.newusers}. There are no unread articles, but some | |
1727 | ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little | |
1728 | asterisk at the beginning of the line?). | |
1729 | ||
1730 | @vindex gnus-group-line-format | |
1731 | You can change that format to whatever you want by fiddling with the | |
1732 | @code{gnus-group-line-format} variable. This variable works along the | |
1733 | lines of a @code{format} specification, which is pretty much the same as | |
1df7defd | 1734 | a @code{printf} specifications, for those of you who use (feh!) C@. |
4009494e GM |
1735 | @xref{Formatting Variables}. |
1736 | ||
1737 | @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above. | |
1738 | ||
1739 | There should always be a colon on the line; the cursor always moves to | |
1740 | the colon after performing an operation. @xref{Positioning | |
1741 | Point}. Nothing else is required---not even the group name. All | |
1742 | displayed text is just window dressing, and is never examined by Gnus. | |
1743 | Gnus stores all real information it needs using text properties. | |
1744 | ||
1745 | (Note that if you make a really strange, wonderful, spreadsheet-like | |
1746 | layout, everybody will believe you are hard at work with the accounting | |
1747 | instead of wasting time reading news.) | |
1748 | ||
1749 | Here's a list of all available format characters: | |
1750 | ||
1751 | @table @samp | |
1752 | ||
1753 | @item M | |
1754 | An asterisk if the group only has marked articles. | |
1755 | ||
1756 | @item S | |
1757 | Whether the group is subscribed. | |
1758 | ||
1759 | @item L | |
1760 | Level of subscribedness. | |
1761 | ||
1762 | @item N | |
1763 | Number of unread articles. | |
1764 | ||
1765 | @item I | |
1766 | Number of dormant articles. | |
1767 | ||
1768 | @item T | |
1769 | Number of ticked articles. | |
1770 | ||
1771 | @item R | |
1772 | Number of read articles. | |
1773 | ||
1774 | @item U | |
1775 | Number of unseen articles. | |
1776 | ||
1777 | @item t | |
1778 | Estimated total number of articles. (This is really @var{max-number} | |
1779 | minus @var{min-number} plus 1.) | |
1780 | ||
1781 | Gnus uses this estimation because the @acronym{NNTP} protocol provides | |
1782 | efficient access to @var{max-number} and @var{min-number} but getting | |
1783 | the true unread message count is not possible efficiently. For | |
1784 | hysterical raisins, even the mail back ends, where the true number of | |
1785 | unread messages might be available efficiently, use the same limited | |
1786 | interface. To remove this restriction from Gnus means that the back | |
01c52d31 MB |
1787 | end interface has to be changed, which is not an easy job. |
1788 | ||
1789 | The nnml backend (@pxref{Mail Spool}) has a feature called ``group | |
1790 | compaction'' which circumvents this deficiency: the idea is to | |
1791 | renumber all articles from 1, removing all gaps between numbers, hence | |
1792 | getting a correct total count. Other backends may support this in the | |
1793 | future. In order to keep your total article count relatively up to | |
1794 | date, you might want to compact your groups (or even directly your | |
1795 | server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}. | |
4009494e GM |
1796 | |
1797 | @item y | |
1798 | Number of unread, unticked, non-dormant articles. | |
1799 | ||
1800 | @item i | |
1801 | Number of ticked and dormant articles. | |
1802 | ||
1803 | @item g | |
1804 | Full group name. | |
1805 | ||
1806 | @item G | |
1807 | Group name. | |
1808 | ||
1809 | @item C | |
1810 | Group comment (@pxref{Group Parameters}) or group name if there is no | |
1811 | comment element in the group parameters. | |
1812 | ||
1813 | @item D | |
1814 | Newsgroup description. You need to read the group descriptions | |
1815 | before these will appear, and to do that, you either have to set | |
1816 | @code{gnus-read-active-file} or use the group buffer @kbd{M-d} | |
1817 | command. | |
1818 | ||
1819 | @item o | |
1820 | @samp{m} if moderated. | |
1821 | ||
1822 | @item O | |
1823 | @samp{(m)} if moderated. | |
1824 | ||
1825 | @item s | |
1826 | Select method. | |
1827 | ||
1828 | @item B | |
1829 | If the summary buffer for the group is open or not. | |
1830 | ||
1831 | @item n | |
1832 | Select from where. | |
1833 | ||
1834 | @item z | |
1835 | A string that looks like @samp{<%s:%n>} if a foreign select method is | |
1836 | used. | |
1837 | ||
1838 | @item P | |
1839 | Indentation based on the level of the topic (@pxref{Group Topics}). | |
1840 | ||
1841 | @item c | |
1842 | @vindex gnus-group-uncollapsed-levels | |
1843 | Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels} | |
1844 | variable says how many levels to leave at the end of the group name. | |
1845 | The default is 1---this will mean that group names like | |
1846 | @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}. | |
1847 | ||
1848 | @item m | |
1849 | @vindex gnus-new-mail-mark | |
1850 | @cindex % | |
1851 | @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to | |
1852 | the group lately. | |
1853 | ||
1854 | @item p | |
1855 | @samp{#} (@code{gnus-process-mark}) if the group is process marked. | |
1856 | ||
1857 | @item d | |
1858 | A string that says when you last read the group (@pxref{Group | |
1859 | Timestamp}). | |
1860 | ||
01c52d31 MB |
1861 | @item F |
1862 | The disk space used by the articles fetched by both the cache and | |
1863 | agent. The value is automatically scaled to bytes(B), kilobytes(K), | |
1864 | megabytes(M), or gigabytes(G) to minimize the column width. A format | |
1865 | of %7F is sufficient for a fixed-width column. | |
1866 | ||
4009494e GM |
1867 | @item u |
1868 | User defined specifier. The next character in the format string should | |
1869 | be a letter. Gnus will call the function | |
1870 | @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter | |
1871 | following @samp{%u}. The function will be passed a single dummy | |
1872 | parameter as argument. The function should return a string, which will | |
1873 | be inserted into the buffer just like information from any other | |
1874 | specifier. | |
1875 | @end table | |
1876 | ||
1877 | @cindex * | |
1878 | All the ``number-of'' specs will be filled with an asterisk (@samp{*}) | |
1879 | if no info is available---for instance, if it is a non-activated foreign | |
1880 | group, or a bogus native group. | |
1881 | ||
1882 | ||
1883 | @node Group Mode Line Specification | |
1884 | @subsection Group Mode Line Specification | |
1885 | @cindex group mode line | |
1886 | ||
1887 | @vindex gnus-group-mode-line-format | |
1888 | The mode line can be changed by setting | |
1889 | @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It | |
1890 | doesn't understand that many format specifiers: | |
1891 | ||
1892 | @table @samp | |
1893 | @item S | |
1894 | The native news server. | |
1895 | @item M | |
1896 | The native select method. | |
1897 | @end table | |
1898 | ||
1899 | ||
1900 | @node Group Highlighting | |
1901 | @subsection Group Highlighting | |
1902 | @cindex highlighting | |
1903 | @cindex group highlighting | |
1904 | ||
1905 | @vindex gnus-group-highlight | |
1906 | Highlighting in the group buffer is controlled by the | |
1907 | @code{gnus-group-highlight} variable. This is an alist with elements | |
1908 | that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to | |
1909 | something non-@code{nil}, the @var{face} will be used on the line. | |
1910 | ||
1911 | Here's an example value for this variable that might look nice if the | |
1912 | background is dark: | |
1913 | ||
1914 | @lisp | |
1915 | (cond (window-system | |
1916 | (setq custom-background-mode 'light) | |
1917 | (defface my-group-face-1 | |
1918 | '((t (:foreground "Red" :bold t))) "First group face") | |
1919 | (defface my-group-face-2 | |
1920 | '((t (:foreground "DarkSeaGreen4" :bold t))) | |
1921 | "Second group face") | |
1922 | (defface my-group-face-3 | |
1923 | '((t (:foreground "Green4" :bold t))) "Third group face") | |
1924 | (defface my-group-face-4 | |
1925 | '((t (:foreground "SteelBlue" :bold t))) "Fourth group face") | |
1926 | (defface my-group-face-5 | |
1927 | '((t (:foreground "Blue" :bold t))) "Fifth group face"))) | |
1928 | ||
1929 | (setq gnus-group-highlight | |
1930 | '(((> unread 200) . my-group-face-1) | |
1931 | ((and (< level 3) (zerop unread)) . my-group-face-2) | |
1932 | ((< level 3) . my-group-face-3) | |
1933 | ((zerop unread) . my-group-face-4) | |
1934 | (t . my-group-face-5))) | |
1935 | @end lisp | |
1936 | ||
1937 | Also @pxref{Faces and Fonts}. | |
1938 | ||
1939 | Variables that are dynamically bound when the forms are evaluated | |
1940 | include: | |
1941 | ||
1942 | @table @code | |
1943 | @item group | |
1944 | The group name. | |
1945 | @item unread | |
1946 | The number of unread articles in the group. | |
1947 | @item method | |
1948 | The select method. | |
1949 | @item mailp | |
1950 | Whether the group is a mail group. | |
1951 | @item level | |
1952 | The level of the group. | |
1953 | @item score | |
1954 | The score of the group. | |
1955 | @item ticked | |
1956 | The number of ticked articles in the group. | |
1957 | @item total | |
1958 | The total number of articles in the group. Or rather, | |
1959 | @var{max-number} minus @var{min-number} plus one. | |
1960 | @item topic | |
1961 | When using the topic minor mode, this variable is bound to the current | |
1962 | topic being inserted. | |
1963 | @end table | |
1964 | ||
1965 | When the forms are @code{eval}ed, point is at the beginning of the line | |
1966 | of the group in question, so you can use many of the normal Gnus | |
1967 | functions for snarfing info on the group. | |
1968 | ||
1969 | @vindex gnus-group-update-hook | |
1970 | @findex gnus-group-highlight-line | |
1971 | @code{gnus-group-update-hook} is called when a group line is changed. | |
b069e5a6 | 1972 | It will not be called when @code{gnus-visual} is @code{nil}. |
4009494e GM |
1973 | |
1974 | ||
1975 | @node Group Maneuvering | |
1976 | @section Group Maneuvering | |
1977 | @cindex group movement | |
1978 | ||
1979 | All movement commands understand the numeric prefix and will behave as | |
1980 | expected, hopefully. | |
1981 | ||
1982 | @table @kbd | |
1983 | ||
1984 | @item n | |
1985 | @kindex n (Group) | |
1986 | @findex gnus-group-next-unread-group | |
1987 | Go to the next group that has unread articles | |
1988 | (@code{gnus-group-next-unread-group}). | |
1989 | ||
1990 | @item p | |
1991 | @itemx DEL | |
1992 | @kindex DEL (Group) | |
1993 | @kindex p (Group) | |
1994 | @findex gnus-group-prev-unread-group | |
1995 | Go to the previous group that has unread articles | |
1996 | (@code{gnus-group-prev-unread-group}). | |
1997 | ||
1998 | @item N | |
1999 | @kindex N (Group) | |
2000 | @findex gnus-group-next-group | |
2001 | Go to the next group (@code{gnus-group-next-group}). | |
2002 | ||
2003 | @item P | |
2004 | @kindex P (Group) | |
2005 | @findex gnus-group-prev-group | |
2006 | Go to the previous group (@code{gnus-group-prev-group}). | |
2007 | ||
2008 | @item M-n | |
2009 | @kindex M-n (Group) | |
2010 | @findex gnus-group-next-unread-group-same-level | |
2011 | Go to the next unread group on the same (or lower) level | |
2012 | (@code{gnus-group-next-unread-group-same-level}). | |
2013 | ||
2014 | @item M-p | |
2015 | @kindex M-p (Group) | |
2016 | @findex gnus-group-prev-unread-group-same-level | |
2017 | Go to the previous unread group on the same (or lower) level | |
2018 | (@code{gnus-group-prev-unread-group-same-level}). | |
2019 | @end table | |
2020 | ||
2021 | Three commands for jumping to groups: | |
2022 | ||
2023 | @table @kbd | |
2024 | ||
2025 | @item j | |
2026 | @kindex j (Group) | |
2027 | @findex gnus-group-jump-to-group | |
2028 | Jump to a group (and make it visible if it isn't already) | |
2029 | (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just | |
2030 | like living groups. | |
2031 | ||
2032 | @item , | |
2033 | @kindex , (Group) | |
2034 | @findex gnus-group-best-unread-group | |
2035 | Jump to the unread group with the lowest level | |
2036 | (@code{gnus-group-best-unread-group}). | |
2037 | ||
2038 | @item . | |
2039 | @kindex . (Group) | |
2040 | @findex gnus-group-first-unread-group | |
2041 | Jump to the first group with unread articles | |
2042 | (@code{gnus-group-first-unread-group}). | |
2043 | @end table | |
2044 | ||
2045 | @vindex gnus-group-goto-unread | |
2046 | If @code{gnus-group-goto-unread} is @code{nil}, all the movement | |
2047 | commands will move to the next group, not the next unread group. Even | |
2048 | the commands that say they move to the next unread group. The default | |
2049 | is @code{t}. | |
2050 | ||
01c52d31 MB |
2051 | @vindex gnus-summary-next-group-on-exit |
2052 | If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is | |
2053 | exited, the point in the group buffer is moved to the next unread group. | |
2054 | Otherwise, the point is set to the group just exited. The default is | |
2055 | @code{t}. | |
4009494e GM |
2056 | |
2057 | @node Selecting a Group | |
2058 | @section Selecting a Group | |
2059 | @cindex group selection | |
2060 | ||
2061 | @table @kbd | |
2062 | ||
2063 | @item SPACE | |
2064 | @kindex SPACE (Group) | |
2065 | @findex gnus-group-read-group | |
2066 | Select the current group, switch to the summary buffer and display the | |
2067 | first unread article (@code{gnus-group-read-group}). If there are no | |
2068 | unread articles in the group, or if you give a non-numerical prefix to | |
2069 | this command, Gnus will offer to fetch all the old articles in this | |
2070 | group from the server. If you give a numerical prefix @var{n}, @var{n} | |
2071 | determines the number of articles Gnus will fetch. If @var{n} is | |
2072 | positive, Gnus fetches the @var{n} newest articles, if @var{n} is | |
2073 | negative, Gnus fetches the @code{abs(@var{n})} oldest articles. | |
2074 | ||
2075 | Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old | |
2076 | articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u | |
2077 | - 4 2 SPC} fetches the 42 oldest ones. | |
2078 | ||
2079 | When you are in the group (in the Summary buffer), you can type | |
2080 | @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old | |
2081 | ones. | |
2082 | ||
2083 | @item RET | |
2084 | @kindex RET (Group) | |
2085 | @findex gnus-group-select-group | |
2086 | Select the current group and switch to the summary buffer | |
2087 | (@code{gnus-group-select-group}). Takes the same arguments as | |
2088 | @code{gnus-group-read-group}---the only difference is that this command | |
2089 | does not display the first unread article automatically upon group | |
2090 | entry. | |
2091 | ||
2092 | @item M-RET | |
2093 | @kindex M-RET (Group) | |
2094 | @findex gnus-group-quick-select-group | |
2095 | This does the same as the command above, but tries to do it with the | |
2096 | minimum amount of fuzz (@code{gnus-group-quick-select-group}). No | |
2097 | scoring/killing will be performed, there will be no highlights and no | |
2098 | expunging. This might be useful if you're in a real hurry and have to | |
2099 | enter some humongous group. If you give a 0 prefix to this command | |
2100 | (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer, | |
2101 | which is useful if you want to toggle threading before generating the | |
2102 | summary buffer (@pxref{Summary Generation Commands}). | |
2103 | ||
2104 | @item M-SPACE | |
2105 | @kindex M-SPACE (Group) | |
2106 | @findex gnus-group-visible-select-group | |
2107 | This is yet one more command that does the same as the @kbd{RET} | |
2108 | command, but this one does it without expunging and hiding dormants | |
2109 | (@code{gnus-group-visible-select-group}). | |
2110 | ||
2111 | @item C-M-RET | |
2112 | @kindex C-M-RET (Group) | |
2113 | @findex gnus-group-select-group-ephemerally | |
2114 | Finally, this command selects the current group ephemerally without | |
2115 | doing any processing of its contents | |
2116 | (@code{gnus-group-select-group-ephemerally}). Even threading has been | |
2117 | turned off. Everything you do in the group after selecting it in this | |
2118 | manner will have no permanent effects. | |
2119 | ||
2120 | @end table | |
2121 | ||
2122 | @vindex gnus-large-newsgroup | |
2123 | The @code{gnus-large-newsgroup} variable says what Gnus should | |
2124 | consider to be a big group. If it is @code{nil}, no groups are | |
2125 | considered big. The default value is 200. If the group has more | |
2126 | (unread and/or ticked) articles than this, Gnus will query the user | |
2127 | before entering the group. The user can then specify how many | |
2128 | articles should be fetched from the server. If the user specifies a | |
2129 | negative number (@var{-n}), the @var{n} oldest articles will be | |
2130 | fetched. If it is positive, the @var{n} articles that have arrived | |
2131 | most recently will be fetched. | |
2132 | ||
2133 | @vindex gnus-large-ephemeral-newsgroup | |
2134 | @code{gnus-large-ephemeral-newsgroup} is the same as | |
2135 | @code{gnus-large-newsgroup}, but is only used for ephemeral | |
2136 | newsgroups. | |
2137 | ||
4b70e299 | 2138 | @vindex gnus-newsgroup-maximum-articles |
4009494e GM |
2139 | In groups in some news servers, there might be a big gap between a few |
2140 | very old articles that will never be expired and the recent ones. In | |
2141 | such a case, the server will return the data like @code{(1 . 30000000)} | |
2142 | for the @code{LIST ACTIVE group} command, for example. Even if there | |
2143 | are actually only the articles 1-10 and 29999900-30000000, Gnus doesn't | |
2144 | know it at first and prepares for getting 30000000 articles. However, | |
2145 | it will consume hundreds megabytes of memories and might make Emacs get | |
2146 | stuck as the case may be. If you use such news servers, set the | |
4b70e299 MB |
2147 | variable @code{gnus-newsgroup-maximum-articles} to a positive number. |
2148 | The value means that Gnus ignores articles other than this number of the | |
2149 | latest ones in every group. For instance, the value 10000 makes Gnus | |
2150 | get only the articles 29990001-30000000 (if the latest article number is | |
2151 | 30000000 in a group). Note that setting this variable to a number might | |
2152 | prevent you from reading very old articles. The default value of the | |
2153 | variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which | |
2154 | means Gnus never ignores old articles. | |
4009494e GM |
2155 | |
2156 | @vindex gnus-select-group-hook | |
2157 | @vindex gnus-auto-select-first | |
2158 | @vindex gnus-auto-select-subject | |
2159 | If @code{gnus-auto-select-first} is non-@code{nil}, select an article | |
2160 | automatically when entering a group with the @kbd{SPACE} command. | |
867d4bb3 | 2161 | Which article this is controlled by the |
4009494e GM |
2162 | @code{gnus-auto-select-subject} variable. Valid values for this |
2163 | variable are: | |
2164 | ||
2165 | @table @code | |
2166 | ||
2167 | @item unread | |
2168 | Place point on the subject line of the first unread article. | |
2169 | ||
2170 | @item first | |
2171 | Place point on the subject line of the first article. | |
2172 | ||
2173 | @item unseen | |
2174 | Place point on the subject line of the first unseen article. | |
2175 | ||
2176 | @item unseen-or-unread | |
2177 | Place point on the subject line of the first unseen article, and if | |
2178 | there is no such article, place point on the subject line of the first | |
2179 | unread article. | |
2180 | ||
2181 | @item best | |
2182 | Place point on the subject line of the highest-scored unread article. | |
2183 | ||
2184 | @end table | |
2185 | ||
2186 | This variable can also be a function. In that case, that function | |
2187 | will be called to place point on a subject line. | |
2188 | ||
2189 | If you want to prevent automatic selection in some group (say, in a | |
2190 | binary group with Huge articles) you can set the | |
2191 | @code{gnus-auto-select-first} variable to @code{nil} in | |
2192 | @code{gnus-select-group-hook}, which is called when a group is | |
2193 | selected. | |
2194 | ||
2195 | ||
2196 | @node Subscription Commands | |
2197 | @section Subscription Commands | |
2198 | @cindex subscription | |
2199 | ||
280f417b G |
2200 | The following commands allow for managing your subscriptions in the |
2201 | Group buffer. If you want to subscribe to many groups, it's probably | |
2202 | more convenient to go to the @ref{Server Buffer}, and choose the | |
2203 | server there using @kbd{RET} or @kbd{SPC}. Then you'll have the | |
2204 | commands listed in @ref{Browse Foreign Server} at hand. | |
2205 | ||
4009494e GM |
2206 | @table @kbd |
2207 | ||
2208 | @item S t | |
2209 | @itemx u | |
2210 | @kindex S t (Group) | |
2211 | @kindex u (Group) | |
2212 | @findex gnus-group-unsubscribe-current-group | |
2213 | @c @icon{gnus-group-unsubscribe} | |
2214 | Toggle subscription to the current group | |
2215 | (@code{gnus-group-unsubscribe-current-group}). | |
2216 | ||
2217 | @item S s | |
2218 | @itemx U | |
2219 | @kindex S s (Group) | |
2220 | @kindex U (Group) | |
2221 | @findex gnus-group-unsubscribe-group | |
2222 | Prompt for a group to subscribe, and then subscribe it. If it was | |
2223 | subscribed already, unsubscribe it instead | |
2224 | (@code{gnus-group-unsubscribe-group}). | |
2225 | ||
2226 | @item S k | |
2227 | @itemx C-k | |
2228 | @kindex S k (Group) | |
2229 | @kindex C-k (Group) | |
2230 | @findex gnus-group-kill-group | |
2231 | @c @icon{gnus-group-kill-group} | |
2232 | Kill the current group (@code{gnus-group-kill-group}). | |
2233 | ||
2234 | @item S y | |
2235 | @itemx C-y | |
2236 | @kindex S y (Group) | |
2237 | @kindex C-y (Group) | |
2238 | @findex gnus-group-yank-group | |
2239 | Yank the last killed group (@code{gnus-group-yank-group}). | |
2240 | ||
2241 | @item C-x C-t | |
2242 | @kindex C-x C-t (Group) | |
2243 | @findex gnus-group-transpose-groups | |
2244 | Transpose two groups (@code{gnus-group-transpose-groups}). This isn't | |
2245 | really a subscription command, but you can use it instead of a | |
2246 | kill-and-yank sequence sometimes. | |
2247 | ||
2248 | @item S w | |
2249 | @itemx C-w | |
2250 | @kindex S w (Group) | |
2251 | @kindex C-w (Group) | |
2252 | @findex gnus-group-kill-region | |
2253 | Kill all groups in the region (@code{gnus-group-kill-region}). | |
2254 | ||
2255 | @item S z | |
2256 | @kindex S z (Group) | |
2257 | @findex gnus-group-kill-all-zombies | |
2258 | Kill all zombie groups (@code{gnus-group-kill-all-zombies}). | |
2259 | ||
2260 | @item S C-k | |
2261 | @kindex S C-k (Group) | |
2262 | @findex gnus-group-kill-level | |
2263 | Kill all groups on a certain level (@code{gnus-group-kill-level}). | |
2264 | These groups can't be yanked back after killing, so this command should | |
2265 | be used with some caution. The only time where this command comes in | |
2266 | really handy is when you have a @file{.newsrc} with lots of unsubscribed | |
2267 | groups that you want to get rid off. @kbd{S C-k} on level 7 will | |
2268 | kill off all unsubscribed groups that do not have message numbers in the | |
2269 | @file{.newsrc} file. | |
2270 | ||
2271 | @end table | |
2272 | ||
2273 | Also @pxref{Group Levels}. | |
2274 | ||
2275 | ||
2276 | @node Group Data | |
2277 | @section Group Data | |
2278 | ||
2279 | @table @kbd | |
2280 | ||
2281 | @item c | |
2282 | @kindex c (Group) | |
2283 | @findex gnus-group-catchup-current | |
2284 | @vindex gnus-group-catchup-group-hook | |
2285 | @c @icon{gnus-group-catchup-current} | |
2286 | Mark all unticked articles in this group as read | |
2287 | (@code{gnus-group-catchup-current}). | |
2288 | @code{gnus-group-catchup-group-hook} is called when catching up a group from | |
2289 | the group buffer. | |
2290 | ||
2291 | @item C | |
2292 | @kindex C (Group) | |
2293 | @findex gnus-group-catchup-current-all | |
2294 | Mark all articles in this group, even the ticked ones, as read | |
2295 | (@code{gnus-group-catchup-current-all}). | |
2296 | ||
2297 | @item M-c | |
2298 | @kindex M-c (Group) | |
2299 | @findex gnus-group-clear-data | |
2300 | Clear the data from the current group---nix out marks and the list of | |
2301 | read articles (@code{gnus-group-clear-data}). | |
2302 | ||
2303 | @item M-x gnus-group-clear-data-on-native-groups | |
2304 | @kindex M-x gnus-group-clear-data-on-native-groups | |
2305 | @findex gnus-group-clear-data-on-native-groups | |
2306 | If you have switched from one @acronym{NNTP} server to another, all your marks | |
2307 | and read ranges have become worthless. You can use this command to | |
2308 | clear out all data that you have on your native groups. Use with | |
2309 | caution. | |
2310 | ||
2311 | @end table | |
2312 | ||
2313 | ||
2314 | @node Group Levels | |
2315 | @section Group Levels | |
2316 | @cindex group level | |
2317 | @cindex level | |
2318 | ||
2319 | All groups have a level of @dfn{subscribedness}. For instance, if a | |
2320 | group is on level 2, it is more subscribed than a group on level 5. You | |
2321 | can ask Gnus to just list groups on a given level or lower | |
2322 | (@pxref{Listing Groups}), or to just check for new articles in groups on | |
2323 | a given level or lower (@pxref{Scanning New Messages}). | |
2324 | ||
2325 | Remember: The higher the level of the group, the less important it is. | |
2326 | ||
2327 | @table @kbd | |
2328 | ||
2329 | @item S l | |
2330 | @kindex S l (Group) | |
2331 | @findex gnus-group-set-current-level | |
2332 | Set the level of the current group. If a numeric prefix is given, the | |
2333 | next @var{n} groups will have their levels set. The user will be | |
2334 | prompted for a level. | |
2335 | @end table | |
2336 | ||
2337 | @vindex gnus-level-killed | |
2338 | @vindex gnus-level-zombie | |
2339 | @vindex gnus-level-unsubscribed | |
2340 | @vindex gnus-level-subscribed | |
2341 | Gnus considers groups from levels 1 to | |
2342 | @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed, | |
2343 | @code{gnus-level-subscribed} (exclusive) and | |
2344 | @code{gnus-level-unsubscribed} (inclusive) (default 7) to be | |
2345 | unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead) | |
2346 | (default 8) and @code{gnus-level-killed} to be killed (completely dead) | |
2347 | (default 9). Gnus treats subscribed and unsubscribed groups exactly the | |
2348 | same, but zombie and killed groups have no information on what articles | |
2349 | you have read, etc, stored. This distinction between dead and living | |
2350 | groups isn't done because it is nice or clever, it is done purely for | |
2351 | reasons of efficiency. | |
2352 | ||
2353 | It is recommended that you keep all your mail groups (if any) on quite | |
1df7defd | 2354 | low levels (e.g., 1 or 2). |
4009494e GM |
2355 | |
2356 | Maybe the following description of the default behavior of Gnus helps to | |
2357 | understand what these levels are all about. By default, Gnus shows you | |
2358 | subscribed nonempty groups, but by hitting @kbd{L} you can have it show | |
2359 | empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to | |
2360 | go back to showing nonempty subscribed groups again. Thus, unsubscribed | |
2361 | groups are hidden, in a way. | |
2362 | ||
cd865a33 | 2363 | @cindex zombie groups |
4009494e GM |
2364 | Zombie and killed groups are similar to unsubscribed groups in that they |
2365 | are hidden by default. But they are different from subscribed and | |
2366 | unsubscribed groups in that Gnus doesn't ask the news server for | |
2367 | information (number of messages, number of unread messages) on zombie | |
2368 | and killed groups. Normally, you use @kbd{C-k} to kill the groups you | |
2369 | aren't interested in. If most groups are killed, Gnus is faster. | |
2370 | ||
2371 | Why does Gnus distinguish between zombie and killed groups? Well, when | |
2372 | a new group arrives on the server, Gnus by default makes it a zombie | |
2373 | group. This means that you are normally not bothered with new groups, | |
2374 | but you can type @kbd{A z} to get a list of all new groups. Subscribe | |
2375 | the ones you like and kill the ones you don't want. (@kbd{A k} shows a | |
2376 | list of killed groups.) | |
2377 | ||
2378 | If you want to play with the level variables, you should show some care. | |
2379 | Set them once, and don't touch them ever again. Better yet, don't touch | |
2380 | them at all unless you know exactly what you're doing. | |
2381 | ||
2382 | @vindex gnus-level-default-unsubscribed | |
2383 | @vindex gnus-level-default-subscribed | |
2384 | Two closely related variables are @code{gnus-level-default-subscribed} | |
2385 | (default 3) and @code{gnus-level-default-unsubscribed} (default 6), | |
2386 | which are the levels that new groups will be put on if they are | |
2387 | (un)subscribed. These two variables should, of course, be inside the | |
2388 | relevant valid ranges. | |
2389 | ||
2390 | @vindex gnus-keep-same-level | |
2391 | If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands | |
2392 | will only move to groups of the same level (or lower). In | |
2393 | particular, going from the last article in one group to the next group | |
2394 | will go to the next group of the same level (or lower). This might be | |
2395 | handy if you want to read the most important groups before you read the | |
2396 | rest. | |
2397 | ||
2398 | If this variable is @code{best}, Gnus will make the next newsgroup the | |
2399 | one with the best level. | |
2400 | ||
2401 | @vindex gnus-group-default-list-level | |
2402 | All groups with a level less than or equal to | |
2403 | @code{gnus-group-default-list-level} will be listed in the group buffer | |
2404 | by default. | |
11a5db4a JD |
2405 | This variable can also be a function. In that case, that function will |
2406 | be called and the result will be used as value. | |
2407 | ||
4009494e GM |
2408 | |
2409 | @vindex gnus-group-list-inactive-groups | |
2410 | If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active | |
2411 | groups will be listed along with the unread groups. This variable is | |
2412 | @code{t} by default. If it is @code{nil}, inactive groups won't be | |
2413 | listed. | |
2414 | ||
2415 | @vindex gnus-group-use-permanent-levels | |
2416 | If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you | |
2417 | give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will | |
2418 | use this level as the ``work'' level. | |
2419 | ||
2420 | @vindex gnus-activate-level | |
1df7defd | 2421 | Gnus will normally just activate (i.e., query the server about) groups |
4009494e GM |
2422 | on level @code{gnus-activate-level} or less. If you don't want to |
2423 | activate unsubscribed groups, for instance, you might set this variable | |
2424 | to 5. The default is 6. | |
2425 | ||
2426 | ||
2427 | @node Group Score | |
2428 | @section Group Score | |
2429 | @cindex group score | |
2430 | @cindex group rank | |
2431 | @cindex rank | |
2432 | ||
2433 | You would normally keep important groups on high levels, but that scheme | |
2434 | is somewhat restrictive. Don't you wish you could have Gnus sort the | |
2435 | group buffer according to how often you read groups, perhaps? Within | |
2436 | reason? | |
2437 | ||
2438 | This is what @dfn{group score} is for. You can have Gnus assign a score | |
2439 | to each group through the mechanism described below. You can then sort | |
2440 | the group buffer based on this score. Alternatively, you can sort on | |
2441 | score and then level. (Taken together, the level and the score is | |
2442 | called the @dfn{rank} of the group. A group that is on level 4 and has | |
2443 | a score of 1 has a higher rank than a group on level 5 that has a score | |
2444 | of 300. (The level is the most significant part and the score is the | |
2445 | least significant part.)) | |
2446 | ||
2447 | @findex gnus-summary-bubble-group | |
2448 | If you want groups you read often to get higher scores than groups you | |
2449 | read seldom you can add the @code{gnus-summary-bubble-group} function to | |
2450 | the @code{gnus-summary-exit-hook} hook. This will result (after | |
2451 | sorting) in a bubbling sort of action. If you want to see that in | |
2452 | action after each summary exit, you can add | |
2453 | @code{gnus-group-sort-groups-by-rank} or | |
2454 | @code{gnus-group-sort-groups-by-score} to the same hook, but that will | |
2455 | slow things down somewhat. | |
2456 | ||
2457 | ||
2458 | @node Marking Groups | |
2459 | @section Marking Groups | |
2460 | @cindex marking groups | |
2461 | ||
2462 | If you want to perform some command on several groups, and they appear | |
2463 | subsequently in the group buffer, you would normally just give a | |
2464 | numerical prefix to the command. Most group commands will then do your | |
2465 | bidding on those groups. | |
2466 | ||
2467 | However, if the groups are not in sequential order, you can still | |
2468 | perform a command on several groups. You simply mark the groups first | |
2469 | with the process mark and then execute the command. | |
2470 | ||
2471 | @table @kbd | |
2472 | ||
2473 | @item # | |
2474 | @kindex # (Group) | |
2475 | @itemx M m | |
2476 | @kindex M m (Group) | |
2477 | @findex gnus-group-mark-group | |
2478 | Set the mark on the current group (@code{gnus-group-mark-group}). | |
2479 | ||
2480 | @item M-# | |
2481 | @kindex M-# (Group) | |
2482 | @itemx M u | |
2483 | @kindex M u (Group) | |
2484 | @findex gnus-group-unmark-group | |
2485 | Remove the mark from the current group | |
2486 | (@code{gnus-group-unmark-group}). | |
2487 | ||
2488 | @item M U | |
2489 | @kindex M U (Group) | |
2490 | @findex gnus-group-unmark-all-groups | |
2491 | Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). | |
2492 | ||
2493 | @item M w | |
2494 | @kindex M w (Group) | |
2495 | @findex gnus-group-mark-region | |
2496 | Mark all groups between point and mark (@code{gnus-group-mark-region}). | |
2497 | ||
2498 | @item M b | |
2499 | @kindex M b (Group) | |
2500 | @findex gnus-group-mark-buffer | |
2501 | Mark all groups in the buffer (@code{gnus-group-mark-buffer}). | |
2502 | ||
2503 | @item M r | |
2504 | @kindex M r (Group) | |
2505 | @findex gnus-group-mark-regexp | |
2506 | Mark all groups that match some regular expression | |
2507 | (@code{gnus-group-mark-regexp}). | |
2508 | @end table | |
2509 | ||
2510 | Also @pxref{Process/Prefix}. | |
2511 | ||
2512 | @findex gnus-group-universal-argument | |
2513 | If you want to execute some command on all groups that have been marked | |
2514 | with the process mark, you can use the @kbd{M-&} | |
2515 | (@code{gnus-group-universal-argument}) command. It will prompt you for | |
2516 | the command to be executed. | |
2517 | ||
2518 | ||
2519 | @node Foreign Groups | |
2520 | @section Foreign Groups | |
2521 | @cindex foreign groups | |
2522 | ||
549c9aed G |
2523 | If you recall how to subscribe to servers (@pxref{Finding the News}) |
2524 | you will remember that @code{gnus-secondary-select-methods} and | |
2525 | @code{gnus-select-method} let you write a definition in Emacs Lisp of | |
2526 | what servers you want to see when you start up. The alternate | |
2527 | approach is to use foreign servers and groups. ``Foreign'' here means | |
2528 | they are not coming from the select methods. All foreign server | |
2529 | configuration and subscriptions are stored only in the | |
2530 | @file{~/.newsrc.eld} file. | |
2531 | ||
4009494e GM |
2532 | Below are some group mode commands for making and editing general foreign |
2533 | groups, as well as commands to ease the creation of a few | |
2534 | special-purpose groups. All these commands insert the newly created | |
2535 | groups under point---@code{gnus-subscribe-newsgroup-method} is not | |
2536 | consulted. | |
2537 | ||
2538 | Changes from the group editing commands are stored in | |
2539 | @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the | |
2540 | variable @code{gnus-parameters}, @xref{Group Parameters}. | |
2541 | ||
2542 | @table @kbd | |
2543 | ||
2544 | @item G m | |
2545 | @kindex G m (Group) | |
2546 | @findex gnus-group-make-group | |
2547 | @cindex making groups | |
2548 | Make a new group (@code{gnus-group-make-group}). Gnus will prompt you | |
2549 | for a name, a method and possibly an @dfn{address}. For an easier way | |
2550 | to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}). | |
2551 | ||
2552 | @item G M | |
2553 | @kindex G M (Group) | |
2554 | @findex gnus-group-read-ephemeral-group | |
2555 | Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus | |
2556 | will prompt you for a name, a method and an @dfn{address}. | |
2557 | ||
2558 | @item G r | |
2559 | @kindex G r (Group) | |
2560 | @findex gnus-group-rename-group | |
2561 | @cindex renaming groups | |
2562 | Rename the current group to something else | |
2563 | (@code{gnus-group-rename-group}). This is valid only on some | |
2564 | groups---mail groups mostly. This command might very well be quite slow | |
2565 | on some back ends. | |
2566 | ||
2567 | @item G c | |
2568 | @kindex G c (Group) | |
2569 | @cindex customizing | |
2570 | @findex gnus-group-customize | |
2571 | Customize the group parameters (@code{gnus-group-customize}). | |
2572 | ||
2573 | @item G e | |
2574 | @kindex G e (Group) | |
2575 | @findex gnus-group-edit-group-method | |
2576 | @cindex renaming groups | |
2577 | Enter a buffer where you can edit the select method of the current | |
2578 | group (@code{gnus-group-edit-group-method}). | |
2579 | ||
2580 | @item G p | |
2581 | @kindex G p (Group) | |
2582 | @findex gnus-group-edit-group-parameters | |
2583 | Enter a buffer where you can edit the group parameters | |
2584 | (@code{gnus-group-edit-group-parameters}). | |
2585 | ||
2586 | @item G E | |
2587 | @kindex G E (Group) | |
2588 | @findex gnus-group-edit-group | |
2589 | Enter a buffer where you can edit the group info | |
2590 | (@code{gnus-group-edit-group}). | |
2591 | ||
2592 | @item G d | |
2593 | @kindex G d (Group) | |
2594 | @findex gnus-group-make-directory-group | |
2595 | @cindex nndir | |
2596 | Make a directory group (@pxref{Directory Groups}). You will be prompted | |
2597 | for a directory name (@code{gnus-group-make-directory-group}). | |
2598 | ||
2599 | @item G h | |
2600 | @kindex G h (Group) | |
2601 | @cindex help group | |
2602 | @findex gnus-group-make-help-group | |
2603 | Make the Gnus help group (@code{gnus-group-make-help-group}). | |
2604 | ||
4009494e GM |
2605 | @item G D |
2606 | @kindex G D (Group) | |
2607 | @findex gnus-group-enter-directory | |
2608 | @cindex nneething | |
2609 | Read an arbitrary directory as if it were a newsgroup with the | |
2610 | @code{nneething} back end (@code{gnus-group-enter-directory}). | |
2611 | @xref{Anything Groups}. | |
2612 | ||
2613 | @item G f | |
2614 | @kindex G f (Group) | |
2615 | @findex gnus-group-make-doc-group | |
2616 | @cindex ClariNet Briefs | |
2617 | @cindex nndoc | |
2618 | Make a group based on some file or other | |
2619 | (@code{gnus-group-make-doc-group}). If you give a prefix to this | |
2620 | command, you will be prompted for a file name and a file type. | |
2621 | Currently supported types are @code{mbox}, @code{babyl}, | |
2622 | @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, | |
2623 | @code{rfc934}, @code{rfc822-forward}, @code{mime-parts}, | |
2624 | @code{standard-digest}, @code{slack-digest}, @code{clari-briefs}, | |
2625 | @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If | |
2626 | you run this command without a prefix, Gnus will guess at the file | |
2627 | type. @xref{Document Groups}. | |
2628 | ||
2629 | @item G u | |
2630 | @kindex G u (Group) | |
2631 | @vindex gnus-useful-groups | |
2632 | @findex gnus-group-make-useful-group | |
2633 | Create one of the groups mentioned in @code{gnus-useful-groups} | |
2634 | (@code{gnus-group-make-useful-group}). | |
2635 | ||
2636 | @item G w | |
2637 | @kindex G w (Group) | |
2638 | @findex gnus-group-make-web-group | |
2639 | @cindex Google | |
2640 | @cindex nnweb | |
2641 | @cindex gmane | |
2642 | Make an ephemeral group based on a web search | |
2643 | (@code{gnus-group-make-web-group}). If you give a prefix to this | |
2644 | command, make a solid group instead. You will be prompted for the | |
2645 | search engine type and the search string. Valid search engine types | |
2646 | include @code{google}, @code{dejanews}, and @code{gmane}. | |
2647 | @xref{Web Searches}. | |
2648 | ||
2649 | If you use the @code{google} search engine, you can limit the search | |
2650 | to a particular group by using a match string like | |
2651 | @samp{shaving group:alt.sysadmin.recovery}. | |
2652 | ||
2653 | @item G R | |
2654 | @kindex G R (Group) | |
2655 | @findex gnus-group-make-rss-group | |
2656 | Make a group based on an @acronym{RSS} feed | |
1df7defd | 2657 | (@code{gnus-group-make-rss-group}). You will be prompted for an URL@. |
4009494e GM |
2658 | @xref{RSS}. |
2659 | ||
2660 | @item G DEL | |
2661 | @kindex G DEL (Group) | |
2662 | @findex gnus-group-delete-group | |
2663 | This function will delete the current group | |
2664 | (@code{gnus-group-delete-group}). If given a prefix, this function will | |
2665 | actually delete all the articles in the group, and forcibly remove the | |
2666 | group itself from the face of the Earth. Use a prefix only if you are | |
2667 | absolutely sure of what you are doing. This command can't be used on | |
2668 | read-only groups (like @code{nntp} groups), though. | |
2669 | ||
2670 | @item G V | |
2671 | @kindex G V (Group) | |
2672 | @findex gnus-group-make-empty-virtual | |
2673 | Make a new, fresh, empty @code{nnvirtual} group | |
2674 | (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}. | |
2675 | ||
2676 | @item G v | |
2677 | @kindex G v (Group) | |
2678 | @findex gnus-group-add-to-virtual | |
2679 | Add the current group to an @code{nnvirtual} group | |
2680 | (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention. | |
2681 | @end table | |
2682 | ||
2683 | @xref{Select Methods}, for more information on the various select | |
2684 | methods. | |
2685 | ||
2686 | @vindex gnus-activate-foreign-newsgroups | |
2687 | If @code{gnus-activate-foreign-newsgroups} is a positive number, | |
2688 | Gnus will check all foreign groups with this level or lower at startup. | |
2689 | This might take quite a while, especially if you subscribe to lots of | |
2690 | groups from different @acronym{NNTP} servers. Also @pxref{Group Levels}; | |
2691 | @code{gnus-activate-level} also affects activation of foreign | |
2692 | newsgroups. | |
2693 | ||
2694 | ||
9b3ebcb6 MB |
2695 | The following commands create ephemeral groups. They can be called not |
2696 | only from the Group buffer, but in any Gnus buffer. | |
2697 | ||
2698 | @table @code | |
2699 | @item gnus-read-ephemeral-gmane-group | |
2700 | @findex gnus-read-ephemeral-gmane-group | |
2701 | @vindex gnus-gmane-group-download-format | |
2702 | Read an ephemeral group on Gmane.org. The articles are downloaded via | |
2703 | HTTP using the URL specified by @code{gnus-gmane-group-download-format}. | |
2704 | Gnus will prompt you for a group name, the start article number and an | |
2705 | the article range. | |
2706 | ||
2707 | @item gnus-read-ephemeral-gmane-group-url | |
2708 | @findex gnus-read-ephemeral-gmane-group-url | |
2709 | This command is similar to @code{gnus-read-ephemeral-gmane-group}, but | |
2710 | the group name and the article number and range are constructed from a | |
1df7defd | 2711 | given @acronym{URL}. Supported @acronym{URL} formats include: |
9b3ebcb6 MB |
2712 | @url{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399}, |
2713 | @url{http://thread.gmane.org/gmane.foo.bar/12345/}, | |
2714 | @url{http://article.gmane.org/gmane.foo.bar/12345/}, | |
2715 | @url{http://permalink.gmane.org/gmane.foo.bar/12345/}, and | |
2716 | @url{http://news.gmane.org/group/gmane.foo.bar/thread=12345}. | |
2717 | ||
2718 | @item gnus-read-ephemeral-emacs-bug-group | |
2719 | @findex gnus-read-ephemeral-emacs-bug-group | |
2720 | Read an Emacs bug report in an ephemeral group. Gnus will prompt for a | |
2721 | bug number. The default is the number at point. The @acronym{URL} is | |
2722 | specified in @code{gnus-bug-group-download-format-alist}. | |
2723 | ||
2724 | @item gnus-read-ephemeral-debian-bug-group | |
2725 | @findex gnus-read-ephemeral-debian-bug-group | |
2726 | Read a Debian bug report in an ephemeral group. Analog to | |
2727 | @code{gnus-read-ephemeral-emacs-bug-group}. | |
2728 | @end table | |
2729 | ||
2730 | Some of these command are also useful for article buttons, @xref{Article | |
2731 | Buttons}. | |
2732 | ||
2733 | Here is an example: | |
2734 | @lisp | |
2735 | (require 'gnus-art) | |
2736 | (add-to-list | |
2737 | 'gnus-button-alist | |
2738 | '("#\\([0-9]+\\)\\>" 1 | |
2739 | (string-match "\\<emacs\\>" (or gnus-newsgroup-name "")) | |
2740 | gnus-read-ephemeral-emacs-bug-group 1)) | |
2741 | @end lisp | |
2742 | ||
2743 | ||
4009494e GM |
2744 | @node Group Parameters |
2745 | @section Group Parameters | |
2746 | @cindex group parameters | |
2747 | ||
2748 | The group parameters store information local to a particular group. | |
87035689 MB |
2749 | |
2750 | Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a | |
2751 | group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c} | |
2752 | presents you with a Customize-like interface. The latter helps avoid | |
2753 | silly Lisp errors.) You might also be interested in reading about topic | |
2754 | parameters (@pxref{Topic Parameters}). | |
2755 | Additionally, you can set group parameters via the | |
2756 | @code{gnus-parameters} variable, see below. | |
2757 | ||
4009494e GM |
2758 | Here's an example group parameter list: |
2759 | ||
2760 | @example | |
2761 | ((to-address . "ding@@gnus.org") | |
2762 | (auto-expire . t)) | |
2763 | @end example | |
2764 | ||
2765 | We see that each element consists of a ``dotted pair''---the thing before | |
2766 | the dot is the key, while the thing after the dot is the value. All the | |
2767 | parameters have this form @emph{except} local variable specs, which are | |
2768 | not dotted pairs, but proper lists. | |
2769 | ||
2770 | Some parameters have correspondent customizable variables, each of which | |
2771 | is an alist of regexps and values. | |
2772 | ||
2773 | The following group parameters can be used: | |
2774 | ||
2775 | @table @code | |
2776 | @item to-address | |
2777 | @cindex to-address | |
2778 | Address used by when doing followups and new posts. | |
2779 | ||
2780 | @example | |
2781 | (to-address . "some@@where.com") | |
2782 | @end example | |
2783 | ||
2784 | This is primarily useful in mail groups that represent closed mailing | |
2785 | lists---mailing lists where it's expected that everybody that writes to | |
2786 | the mailing list is subscribed to it. Since using this parameter | |
2787 | ensures that the mail only goes to the mailing list itself, it means | |
2788 | that members won't receive two copies of your followups. | |
2789 | ||
2790 | Using @code{to-address} will actually work whether the group is foreign | |
2791 | or not. Let's say there's a group on the server that is called | |
2792 | @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten | |
2793 | the articles from a mail-to-news gateway. Posting directly to this | |
2794 | group is therefore impossible---you have to send mail to the mailing | |
2795 | list address instead. | |
2796 | ||
2797 | See also @code{gnus-parameter-to-address-alist}. | |
2798 | ||
2799 | @item to-list | |
2800 | @cindex to-list | |
2801 | Address used when doing @kbd{a} in that group. | |
2802 | ||
2803 | @example | |
2804 | (to-list . "some@@where.com") | |
2805 | @end example | |
2806 | ||
2807 | It is totally ignored | |
2808 | when doing a followup---except that if it is present in a news group, | |
2809 | you'll get mail group semantics when doing @kbd{f}. | |
2810 | ||
2811 | If you do an @kbd{a} command in a mail group and you have neither a | |
2812 | @code{to-list} group parameter nor a @code{to-address} group parameter, | |
2813 | then a @code{to-list} group parameter will be added automatically upon | |
2814 | sending the message if @code{gnus-add-to-list} is set to @code{t}. | |
2815 | @vindex gnus-add-to-list | |
2816 | ||
2817 | @findex gnus-mailing-list-mode | |
2818 | @cindex mail list groups | |
2819 | If this variable is set, @code{gnus-mailing-list-mode} is turned on when | |
2820 | entering summary buffer. | |
2821 | ||
2822 | See also @code{gnus-parameter-to-list-alist}. | |
2823 | ||
2824 | @anchor{subscribed} | |
2825 | @item subscribed | |
2826 | @cindex subscribed | |
2827 | @cindex Mail-Followup-To | |
2828 | @findex gnus-find-subscribed-addresses | |
2829 | If this parameter is set to @code{t}, Gnus will consider the | |
2830 | to-address and to-list parameters for this group as addresses of | |
2831 | mailing lists you are subscribed to. Giving Gnus this information is | |
2832 | (only) a first step in getting it to generate correct Mail-Followup-To | |
2833 | headers for your posts to these lists. The second step is to put the | |
2834 | following in your @file{.gnus.el} | |
2835 | ||
2836 | @lisp | |
2837 | (setq message-subscribed-address-functions | |
2838 | '(gnus-find-subscribed-addresses)) | |
2839 | @end lisp | |
2840 | ||
2841 | @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for | |
2842 | a complete treatment of available MFT support. | |
2843 | ||
2844 | @item visible | |
2845 | @cindex visible | |
2846 | If the group parameter list has the element @code{(visible . t)}, | |
2847 | that group will always be visible in the Group buffer, regardless | |
2848 | of whether it has any unread articles. | |
2849 | ||
2850 | This parameter cannot be set via @code{gnus-parameters}. See | |
2851 | @code{gnus-permanently-visible-groups} as an alternative. | |
2852 | ||
2853 | @item broken-reply-to | |
2854 | @cindex broken-reply-to | |
2855 | Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To} | |
2856 | headers in this group are to be ignored, and for the header to be hidden | |
2857 | if @code{reply-to} is part of @code{gnus-boring-article-headers}. This | |
2858 | can be useful if you're reading a mailing list group where the listserv | |
2859 | has inserted @code{Reply-To} headers that point back to the listserv | |
2860 | itself. That is broken behavior. So there! | |
2861 | ||
2862 | @item to-group | |
2863 | @cindex to-group | |
2864 | Elements like @code{(to-group . "some.group.name")} means that all | |
2865 | posts in that group will be sent to @code{some.group.name}. | |
2866 | ||
2867 | @item newsgroup | |
2868 | @cindex newsgroup | |
2869 | If you have @code{(newsgroup . t)} in the group parameter list, Gnus | |
2870 | will treat all responses as if they were responses to news articles. | |
2871 | This can be useful if you have a mail group that's really a mirror of a | |
2872 | news group. | |
2873 | ||
2874 | @item gcc-self | |
2875 | @cindex gcc-self | |
2876 | If @code{(gcc-self . t)} is present in the group parameter list, newly | |
2877 | composed messages will be @code{Gcc}'d to the current group. If | |
2878 | @code{(gcc-self . none)} is present, no @code{Gcc:} header will be | |
2879 | generated, if @code{(gcc-self . "string")} is present, this string will | |
2880 | be inserted literally as a @code{gcc} header. This parameter takes | |
2881 | precedence over any default @code{Gcc} rules as described later | |
89b163db | 2882 | (@pxref{Archived Messages}), with the exception for messages to resend. |
4009494e GM |
2883 | |
2884 | @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of | |
2885 | @code{nntp} groups (or the like) isn't valid. An @code{nntp} server | |
2886 | doesn't accept articles. | |
2887 | ||
2888 | @item auto-expire | |
2889 | @cindex auto-expire | |
2890 | @cindex expiring mail | |
2891 | If the group parameter has an element that looks like @code{(auto-expire | |
2892 | . t)}, all articles read will be marked as expirable. For an | |
2893 | alternative approach, @pxref{Expiring Mail}. | |
2894 | ||
2895 | See also @code{gnus-auto-expirable-newsgroups}. | |
2896 | ||
2897 | @item total-expire | |
2898 | @cindex total-expire | |
2899 | @cindex expiring mail | |
2900 | If the group parameter has an element that looks like | |
2901 | @code{(total-expire . t)}, all read articles will be put through the | |
2902 | expiry process, even if they are not marked as expirable. Use with | |
2903 | caution. Unread, ticked and dormant articles are not eligible for | |
2904 | expiry. | |
2905 | ||
2906 | See also @code{gnus-total-expirable-newsgroups}. | |
2907 | ||
2908 | @item expiry-wait | |
2909 | @cindex expiry-wait | |
2910 | @vindex nnmail-expiry-wait-function | |
2911 | If the group parameter has an element that looks like | |
2912 | @code{(expiry-wait . 10)}, this value will override any | |
2913 | @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function} | |
2914 | (@pxref{Expiring Mail}) when expiring expirable messages. The value | |
2915 | can either be a number of days (not necessarily an integer) or the | |
2916 | symbols @code{never} or @code{immediate}. | |
2917 | ||
2918 | @item expiry-target | |
2919 | @cindex expiry-target | |
2920 | Where expired messages end up. This parameter overrides | |
2921 | @code{nnmail-expiry-target}. | |
2922 | ||
2923 | @item score-file | |
2924 | @cindex score file group parameter | |
2925 | Elements that look like @code{(score-file . "file")} will make | |
2926 | @file{file} into the current score file for the group in question. All | |
2927 | interactive score entries will be put into this file. | |
2928 | ||
2929 | @item adapt-file | |
2930 | @cindex adapt file group parameter | |
2931 | Elements that look like @code{(adapt-file . "file")} will make | |
2932 | @file{file} into the current adaptive file for the group in question. | |
2933 | All adaptive score entries will be put into this file. | |
2934 | ||
2935 | @item admin-address | |
2936 | @cindex admin-address | |
2937 | When unsubscribing from a mailing list you should never send the | |
2938 | unsubscription notice to the mailing list itself. Instead, you'd send | |
2939 | messages to the administrative address. This parameter allows you to | |
2940 | put the admin address somewhere convenient. | |
2941 | ||
2942 | @item display | |
2943 | @cindex display | |
2944 | Elements that look like @code{(display . MODE)} say which articles to | |
2945 | display on entering the group. Valid values are: | |
2946 | ||
2947 | @table @code | |
2948 | @item all | |
2949 | Display all articles, both read and unread. | |
2950 | ||
2951 | @item an integer | |
2952 | Display the last @var{integer} articles in the group. This is the same as | |
2953 | entering the group with @kbd{C-u @var{integer}}. | |
2954 | ||
2955 | @item default | |
2956 | Display the default visible articles, which normally includes unread and | |
2957 | ticked articles. | |
2958 | ||
2959 | @item an array | |
2960 | Display articles that satisfy a predicate. | |
2961 | ||
2962 | Here are some examples: | |
2963 | ||
2964 | @table @code | |
2965 | @item [unread] | |
2966 | Display only unread articles. | |
2967 | ||
2968 | @item [not expire] | |
2969 | Display everything except expirable articles. | |
2970 | ||
2971 | @item [and (not reply) (not expire)] | |
2972 | Display everything except expirable and articles you've already | |
2973 | responded to. | |
2974 | @end table | |
2975 | ||
2976 | The available operators are @code{not}, @code{and} and @code{or}. | |
2977 | Predicates include @code{tick}, @code{unsend}, @code{undownload}, | |
2978 | @code{unread}, @code{dormant}, @code{expire}, @code{reply}, | |
2979 | @code{killed}, @code{bookmark}, @code{score}, @code{save}, | |
e21bac42 | 2980 | @code{cache}, @code{forward}, and @code{unseen}. |
4009494e GM |
2981 | |
2982 | @end table | |
2983 | ||
2984 | The @code{display} parameter works by limiting the summary buffer to | |
2985 | the subset specified. You can pop the limit by using the @kbd{/ w} | |
2986 | command (@pxref{Limiting}). | |
2987 | ||
2988 | @item comment | |
2989 | @cindex comment | |
2990 | Elements that look like @code{(comment . "This is a comment")} are | |
2991 | arbitrary comments on the group. You can display comments in the | |
2992 | group line (@pxref{Group Line Specification}). | |
2993 | ||
2994 | @item charset | |
2995 | @cindex charset | |
2996 | Elements that look like @code{(charset . iso-8859-1)} will make | |
2997 | @code{iso-8859-1} the default charset; that is, the charset that will be | |
2998 | used for all articles that do not specify a charset. | |
2999 | ||
3000 | See also @code{gnus-group-charset-alist}. | |
3001 | ||
3002 | @item ignored-charsets | |
3003 | @cindex ignored-charset | |
3004 | Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)} | |
3005 | will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the | |
3006 | default charset will be used for decoding articles. | |
3007 | ||
3008 | See also @code{gnus-group-ignored-charsets-alist}. | |
3009 | ||
3010 | @item posting-style | |
3011 | @cindex posting-style | |
3012 | You can store additional posting style information for this group | |
3013 | here (@pxref{Posting Styles}). The format is that of an entry in the | |
3014 | @code{gnus-posting-styles} alist, except that there's no regexp matching | |
3015 | the group name (of course). Style elements in this group parameter will | |
3016 | take precedence over the ones found in @code{gnus-posting-styles}. | |
3017 | ||
3018 | For instance, if you want a funky name and signature in this group only, | |
3019 | instead of hacking @code{gnus-posting-styles}, you could put something | |
3020 | like this in the group parameters: | |
3021 | ||
3022 | @example | |
3023 | (posting-style | |
3024 | (name "Funky Name") | |
89b163db | 3025 | ("X-Message-SMTP-Method" "smtp smtp.example.org 587") |
4009494e GM |
3026 | ("X-My-Header" "Funky Value") |
3027 | (signature "Funky Signature")) | |
3028 | @end example | |
3029 | ||
01c52d31 MB |
3030 | If you're using topics to organize your group buffer |
3031 | (@pxref{Group Topics}), note that posting styles can also be set in | |
3032 | the topics parameters. Posting styles in topic parameters apply to all | |
3033 | groups in this topic. More precisely, the posting-style settings for a | |
3034 | group result from the hierarchical merging of all posting-style | |
3035 | entries in the parameters of this group and all the topics it belongs | |
3036 | to. | |
3037 | ||
3038 | ||
4009494e GM |
3039 | @item post-method |
3040 | @cindex post-method | |
3041 | If it is set, the value is used as the method for posting message | |
3042 | instead of @code{gnus-post-method}. | |
3043 | ||
a1da1e37 MB |
3044 | @item mail-source |
3045 | @cindex mail-source | |
3046 | If it is set, and the setting of @code{mail-sources} includes a | |
3047 | @code{group} mail source (@pxref{Mail Sources}), the value is a | |
3048 | mail source for this group. | |
3049 | ||
4009494e GM |
3050 | @item banner |
3051 | @cindex banner | |
3052 | An item like @code{(banner . @var{regexp})} causes any part of an article | |
3053 | that matches the regular expression @var{regexp} to be stripped. Instead of | |
3054 | @var{regexp}, you can also use the symbol @code{signature} which strips the | |
3055 | last signature or any of the elements of the alist | |
3056 | @code{gnus-article-banner-alist}. | |
3057 | ||
3058 | @item sieve | |
3059 | @cindex sieve | |
3060 | This parameter contains a Sieve test that should match incoming mail | |
3061 | that should be placed in this group. From this group parameter, a | |
3062 | Sieve @samp{IF} control structure is generated, having the test as the | |
3063 | condition and @samp{fileinto "group.name";} as the body. | |
3064 | ||
3065 | For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve | |
3066 | address "sender" "sieve-admin@@extundo.com")} group parameter, when | |
3067 | translating the group parameter into a Sieve script (@pxref{Sieve | |
3068 | Commands}) the following Sieve code is generated: | |
3069 | ||
3070 | @example | |
01c52d31 MB |
3071 | if address "sender" "sieve-admin@@extundo.com" @{ |
3072 | fileinto "INBOX.list.sieve"; | |
3073 | @} | |
3074 | @end example | |
3075 | ||
3076 | To generate tests for multiple email-addresses use a group parameter | |
3077 | like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}. | |
3078 | When generating a sieve script (@pxref{Sieve Commands}) Sieve code | |
3079 | like the following is generated: | |
3080 | ||
3081 | @example | |
3082 | if address "sender" ["name@@one.org", "else@@two.org"] @{ | |
3083 | fileinto "INBOX.list.sieve"; | |
4009494e GM |
3084 | @} |
3085 | @end example | |
3086 | ||
01c52d31 MB |
3087 | See @pxref{Sieve Commands} for commands and variables that might be of |
3088 | interest in relation to the sieve parameter. | |
3089 | ||
4009494e GM |
3090 | The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve, |
3091 | Top, sieve, Emacs Sieve}. | |
3092 | ||
3093 | @item (agent parameters) | |
88dbda51 JB |
3094 | If the agent has been enabled, you can set any of its parameters to |
3095 | control the behavior of the agent in individual groups. See Agent | |
4009494e GM |
3096 | Parameters in @ref{Category Syntax}. Most users will choose to set |
3097 | agent parameters in either an agent category or group topic to | |
3098 | minimize the configuration effort. | |
3099 | ||
3100 | @item (@var{variable} @var{form}) | |
3101 | You can use the group parameters to set variables local to the group you | |
3102 | are entering. If you want to turn threading off in @samp{news.answers}, | |
3103 | you could put @code{(gnus-show-threads nil)} in the group parameters of | |
3104 | that group. @code{gnus-show-threads} will be made into a local variable | |
3105 | in the summary buffer you enter, and the form @code{nil} will be | |
3106 | @code{eval}ed there. | |
3107 | ||
e3e955fe MB |
3108 | Note that this feature sets the variable locally to the summary buffer |
3109 | if and only if @var{variable} has been bound as a variable. Otherwise, | |
3110 | only evaluating the form will take place. So, you may want to bind the | |
3111 | variable in advance using @code{defvar} or other if the result of the | |
3112 | form needs to be set to it. | |
3113 | ||
4009494e GM |
3114 | But some variables are evaluated in the article buffer, or in the |
3115 | message buffer (of a reply or followup or otherwise newly created | |
3116 | message). As a workaround, it might help to add the variable in | |
3117 | question to @code{gnus-newsgroup-variables}. @xref{Various Summary | |
3118 | Stuff}. So if you want to set @code{message-from-style} via the group | |
3119 | parameters, then you may need the following statement elsewhere in your | |
e6d2d263 | 3120 | @file{~/.gnus.el} file: |
4009494e GM |
3121 | |
3122 | @lisp | |
3123 | (add-to-list 'gnus-newsgroup-variables 'message-from-style) | |
3124 | @end lisp | |
3125 | ||
3126 | @vindex gnus-list-identifiers | |
3127 | A use for this feature is to remove a mailing list identifier tag in | |
1df7defd | 3128 | the subject fields of articles. E.g., if the news group |
4009494e GM |
3129 | |
3130 | @example | |
3131 | nntp+news.gnus.org:gmane.text.docbook.apps | |
3132 | @end example | |
3133 | ||
3134 | has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this | |
3135 | tag can be removed from the article subjects in the summary buffer for | |
3136 | the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")} | |
3137 | into the group parameters for the group. | |
3138 | ||
3139 | This can also be used as a group-specific hook function. If you want to | |
3140 | hear a beep when you enter a group, you could put something like | |
e3e955fe MB |
3141 | @code{(dummy-variable (ding))} in the parameters of that group. If |
3142 | @code{dummy-variable} has been bound (see above), it will be set to the | |
3143 | (meaningless) result of the @code{(ding)} form. | |
4009494e GM |
3144 | |
3145 | Alternatively, since the VARIABLE becomes local to the group, this | |
3146 | pattern can be used to temporarily change a hook. For example, if the | |
3147 | following is added to a group parameter | |
3148 | ||
3149 | @lisp | |
3150 | (gnus-summary-prepared-hook | |
d1069532 | 3151 | (lambda nil (local-set-key "d" (local-key-binding "n")))) |
4009494e GM |
3152 | @end lisp |
3153 | ||
3154 | when the group is entered, the 'd' key will not mark the article as | |
3155 | expired. | |
3156 | ||
3157 | @end table | |
3158 | ||
4009494e GM |
3159 | @vindex gnus-parameters |
3160 | Group parameters can be set via the @code{gnus-parameters} variable too. | |
3161 | But some variables, such as @code{visible}, have no effect (For this | |
3162 | case see @code{gnus-permanently-visible-groups} as an alternative.). | |
3163 | For example: | |
3164 | ||
3165 | @lisp | |
3166 | (setq gnus-parameters | |
3167 | '(("mail\\..*" | |
3168 | (gnus-show-threads nil) | |
3169 | (gnus-use-scoring nil) | |
3170 | (gnus-summary-line-format | |
3171 | "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n") | |
3172 | (gcc-self . t) | |
3173 | (display . all)) | |
3174 | ||
3175 | ("^nnimap:\\(foo.bar\\)$" | |
3176 | (to-group . "\\1")) | |
3177 | ||
3178 | ("mail\\.me" | |
e7719ea1 | 3179 | (gnus-use-scoring t)) |
4009494e GM |
3180 | |
3181 | ("list\\..*" | |
3182 | (total-expire . t) | |
3183 | (broken-reply-to . t)))) | |
3184 | @end lisp | |
3185 | ||
e7719ea1 G |
3186 | All clauses that matches the group name will be used, but the last |
3187 | setting ``wins''. So if you have two clauses that both match the | |
3188 | group name, and both set, say @code{display}, the last setting will | |
3189 | override the first. | |
9937bef4 G |
3190 | |
3191 | Parameters that are strings will be subjected to regexp substitution, | |
3192 | as the @code{to-group} example shows. | |
4009494e GM |
3193 | |
3194 | @vindex gnus-parameters-case-fold-search | |
3195 | By default, whether comparing the group name and one of those regexps | |
3196 | specified in @code{gnus-parameters} is done in a case-sensitive manner | |
3197 | or a case-insensitive manner depends on the value of | |
3198 | @code{case-fold-search} at the time when the comparison is done. The | |
3199 | value of @code{case-fold-search} is typically @code{t}; it means, for | |
3200 | example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be | |
3201 | applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo} | |
3202 | group. If you want to make those regexps always case-sensitive, set the | |
3203 | value of the @code{gnus-parameters-case-fold-search} variable to | |
3204 | @code{nil}. Otherwise, set it to @code{t} if you want to compare them | |
3205 | always in a case-insensitive manner. | |
3206 | ||
01c52d31 MB |
3207 | You can define different sorting to different groups via |
3208 | @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP} | |
3209 | group by reverse date to see the latest news at the top and an | |
3210 | @acronym{RSS} group by subject. In this example, the first group is the | |
3211 | Debian daily news group @code{gmane.linux.debian.user.news} from | |
3212 | news.gmane.org. The @acronym{RSS} group corresponds to the Debian | |
3213 | weekly news RSS feed | |
3214 | @url{http://packages.debian.org/unstable/newpkg_main.en.rdf}, | |
3215 | @xref{RSS}. | |
3216 | ||
3217 | @lisp | |
3218 | (setq | |
3219 | gnus-parameters | |
3220 | '(("nntp.*gmane\\.debian\\.user\\.news" | |
3221 | (gnus-show-threads nil) | |
3222 | (gnus-article-sort-functions '((not gnus-article-sort-by-date))) | |
3223 | (gnus-use-adaptive-scoring nil) | |
3224 | (gnus-use-scoring nil)) | |
3225 | ("nnrss.*debian" | |
3226 | (gnus-show-threads nil) | |
3227 | (gnus-article-sort-functions 'gnus-article-sort-by-subject) | |
3228 | (gnus-use-adaptive-scoring nil) | |
3229 | (gnus-use-scoring t) | |
3230 | (gnus-score-find-score-files-function 'gnus-score-find-single) | |
3231 | (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n")))) | |
3232 | @end lisp | |
3233 | ||
4009494e GM |
3234 | |
3235 | @node Listing Groups | |
3236 | @section Listing Groups | |
3237 | @cindex group listing | |
3238 | ||
3239 | These commands all list various slices of the groups available. | |
3240 | ||
3241 | @table @kbd | |
3242 | ||
3243 | @item l | |
3244 | @itemx A s | |
3245 | @kindex A s (Group) | |
3246 | @kindex l (Group) | |
3247 | @findex gnus-group-list-groups | |
3248 | List all groups that have unread articles | |
3249 | (@code{gnus-group-list-groups}). If the numeric prefix is used, this | |
3250 | command will list only groups of level ARG and lower. By default, it | |
3251 | only lists groups of level five (i.e., | |
3252 | @code{gnus-group-default-list-level}) or lower (i.e., just subscribed | |
3253 | groups). | |
3254 | ||
3255 | @item L | |
3256 | @itemx A u | |
3257 | @kindex A u (Group) | |
3258 | @kindex L (Group) | |
3259 | @findex gnus-group-list-all-groups | |
3260 | List all groups, whether they have unread articles or not | |
3261 | (@code{gnus-group-list-all-groups}). If the numeric prefix is used, | |
3262 | this command will list only groups of level ARG and lower. By default, | |
3263 | it lists groups of level seven or lower (i.e., just subscribed and | |
3264 | unsubscribed groups). | |
3265 | ||
3266 | @item A l | |
3267 | @kindex A l (Group) | |
3268 | @findex gnus-group-list-level | |
3269 | List all unread groups on a specific level | |
3270 | (@code{gnus-group-list-level}). If given a prefix, also list the groups | |
3271 | with no unread articles. | |
3272 | ||
3273 | @item A k | |
3274 | @kindex A k (Group) | |
3275 | @findex gnus-group-list-killed | |
3276 | List all killed groups (@code{gnus-group-list-killed}). If given a | |
3277 | prefix argument, really list all groups that are available, but aren't | |
3278 | currently (un)subscribed. This could entail reading the active file | |
3279 | from the server. | |
3280 | ||
3281 | @item A z | |
3282 | @kindex A z (Group) | |
3283 | @findex gnus-group-list-zombies | |
3284 | List all zombie groups (@code{gnus-group-list-zombies}). | |
3285 | ||
3286 | @item A m | |
3287 | @kindex A m (Group) | |
3288 | @findex gnus-group-list-matching | |
3289 | List all unread, subscribed groups with names that match a regexp | |
3290 | (@code{gnus-group-list-matching}). | |
3291 | ||
3292 | @item A M | |
3293 | @kindex A M (Group) | |
3294 | @findex gnus-group-list-all-matching | |
3295 | List groups that match a regexp (@code{gnus-group-list-all-matching}). | |
3296 | ||
3297 | @item A A | |
3298 | @kindex A A (Group) | |
3299 | @findex gnus-group-list-active | |
3300 | List absolutely all groups in the active file(s) of the | |
3301 | server(s) you are connected to (@code{gnus-group-list-active}). This | |
3302 | might very well take quite a while. It might actually be a better idea | |
3303 | to do a @kbd{A M} to list all matching, and just give @samp{.} as the | |
3304 | thing to match on. Also note that this command may list groups that | |
3305 | don't exist (yet)---these will be listed as if they were killed groups. | |
3306 | Take the output with some grains of salt. | |
3307 | ||
3308 | @item A a | |
3309 | @kindex A a (Group) | |
3310 | @findex gnus-group-apropos | |
3311 | List all groups that have names that match a regexp | |
3312 | (@code{gnus-group-apropos}). | |
3313 | ||
3314 | @item A d | |
3315 | @kindex A d (Group) | |
3316 | @findex gnus-group-description-apropos | |
3317 | List all groups that have names or descriptions that match a regexp | |
3318 | (@code{gnus-group-description-apropos}). | |
3319 | ||
3320 | @item A c | |
3321 | @kindex A c (Group) | |
3322 | @findex gnus-group-list-cached | |
3323 | List all groups with cached articles (@code{gnus-group-list-cached}). | |
3324 | ||
3325 | @item A ? | |
3326 | @kindex A ? (Group) | |
3327 | @findex gnus-group-list-dormant | |
3328 | List all groups with dormant articles (@code{gnus-group-list-dormant}). | |
3329 | ||
a5954fa5 G |
3330 | @item A ! |
3331 | @kindex A ! (Group) | |
3332 | @findex gnus-group-list-ticked | |
3333 | List all groups with ticked articles (@code{gnus-group-list-ticked}). | |
3334 | ||
4009494e GM |
3335 | @item A / |
3336 | @kindex A / (Group) | |
3337 | @findex gnus-group-list-limit | |
0afb49a1 LMI |
3338 | Further limit groups within the current selection |
3339 | (@code{gnus-group-list-limit}). If you've first limited to groups | |
3340 | with dormant articles with @kbd{A ?}, you can then further limit with | |
3341 | @kbd{A / c}, which will then limit to groups with cached articles, | |
3342 | giving you the groups that have both dormant articles and cached | |
3343 | articles. | |
4009494e GM |
3344 | |
3345 | @item A f | |
3346 | @kindex A f (Group) | |
3347 | @findex gnus-group-list-flush | |
3348 | Flush groups from the current selection (@code{gnus-group-list-flush}). | |
3349 | ||
3350 | @item A p | |
3351 | @kindex A p (Group) | |
3352 | @findex gnus-group-list-plus | |
3353 | List groups plus the current selection (@code{gnus-group-list-plus}). | |
3354 | ||
3355 | @end table | |
3356 | ||
3357 | @vindex gnus-permanently-visible-groups | |
3358 | @cindex visible group parameter | |
3359 | Groups that match the @code{gnus-permanently-visible-groups} regexp will | |
3360 | always be shown, whether they have unread articles or not. You can also | |
3361 | add the @code{visible} element to the group parameters in question to | |
3362 | get the same effect. | |
3363 | ||
3364 | @vindex gnus-list-groups-with-ticked-articles | |
3365 | Groups that have just ticked articles in it are normally listed in the | |
3366 | group buffer. If @code{gnus-list-groups-with-ticked-articles} is | |
3367 | @code{nil}, these groups will be treated just like totally empty | |
3368 | groups. It is @code{t} by default. | |
3369 | ||
3370 | ||
3371 | @node Sorting Groups | |
3372 | @section Sorting Groups | |
3373 | @cindex sorting groups | |
3374 | ||
3375 | @kindex C-c C-s (Group) | |
3376 | @findex gnus-group-sort-groups | |
3377 | @vindex gnus-group-sort-function | |
3378 | The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the | |
3379 | group buffer according to the function(s) given by the | |
3380 | @code{gnus-group-sort-function} variable. Available sorting functions | |
3381 | include: | |
3382 | ||
3383 | @table @code | |
3384 | ||
3385 | @item gnus-group-sort-by-alphabet | |
3386 | @findex gnus-group-sort-by-alphabet | |
3387 | Sort the group names alphabetically. This is the default. | |
3388 | ||
3389 | @item gnus-group-sort-by-real-name | |
3390 | @findex gnus-group-sort-by-real-name | |
3391 | Sort the group alphabetically on the real (unprefixed) group names. | |
3392 | ||
3393 | @item gnus-group-sort-by-level | |
3394 | @findex gnus-group-sort-by-level | |
3395 | Sort by group level. | |
3396 | ||
3397 | @item gnus-group-sort-by-score | |
3398 | @findex gnus-group-sort-by-score | |
3399 | Sort by group score. @xref{Group Score}. | |
3400 | ||
3401 | @item gnus-group-sort-by-rank | |
3402 | @findex gnus-group-sort-by-rank | |
3403 | Sort by group score and then the group level. The level and the score | |
3404 | are, when taken together, the group's @dfn{rank}. @xref{Group Score}. | |
3405 | ||
3406 | @item gnus-group-sort-by-unread | |
3407 | @findex gnus-group-sort-by-unread | |
3408 | Sort by number of unread articles. | |
3409 | ||
3410 | @item gnus-group-sort-by-method | |
3411 | @findex gnus-group-sort-by-method | |
3412 | Sort alphabetically on the select method. | |
3413 | ||
3414 | @item gnus-group-sort-by-server | |
3415 | @findex gnus-group-sort-by-server | |
3416 | Sort alphabetically on the Gnus server name. | |
3417 | ||
3418 | ||
3419 | @end table | |
3420 | ||
3421 | @code{gnus-group-sort-function} can also be a list of sorting | |
3422 | functions. In that case, the most significant sort key function must be | |
3423 | the last one. | |
3424 | ||
3425 | ||
3426 | There are also a number of commands for sorting directly according to | |
3427 | some sorting criteria: | |
3428 | ||
3429 | @table @kbd | |
3430 | @item G S a | |
3431 | @kindex G S a (Group) | |
3432 | @findex gnus-group-sort-groups-by-alphabet | |
3433 | Sort the group buffer alphabetically by group name | |
3434 | (@code{gnus-group-sort-groups-by-alphabet}). | |
3435 | ||
3436 | @item G S u | |
3437 | @kindex G S u (Group) | |
3438 | @findex gnus-group-sort-groups-by-unread | |
3439 | Sort the group buffer by the number of unread articles | |
3440 | (@code{gnus-group-sort-groups-by-unread}). | |
3441 | ||
3442 | @item G S l | |
3443 | @kindex G S l (Group) | |
3444 | @findex gnus-group-sort-groups-by-level | |
3445 | Sort the group buffer by group level | |
3446 | (@code{gnus-group-sort-groups-by-level}). | |
3447 | ||
3448 | @item G S v | |
3449 | @kindex G S v (Group) | |
3450 | @findex gnus-group-sort-groups-by-score | |
3451 | Sort the group buffer by group score | |
3452 | (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}. | |
3453 | ||
3454 | @item G S r | |
3455 | @kindex G S r (Group) | |
3456 | @findex gnus-group-sort-groups-by-rank | |
3457 | Sort the group buffer by group rank | |
3458 | (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}. | |
3459 | ||
3460 | @item G S m | |
3461 | @kindex G S m (Group) | |
3462 | @findex gnus-group-sort-groups-by-method | |
3463 | Sort the group buffer alphabetically by back end name@* | |
3464 | (@code{gnus-group-sort-groups-by-method}). | |
3465 | ||
3466 | @item G S n | |
3467 | @kindex G S n (Group) | |
3468 | @findex gnus-group-sort-groups-by-real-name | |
3469 | Sort the group buffer alphabetically by real (unprefixed) group name | |
3470 | (@code{gnus-group-sort-groups-by-real-name}). | |
3471 | ||
3472 | @end table | |
3473 | ||
3474 | All the commands below obey the process/prefix convention | |
3475 | (@pxref{Process/Prefix}). | |
3476 | ||
3477 | When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these | |
3478 | commands will sort in reverse order. | |
3479 | ||
3480 | You can also sort a subset of the groups: | |
3481 | ||
3482 | @table @kbd | |
3483 | @item G P a | |
3484 | @kindex G P a (Group) | |
3485 | @findex gnus-group-sort-selected-groups-by-alphabet | |
3486 | Sort the groups alphabetically by group name | |
3487 | (@code{gnus-group-sort-selected-groups-by-alphabet}). | |
3488 | ||
3489 | @item G P u | |
3490 | @kindex G P u (Group) | |
3491 | @findex gnus-group-sort-selected-groups-by-unread | |
3492 | Sort the groups by the number of unread articles | |
3493 | (@code{gnus-group-sort-selected-groups-by-unread}). | |
3494 | ||
3495 | @item G P l | |
3496 | @kindex G P l (Group) | |
3497 | @findex gnus-group-sort-selected-groups-by-level | |
3498 | Sort the groups by group level | |
3499 | (@code{gnus-group-sort-selected-groups-by-level}). | |
3500 | ||
3501 | @item G P v | |
3502 | @kindex G P v (Group) | |
3503 | @findex gnus-group-sort-selected-groups-by-score | |
3504 | Sort the groups by group score | |
3505 | (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}. | |
3506 | ||
3507 | @item G P r | |
3508 | @kindex G P r (Group) | |
3509 | @findex gnus-group-sort-selected-groups-by-rank | |
3510 | Sort the groups by group rank | |
3511 | (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}. | |
3512 | ||
3513 | @item G P m | |
3514 | @kindex G P m (Group) | |
3515 | @findex gnus-group-sort-selected-groups-by-method | |
3516 | Sort the groups alphabetically by back end name@* | |
3517 | (@code{gnus-group-sort-selected-groups-by-method}). | |
3518 | ||
3519 | @item G P n | |
3520 | @kindex G P n (Group) | |
3521 | @findex gnus-group-sort-selected-groups-by-real-name | |
3522 | Sort the groups alphabetically by real (unprefixed) group name | |
3523 | (@code{gnus-group-sort-selected-groups-by-real-name}). | |
3524 | ||
3525 | @item G P s | |
3526 | @kindex G P s (Group) | |
3527 | @findex gnus-group-sort-selected-groups | |
3528 | Sort the groups according to @code{gnus-group-sort-function}. | |
3529 | ||
3530 | @end table | |
3531 | ||
3532 | And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually | |
3533 | move groups around. | |
3534 | ||
3535 | ||
3536 | @node Group Maintenance | |
3537 | @section Group Maintenance | |
3538 | @cindex bogus groups | |
3539 | ||
3540 | @table @kbd | |
3541 | @item b | |
3542 | @kindex b (Group) | |
3543 | @findex gnus-group-check-bogus-groups | |
3544 | Find bogus groups and delete them | |
3545 | (@code{gnus-group-check-bogus-groups}). | |
3546 | ||
3547 | @item F | |
3548 | @kindex F (Group) | |
3549 | @findex gnus-group-find-new-groups | |
3550 | Find new groups and process them (@code{gnus-group-find-new-groups}). | |
3551 | With 1 @kbd{C-u}, use the @code{ask-server} method to query the server | |
3552 | for new groups. With 2 @kbd{C-u}'s, use most complete method possible | |
3553 | to query the server for new groups, and subscribe the new groups as | |
3554 | zombies. | |
3555 | ||
3556 | @item C-c C-x | |
3557 | @kindex C-c C-x (Group) | |
3558 | @findex gnus-group-expire-articles | |
3559 | @cindex expiring mail | |
3560 | Run all expirable articles in the current group through the expiry | |
3561 | process (if any) (@code{gnus-group-expire-articles}). That is, delete | |
3562 | all expirable articles in the group that have been around for a while. | |
3563 | (@pxref{Expiring Mail}). | |
3564 | ||
3565 | @item C-c C-M-x | |
3566 | @kindex C-c C-M-x (Group) | |
3567 | @findex gnus-group-expire-all-groups | |
3568 | @cindex expiring mail | |
3569 | Run all expirable articles in all groups through the expiry process | |
3570 | (@code{gnus-group-expire-all-groups}). | |
3571 | ||
3572 | @end table | |
3573 | ||
3574 | ||
3575 | @node Browse Foreign Server | |
3576 | @section Browse Foreign Server | |
3577 | @cindex foreign servers | |
3578 | @cindex browsing servers | |
3579 | ||
3580 | @table @kbd | |
3581 | @item B | |
3582 | @kindex B (Group) | |
3583 | @findex gnus-group-browse-foreign-server | |
3584 | You will be queried for a select method and a server name. Gnus will | |
3585 | then attempt to contact this server and let you browse the groups there | |
3586 | (@code{gnus-group-browse-foreign-server}). | |
3587 | @end table | |
3588 | ||
3589 | @findex gnus-browse-mode | |
3590 | A new buffer with a list of available groups will appear. This buffer | |
3591 | will use the @code{gnus-browse-mode}. This buffer looks a bit (well, | |
3592 | a lot) like a normal group buffer. | |
3593 | ||
3594 | Here's a list of keystrokes available in the browse mode: | |
3595 | ||
3596 | @table @kbd | |
3597 | @item n | |
3598 | @kindex n (Browse) | |
3599 | @findex gnus-group-next-group | |
3600 | Go to the next group (@code{gnus-group-next-group}). | |
3601 | ||
3602 | @item p | |
3603 | @kindex p (Browse) | |
3604 | @findex gnus-group-prev-group | |
3605 | Go to the previous group (@code{gnus-group-prev-group}). | |
3606 | ||
3607 | @item SPACE | |
3608 | @kindex SPACE (Browse) | |
3609 | @findex gnus-browse-read-group | |
3610 | Enter the current group and display the first article | |
3611 | (@code{gnus-browse-read-group}). | |
3612 | ||
3613 | @item RET | |
3614 | @kindex RET (Browse) | |
3615 | @findex gnus-browse-select-group | |
3616 | Enter the current group (@code{gnus-browse-select-group}). | |
3617 | ||
3618 | @item u | |
3619 | @kindex u (Browse) | |
3620 | @findex gnus-browse-unsubscribe-current-group | |
8ccbef23 | 3621 | @vindex gnus-browse-subscribe-newsgroup-method |
4009494e | 3622 | Unsubscribe to the current group, or, as will be the case here, |
8ccbef23 G |
3623 | subscribe to it (@code{gnus-browse-unsubscribe-current-group}). You |
3624 | can affect the way the new group is entered into the Group buffer | |
3625 | using the variable @code{gnus-browse-subscribe-newsgroup-method}. See | |
3626 | @pxref{Subscription Methods} for available options. | |
4009494e GM |
3627 | |
3628 | @item l | |
3629 | @itemx q | |
3630 | @kindex q (Browse) | |
3631 | @kindex l (Browse) | |
3632 | @findex gnus-browse-exit | |
3633 | Exit browse mode (@code{gnus-browse-exit}). | |
3634 | ||
3635 | @item d | |
3636 | @kindex d (Browse) | |
3637 | @findex gnus-browse-describe-group | |
3638 | Describe the current group (@code{gnus-browse-describe-group}). | |
3639 | ||
3640 | @item ? | |
3641 | @kindex ? (Browse) | |
3642 | @findex gnus-browse-describe-briefly | |
3643 | Describe browse mode briefly (well, there's not much to describe, is | |
3644 | there) (@code{gnus-browse-describe-briefly}). | |
3645 | @end table | |
3646 | ||
3647 | ||
3648 | @node Exiting Gnus | |
3649 | @section Exiting Gnus | |
3650 | @cindex exiting Gnus | |
3651 | ||
3652 | Yes, Gnus is ex(c)iting. | |
3653 | ||
3654 | @table @kbd | |
3655 | @item z | |
3656 | @kindex z (Group) | |
3657 | @findex gnus-group-suspend | |
3658 | Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus, | |
3659 | but it kills all buffers except the Group buffer. I'm not sure why this | |
3660 | is a gain, but then who am I to judge? | |
3661 | ||
3662 | @item q | |
3663 | @kindex q (Group) | |
3664 | @findex gnus-group-exit | |
3665 | @c @icon{gnus-group-exit} | |
3666 | Quit Gnus (@code{gnus-group-exit}). | |
3667 | ||
3668 | @item Q | |
3669 | @kindex Q (Group) | |
3670 | @findex gnus-group-quit | |
3671 | Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}). | |
3672 | The dribble file will be saved, though (@pxref{Auto Save}). | |
3673 | @end table | |
3674 | ||
3675 | @vindex gnus-exit-gnus-hook | |
3676 | @vindex gnus-suspend-gnus-hook | |
3677 | @vindex gnus-after-exiting-gnus-hook | |
3678 | @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and | |
3679 | @code{gnus-exit-gnus-hook} is called when you quit Gnus, while | |
3680 | @code{gnus-after-exiting-gnus-hook} is called as the final item when | |
3681 | exiting Gnus. | |
3682 | ||
3683 | Note: | |
3684 | ||
3685 | @quotation | |
3686 | Miss Lisa Cannifax, while sitting in English class, felt her feet go | |
3687 | numbly heavy and herself fall into a hazy trance as the boy sitting | |
3688 | behind her drew repeated lines with his pencil across the back of her | |
3689 | plastic chair. | |
3690 | @end quotation | |
3691 | ||
3692 | ||
3693 | @node Group Topics | |
3694 | @section Group Topics | |
3695 | @cindex topics | |
3696 | ||
3697 | If you read lots and lots of groups, it might be convenient to group | |
3698 | them hierarchically according to topics. You put your Emacs groups over | |
3699 | here, your sex groups over there, and the rest (what, two groups or so?) | |
3700 | you put in some misc section that you never bother with anyway. You can | |
3701 | even group the Emacs sex groups as a sub-topic to either the Emacs | |
3702 | groups or the sex groups---or both! Go wild! | |
3703 | ||
3704 | @iftex | |
3705 | @iflatex | |
3706 | \gnusfigure{Group Topics}{400}{ | |
3707 | \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}} | |
3708 | } | |
3709 | @end iflatex | |
3710 | @end iftex | |
3711 | ||
3712 | Here's an example: | |
3713 | ||
3714 | @example | |
3715 | Gnus | |
3716 | Emacs -- I wuw it! | |
3717 | 3: comp.emacs | |
3718 | 2: alt.religion.emacs | |
3719 | Naughty Emacs | |
3720 | 452: alt.sex.emacs | |
3721 | 0: comp.talk.emacs.recovery | |
3722 | Misc | |
3723 | 8: comp.binaries.fractals | |
3724 | 13: comp.sources.unix | |
3725 | @end example | |
3726 | ||
3727 | @findex gnus-topic-mode | |
3728 | @kindex t (Group) | |
3729 | To get this @emph{fab} functionality you simply turn on (ooh!) the | |
3730 | @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This | |
3731 | is a toggling command.) | |
3732 | ||
3733 | Go ahead, just try it. I'll still be here when you get back. La de | |
3734 | dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back? | |
3735 | Yes, and now press @kbd{l}. There. All your groups are now listed | |
3736 | under @samp{misc}. Doesn't that make you feel all warm and fuzzy? | |
3737 | Hot and bothered? | |
3738 | ||
3739 | If you want this permanently enabled, you should add that minor mode to | |
3740 | the hook for the group mode. Put the following line in your | |
3741 | @file{~/.gnus.el} file: | |
3742 | ||
3743 | @lisp | |
3744 | (add-hook 'gnus-group-mode-hook 'gnus-topic-mode) | |
3745 | @end lisp | |
3746 | ||
3747 | @menu | |
3748 | * Topic Commands:: Interactive E-Z commands. | |
3749 | * Topic Variables:: How to customize the topics the Lisp Way. | |
3750 | * Topic Sorting:: Sorting each topic individually. | |
3751 | * Topic Topology:: A map of the world. | |
3752 | * Topic Parameters:: Parameters that apply to all groups in a topic. | |
3753 | @end menu | |
3754 | ||
3755 | ||
3756 | @node Topic Commands | |
3757 | @subsection Topic Commands | |
3758 | @cindex topic commands | |
3759 | ||
3760 | When the topic minor mode is turned on, a new @kbd{T} submap will be | |
3761 | available. In addition, a few of the standard keys change their | |
3762 | definitions slightly. | |
3763 | ||
3764 | In general, the following kinds of operations are possible on topics. | |
3765 | First of all, you want to create topics. Secondly, you want to put | |
3766 | groups in topics and to move them around until you have an order you | |
3767 | like. The third kind of operation is to show/hide parts of the whole | |
3768 | shebang. You might want to hide a topic including its subtopics and | |
3769 | groups, to get a better overview of the other groups. | |
3770 | ||
3771 | Here is a list of the basic keys that you might need to set up topics | |
3772 | the way you like. | |
3773 | ||
3774 | @table @kbd | |
3775 | ||
3776 | @item T n | |
3777 | @kindex T n (Topic) | |
3778 | @findex gnus-topic-create-topic | |
3779 | Prompt for a new topic name and create it | |
3780 | (@code{gnus-topic-create-topic}). | |
3781 | ||
3782 | @item T TAB | |
3783 | @itemx TAB | |
3784 | @kindex T TAB (Topic) | |
3785 | @kindex TAB (Topic) | |
3786 | @findex gnus-topic-indent | |
3787 | ``Indent'' the current topic so that it becomes a sub-topic of the | |
3788 | previous topic (@code{gnus-topic-indent}). If given a prefix, | |
3789 | ``un-indent'' the topic instead. | |
3790 | ||
3791 | @item M-TAB | |
3792 | @kindex M-TAB (Topic) | |
3793 | @findex gnus-topic-unindent | |
3794 | ``Un-indent'' the current topic so that it becomes a sub-topic of the | |
3795 | parent of its current parent (@code{gnus-topic-unindent}). | |
3796 | ||
3797 | @end table | |
3798 | ||
3799 | The following two keys can be used to move groups and topics around. | |
3800 | They work like the well-known cut and paste. @kbd{C-k} is like cut and | |
3801 | @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms | |
3802 | kill and yank rather than cut and paste. | |
3803 | ||
3804 | @table @kbd | |
3805 | ||
3806 | @item C-k | |
3807 | @kindex C-k (Topic) | |
3808 | @findex gnus-topic-kill-group | |
3809 | Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the | |
3810 | topic will be removed along with the topic. | |
3811 | ||
3812 | @item C-y | |
3813 | @kindex C-y (Topic) | |
3814 | @findex gnus-topic-yank-group | |
3815 | Yank the previously killed group or topic | |
3816 | (@code{gnus-topic-yank-group}). Note that all topics will be yanked | |
3817 | before all groups. | |
3818 | ||
3819 | So, to move a topic to the beginning of the list of topics, just hit | |
3820 | @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then, | |
3821 | move the cursor to the beginning of the buffer (just below the ``Gnus'' | |
3822 | topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and | |
3823 | paste. Like I said -- E-Z. | |
3824 | ||
3825 | You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So | |
3826 | you can move topics around as well as groups. | |
3827 | ||
3828 | @end table | |
3829 | ||
3830 | After setting up the topics the way you like them, you might wish to | |
3831 | hide a topic, or to show it again. That's why we have the following | |
3832 | key. | |
3833 | ||
3834 | @table @kbd | |
3835 | ||
3836 | @item RET | |
3837 | @kindex RET (Topic) | |
3838 | @findex gnus-topic-select-group | |
3839 | @itemx SPACE | |
3840 | Either select a group or fold a topic (@code{gnus-topic-select-group}). | |
3841 | When you perform this command on a group, you'll enter the group, as | |
3842 | usual. When done on a topic line, the topic will be folded (if it was | |
3843 | visible) or unfolded (if it was folded already). So it's basically a | |
3844 | toggling command on topics. In addition, if you give a numerical | |
3845 | prefix, group on that level (and lower) will be displayed. | |
3846 | ||
3847 | @end table | |
3848 | ||
3849 | Now for a list of other commands, in no particular order. | |
3850 | ||
3851 | @table @kbd | |
3852 | ||
3853 | @item T m | |
3854 | @kindex T m (Topic) | |
3855 | @findex gnus-topic-move-group | |
3856 | Move the current group to some other topic | |
3857 | (@code{gnus-topic-move-group}). This command uses the process/prefix | |
3858 | convention (@pxref{Process/Prefix}). | |
3859 | ||
3860 | @item T j | |
3861 | @kindex T j (Topic) | |
3862 | @findex gnus-topic-jump-to-topic | |
3863 | Go to a topic (@code{gnus-topic-jump-to-topic}). | |
3864 | ||
3865 | @item T c | |
3866 | @kindex T c (Topic) | |
3867 | @findex gnus-topic-copy-group | |
3868 | Copy the current group to some other topic | |
3869 | (@code{gnus-topic-copy-group}). This command uses the process/prefix | |
3870 | convention (@pxref{Process/Prefix}). | |
3871 | ||
3872 | @item T h | |
3873 | @kindex T h (Topic) | |
3874 | @findex gnus-topic-hide-topic | |
3875 | Hide the current topic (@code{gnus-topic-hide-topic}). If given | |
3876 | a prefix, hide the topic permanently. | |
3877 | ||
3878 | @item T s | |
3879 | @kindex T s (Topic) | |
3880 | @findex gnus-topic-show-topic | |
3881 | Show the current topic (@code{gnus-topic-show-topic}). If given | |
3882 | a prefix, show the topic permanently. | |
3883 | ||
3884 | @item T D | |
3885 | @kindex T D (Topic) | |
3886 | @findex gnus-topic-remove-group | |
3887 | Remove a group from the current topic (@code{gnus-topic-remove-group}). | |
3888 | This command is mainly useful if you have the same group in several | |
3889 | topics and wish to remove it from one of the topics. You may also | |
3890 | remove a group from all topics, but in that case, Gnus will add it to | |
3891 | the root topic the next time you start Gnus. In fact, all new groups | |
3892 | (which, naturally, don't belong to any topic) will show up in the root | |
3893 | topic. | |
3894 | ||
3895 | This command uses the process/prefix convention | |
3896 | (@pxref{Process/Prefix}). | |
3897 | ||
3898 | @item T M | |
3899 | @kindex T M (Topic) | |
3900 | @findex gnus-topic-move-matching | |
3901 | Move all groups that match some regular expression to a topic | |
3902 | (@code{gnus-topic-move-matching}). | |
3903 | ||
3904 | @item T C | |
3905 | @kindex T C (Topic) | |
3906 | @findex gnus-topic-copy-matching | |
3907 | Copy all groups that match some regular expression to a topic | |
3908 | (@code{gnus-topic-copy-matching}). | |
3909 | ||
3910 | @item T H | |
3911 | @kindex T H (Topic) | |
3912 | @findex gnus-topic-toggle-display-empty-topics | |
3913 | Toggle hiding empty topics | |
3914 | (@code{gnus-topic-toggle-display-empty-topics}). | |
3915 | ||
3916 | @item T # | |
3917 | @kindex T # (Topic) | |
3918 | @findex gnus-topic-mark-topic | |
3919 | Mark all groups in the current topic with the process mark | |
3920 | (@code{gnus-topic-mark-topic}). This command works recursively on | |
3921 | sub-topics unless given a prefix. | |
3922 | ||
3923 | @item T M-# | |
3924 | @kindex T M-# (Topic) | |
3925 | @findex gnus-topic-unmark-topic | |
3926 | Remove the process mark from all groups in the current topic | |
3927 | (@code{gnus-topic-unmark-topic}). This command works recursively on | |
3928 | sub-topics unless given a prefix. | |
3929 | ||
3930 | @item C-c C-x | |
3931 | @kindex C-c C-x (Topic) | |
3932 | @findex gnus-topic-expire-articles | |
3933 | @cindex expiring mail | |
3934 | Run all expirable articles in the current group or topic through the | |
3935 | expiry process (if any) | |
3936 | (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}). | |
3937 | ||
3938 | @item T r | |
3939 | @kindex T r (Topic) | |
3940 | @findex gnus-topic-rename | |
3941 | Rename a topic (@code{gnus-topic-rename}). | |
3942 | ||
3943 | @item T DEL | |
3944 | @kindex T DEL (Topic) | |
3945 | @findex gnus-topic-delete | |
3946 | Delete an empty topic (@code{gnus-topic-delete}). | |
3947 | ||
3948 | @item A T | |
3949 | @kindex A T (Topic) | |
3950 | @findex gnus-topic-list-active | |
3951 | List all groups that Gnus knows about in a topics-ified way | |
3952 | (@code{gnus-topic-list-active}). | |
3953 | ||
3954 | @item T M-n | |
3955 | @kindex T M-n (Topic) | |
3956 | @findex gnus-topic-goto-next-topic | |
3957 | Go to the next topic (@code{gnus-topic-goto-next-topic}). | |
3958 | ||
3959 | @item T M-p | |
3960 | @kindex T M-p (Topic) | |
3961 | @findex gnus-topic-goto-previous-topic | |
01c52d31 | 3962 | Go to the previous topic (@code{gnus-topic-goto-previous-topic}). |
4009494e GM |
3963 | |
3964 | @item G p | |
3965 | @kindex G p (Topic) | |
3966 | @findex gnus-topic-edit-parameters | |
3967 | @cindex group parameters | |
3968 | @cindex topic parameters | |
3969 | @cindex parameters | |
3970 | Edit the topic parameters (@code{gnus-topic-edit-parameters}). | |
3971 | @xref{Topic Parameters}. | |
3972 | ||
3973 | @end table | |
3974 | ||
3975 | ||
3976 | @node Topic Variables | |
3977 | @subsection Topic Variables | |
3978 | @cindex topic variables | |
3979 | ||
3980 | The previous section told you how to tell Gnus which topics to display. | |
3981 | This section explains how to tell Gnus what to display about each topic. | |
3982 | ||
3983 | @vindex gnus-topic-line-format | |
3984 | The topic lines themselves are created according to the | |
3985 | @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}). | |
3986 | Valid elements are: | |
3987 | ||
3988 | @table @samp | |
3989 | @item i | |
3990 | Indentation. | |
3991 | @item n | |
3992 | Topic name. | |
3993 | @item v | |
3994 | Visibility. | |
3995 | @item l | |
3996 | Level. | |
3997 | @item g | |
3998 | Number of groups in the topic. | |
3999 | @item a | |
4000 | Number of unread articles in the topic. | |
4001 | @item A | |
4002 | Number of unread articles in the topic and all its subtopics. | |
4003 | @end table | |
4004 | ||
4005 | @vindex gnus-topic-indent-level | |
4006 | Each sub-topic (and the groups in the sub-topics) will be indented with | |
4007 | @code{gnus-topic-indent-level} times the topic level number of spaces. | |
4008 | The default is 2. | |
4009 | ||
4010 | @vindex gnus-topic-mode-hook | |
4011 | @code{gnus-topic-mode-hook} is called in topic minor mode buffers. | |
4012 | ||
4013 | @vindex gnus-topic-display-empty-topics | |
4014 | The @code{gnus-topic-display-empty-topics} says whether to display even | |
4015 | topics that have no unread articles in them. The default is @code{t}. | |
4016 | ||
4017 | ||
4018 | @node Topic Sorting | |
4019 | @subsection Topic Sorting | |
4020 | @cindex topic sorting | |
4021 | ||
4022 | You can sort the groups in each topic individually with the following | |
4023 | commands: | |
4024 | ||
4025 | ||
4026 | @table @kbd | |
4027 | @item T S a | |
4028 | @kindex T S a (Topic) | |
4029 | @findex gnus-topic-sort-groups-by-alphabet | |
4030 | Sort the current topic alphabetically by group name | |
4031 | (@code{gnus-topic-sort-groups-by-alphabet}). | |
4032 | ||
4033 | @item T S u | |
4034 | @kindex T S u (Topic) | |
4035 | @findex gnus-topic-sort-groups-by-unread | |
4036 | Sort the current topic by the number of unread articles | |
4037 | (@code{gnus-topic-sort-groups-by-unread}). | |
4038 | ||
4039 | @item T S l | |
4040 | @kindex T S l (Topic) | |
4041 | @findex gnus-topic-sort-groups-by-level | |
4042 | Sort the current topic by group level | |
4043 | (@code{gnus-topic-sort-groups-by-level}). | |
4044 | ||
4045 | @item T S v | |
4046 | @kindex T S v (Topic) | |
4047 | @findex gnus-topic-sort-groups-by-score | |
4048 | Sort the current topic by group score | |
4049 | (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}. | |
4050 | ||
4051 | @item T S r | |
4052 | @kindex T S r (Topic) | |
4053 | @findex gnus-topic-sort-groups-by-rank | |
4054 | Sort the current topic by group rank | |
4055 | (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}. | |
4056 | ||
4057 | @item T S m | |
4058 | @kindex T S m (Topic) | |
4059 | @findex gnus-topic-sort-groups-by-method | |
4060 | Sort the current topic alphabetically by back end name | |
4061 | (@code{gnus-topic-sort-groups-by-method}). | |
4062 | ||
4063 | @item T S e | |
4064 | @kindex T S e (Topic) | |
4065 | @findex gnus-topic-sort-groups-by-server | |
4066 | Sort the current topic alphabetically by server name | |
4067 | (@code{gnus-topic-sort-groups-by-server}). | |
4068 | ||
4069 | @item T S s | |
4070 | @kindex T S s (Topic) | |
4071 | @findex gnus-topic-sort-groups | |
4072 | Sort the current topic according to the function(s) given by the | |
4073 | @code{gnus-group-sort-function} variable | |
4074 | (@code{gnus-topic-sort-groups}). | |
4075 | ||
4076 | @end table | |
4077 | ||
4078 | When given a prefix argument, all these commands will sort in reverse | |
4079 | order. @xref{Sorting Groups}, for more information about group | |
4080 | sorting. | |
4081 | ||
4082 | ||
4083 | @node Topic Topology | |
4084 | @subsection Topic Topology | |
4085 | @cindex topic topology | |
4086 | @cindex topology | |
4087 | ||
4088 | So, let's have a look at an example group buffer: | |
4089 | ||
4090 | @example | |
4091 | @group | |
4092 | Gnus | |
4093 | Emacs -- I wuw it! | |
4094 | 3: comp.emacs | |
4095 | 2: alt.religion.emacs | |
4096 | Naughty Emacs | |
4097 | 452: alt.sex.emacs | |
4098 | 0: comp.talk.emacs.recovery | |
4099 | Misc | |
4100 | 8: comp.binaries.fractals | |
4101 | 13: comp.sources.unix | |
4102 | @end group | |
4103 | @end example | |
4104 | ||
4105 | So, here we have one top-level topic (@samp{Gnus}), two topics under | |
4106 | that, and one sub-topic under one of the sub-topics. (There is always | |
4107 | just one (1) top-level topic). This topology can be expressed as | |
4108 | follows: | |
4109 | ||
4110 | @lisp | |
4111 | (("Gnus" visible) | |
4112 | (("Emacs -- I wuw it!" visible) | |
4113 | (("Naughty Emacs" visible))) | |
4114 | (("Misc" visible))) | |
4115 | @end lisp | |
4116 | ||
4117 | @vindex gnus-topic-topology | |
4118 | This is in fact how the variable @code{gnus-topic-topology} would look | |
4119 | for the display above. That variable is saved in the @file{.newsrc.eld} | |
4120 | file, and shouldn't be messed with manually---unless you really want | |
4121 | to. Since this variable is read from the @file{.newsrc.eld} file, | |
4122 | setting it in any other startup files will have no effect. | |
4123 | ||
4124 | This topology shows what topics are sub-topics of what topics (right), | |
4125 | and which topics are visible. Two settings are currently | |
4126 | allowed---@code{visible} and @code{invisible}. | |
4127 | ||
4128 | ||
4129 | @node Topic Parameters | |
4130 | @subsection Topic Parameters | |
4131 | @cindex topic parameters | |
4132 | ||
4133 | All groups in a topic will inherit group parameters from the parent | |
4134 | (and ancestor) topic parameters. All valid group parameters are valid | |
4135 | topic parameters (@pxref{Group Parameters}). When the agent is | |
4136 | enabled, all agent parameters (See Agent Parameters in @ref{Category | |
4137 | Syntax}) are also valid topic parameters. | |
4138 | ||
4139 | In addition, the following parameters are only valid as topic | |
4140 | parameters: | |
4141 | ||
4142 | @table @code | |
4143 | @item subscribe | |
4144 | When subscribing new groups by topic (@pxref{Subscription Methods}), the | |
4145 | @code{subscribe} topic parameter says what groups go in what topic. Its | |
4146 | value should be a regexp to match the groups that should go in that | |
4147 | topic. | |
4148 | ||
4149 | @item subscribe-level | |
4150 | When subscribing new groups by topic (see the @code{subscribe} parameter), | |
4151 | the group will be subscribed with the level specified in the | |
4152 | @code{subscribe-level} instead of @code{gnus-level-default-subscribed}. | |
4153 | ||
4154 | @end table | |
4155 | ||
4156 | Group parameters (of course) override topic parameters, and topic | |
4157 | parameters in sub-topics override topic parameters in super-topics. You | |
4158 | know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a | |
4159 | verb, although you may feel free to disagree with me here.) | |
4160 | ||
4161 | @example | |
4162 | @group | |
4163 | Gnus | |
4164 | Emacs | |
4165 | 3: comp.emacs | |
4166 | 2: alt.religion.emacs | |
4167 | 452: alt.sex.emacs | |
4168 | Relief | |
4169 | 452: alt.sex.emacs | |
4170 | 0: comp.talk.emacs.recovery | |
4171 | Misc | |
4172 | 8: comp.binaries.fractals | |
4173 | 13: comp.sources.unix | |
4174 | 452: alt.sex.emacs | |
4175 | @end group | |
4176 | @end example | |
4177 | ||
4178 | The @samp{Emacs} topic has the topic parameter @code{(score-file | |
4179 | . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter | |
4180 | @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the | |
4181 | topic parameter @code{(score-file . "emacs.SCORE")}. In addition, | |
4182 | @* @samp{alt.religion.emacs} has the group parameter @code{(score-file | |
4183 | . "religion.SCORE")}. | |
4184 | ||
4185 | Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you | |
4186 | will get the @file{relief.SCORE} home score file. If you enter the same | |
4187 | group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home | |
4188 | score file. If you enter the group @samp{alt.religion.emacs}, you'll | |
4189 | get the @file{religion.SCORE} home score file. | |
4190 | ||
4191 | This seems rather simple and self-evident, doesn't it? Well, yes. But | |
4192 | there are some problems, especially with the @code{total-expiry} | |
4193 | parameter. Say you have a mail group in two topics; one with | |
4194 | @code{total-expiry} and one without. What happens when you do @kbd{M-x | |
4195 | gnus-expire-all-expirable-groups}? Gnus has no way of telling which one | |
4196 | of these topics you mean to expire articles from, so anything may | |
4197 | happen. In fact, I hereby declare that it is @dfn{undefined} what | |
4198 | happens. You just have to be careful if you do stuff like that. | |
4199 | ||
4200 | ||
01c52d31 MB |
4201 | @node Non-ASCII Group Names |
4202 | @section Accessing groups of non-English names | |
4203 | @cindex non-ascii group names | |
4204 | ||
4205 | There are some news servers that provide groups of which the names are | |
4206 | expressed with their native languages in the world. For instance, in a | |
4207 | certain news server there are some newsgroups of which the names are | |
4208 | spelled in Chinese, where people are talking in Chinese. You can, of | |
4209 | course, subscribe to such news groups using Gnus. Currently Gnus | |
4210 | supports non-@acronym{ASCII} group names not only with the @code{nntp} | |
4211 | back end but also with the @code{nnml} back end and the @code{nnrss} | |
4212 | back end. | |
4213 | ||
4214 | Every such group name is encoded by a certain charset in the server | |
4215 | side (in an @acronym{NNTP} server its administrator determines the | |
4216 | charset, but for groups in the other back ends it is determined by you). | |
4217 | Gnus has to display the decoded ones for you in the group buffer and the | |
4218 | article buffer, and needs to use the encoded ones when communicating | |
4219 | with servers. However, Gnus doesn't know what charset is used for each | |
4220 | non-@acronym{ASCII} group name. The following two variables are just | |
4221 | the ones for telling Gnus what charset should be used for each group: | |
4222 | ||
4223 | @table @code | |
4224 | @item gnus-group-name-charset-method-alist | |
4225 | @vindex gnus-group-name-charset-method-alist | |
4226 | An alist of select methods and charsets. The default value is | |
4227 | @code{nil}. The names of groups in the server specified by that select | |
4228 | method are all supposed to use the corresponding charset. For example: | |
4229 | ||
4230 | @lisp | |
4231 | (setq gnus-group-name-charset-method-alist | |
4232 | '(((nntp "news.com.cn") . cn-gb-2312))) | |
4233 | @end lisp | |
4234 | ||
4235 | Charsets specified for groups with this variable are preferred to the | |
4236 | ones specified for the same groups with the | |
4237 | @code{gnus-group-name-charset-group-alist} variable (see below). | |
4238 | ||
4239 | A select method can be very long, like: | |
4240 | ||
4241 | @lisp | |
4242 | (nntp "gmane" | |
4243 | (nntp-address "news.gmane.org") | |
4244 | (nntp-end-of-line "\n") | |
4245 | (nntp-open-connection-function | |
4246 | nntp-open-via-rlogin-and-telnet) | |
4247 | (nntp-via-rlogin-command "ssh") | |
4248 | (nntp-via-rlogin-command-switches | |
4249 | ("-C" "-t" "-e" "none")) | |
4250 | (nntp-via-address @dots{})) | |
4251 | @end lisp | |
4252 | ||
4253 | In that case, you can truncate it into @code{(nntp "gmane")} in this | |
4254 | variable. That is, it is enough to contain only the back end name and | |
4255 | the server name. | |
4256 | ||
4257 | @item gnus-group-name-charset-group-alist | |
4258 | @cindex UTF-8 group names | |
4259 | @vindex gnus-group-name-charset-group-alist | |
4260 | An alist of regexp of group name and the charset for group names. | |
4261 | @code{((".*" . utf-8))} is the default value if UTF-8 is supported, | |
4262 | otherwise the default is @code{nil}. For example: | |
4263 | ||
4264 | @lisp | |
4265 | (setq gnus-group-name-charset-group-alist | |
4266 | '(("\\.com\\.cn:" . cn-gb-2312) | |
4267 | (".*" . utf-8))) | |
4268 | @end lisp | |
4269 | ||
4270 | Note that this variable is ignored if the match is made with | |
4271 | @code{gnus-group-name-charset-method-alist}. | |
4272 | @end table | |
4273 | ||
4274 | Those two variables are used also to determine the charset for encoding | |
4275 | and decoding non-@acronym{ASCII} group names that are in the back ends | |
4276 | other than @code{nntp}. It means that it is you who determine it. If | |
4277 | you do nothing, the charset used for group names in those back ends will | |
4278 | all be @code{utf-8} because of the last element of | |
4279 | @code{gnus-group-name-charset-group-alist}. | |
4280 | ||
4281 | There is one more important variable for non-@acronym{ASCII} group | |
26b9f88d | 4282 | names: |
01c52d31 MB |
4283 | |
4284 | @table @code | |
4285 | @item nnmail-pathname-coding-system | |
26b9f88d MB |
4286 | @vindex nnmail-pathname-coding-system |
4287 | The value of this variable should be a coding system or @code{nil}. The | |
4288 | default is @code{nil} in Emacs, or is the aliasee of the coding system | |
4289 | named @code{file-name} (a certain coding system of which an alias is | |
4290 | @code{file-name}) in XEmacs. | |
4291 | ||
89b163db G |
4292 | The @code{nnml} back end, the @code{nnrss} back end, the agent, and |
4293 | the cache use non-@acronym{ASCII} group names in those files and | |
4294 | directories. This variable overrides the value of | |
4295 | @code{file-name-coding-system} which specifies the coding system used | |
4296 | when encoding and decoding those file names and directory names. | |
01c52d31 MB |
4297 | |
4298 | In XEmacs (with the @code{mule} feature), @code{file-name-coding-system} | |
4299 | is the only means to specify the coding system used to encode and decode | |
26b9f88d | 4300 | file names. On the other hand, Emacs uses the value of |
01c52d31 | 4301 | @code{default-file-name-coding-system} if @code{file-name-coding-system} |
26b9f88d MB |
4302 | is @code{nil} or it is bound to the value of |
4303 | @code{nnmail-pathname-coding-system} which is @code{nil}. | |
4304 | ||
4305 | Normally the value of @code{default-file-name-coding-system} in Emacs or | |
4306 | @code{nnmail-pathname-coding-system} in XEmacs is initialized according | |
4307 | to the locale, so you will need to do nothing if the value is suitable | |
4308 | to encode and decode non-@acronym{ASCII} group names. | |
01c52d31 MB |
4309 | |
4310 | The value of this variable (or @code{default-file-name-coding-system}) | |
4311 | does not necessarily need to be the same value that is determined by | |
4312 | @code{gnus-group-name-charset-method-alist} and | |
4313 | @code{gnus-group-name-charset-group-alist}. | |
4314 | ||
26b9f88d MB |
4315 | If @code{default-file-name-coding-system} or this variable is |
4316 | initialized by default to @code{iso-latin-1} for example, although you | |
4317 | want to subscribe to the groups spelled in Chinese, that is the most | |
4318 | typical case where you have to customize | |
4319 | @code{nnmail-pathname-coding-system}. The @code{utf-8} coding system is | |
4320 | a good candidate for it. Otherwise, you may change the locale in your | |
4321 | system so that @code{default-file-name-coding-system} or this variable | |
4322 | may be initialized to an appropriate value. | |
01c52d31 MB |
4323 | @end table |
4324 | ||
4325 | Note that when you copy or move articles from a non-@acronym{ASCII} | |
4326 | group to another group, the charset used to encode and decode group | |
4327 | names should be the same in both groups. Otherwise the Newsgroups | |
4328 | header will be displayed incorrectly in the article buffer. | |
4329 | ||
4330 | ||
8a1cdce5 AC |
4331 | @node Misc Group Stuff |
4332 | @section Misc Group Stuff | |
e6d2d263 MB |
4333 | |
4334 | @menu | |
8a1cdce5 AC |
4335 | * Scanning New Messages:: Asking Gnus to see whether new messages have arrived. |
4336 | * Group Information:: Information and help on groups and Gnus. | |
4337 | * Group Timestamp:: Making Gnus keep track of when you last read a group. | |
4338 | * File Commands:: Reading and writing the Gnus files. | |
4339 | * Sieve Commands:: Managing Sieve scripts. | |
e6d2d263 MB |
4340 | @end menu |
4341 | ||
8a1cdce5 | 4342 | @table @kbd |
e6d2d263 | 4343 | |
8a1cdce5 AC |
4344 | @item v |
4345 | @kindex v (Group) | |
4346 | @cindex keys, reserved for users (Group) | |
4347 | The key @kbd{v} is reserved for users. You can bind it to some | |
4348 | command or better use it as a prefix key. For example: | |
e6d2d263 | 4349 | |
8a1cdce5 AC |
4350 | @lisp |
4351 | (define-key gnus-group-mode-map (kbd "v j d") | |
4352 | (lambda () | |
4353 | (interactive) | |
4354 | (gnus-group-jump-to-group "nndraft:drafts"))) | |
4355 | @end lisp | |
e6d2d263 | 4356 | |
8a1cdce5 AC |
4357 | On keys reserved for users in Emacs and on keybindings in general |
4358 | @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}. | |
e6d2d263 | 4359 | |
8a1cdce5 AC |
4360 | @item ^ |
4361 | @kindex ^ (Group) | |
4362 | @findex gnus-group-enter-server-mode | |
4363 | Enter the server buffer (@code{gnus-group-enter-server-mode}). | |
4364 | @xref{Server Buffer}. | |
e6d2d263 | 4365 | |
8a1cdce5 AC |
4366 | @item a |
4367 | @kindex a (Group) | |
4368 | @findex gnus-group-post-news | |
4369 | Start composing a message (a news by default) | |
4370 | (@code{gnus-group-post-news}). If given a prefix, post to the group | |
4371 | under the point. If the prefix is 1, prompt for a group to post to. | |
4372 | Contrary to what the name of this function suggests, the prepared | |
4373 | article might be a mail instead of a news, if a mail group is specified | |
4374 | with the prefix argument. @xref{Composing Messages}. | |
e6d2d263 | 4375 | |
8a1cdce5 AC |
4376 | @item m |
4377 | @kindex m (Group) | |
4378 | @findex gnus-group-mail | |
4379 | Mail a message somewhere (@code{gnus-group-mail}). If given a prefix, | |
4380 | use the posting style of the group under the point. If the prefix is 1, | |
4381 | prompt for a group name to find the posting style. | |
4382 | @xref{Composing Messages}. | |
e6d2d263 | 4383 | |
8a1cdce5 AC |
4384 | @item i |
4385 | @kindex i (Group) | |
4386 | @findex gnus-group-news | |
4387 | Start composing a news (@code{gnus-group-news}). If given a prefix, | |
4388 | post to the group under the point. If the prefix is 1, prompt | |
4389 | for group to post to. @xref{Composing Messages}. | |
e6d2d263 | 4390 | |
8a1cdce5 AC |
4391 | This function actually prepares a news even when using mail groups. |
4392 | This is useful for ``posting'' messages to mail groups without actually | |
4393 | sending them over the network: they're just saved directly to the group | |
4394 | in question. The corresponding back end must have a request-post method | |
4395 | for this to work though. | |
e6d2d263 | 4396 | |
8a1cdce5 AC |
4397 | @item G z |
4398 | @kindex G z (Group) | |
4399 | @findex gnus-group-compact-group | |
e6d2d263 | 4400 | |
8a1cdce5 AC |
4401 | Compact the group under point (@code{gnus-group-compact-group}). |
4402 | Currently implemented only in nnml (@pxref{Mail Spool}). This removes | |
4403 | gaps between article numbers, hence getting a correct total article | |
4404 | count. | |
e6d2d263 | 4405 | |
8a1cdce5 | 4406 | @end table |
e6d2d263 | 4407 | |
8a1cdce5 | 4408 | Variables for the group buffer: |
e6d2d263 | 4409 | |
8a1cdce5 | 4410 | @table @code |
e6d2d263 | 4411 | |
8a1cdce5 AC |
4412 | @item gnus-group-mode-hook |
4413 | @vindex gnus-group-mode-hook | |
4414 | is called after the group buffer has been | |
4415 | created. | |
e6d2d263 | 4416 | |
8a1cdce5 AC |
4417 | @item gnus-group-prepare-hook |
4418 | @vindex gnus-group-prepare-hook | |
4419 | is called after the group buffer is | |
4420 | generated. It may be used to modify the buffer in some strange, | |
4421 | unnatural way. | |
e6d2d263 | 4422 | |
8a1cdce5 AC |
4423 | @item gnus-group-prepared-hook |
4424 | @vindex gnus-group-prepare-hook | |
4425 | is called as the very last thing after the group buffer has been | |
4426 | generated. It may be used to move point around, for instance. | |
e6d2d263 | 4427 | |
8a1cdce5 AC |
4428 | @item gnus-permanently-visible-groups |
4429 | @vindex gnus-permanently-visible-groups | |
4430 | Groups matching this regexp will always be listed in the group buffer, | |
4431 | whether they are empty or not. | |
e6d2d263 | 4432 | |
8a1cdce5 | 4433 | @end table |
e6d2d263 | 4434 | |
8a1cdce5 AC |
4435 | @node Scanning New Messages |
4436 | @subsection Scanning New Messages | |
4437 | @cindex new messages | |
4438 | @cindex scanning new news | |
e6d2d263 | 4439 | |
8a1cdce5 | 4440 | @table @kbd |
e6d2d263 | 4441 | |
8a1cdce5 AC |
4442 | @item g |
4443 | @kindex g (Group) | |
4444 | @findex gnus-group-get-new-news | |
4445 | @c @icon{gnus-group-get-new-news} | |
4446 | Check the server(s) for new articles. If the numerical prefix is used, | |
4447 | this command will check only groups of level @var{arg} and lower | |
4448 | (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this | |
4449 | command will force a total re-reading of the active file(s) from the | |
4450 | back end(s). | |
e6d2d263 | 4451 | |
8a1cdce5 AC |
4452 | @item M-g |
4453 | @kindex M-g (Group) | |
4454 | @findex gnus-group-get-new-news-this-group | |
4455 | @vindex gnus-goto-next-group-when-activating | |
4456 | @c @icon{gnus-group-get-new-news-this-group} | |
4457 | Check whether new articles have arrived in the current group | |
4458 | (@code{gnus-group-get-new-news-this-group}). | |
4459 | @code{gnus-goto-next-group-when-activating} says whether this command is | |
4460 | to move point to the next group or not. It is @code{t} by default. | |
e6d2d263 | 4461 | |
8a1cdce5 AC |
4462 | @findex gnus-activate-all-groups |
4463 | @cindex activating groups | |
4464 | @item C-c M-g | |
4465 | @kindex C-c M-g (Group) | |
4466 | Activate absolutely all groups (@code{gnus-activate-all-groups}). | |
e6d2d263 | 4467 | |
8a1cdce5 AC |
4468 | @item R |
4469 | @kindex R (Group) | |
4470 | @cindex restarting | |
4471 | @findex gnus-group-restart | |
4472 | Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc} | |
4473 | file(s), closes the connection to all servers, clears up all run-time | |
4474 | Gnus variables, and then starts Gnus all over again. | |
e6d2d263 | 4475 | |
8a1cdce5 | 4476 | @end table |
e6d2d263 | 4477 | |
8a1cdce5 AC |
4478 | @vindex gnus-get-new-news-hook |
4479 | @code{gnus-get-new-news-hook} is run just before checking for new news. | |
e6d2d263 | 4480 | |
8a1cdce5 AC |
4481 | @vindex gnus-after-getting-new-news-hook |
4482 | @code{gnus-after-getting-new-news-hook} is run after checking for new | |
4483 | news. | |
e6d2d263 | 4484 | |
e6d2d263 | 4485 | |
8a1cdce5 AC |
4486 | @node Group Information |
4487 | @subsection Group Information | |
4488 | @cindex group information | |
4489 | @cindex information on groups | |
e6d2d263 | 4490 | |
8a1cdce5 | 4491 | @table @kbd |
e6d2d263 | 4492 | |
e6d2d263 | 4493 | |
8a1cdce5 AC |
4494 | @item H d |
4495 | @itemx C-c C-d | |
4496 | @c @icon{gnus-group-describe-group} | |
4497 | @kindex H d (Group) | |
4498 | @kindex C-c C-d (Group) | |
4499 | @cindex describing groups | |
4500 | @cindex group description | |
4501 | @findex gnus-group-describe-group | |
4502 | Describe the current group (@code{gnus-group-describe-group}). If given | |
4503 | a prefix, force Gnus to re-read the description from the server. | |
2b968687 | 4504 | |
8a1cdce5 AC |
4505 | @item M-d |
4506 | @kindex M-d (Group) | |
4507 | @findex gnus-group-describe-all-groups | |
4508 | Describe all groups (@code{gnus-group-describe-all-groups}). If given a | |
4509 | prefix, force Gnus to re-read the description file from the server. | |
2b968687 | 4510 | |
8a1cdce5 AC |
4511 | @item H v |
4512 | @itemx V | |
4513 | @kindex V (Group) | |
4514 | @kindex H v (Group) | |
4515 | @cindex version | |
4516 | @findex gnus-version | |
4517 | Display current Gnus version numbers (@code{gnus-version}). | |
2b968687 | 4518 | |
8a1cdce5 AC |
4519 | @item ? |
4520 | @kindex ? (Group) | |
4521 | @findex gnus-group-describe-briefly | |
4522 | Give a very short help message (@code{gnus-group-describe-briefly}). | |
2b968687 | 4523 | |
8a1cdce5 AC |
4524 | @item C-c C-i |
4525 | @kindex C-c C-i (Group) | |
4526 | @cindex info | |
4527 | @cindex manual | |
4528 | @findex gnus-info-find-node | |
4529 | Go to the Gnus info node (@code{gnus-info-find-node}). | |
4530 | @end table | |
e6d2d263 | 4531 | |
e6d2d263 | 4532 | |
8a1cdce5 AC |
4533 | @node Group Timestamp |
4534 | @subsection Group Timestamp | |
4535 | @cindex timestamps | |
4536 | @cindex group timestamps | |
e6d2d263 | 4537 | |
8a1cdce5 AC |
4538 | It can be convenient to let Gnus keep track of when you last read a |
4539 | group. To set the ball rolling, you should add | |
4540 | @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}: | |
e6d2d263 | 4541 | |
8a1cdce5 AC |
4542 | @lisp |
4543 | (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp) | |
4544 | @end lisp | |
e6d2d263 | 4545 | |
8a1cdce5 | 4546 | After doing this, each time you enter a group, it'll be recorded. |
e6d2d263 | 4547 | |
8a1cdce5 AC |
4548 | This information can be displayed in various ways---the easiest is to |
4549 | use the @samp{%d} spec in the group line format: | |
e6d2d263 | 4550 | |
8a1cdce5 AC |
4551 | @lisp |
4552 | (setq gnus-group-line-format | |
4553 | "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n") | |
4554 | @end lisp | |
e6d2d263 | 4555 | |
8a1cdce5 | 4556 | This will result in lines looking like: |
e6d2d263 | 4557 | |
8a1cdce5 AC |
4558 | @example |
4559 | * 0: mail.ding 19961002T012943 | |
4560 | 0: custom 19961002T012713 | |
4561 | @end example | |
e6d2d263 | 4562 | |
8a1cdce5 AC |
4563 | As you can see, the date is displayed in compact ISO 8601 format. This |
4564 | may be a bit too much, so to just display the date, you could say | |
4565 | something like: | |
e6d2d263 | 4566 | |
8a1cdce5 AC |
4567 | @lisp |
4568 | (setq gnus-group-line-format | |
4569 | "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n") | |
4570 | @end lisp | |
e6d2d263 | 4571 | |
8a1cdce5 AC |
4572 | If you would like greater control of the time format, you can use a |
4573 | user-defined format spec. Something like the following should do the | |
4574 | trick: | |
e6d2d263 | 4575 | |
8a1cdce5 AC |
4576 | @lisp |
4577 | (setq gnus-group-line-format | |
4578 | "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n") | |
4579 | (defun gnus-user-format-function-d (headers) | |
4580 | (let ((time (gnus-group-timestamp gnus-tmp-group))) | |
4581 | (if time | |
4582 | (format-time-string "%b %d %H:%M" time) | |
4583 | ""))) | |
4584 | @end lisp | |
e6d2d263 | 4585 | |
71cca84d G |
4586 | To see what variables are dynamically bound (like |
4587 | @code{gnus-tmp-group}), you have to look at the source code. The | |
4588 | variable names aren't guaranteed to be stable over Gnus versions, | |
4589 | either. | |
4590 | ||
e6d2d263 | 4591 | |
8a1cdce5 AC |
4592 | @node File Commands |
4593 | @subsection File Commands | |
4594 | @cindex file commands | |
e6d2d263 | 4595 | |
8a1cdce5 | 4596 | @table @kbd |
e6d2d263 | 4597 | |
8a1cdce5 AC |
4598 | @item r |
4599 | @kindex r (Group) | |
4600 | @findex gnus-group-read-init-file | |
4601 | @vindex gnus-init-file | |
4602 | @cindex reading init file | |
4603 | Re-read the init file (@code{gnus-init-file}, which defaults to | |
4604 | @file{~/.gnus.el}) (@code{gnus-group-read-init-file}). | |
e6d2d263 | 4605 | |
8a1cdce5 AC |
4606 | @item s |
4607 | @kindex s (Group) | |
4608 | @findex gnus-group-save-newsrc | |
4609 | @cindex saving .newsrc | |
4610 | Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted) | |
4611 | (@code{gnus-group-save-newsrc}). If given a prefix, force saving the | |
4612 | file(s) whether Gnus thinks it is necessary or not. | |
e6d2d263 | 4613 | |
8a1cdce5 AC |
4614 | @c @item Z |
4615 | @c @kindex Z (Group) | |
4616 | @c @findex gnus-group-clear-dribble | |
4617 | @c Clear the dribble buffer (@code{gnus-group-clear-dribble}). | |
e6d2d263 | 4618 | |
8a1cdce5 | 4619 | @end table |
e6d2d263 | 4620 | |
e6d2d263 | 4621 | |
8a1cdce5 AC |
4622 | @node Sieve Commands |
4623 | @subsection Sieve Commands | |
4624 | @cindex group sieve commands | |
e6d2d263 | 4625 | |
8a1cdce5 AC |
4626 | Sieve is a server-side mail filtering language. In Gnus you can use |
4627 | the @code{sieve} group parameter (@pxref{Group Parameters}) to specify | |
4628 | sieve rules that should apply to each group. Gnus provides two | |
4629 | commands to translate all these group parameters into a proper Sieve | |
333f9019 | 4630 | script that can be transferred to the server somehow. |
e6d2d263 | 4631 | |
8a1cdce5 AC |
4632 | @vindex gnus-sieve-file |
4633 | @vindex gnus-sieve-region-start | |
4634 | @vindex gnus-sieve-region-end | |
4635 | The generated Sieve script is placed in @code{gnus-sieve-file} (by | |
4636 | default @file{~/.sieve}). The Sieve code that Gnus generate is placed | |
4637 | between two delimiters, @code{gnus-sieve-region-start} and | |
4638 | @code{gnus-sieve-region-end}, so you may write additional Sieve code | |
4639 | outside these delimiters that will not be removed the next time you | |
4640 | regenerate the Sieve script. | |
e6d2d263 | 4641 | |
8a1cdce5 AC |
4642 | @vindex gnus-sieve-crosspost |
4643 | The variable @code{gnus-sieve-crosspost} controls how the Sieve script | |
4644 | is generated. If it is non-@code{nil} (the default) articles is | |
4645 | placed in all groups that have matching rules, otherwise the article | |
4646 | is only placed in the group with the first matching rule. For | |
4647 | example, the group parameter @samp{(sieve address "sender" | |
4648 | "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve | |
4649 | code if @code{gnus-sieve-crosspost} is @code{nil}. (When | |
4650 | @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same | |
4651 | except that the line containing the call to @code{stop} is removed.) | |
e6d2d263 | 4652 | |
8a1cdce5 AC |
4653 | @example |
4654 | if address "sender" "owner-ding@@hpc.uh.edu" @{ | |
4655 | fileinto "INBOX.ding"; | |
4656 | stop; | |
4657 | @} | |
4658 | @end example | |
e6d2d263 | 4659 | |
8a1cdce5 | 4660 | @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}. |
e6d2d263 MB |
4661 | |
4662 | @table @kbd | |
4663 | ||
8a1cdce5 AC |
4664 | @item D g |
4665 | @kindex D g (Group) | |
4666 | @findex gnus-sieve-generate | |
4667 | @vindex gnus-sieve-file | |
4668 | @cindex generating sieve script | |
4669 | Regenerate a Sieve script from the @code{sieve} group parameters and | |
4670 | put you into the @code{gnus-sieve-file} without saving it. | |
e6d2d263 | 4671 | |
8a1cdce5 AC |
4672 | @item D u |
4673 | @kindex D u (Group) | |
4674 | @findex gnus-sieve-update | |
4675 | @vindex gnus-sieve-file | |
4676 | @cindex updating sieve script | |
4677 | Regenerates the Gnus managed part of @code{gnus-sieve-file} using the | |
4678 | @code{sieve} group parameters, save the file and upload it to the | |
4679 | server using the @code{sieveshell} program. | |
e6d2d263 MB |
4680 | |
4681 | @end table | |
4682 | ||
e6d2d263 | 4683 | |
8a1cdce5 AC |
4684 | @node Summary Buffer |
4685 | @chapter Summary Buffer | |
4686 | @cindex summary buffer | |
e6d2d263 | 4687 | |
8a1cdce5 AC |
4688 | A line for each article is displayed in the summary buffer. You can |
4689 | move around, read articles, post articles and reply to articles. | |
e6d2d263 | 4690 | |
8a1cdce5 AC |
4691 | The most common way to a summary buffer is to select a group from the |
4692 | group buffer (@pxref{Selecting a Group}). | |
e6d2d263 | 4693 | |
8a1cdce5 | 4694 | You can have as many summary buffers open as you wish. |
e6d2d263 | 4695 | |
8a1cdce5 AC |
4696 | You can customize the Summary Mode tool bar, see @kbd{M-x |
4697 | customize-apropos RET gnus-summary-tool-bar}. This feature is only | |
4698 | available in Emacs. | |
e6d2d263 | 4699 | |
8a1cdce5 AC |
4700 | @kindex v (Summary) |
4701 | @cindex keys, reserved for users (Summary) | |
4702 | The key @kbd{v} is reserved for users. You can bind it to some | |
4703 | command or better use it as a prefix key. For example: | |
4704 | @lisp | |
4705 | (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread | |
4706 | @end lisp | |
e6d2d263 | 4707 | |
8a1cdce5 AC |
4708 | @menu |
4709 | * Summary Buffer Format:: Deciding how the summary buffer is to look. | |
4710 | * Summary Maneuvering:: Moving around the summary buffer. | |
4711 | * Choosing Articles:: Reading articles. | |
4712 | * Paging the Article:: Scrolling the current article. | |
4713 | * Reply Followup and Post:: Posting articles. | |
4714 | * Delayed Articles:: Send articles at a later time. | |
4715 | * Marking Articles:: Marking articles as read, expirable, etc. | |
4716 | * Limiting:: You can limit the summary buffer. | |
4717 | * Threading:: How threads are made. | |
4718 | * Sorting the Summary Buffer:: How articles and threads are sorted. | |
4719 | * Asynchronous Fetching:: Gnus might be able to pre-fetch articles. | |
4720 | * Article Caching:: You may store articles in a cache. | |
4721 | * Persistent Articles:: Making articles expiry-resistant. | |
4722 | * Sticky Articles:: Article buffers that are not reused. | |
4723 | * Article Backlog:: Having already read articles hang around. | |
4724 | * Saving Articles:: Ways of customizing article saving. | |
4725 | * Decoding Articles:: Gnus can treat series of (uu)encoded articles. | |
4726 | * Article Treatment:: The article buffer can be mangled at will. | |
4727 | * MIME Commands:: Doing MIMEy things with the articles. | |
4728 | * Charsets:: Character set issues. | |
4729 | * Article Commands:: Doing various things with the article buffer. | |
4730 | * Summary Sorting:: Sorting the summary buffer in various ways. | |
4731 | * Finding the Parent:: No child support? Get the parent. | |
4732 | * Alternative Approaches:: Reading using non-default summaries. | |
4733 | * Tree Display:: A more visual display of threads. | |
4734 | * Mail Group Commands:: Some commands can only be used in mail groups. | |
4735 | * Various Summary Stuff:: What didn't fit anywhere else. | |
4736 | * Exiting the Summary Buffer:: Returning to the Group buffer, | |
4737 | or reselecting the current group. | |
4738 | * Crosspost Handling:: How crossposted articles are dealt with. | |
4739 | * Duplicate Suppression:: An alternative when crosspost handling fails. | |
4740 | * Security:: Decrypt and Verify. | |
4741 | * Mailing List:: Mailing list minor mode. | |
4742 | @end menu | |
e6d2d263 | 4743 | |
e6d2d263 | 4744 | |
8a1cdce5 AC |
4745 | @node Summary Buffer Format |
4746 | @section Summary Buffer Format | |
4747 | @cindex summary buffer format | |
e6d2d263 | 4748 | |
8a1cdce5 AC |
4749 | @iftex |
4750 | @iflatex | |
4751 | \gnusfigure{The Summary Buffer}{180}{ | |
4752 | \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}} | |
4753 | \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}} | |
4754 | } | |
4755 | @end iflatex | |
4756 | @end iftex | |
e6d2d263 | 4757 | |
8a1cdce5 AC |
4758 | @menu |
4759 | * Summary Buffer Lines:: You can specify how summary lines should look. | |
4760 | * To From Newsgroups:: How to not display your own name. | |
4761 | * Summary Buffer Mode Line:: You can say how the mode line should look. | |
4762 | * Summary Highlighting:: Making the summary buffer all pretty and nice. | |
4763 | @end menu | |
e6d2d263 | 4764 | |
8a1cdce5 AC |
4765 | @findex mail-extract-address-components |
4766 | @findex gnus-extract-address-components | |
4767 | @vindex gnus-extract-address-components | |
4768 | Gnus will use the value of the @code{gnus-extract-address-components} | |
4769 | variable as a function for getting the name and address parts of a | |
4770 | @code{From} header. Two pre-defined functions exist: | |
4771 | @code{gnus-extract-address-components}, which is the default, quite | |
4772 | fast, and too simplistic solution; and | |
4773 | @code{mail-extract-address-components}, which works very nicely, but is | |
4774 | slower. The default function will return the wrong answer in 5% of the | |
4775 | cases. If this is unacceptable to you, use the other function instead: | |
e6d2d263 MB |
4776 | |
4777 | @lisp | |
8a1cdce5 AC |
4778 | (setq gnus-extract-address-components |
4779 | 'mail-extract-address-components) | |
e6d2d263 MB |
4780 | @end lisp |
4781 | ||
8a1cdce5 AC |
4782 | @vindex gnus-summary-same-subject |
4783 | @code{gnus-summary-same-subject} is a string indicating that the current | |
4784 | article has the same subject as the previous. This string will be used | |
4785 | with those specs that require it. The default is @code{""}. | |
e6d2d263 | 4786 | |
e6d2d263 | 4787 | |
8a1cdce5 AC |
4788 | @node Summary Buffer Lines |
4789 | @subsection Summary Buffer Lines | |
e6d2d263 | 4790 | |
8a1cdce5 AC |
4791 | @vindex gnus-summary-line-format |
4792 | You can change the format of the lines in the summary buffer by changing | |
4793 | the @code{gnus-summary-line-format} variable. It works along the same | |
4794 | lines as a normal @code{format} string, with some extensions | |
4795 | (@pxref{Formatting Variables}). | |
e6d2d263 | 4796 | |
8a1cdce5 AC |
4797 | There should always be a colon or a point position marker on the line; |
4798 | the cursor always moves to the point position marker or the colon after | |
4799 | performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't | |
4800 | possible to change this. Just write a new function | |
4801 | @code{gnus-goto-colon} which does whatever you like with the cursor.) | |
4802 | @xref{Positioning Point}. | |
e6d2d263 | 4803 | |
8a1cdce5 | 4804 | The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}. |
e6d2d263 | 4805 | |
8a1cdce5 AC |
4806 | The following format specification characters and extended format |
4807 | specification(s) are understood: | |
e6d2d263 | 4808 | |
8a1cdce5 AC |
4809 | @table @samp |
4810 | @item N | |
4811 | Article number. | |
4812 | @item S | |
4813 | Subject string. List identifiers stripped, | |
4814 | @code{gnus-list-identifiers}. @xref{Article Hiding}. | |
4815 | @item s | |
4816 | Subject if the article is the root of the thread or the previous article | |
4817 | had a different subject, @code{gnus-summary-same-subject} otherwise. | |
4818 | (@code{gnus-summary-same-subject} defaults to @code{""}.) | |
4819 | @item F | |
4820 | Full @code{From} header. | |
4821 | @item n | |
4822 | The name (from the @code{From} header). | |
4823 | @item f | |
4824 | The name, @code{To} header or the @code{Newsgroups} header (@pxref{To | |
4825 | From Newsgroups}). | |
4826 | @item a | |
4827 | The name (from the @code{From} header). This differs from the @code{n} | |
4828 | spec in that it uses the function designated by the | |
4829 | @code{gnus-extract-address-components} variable, which is slower, but | |
4830 | may be more thorough. | |
4831 | @item A | |
4832 | The address (from the @code{From} header). This works the same way as | |
4833 | the @code{a} spec. | |
4834 | @item L | |
4835 | Number of lines in the article. | |
4836 | @item c | |
4837 | Number of characters in the article. This specifier is not supported | |
4838 | in some methods (like nnfolder). | |
4839 | @item k | |
4840 | Pretty-printed version of the number of characters in the article; | |
4841 | for example, @samp{1.2k} or @samp{0.4M}. | |
4842 | @item I | |
4843 | Indentation based on thread level (@pxref{Customizing Threading}). | |
4844 | @item B | |
4845 | A complex trn-style thread tree, showing response-connecting trace | |
4846 | lines. A thread could be drawn like this: | |
e6d2d263 | 4847 | |
8a1cdce5 AC |
4848 | @example |
4849 | > | |
4850 | +-> | |
4851 | | +-> | |
4852 | | | \-> | |
4853 | | | \-> | |
4854 | | \-> | |
4855 | +-> | |
4856 | \-> | |
4857 | @end example | |
e6d2d263 | 4858 | |
8a1cdce5 AC |
4859 | You can customize the appearance with the following options. Note |
4860 | that it is possible to make the thread display look really neat by | |
4861 | replacing the default @acronym{ASCII} characters with graphic | |
4862 | line-drawing glyphs. | |
4863 | @table @code | |
4864 | @item gnus-sum-thread-tree-root | |
4865 | @vindex gnus-sum-thread-tree-root | |
4866 | Used for the root of a thread. If @code{nil}, use subject | |
4867 | instead. The default is @samp{> }. | |
e6d2d263 | 4868 | |
8a1cdce5 AC |
4869 | @item gnus-sum-thread-tree-false-root |
4870 | @vindex gnus-sum-thread-tree-false-root | |
4871 | Used for the false root of a thread (@pxref{Loose Threads}). If | |
4872 | @code{nil}, use subject instead. The default is @samp{> }. | |
e6d2d263 | 4873 | |
8a1cdce5 AC |
4874 | @item gnus-sum-thread-tree-single-indent |
4875 | @vindex gnus-sum-thread-tree-single-indent | |
4876 | Used for a thread with just one message. If @code{nil}, use subject | |
4877 | instead. The default is @samp{}. | |
030cca00 | 4878 | |
8a1cdce5 AC |
4879 | @item gnus-sum-thread-tree-vertical |
4880 | @vindex gnus-sum-thread-tree-vertical | |
4881 | Used for drawing a vertical line. The default is @samp{| }. | |
030cca00 | 4882 | |
8a1cdce5 AC |
4883 | @item gnus-sum-thread-tree-indent |
4884 | @vindex gnus-sum-thread-tree-indent | |
4885 | Used for indenting. The default is @samp{ }. | |
e6d2d263 | 4886 | |
8a1cdce5 AC |
4887 | @item gnus-sum-thread-tree-leaf-with-other |
4888 | @vindex gnus-sum-thread-tree-leaf-with-other | |
4889 | Used for a leaf with brothers. The default is @samp{+-> }. | |
e6d2d263 | 4890 | |
8a1cdce5 AC |
4891 | @item gnus-sum-thread-tree-single-leaf |
4892 | @vindex gnus-sum-thread-tree-single-leaf | |
4893 | Used for a leaf without brothers. The default is @samp{\-> } | |
e6d2d263 | 4894 | |
8a1cdce5 | 4895 | @end table |
030cca00 | 4896 | |
8a1cdce5 AC |
4897 | @item T |
4898 | Nothing if the article is a root and lots of spaces if it isn't (it | |
4899 | pushes everything after it off the screen). | |
4900 | @item [ | |
4901 | Opening bracket, which is normally @samp{[}, but can also be @samp{<} | |
4902 | for adopted articles (@pxref{Customizing Threading}). | |
4903 | @item ] | |
4904 | Closing bracket, which is normally @samp{]}, but can also be @samp{>} | |
4905 | for adopted articles. | |
4906 | @item > | |
4907 | One space for each thread level. | |
4908 | @item < | |
4909 | Twenty minus thread level spaces. | |
4910 | @item U | |
4911 | Unread. @xref{Read Articles}. | |
e6d2d263 | 4912 | |
8a1cdce5 AC |
4913 | @item R |
4914 | This misleadingly named specifier is the @dfn{secondary mark}. This | |
4915 | mark will say whether the article has been replied to, has been cached, | |
4916 | or has been saved. @xref{Other Marks}. | |
e6d2d263 | 4917 | |
8a1cdce5 AC |
4918 | @item i |
4919 | Score as a number (@pxref{Scoring}). | |
4920 | @item z | |
4921 | @vindex gnus-summary-zcore-fuzz | |
4922 | Zcore, @samp{+} if above the default level and @samp{-} if below the | |
4923 | default level. If the difference between | |
4924 | @code{gnus-summary-default-score} and the score is less than | |
4925 | @code{gnus-summary-zcore-fuzz}, this spec will not be used. | |
4926 | @item V | |
4927 | Total thread score. | |
4928 | @item x | |
4929 | @code{Xref}. | |
4930 | @item D | |
4931 | @code{Date}. | |
4932 | @item d | |
4933 | The @code{Date} in @code{DD-MMM} format. | |
4934 | @item o | |
4935 | The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format. | |
4936 | @item M | |
4937 | @code{Message-ID}. | |
4938 | @item r | |
4939 | @code{References}. | |
4940 | @item t | |
4941 | Number of articles in the current sub-thread. Using this spec will slow | |
4942 | down summary buffer generation somewhat. | |
4943 | @item e | |
4944 | An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the | |
4945 | article has any children. | |
4946 | @item P | |
4947 | The line number. | |
4948 | @item O | |
4949 | Download mark. | |
4950 | @item * | |
4951 | Desired cursor position (instead of after first colon). | |
4952 | @item &user-date; | |
4953 | Age sensitive date format. Various date format is defined in | |
c2f51e23 | 4954 | @code{gnus-user-date-format-alist}. |
8a1cdce5 AC |
4955 | @item u |
4956 | User defined specifier. The next character in the format string should | |
4957 | be a letter. Gnus will call the function | |
4958 | @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter | |
4959 | following @samp{%u}. The function will be passed the current header as | |
4960 | argument. The function should return a string, which will be inserted | |
4961 | into the summary just like information from any other summary specifier. | |
4962 | @end table | |
e6d2d263 | 4963 | |
8a1cdce5 AC |
4964 | Text between @samp{%(} and @samp{%)} will be highlighted with |
4965 | @code{gnus-mouse-face} when the mouse point is placed inside the area. | |
4966 | There can only be one such area. | |
e6d2d263 | 4967 | |
8a1cdce5 AC |
4968 | The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs |
4969 | have to be handled with care. For reasons of efficiency, Gnus will | |
4970 | compute what column these characters will end up in, and ``hard-code'' | |
4971 | that. This means that it is invalid to have these specs after a | |
4972 | variable-length spec. Well, you might not be arrested, but your summary | |
4973 | buffer will look strange, which is bad enough. | |
e6d2d263 | 4974 | |
8a1cdce5 AC |
4975 | The smart choice is to have these specs as far to the left as possible. |
4976 | (Isn't that the case with everything, though? But I digress.) | |
e6d2d263 | 4977 | |
8a1cdce5 | 4978 | This restriction may disappear in later versions of Gnus. |
e6d2d263 | 4979 | |
4009494e | 4980 | |
8a1cdce5 AC |
4981 | @node To From Newsgroups |
4982 | @subsection To From Newsgroups | |
4983 | @cindex To | |
4984 | @cindex Newsgroups | |
4009494e | 4985 | |
8a1cdce5 AC |
4986 | In some groups (particularly in archive groups), the @code{From} header |
4987 | isn't very interesting, since all the articles there are written by | |
4988 | you. To display the information in the @code{To} or @code{Newsgroups} | |
4989 | headers instead, you need to decide three things: What information to | |
4990 | gather; where to display it; and when to display it. | |
4009494e | 4991 | |
8a1cdce5 AC |
4992 | @enumerate |
4993 | @item | |
4994 | @vindex gnus-extra-headers | |
4995 | The reading of extra header information is controlled by the | |
4996 | @code{gnus-extra-headers}. This is a list of header symbols. For | |
4997 | instance: | |
4009494e GM |
4998 | |
4999 | @lisp | |
8a1cdce5 AC |
5000 | (setq gnus-extra-headers |
5001 | '(To Newsgroups X-Newsreader)) | |
4009494e GM |
5002 | @end lisp |
5003 | ||
8a1cdce5 AC |
5004 | This will result in Gnus trying to obtain these three headers, and |
5005 | storing it in header structures for later easy retrieval. | |
4009494e | 5006 | |
8a1cdce5 AC |
5007 | @item |
5008 | @findex gnus-extra-header | |
5009 | The value of these extra headers can be accessed via the | |
5010 | @code{gnus-extra-header} function. Here's a format line spec that will | |
5011 | access the @code{X-Newsreader} header: | |
4009494e | 5012 | |
8a1cdce5 AC |
5013 | @example |
5014 | "%~(form (gnus-extra-header 'X-Newsreader))@@" | |
5015 | @end example | |
4009494e | 5016 | |
8a1cdce5 AC |
5017 | @item |
5018 | @vindex gnus-ignored-from-addresses | |
5019 | The @code{gnus-ignored-from-addresses} variable says when the @samp{%f} | |
5020 | summary line spec returns the @code{To}, @code{Newsreader} or | |
5021 | @code{From} header. If this regexp matches the contents of the | |
5022 | @code{From} header, the value of the @code{To} or @code{Newsreader} | |
5023 | headers are used instead. | |
4009494e | 5024 | |
8a1cdce5 AC |
5025 | To distinguish regular articles from those where the @code{From} field |
5026 | has been swapped, a string is prefixed to the @code{To} or | |
5027 | @code{Newsgroups} header in the summary line. By default the string is | |
5028 | @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can | |
5029 | customize these strings with @code{gnus-summary-to-prefix} and | |
5030 | @code{gnus-summary-newsgroup-prefix}. | |
4009494e | 5031 | |
8a1cdce5 | 5032 | @end enumerate |
4009494e | 5033 | |
8a1cdce5 AC |
5034 | @vindex nnmail-extra-headers |
5035 | A related variable is @code{nnmail-extra-headers}, which controls when | |
5036 | to include extra headers when generating overview (@acronym{NOV}) files. | |
5037 | If you have old overview files, you should regenerate them after | |
5038 | changing this variable, by entering the server buffer using @kbd{^}, | |
1df7defd | 5039 | and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause |
8a1cdce5 | 5040 | regeneration. |
01c52d31 | 5041 | |
8a1cdce5 AC |
5042 | @vindex gnus-summary-line-format |
5043 | You also have to instruct Gnus to display the data by changing the | |
5044 | @code{%n} spec to the @code{%f} spec in the | |
5045 | @code{gnus-summary-line-format} variable. | |
01c52d31 | 5046 | |
8a1cdce5 AC |
5047 | In summary, you'd typically put something like the following in |
5048 | @file{~/.gnus.el}: | |
4009494e | 5049 | |
8a1cdce5 AC |
5050 | @lisp |
5051 | (setq gnus-extra-headers | |
5052 | '(To Newsgroups)) | |
5053 | (setq nnmail-extra-headers gnus-extra-headers) | |
5054 | (setq gnus-summary-line-format | |
5055 | "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n") | |
5056 | (setq gnus-ignored-from-addresses | |
5057 | "Your Name Here") | |
5058 | @end lisp | |
4009494e | 5059 | |
8a1cdce5 AC |
5060 | (The values listed above are the default values in Gnus. Alter them |
5061 | to fit your needs.) | |
4009494e | 5062 | |
8a1cdce5 AC |
5063 | A note for news server administrators, or for users who wish to try to |
5064 | convince their news server administrator to provide some additional | |
5065 | support: | |
4009494e | 5066 | |
8a1cdce5 AC |
5067 | The above is mostly useful for mail groups, where you have control over |
5068 | the @acronym{NOV} files that are created. However, if you can persuade your | |
5069 | nntp admin to add (in the usual implementation, notably INN): | |
4009494e | 5070 | |
8a1cdce5 AC |
5071 | @example |
5072 | Newsgroups:full | |
5073 | @end example | |
4009494e | 5074 | |
8a1cdce5 AC |
5075 | to the end of her @file{overview.fmt} file, then you can use that just |
5076 | as you would the extra headers from the mail groups. | |
4009494e | 5077 | |
4009494e | 5078 | |
8a1cdce5 AC |
5079 | @node Summary Buffer Mode Line |
5080 | @subsection Summary Buffer Mode Line | |
4009494e | 5081 | |
8a1cdce5 AC |
5082 | @vindex gnus-summary-mode-line-format |
5083 | You can also change the format of the summary mode bar (@pxref{Mode Line | |
5084 | Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you | |
5085 | like. The default is @samp{Gnus: %%b [%A] %Z}. | |
5086 | ||
5087 | Here are the elements you can play with: | |
4009494e | 5088 | |
8a1cdce5 AC |
5089 | @table @samp |
5090 | @item G | |
5091 | Group name. | |
5092 | @item p | |
5093 | Unprefixed group name. | |
5094 | @item A | |
5095 | Current article number. | |
5096 | @item z | |
5097 | Current article score. | |
5098 | @item V | |
5099 | Gnus version. | |
5100 | @item U | |
5101 | Number of unread articles in this group. | |
5102 | @item e | |
5103 | Number of unread articles in this group that aren't displayed in the | |
5104 | summary buffer. | |
5105 | @item Z | |
5106 | A string with the number of unread and unselected articles represented | |
5107 | either as @samp{<%U(+%e) more>} if there are both unread and unselected | |
5108 | articles, and just as @samp{<%U more>} if there are just unread articles | |
5109 | and no unselected ones. | |
4009494e | 5110 | @item g |
8a1cdce5 AC |
5111 | Shortish group name. For instance, @samp{rec.arts.anime} will be |
5112 | shortened to @samp{r.a.anime}. | |
5113 | @item S | |
5114 | Subject of the current article. | |
5115 | @item u | |
5116 | User-defined spec (@pxref{User-Defined Specs}). | |
5117 | @item s | |
5118 | Name of the current score file (@pxref{Scoring}). | |
5119 | @item d | |
5120 | Number of dormant articles (@pxref{Unread Articles}). | |
5121 | @item t | |
5122 | Number of ticked articles (@pxref{Unread Articles}). | |
5123 | @item r | |
5124 | Number of articles that have been marked as read in this session. | |
5125 | @item E | |
5126 | Number of articles expunged by the score files. | |
5127 | @end table | |
4009494e | 5128 | |
4009494e | 5129 | |
8a1cdce5 AC |
5130 | @node Summary Highlighting |
5131 | @subsection Summary Highlighting | |
4009494e | 5132 | |
8a1cdce5 AC |
5133 | @table @code |
5134 | ||
5135 | @item gnus-visual-mark-article-hook | |
5136 | @vindex gnus-visual-mark-article-hook | |
5137 | This hook is run after selecting an article. It is meant to be used for | |
5138 | highlighting the article in some way. It is not run if | |
5139 | @code{gnus-visual} is @code{nil}. | |
5140 | ||
5141 | @item gnus-summary-update-hook | |
5142 | @vindex gnus-summary-update-hook | |
5143 | This hook is called when a summary line is changed. It is not run if | |
5144 | @code{gnus-visual} is @code{nil}. | |
5145 | ||
5146 | @item gnus-summary-selected-face | |
5147 | @vindex gnus-summary-selected-face | |
5148 | This is the face (or @dfn{font} as some people call it) used to | |
5149 | highlight the current article in the summary buffer. | |
4009494e | 5150 | |
8a1cdce5 AC |
5151 | @item gnus-summary-highlight |
5152 | @vindex gnus-summary-highlight | |
5153 | Summary lines are highlighted according to this variable, which is a | |
5154 | list where the elements are of the format @code{(@var{form} | |
5155 | . @var{face})}. If you would, for instance, like ticked articles to be | |
5156 | italic and high-scored articles to be bold, you could set this variable | |
5157 | to something like | |
5158 | @lisp | |
5159 | (((eq mark gnus-ticked-mark) . italic) | |
5160 | ((> score default) . bold)) | |
5161 | @end lisp | |
5162 | As you may have guessed, if @var{form} returns a non-@code{nil} value, | |
5163 | @var{face} will be applied to the line. | |
4009494e GM |
5164 | @end table |
5165 | ||
4009494e | 5166 | |
8a1cdce5 AC |
5167 | @node Summary Maneuvering |
5168 | @section Summary Maneuvering | |
5169 | @cindex summary movement | |
4009494e | 5170 | |
8a1cdce5 AC |
5171 | All the straight movement commands understand the numeric prefix and |
5172 | behave pretty much as you'd expect. | |
4009494e | 5173 | |
8a1cdce5 | 5174 | None of these commands select articles. |
4009494e GM |
5175 | |
5176 | @table @kbd | |
8a1cdce5 AC |
5177 | @item G M-n |
5178 | @itemx M-n | |
5179 | @kindex M-n (Summary) | |
5180 | @kindex G M-n (Summary) | |
5181 | @findex gnus-summary-next-unread-subject | |
5182 | Go to the next summary line of an unread article | |
5183 | (@code{gnus-summary-next-unread-subject}). | |
4009494e | 5184 | |
8a1cdce5 AC |
5185 | @item G M-p |
5186 | @itemx M-p | |
5187 | @kindex M-p (Summary) | |
5188 | @kindex G M-p (Summary) | |
5189 | @findex gnus-summary-prev-unread-subject | |
5190 | Go to the previous summary line of an unread article | |
5191 | (@code{gnus-summary-prev-unread-subject}). | |
4009494e | 5192 | |
8a1cdce5 AC |
5193 | @item G g |
5194 | @kindex G g (Summary) | |
5195 | @findex gnus-summary-goto-subject | |
5196 | Ask for an article number and then go to the summary line of that article | |
5197 | without displaying the article (@code{gnus-summary-goto-subject}). | |
5198 | @end table | |
4009494e | 5199 | |
8a1cdce5 AC |
5200 | If Gnus asks you to press a key to confirm going to the next group, you |
5201 | can use the @kbd{C-n} and @kbd{C-p} keys to move around the group | |
5202 | buffer, searching for the next group to read without actually returning | |
5203 | to the group buffer. | |
4009494e | 5204 | |
8a1cdce5 | 5205 | Variables related to summary movement: |
4009494e | 5206 | |
8a1cdce5 | 5207 | @table @code |
4009494e | 5208 | |
8a1cdce5 AC |
5209 | @vindex gnus-auto-select-next |
5210 | @item gnus-auto-select-next | |
5211 | If you issue one of the movement commands (like @kbd{n}) and there are | |
5212 | no more unread articles after the current one, Gnus will offer to go to | |
5213 | the next group. If this variable is @code{t} and the next group is | |
5214 | empty, Gnus will exit summary mode and return to the group buffer. If | |
5215 | this variable is neither @code{t} nor @code{nil}, Gnus will select the | |
5216 | next group with unread articles. As a special case, if this variable | |
5217 | is @code{quietly}, Gnus will select the next group without asking for | |
5218 | confirmation. If this variable is @code{almost-quietly}, the same | |
5219 | will happen only if you are located on the last article in the group. | |
5220 | Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n} | |
5221 | command will go to the next group without confirmation. Also | |
5222 | @pxref{Group Levels}. | |
4009494e | 5223 | |
8a1cdce5 AC |
5224 | @item gnus-auto-select-same |
5225 | @vindex gnus-auto-select-same | |
5226 | If non-@code{nil}, all the movement commands will try to go to the next | |
5227 | article with the same subject as the current. (@dfn{Same} here might | |
5228 | mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit} | |
5229 | for details (@pxref{Customizing Threading}).) If there are no more | |
5230 | articles with the same subject, go to the first unread article. | |
4009494e | 5231 | |
8a1cdce5 | 5232 | This variable is not particularly useful if you use a threaded display. |
4009494e | 5233 | |
8a1cdce5 AC |
5234 | @item gnus-summary-check-current |
5235 | @vindex gnus-summary-check-current | |
5236 | If non-@code{nil}, all the ``unread'' movement commands will not proceed | |
5237 | to the next (or previous) article if the current article is unread. | |
5238 | Instead, they will choose the current article. | |
4009494e | 5239 | |
8a1cdce5 AC |
5240 | @item gnus-auto-center-summary |
5241 | @vindex gnus-auto-center-summary | |
5242 | If non-@code{nil}, Gnus will keep the point in the summary buffer | |
5243 | centered at all times. This makes things quite tidy, but if you have a | |
5244 | slow network connection, or simply do not like this un-Emacsism, you can | |
5245 | set this variable to @code{nil} to get the normal Emacs scrolling | |
5246 | action. This will also inhibit horizontal re-centering of the summary | |
5247 | buffer, which might make it more inconvenient to read extremely long | |
5248 | threads. | |
4009494e | 5249 | |
8a1cdce5 AC |
5250 | This variable can also be a number. In that case, center the window at |
5251 | the given number of lines from the top. | |
4009494e | 5252 | |
8a1cdce5 AC |
5253 | @item gnus-summary-stop-at-end-of-message |
5254 | @vindex gnus-summary-stop-at-end-of-message | |
5255 | If non-@code{nil}, don't go to the next article when hitting | |
5256 | @kbd{SPC}, and you're at the end of the article. | |
4009494e | 5257 | |
8a1cdce5 | 5258 | @end table |
4009494e | 5259 | |
4009494e | 5260 | |
8a1cdce5 AC |
5261 | @node Choosing Articles |
5262 | @section Choosing Articles | |
5263 | @cindex selecting articles | |
4009494e | 5264 | |
8a1cdce5 AC |
5265 | @menu |
5266 | * Choosing Commands:: Commands for choosing articles. | |
5267 | * Choosing Variables:: Variables that influence these commands. | |
5268 | @end menu | |
4009494e | 5269 | |
4009494e | 5270 | |
8a1cdce5 AC |
5271 | @node Choosing Commands |
5272 | @subsection Choosing Commands | |
4009494e | 5273 | |
8a1cdce5 AC |
5274 | None of the following movement commands understand the numeric prefix, |
5275 | and they all select and display an article. | |
4009494e | 5276 | |
8a1cdce5 AC |
5277 | If you want to fetch new articles or redisplay the group, see |
5278 | @ref{Exiting the Summary Buffer}. | |
4009494e | 5279 | |
8a1cdce5 AC |
5280 | @table @kbd |
5281 | @item SPACE | |
5282 | @kindex SPACE (Summary) | |
5283 | @findex gnus-summary-next-page | |
5284 | Select the current article, or, if that one's read already, the next | |
5285 | unread article (@code{gnus-summary-next-page}). | |
4009494e | 5286 | |
8a1cdce5 AC |
5287 | If you have an article window open already and you press @kbd{SPACE} |
5288 | again, the article will be scrolled. This lets you conveniently | |
5289 | @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}. | |
4009494e | 5290 | |
8a1cdce5 AC |
5291 | @item G n |
5292 | @itemx n | |
5293 | @kindex n (Summary) | |
5294 | @kindex G n (Summary) | |
5295 | @findex gnus-summary-next-unread-article | |
5296 | @c @icon{gnus-summary-next-unread} | |
5297 | Go to next unread article (@code{gnus-summary-next-unread-article}). | |
4009494e | 5298 | |
8a1cdce5 AC |
5299 | @item G p |
5300 | @itemx p | |
5301 | @kindex p (Summary) | |
5302 | @findex gnus-summary-prev-unread-article | |
5303 | @c @icon{gnus-summary-prev-unread} | |
5304 | Go to previous unread article (@code{gnus-summary-prev-unread-article}). | |
4009494e | 5305 | |
8a1cdce5 AC |
5306 | @item G N |
5307 | @itemx N | |
5308 | @kindex N (Summary) | |
5309 | @kindex G N (Summary) | |
5310 | @findex gnus-summary-next-article | |
5311 | Go to the next article (@code{gnus-summary-next-article}). | |
4009494e | 5312 | |
8a1cdce5 AC |
5313 | @item G P |
5314 | @itemx P | |
5315 | @kindex P (Summary) | |
5316 | @kindex G P (Summary) | |
5317 | @findex gnus-summary-prev-article | |
5318 | Go to the previous article (@code{gnus-summary-prev-article}). | |
4009494e | 5319 | |
8a1cdce5 AC |
5320 | @item G C-n |
5321 | @kindex G C-n (Summary) | |
5322 | @findex gnus-summary-next-same-subject | |
5323 | Go to the next article with the same subject | |
5324 | (@code{gnus-summary-next-same-subject}). | |
4009494e | 5325 | |
8a1cdce5 AC |
5326 | @item G C-p |
5327 | @kindex G C-p (Summary) | |
5328 | @findex gnus-summary-prev-same-subject | |
5329 | Go to the previous article with the same subject | |
5330 | (@code{gnus-summary-prev-same-subject}). | |
4009494e | 5331 | |
8a1cdce5 AC |
5332 | @item G f |
5333 | @itemx . | |
5334 | @kindex G f (Summary) | |
5335 | @kindex . (Summary) | |
5336 | @findex gnus-summary-first-unread-article | |
5337 | Go to the first unread article | |
5338 | (@code{gnus-summary-first-unread-article}). | |
4009494e | 5339 | |
8a1cdce5 AC |
5340 | @item G b |
5341 | @itemx , | |
5342 | @kindex G b (Summary) | |
5343 | @kindex , (Summary) | |
5344 | @findex gnus-summary-best-unread-article | |
5345 | Go to the unread article with the highest score | |
5346 | (@code{gnus-summary-best-unread-article}). If given a prefix argument, | |
5347 | go to the first unread article that has a score over the default score. | |
4009494e | 5348 | |
8a1cdce5 AC |
5349 | @item G l |
5350 | @itemx l | |
5351 | @kindex l (Summary) | |
5352 | @kindex G l (Summary) | |
5353 | @findex gnus-summary-goto-last-article | |
5354 | Go to the previous article read (@code{gnus-summary-goto-last-article}). | |
4009494e | 5355 | |
8a1cdce5 AC |
5356 | @item G o |
5357 | @kindex G o (Summary) | |
5358 | @findex gnus-summary-pop-article | |
5359 | @cindex history | |
5360 | @cindex article history | |
5361 | Pop an article off the summary history and go to this article | |
5362 | (@code{gnus-summary-pop-article}). This command differs from the | |
5363 | command above in that you can pop as many previous articles off the | |
5364 | history as you like, while @kbd{l} toggles the two last read articles. | |
5365 | For a somewhat related issue (if you use these commands a lot), | |
5366 | @pxref{Article Backlog}. | |
4009494e | 5367 | |
8a1cdce5 AC |
5368 | @item G j |
5369 | @itemx j | |
5370 | @kindex j (Summary) | |
5371 | @kindex G j (Summary) | |
5372 | @findex gnus-summary-goto-article | |
5373 | Ask for an article number or @code{Message-ID}, and then go to that | |
5374 | article (@code{gnus-summary-goto-article}). | |
4009494e | 5375 | |
8a1cdce5 | 5376 | @end table |
4009494e | 5377 | |
4009494e | 5378 | |
8a1cdce5 AC |
5379 | @node Choosing Variables |
5380 | @subsection Choosing Variables | |
4009494e | 5381 | |
8a1cdce5 | 5382 | Some variables relevant for moving and selecting articles: |
4009494e | 5383 | |
8a1cdce5 AC |
5384 | @table @code |
5385 | @item gnus-auto-extend-newsgroup | |
5386 | @vindex gnus-auto-extend-newsgroup | |
5387 | All the movement commands will try to go to the previous (or next) | |
5388 | article, even if that article isn't displayed in the Summary buffer if | |
5389 | this variable is non-@code{nil}. Gnus will then fetch the article from | |
5390 | the server and display it in the article buffer. | |
4009494e | 5391 | |
8a1cdce5 AC |
5392 | @item gnus-select-article-hook |
5393 | @vindex gnus-select-article-hook | |
5394 | This hook is called whenever an article is selected. The default is | |
5395 | @code{nil}. If you would like each article to be saved in the Agent as | |
5396 | you read it, putting @code{gnus-agent-fetch-selected-article} on this | |
5397 | hook will do so. | |
4009494e | 5398 | |
8a1cdce5 AC |
5399 | @item gnus-mark-article-hook |
5400 | @vindex gnus-mark-article-hook | |
5401 | @findex gnus-summary-mark-unread-as-read | |
5402 | @findex gnus-summary-mark-read-and-unread-as-read | |
5403 | @findex gnus-unread-mark | |
5404 | This hook is called whenever an article is selected. It is intended to | |
5405 | be used for marking articles as read. The default value is | |
5406 | @code{gnus-summary-mark-read-and-unread-as-read}, and will change the | |
5407 | mark of almost any article you read to @code{gnus-read-mark}. The only | |
5408 | articles not affected by this function are ticked, dormant, and | |
5409 | expirable articles. If you'd instead like to just have unread articles | |
5410 | marked as read, you can use @code{gnus-summary-mark-unread-as-read} | |
5411 | instead. It will leave marks like @code{gnus-low-score-mark}, | |
5412 | @code{gnus-del-mark} (and so on) alone. | |
4009494e | 5413 | |
8a1cdce5 | 5414 | @end table |
4009494e | 5415 | |
4009494e | 5416 | |
8a1cdce5 AC |
5417 | @node Paging the Article |
5418 | @section Scrolling the Article | |
5419 | @cindex article scrolling | |
4009494e | 5420 | |
8a1cdce5 | 5421 | @table @kbd |
4009494e | 5422 | |
8a1cdce5 AC |
5423 | @item SPACE |
5424 | @kindex SPACE (Summary) | |
5425 | @findex gnus-summary-next-page | |
5426 | Pressing @kbd{SPACE} will scroll the current article forward one page, | |
5427 | or, if you have come to the end of the current article, will choose the | |
5428 | next article (@code{gnus-summary-next-page}). | |
4009494e | 5429 | |
8a1cdce5 AC |
5430 | @vindex gnus-article-boring-faces |
5431 | @vindex gnus-article-skip-boring | |
5432 | If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of | |
5433 | the article consists only of citations and signature, then it will be | |
5434 | skipped; the next article will be shown instead. You can customize | |
5435 | what is considered uninteresting with | |
5436 | @code{gnus-article-boring-faces}. You can manually view the article's | |
5437 | pages, no matter how boring, using @kbd{C-M-v}. | |
4009494e | 5438 | |
8a1cdce5 AC |
5439 | @item DEL |
5440 | @kindex DEL (Summary) | |
5441 | @findex gnus-summary-prev-page | |
5442 | Scroll the current article back one page (@code{gnus-summary-prev-page}). | |
4009494e | 5443 | |
8a1cdce5 AC |
5444 | @item RET |
5445 | @kindex RET (Summary) | |
5446 | @findex gnus-summary-scroll-up | |
5447 | Scroll the current article one line forward | |
5448 | (@code{gnus-summary-scroll-up}). | |
4009494e | 5449 | |
8a1cdce5 AC |
5450 | @item M-RET |
5451 | @kindex M-RET (Summary) | |
5452 | @findex gnus-summary-scroll-down | |
5453 | Scroll the current article one line backward | |
5454 | (@code{gnus-summary-scroll-down}). | |
4009494e | 5455 | |
8a1cdce5 AC |
5456 | @item A g |
5457 | @itemx g | |
5458 | @kindex A g (Summary) | |
5459 | @kindex g (Summary) | |
5460 | @findex gnus-summary-show-article | |
5461 | @vindex gnus-summary-show-article-charset-alist | |
5462 | (Re)fetch the current article (@code{gnus-summary-show-article}). If | |
5463 | given a prefix, show a completely ``raw'' article, just the way it | |
5464 | came from the server. If given a prefix twice (i.e., @kbd{C-u C-u | |
5465 | g'}), fetch the current article, but don't run any of the article | |
5466 | treatment functions. | |
4009494e | 5467 | |
8a1cdce5 AC |
5468 | @cindex charset, view article with different charset |
5469 | If given a numerical prefix, you can do semi-manual charset stuff. | |
5470 | @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were | |
5471 | encoded in the @code{cn-gb-2312} charset. If you have | |
4009494e GM |
5472 | |
5473 | @lisp | |
8a1cdce5 AC |
5474 | (setq gnus-summary-show-article-charset-alist |
5475 | '((1 . cn-gb-2312) | |
5476 | (2 . big5))) | |
4009494e GM |
5477 | @end lisp |
5478 | ||
8a1cdce5 | 5479 | then you can say @kbd{C-u 1 g} to get the same effect. |
4009494e | 5480 | |
8a1cdce5 AC |
5481 | @item A < |
5482 | @itemx < | |
5483 | @kindex < (Summary) | |
5484 | @kindex A < (Summary) | |
5485 | @findex gnus-summary-beginning-of-article | |
5486 | Scroll to the beginning of the article | |
5487 | (@code{gnus-summary-beginning-of-article}). | |
4009494e | 5488 | |
8a1cdce5 AC |
5489 | @item A > |
5490 | @itemx > | |
5491 | @kindex > (Summary) | |
5492 | @kindex A > (Summary) | |
5493 | @findex gnus-summary-end-of-article | |
5494 | Scroll to the end of the article (@code{gnus-summary-end-of-article}). | |
4009494e | 5495 | |
8a1cdce5 AC |
5496 | @item A s |
5497 | @itemx s | |
5498 | @kindex A s (Summary) | |
5499 | @kindex s (Summary) | |
5500 | @findex gnus-summary-isearch-article | |
5501 | Perform an isearch in the article buffer | |
5502 | (@code{gnus-summary-isearch-article}). | |
4009494e | 5503 | |
8a1cdce5 AC |
5504 | @item h |
5505 | @kindex h (Summary) | |
5506 | @findex gnus-summary-select-article-buffer | |
5507 | Select the article buffer (@code{gnus-summary-select-article-buffer}). | |
4009494e | 5508 | |
8a1cdce5 | 5509 | @end table |
4009494e | 5510 | |
4009494e | 5511 | |
8a1cdce5 AC |
5512 | @node Reply Followup and Post |
5513 | @section Reply, Followup and Post | |
4009494e | 5514 | |
8a1cdce5 AC |
5515 | @menu |
5516 | * Summary Mail Commands:: Sending mail. | |
5517 | * Summary Post Commands:: Sending news. | |
5518 | * Summary Message Commands:: Other Message-related commands. | |
5519 | * Canceling and Superseding:: | |
5520 | @end menu | |
4009494e | 5521 | |
4009494e | 5522 | |
8a1cdce5 AC |
5523 | @node Summary Mail Commands |
5524 | @subsection Summary Mail Commands | |
5525 | @cindex mail | |
5526 | @cindex composing mail | |
4009494e | 5527 | |
8a1cdce5 | 5528 | Commands for composing a mail message: |
4009494e | 5529 | |
8a1cdce5 | 5530 | @table @kbd |
4009494e | 5531 | |
8a1cdce5 AC |
5532 | @item S r |
5533 | @itemx r | |
5534 | @kindex S r (Summary) | |
5535 | @kindex r (Summary) | |
5536 | @findex gnus-summary-reply | |
5537 | @c @icon{gnus-summary-mail-reply} | |
5538 | @c @icon{gnus-summary-reply} | |
5539 | Mail a reply to the author of the current article | |
5540 | (@code{gnus-summary-reply}). | |
4009494e | 5541 | |
8a1cdce5 AC |
5542 | @item S R |
5543 | @itemx R | |
5544 | @kindex R (Summary) | |
5545 | @kindex S R (Summary) | |
5546 | @findex gnus-summary-reply-with-original | |
5547 | @c @icon{gnus-summary-reply-with-original} | |
5548 | Mail a reply to the author of the current article and include the | |
5549 | original message (@code{gnus-summary-reply-with-original}). This | |
5550 | command uses the process/prefix convention. | |
4009494e | 5551 | |
8a1cdce5 AC |
5552 | @item S w |
5553 | @kindex S w (Summary) | |
5554 | @findex gnus-summary-wide-reply | |
5555 | Mail a wide reply to the author of the current article | |
5556 | (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that | |
5557 | goes out to all people listed in the @code{To}, @code{From} (or | |
5558 | @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is | |
5559 | present, that's used instead. | |
4009494e | 5560 | |
8a1cdce5 AC |
5561 | @item S W |
5562 | @kindex S W (Summary) | |
5563 | @findex gnus-summary-wide-reply-with-original | |
5564 | Mail a wide reply to the current article and include the original | |
5565 | message (@code{gnus-summary-wide-reply-with-original}). This command uses | |
5566 | the process/prefix convention, but only uses the headers from the | |
5567 | first article to determine the recipients. | |
5568 | ||
60a0884e G |
5569 | @item S L |
5570 | @kindex S L (Summary) | |
5571 | @findex gnus-summary-reply-to-list-with-original | |
5572 | When replying to a message from a mailing list, send a reply to that | |
5573 | message to the mailing list, and include the original message | |
5574 | (@code{gnus-summary-reply-to-list-with-original}). | |
5575 | ||
8a1cdce5 AC |
5576 | @item S v |
5577 | @kindex S v (Summary) | |
5578 | @findex gnus-summary-very-wide-reply | |
5579 | Mail a very wide reply to the author of the current article | |
5580 | (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply | |
5581 | that goes out to all people listed in the @code{To}, @code{From} (or | |
5582 | @code{Reply-to}) and @code{Cc} headers in all the process/prefixed | |
5583 | articles. This command uses the process/prefix convention. | |
5584 | ||
5585 | @item S V | |
5586 | @kindex S V (Summary) | |
5587 | @findex gnus-summary-very-wide-reply-with-original | |
5588 | Mail a very wide reply to the author of the current article and include the | |
5589 | original message (@code{gnus-summary-very-wide-reply-with-original}). This | |
5590 | command uses the process/prefix convention. | |
5591 | ||
5592 | @item S B r | |
5593 | @kindex S B r (Summary) | |
5594 | @findex gnus-summary-reply-broken-reply-to | |
5595 | Mail a reply to the author of the current article but ignore the | |
5596 | @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}). | |
5597 | If you need this because a mailing list incorrectly sets a | |
5598 | @code{Reply-To} header pointing to the list, you probably want to set | |
5599 | the @code{broken-reply-to} group parameter instead, so things will work | |
5600 | correctly. @xref{Group Parameters}. | |
5601 | ||
5602 | @item S B R | |
5603 | @kindex S B R (Summary) | |
5604 | @findex gnus-summary-reply-broken-reply-to-with-original | |
5605 | Mail a reply to the author of the current article and include the | |
5606 | original message but ignore the @code{Reply-To} field | |
5607 | (@code{gnus-summary-reply-broken-reply-to-with-original}). | |
5608 | ||
5609 | @item S o m | |
5610 | @itemx C-c C-f | |
5611 | @kindex S o m (Summary) | |
5612 | @kindex C-c C-f (Summary) | |
5613 | @findex gnus-summary-mail-forward | |
5614 | @c @icon{gnus-summary-mail-forward} | |
5615 | Forward the current article to some other person | |
5616 | (@code{gnus-summary-mail-forward}). If no prefix is given, the message | |
5617 | is forwarded according to the value of (@code{message-forward-as-mime}) | |
5618 | and (@code{message-forward-show-mml}); if the prefix is 1, decode the | |
5619 | message and forward directly inline; if the prefix is 2, forward message | |
5620 | as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and | |
5621 | forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message | |
5622 | directly inline; otherwise, the message is forwarded as no prefix given | |
5623 | but use the flipped value of (@code{message-forward-as-mime}). By | |
5624 | default, the message is decoded and forwarded as an rfc822 @acronym{MIME} | |
5625 | section. | |
5626 | ||
5627 | @item S m | |
5628 | @itemx m | |
5629 | @kindex m (Summary) | |
5630 | @kindex S m (Summary) | |
5631 | @findex gnus-summary-mail-other-window | |
5632 | @c @icon{gnus-summary-mail-originate} | |
5633 | Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use | |
5634 | the posting style of the current group. If given a prefix, disable that. | |
5635 | If the prefix is 1, prompt for a group name to find the posting style. | |
5636 | ||
5637 | @item S i | |
5638 | @kindex S i (Summary) | |
5639 | @findex gnus-summary-news-other-window | |
5640 | Prepare a news (@code{gnus-summary-news-other-window}). By default, | |
5641 | post to the current group. If given a prefix, disable that. If the | |
5642 | prefix is 1, prompt for a group to post to. | |
5643 | ||
5644 | This function actually prepares a news even when using mail groups. | |
5645 | This is useful for ``posting'' messages to mail groups without actually | |
5646 | sending them over the network: they're just saved directly to the group | |
5647 | in question. The corresponding back end must have a request-post method | |
5648 | for this to work though. | |
5649 | ||
5650 | @item S D b | |
5651 | @kindex S D b (Summary) | |
5652 | @findex gnus-summary-resend-bounced-mail | |
5653 | @cindex bouncing mail | |
5654 | If you have sent a mail, but the mail was bounced back to you for some | |
5655 | reason (wrong address, transient failure), you can use this command to | |
5656 | resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You | |
5657 | will be popped into a mail buffer where you can edit the headers before | |
5658 | sending the mail off again. If you give a prefix to this command, and | |
5659 | the bounced mail is a reply to some other mail, Gnus will try to fetch | |
5660 | that mail and display it for easy perusal of its headers. This might | |
5661 | very well fail, though. | |
5662 | ||
5663 | @item S D r | |
5664 | @kindex S D r (Summary) | |
5665 | @findex gnus-summary-resend-message | |
5666 | Not to be confused with the previous command, | |
5667 | @code{gnus-summary-resend-message} will prompt you for an address to | |
5668 | send the current message off to, and then send it to that place. The | |
5669 | headers of the message won't be altered---but lots of headers that say | |
5670 | @code{Resent-To}, @code{Resent-From} and so on will be added. This | |
5671 | means that you actually send a mail to someone that has a @code{To} | |
5672 | header that (probably) points to yourself. This will confuse people. | |
5673 | So, natcherly you'll only do that if you're really eVIl. | |
5674 | ||
5675 | This command is mainly used if you have several accounts and want to | |
5676 | ship a mail to a different account of yours. (If you're both | |
5677 | @code{root} and @code{postmaster} and get a mail for @code{postmaster} | |
5678 | to the @code{root} account, you may want to resend it to | |
5679 | @code{postmaster}. Ordnung muss sein! | |
5680 | ||
5681 | This command understands the process/prefix convention | |
5682 | (@pxref{Process/Prefix}). | |
5683 | ||
5684 | @item S D e | |
5685 | @kindex S D e (Summary) | |
5686 | @findex gnus-summary-resend-message-edit | |
5687 | ||
5688 | Like the previous command, but will allow you to edit the message as | |
5689 | if it were a new message before resending. | |
5690 | ||
5691 | @item S O m | |
5692 | @kindex S O m (Summary) | |
5693 | @findex gnus-uu-digest-mail-forward | |
5694 | Digest the current series (@pxref{Decoding Articles}) and forward the | |
5695 | result using mail (@code{gnus-uu-digest-mail-forward}). This command | |
5696 | uses the process/prefix convention (@pxref{Process/Prefix}). | |
5697 | ||
5698 | @item S M-c | |
5699 | @kindex S M-c (Summary) | |
5700 | @findex gnus-summary-mail-crosspost-complaint | |
5701 | @cindex crossposting | |
5702 | @cindex excessive crossposting | |
5703 | Send a complaint about excessive crossposting to the author of the | |
5704 | current article (@code{gnus-summary-mail-crosspost-complaint}). | |
5705 | ||
5706 | @findex gnus-crosspost-complaint | |
5707 | This command is provided as a way to fight back against the current | |
5708 | crossposting pandemic that's sweeping Usenet. It will compose a reply | |
5709 | using the @code{gnus-crosspost-complaint} variable as a preamble. This | |
5710 | command understands the process/prefix convention | |
5711 | (@pxref{Process/Prefix}) and will prompt you before sending each mail. | |
4009494e | 5712 | |
4009494e GM |
5713 | @end table |
5714 | ||
8a1cdce5 AC |
5715 | Also @xref{Header Commands, ,Header Commands, message, The Message |
5716 | Manual}, for more information. | |
4009494e | 5717 | |
4009494e | 5718 | |
8a1cdce5 AC |
5719 | @node Summary Post Commands |
5720 | @subsection Summary Post Commands | |
5721 | @cindex post | |
5722 | @cindex composing news | |
4009494e | 5723 | |
8a1cdce5 | 5724 | Commands for posting a news article: |
4009494e | 5725 | |
8a1cdce5 AC |
5726 | @table @kbd |
5727 | @item S p | |
5728 | @itemx a | |
5729 | @kindex a (Summary) | |
5730 | @kindex S p (Summary) | |
5731 | @findex gnus-summary-post-news | |
5732 | @c @icon{gnus-summary-post-news} | |
5733 | Prepare for posting an article (@code{gnus-summary-post-news}). By | |
5734 | default, post to the current group. If given a prefix, disable that. | |
5735 | If the prefix is 1, prompt for another group instead. | |
4009494e | 5736 | |
8a1cdce5 AC |
5737 | @item S f |
5738 | @itemx f | |
5739 | @kindex f (Summary) | |
5740 | @kindex S f (Summary) | |
5741 | @findex gnus-summary-followup | |
5742 | @c @icon{gnus-summary-followup} | |
5743 | Post a followup to the current article (@code{gnus-summary-followup}). | |
4009494e | 5744 | |
8a1cdce5 AC |
5745 | @item S F |
5746 | @itemx F | |
5747 | @kindex S F (Summary) | |
5748 | @kindex F (Summary) | |
5749 | @c @icon{gnus-summary-followup-with-original} | |
5750 | @findex gnus-summary-followup-with-original | |
5751 | Post a followup to the current article and include the original message | |
5752 | (@code{gnus-summary-followup-with-original}). This command uses the | |
5753 | process/prefix convention. | |
4009494e | 5754 | |
8a1cdce5 AC |
5755 | @item S n |
5756 | @kindex S n (Summary) | |
5757 | @findex gnus-summary-followup-to-mail | |
5758 | Post a followup to the current article via news, even if you got the | |
5759 | message through mail (@code{gnus-summary-followup-to-mail}). | |
5760 | ||
5761 | @item S N | |
5762 | @kindex S N (Summary) | |
5763 | @findex gnus-summary-followup-to-mail-with-original | |
5764 | Post a followup to the current article via news, even if you got the | |
5765 | message through mail and include the original message | |
5766 | (@code{gnus-summary-followup-to-mail-with-original}). This command uses | |
5767 | the process/prefix convention. | |
5768 | ||
5769 | @item S o p | |
5770 | @kindex S o p (Summary) | |
5771 | @findex gnus-summary-post-forward | |
5772 | Forward the current article to a newsgroup | |
5773 | (@code{gnus-summary-post-forward}). | |
5774 | If no prefix is given, the message is forwarded according to the value | |
5775 | of (@code{message-forward-as-mime}) and | |
5776 | (@code{message-forward-show-mml}); if the prefix is 1, decode the | |
5777 | message and forward directly inline; if the prefix is 2, forward message | |
5778 | as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and | |
5779 | forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message | |
5780 | directly inline; otherwise, the message is forwarded as no prefix given | |
5781 | but use the flipped value of (@code{message-forward-as-mime}). By | |
5782 | default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section. | |
4009494e | 5783 | |
8a1cdce5 AC |
5784 | @item S O p |
5785 | @kindex S O p (Summary) | |
5786 | @findex gnus-uu-digest-post-forward | |
5787 | @cindex digests | |
5788 | @cindex making digests | |
5789 | Digest the current series and forward the result to a newsgroup | |
5790 | (@code{gnus-uu-digest-post-forward}). This command uses the | |
5791 | process/prefix convention. | |
4009494e | 5792 | |
8a1cdce5 AC |
5793 | @item S u |
5794 | @kindex S u (Summary) | |
5795 | @findex gnus-uu-post-news | |
5796 | @c @icon{gnus-uu-post-news} | |
5797 | Uuencode a file, split it into parts, and post it as a series | |
5798 | (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). | |
5799 | @end table | |
4009494e | 5800 | |
8a1cdce5 AC |
5801 | Also @xref{Header Commands, ,Header Commands, message, The Message |
5802 | Manual}, for more information. | |
4009494e | 5803 | |
4009494e | 5804 | |
8a1cdce5 AC |
5805 | @node Summary Message Commands |
5806 | @subsection Summary Message Commands | |
4009494e | 5807 | |
8a1cdce5 AC |
5808 | @table @kbd |
5809 | @item S y | |
5810 | @kindex S y (Summary) | |
5811 | @findex gnus-summary-yank-message | |
5812 | Yank the current article into an already existing Message composition | |
5813 | buffer (@code{gnus-summary-yank-message}). This command prompts for | |
5814 | what message buffer you want to yank into, and understands the | |
5815 | process/prefix convention (@pxref{Process/Prefix}). | |
01c52d31 | 5816 | |
8a1cdce5 | 5817 | @end table |
4009494e | 5818 | |
4009494e | 5819 | |
8a1cdce5 AC |
5820 | @node Canceling and Superseding |
5821 | @subsection Canceling Articles | |
5822 | @cindex canceling articles | |
5823 | @cindex superseding articles | |
4009494e | 5824 | |
8a1cdce5 AC |
5825 | Have you ever written something, and then decided that you really, |
5826 | really, really wish you hadn't posted that? | |
4009494e | 5827 | |
8a1cdce5 | 5828 | Well, you can't cancel mail, but you can cancel posts. |
4009494e | 5829 | |
8a1cdce5 AC |
5830 | @findex gnus-summary-cancel-article |
5831 | @kindex C (Summary) | |
5832 | @c @icon{gnus-summary-cancel-article} | |
5833 | Find the article you wish to cancel (you can only cancel your own | |
5834 | articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S | |
5835 | c} (@code{gnus-summary-cancel-article}). Your article will be | |
5836 | canceled---machines all over the world will be deleting your article. | |
5837 | This command uses the process/prefix convention (@pxref{Process/Prefix}). | |
4009494e | 5838 | |
8a1cdce5 AC |
5839 | Be aware, however, that not all sites honor cancels, so your article may |
5840 | live on here and there, while most sites will delete the article in | |
5841 | question. | |
4009494e | 5842 | |
8a1cdce5 AC |
5843 | Gnus will use the ``current'' select method when canceling. If you |
5844 | want to use the standard posting method, use the @samp{a} symbolic | |
5845 | prefix (@pxref{Symbolic Prefixes}). | |
4009494e | 5846 | |
8a1cdce5 AC |
5847 | Gnus ensures that only you can cancel your own messages using a |
5848 | @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, , | |
5849 | message, Message Manual}). | |
4009494e | 5850 | |
8a1cdce5 AC |
5851 | If you discover that you have made some mistakes and want to do some |
5852 | corrections, you can post a @dfn{superseding} article that will replace | |
5853 | your original article. | |
4009494e | 5854 | |
8a1cdce5 AC |
5855 | @findex gnus-summary-supersede-article |
5856 | @kindex S (Summary) | |
5857 | Go to the original article and press @kbd{S s} | |
5858 | (@code{gnus-summary-supersede-article}). You will be put in a buffer | |
5859 | where you can edit the article all you want before sending it off the | |
5860 | usual way. | |
4009494e | 5861 | |
8a1cdce5 AC |
5862 | The same goes for superseding as for canceling, only more so: Some |
5863 | sites do not honor superseding. On those sites, it will appear that you | |
5864 | have posted almost the same article twice. | |
4009494e | 5865 | |
8a1cdce5 AC |
5866 | If you have just posted the article, and change your mind right away, |
5867 | there is a trick you can use to cancel/supersede the article without | |
5868 | waiting for the article to appear on your site first. You simply return | |
5869 | to the post buffer (which is called @code{*sent ...*}). There you will | |
5870 | find the article you just posted, with all the headers intact. Change | |
5871 | the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes} | |
5872 | header by substituting one of those words for the word | |
5873 | @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as | |
5874 | you would do normally. The previous article will be | |
5875 | canceled/superseded. | |
4009494e | 5876 | |
8a1cdce5 | 5877 | Just remember, kids: There is no 'c' in 'supersede'. |
4009494e | 5878 | |
8a1cdce5 AC |
5879 | @node Delayed Articles |
5880 | @section Delayed Articles | |
5881 | @cindex delayed sending | |
5882 | @cindex send delayed | |
5883 | ||
5884 | Sometimes, you might wish to delay the sending of a message. For | |
5885 | example, you might wish to arrange for a message to turn up just in time | |
5886 | to remind your about the birthday of your Significant Other. For this, | |
5887 | there is the @code{gnus-delay} package. Setup is simple: | |
4009494e | 5888 | |
8a1cdce5 AC |
5889 | @lisp |
5890 | (gnus-delay-initialize) | |
5891 | @end lisp | |
4009494e | 5892 | |
8a1cdce5 AC |
5893 | @findex gnus-delay-article |
5894 | Normally, to send a message you use the @kbd{C-c C-c} command from | |
5895 | Message mode. To delay a message, use @kbd{C-c C-j} | |
5896 | (@code{gnus-delay-article}) instead. This will ask you for how long the | |
5897 | message should be delayed. Possible answers are: | |
4009494e | 5898 | |
8a1cdce5 AC |
5899 | @itemize @bullet |
5900 | @item | |
5901 | A time span. Consists of an integer and a letter. For example, | |
5902 | @code{42d} means to delay for 42 days. Available letters are @code{m} | |
5903 | (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M} | |
5904 | (months) and @code{Y} (years). | |
4009494e | 5905 | |
8a1cdce5 AC |
5906 | @item |
5907 | A specific date. Looks like @code{YYYY-MM-DD}. The message will be | |
5908 | delayed until that day, at a specific time (eight o'clock by default). | |
5909 | See also @code{gnus-delay-default-hour}. | |
4009494e | 5910 | |
8a1cdce5 AC |
5911 | @item |
5912 | A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm | |
5913 | stuff. The deadline will be at that time today, except if that time has | |
5914 | already passed, then it's at the given time tomorrow. So if it's ten | |
5915 | o'clock in the morning and you specify @code{11:15}, then the deadline | |
5916 | is one hour and fifteen minutes hence. But if you specify @code{9:20}, | |
5917 | that means a time tomorrow. | |
5918 | @end itemize | |
4009494e | 5919 | |
8a1cdce5 AC |
5920 | The action of the @code{gnus-delay-article} command is influenced by a |
5921 | couple of variables: | |
4009494e | 5922 | |
8a1cdce5 AC |
5923 | @table @code |
5924 | @item gnus-delay-default-hour | |
5925 | @vindex gnus-delay-default-hour | |
5926 | When you specify a specific date, the message will be due on that hour | |
5927 | on the given date. Possible values are integers 0 through 23. | |
4009494e | 5928 | |
8a1cdce5 AC |
5929 | @item gnus-delay-default-delay |
5930 | @vindex gnus-delay-default-delay | |
5931 | This is a string and gives the default delay. It can be of any of the | |
5932 | formats described above. | |
4009494e | 5933 | |
8a1cdce5 AC |
5934 | @item gnus-delay-group |
5935 | @vindex gnus-delay-group | |
5936 | Delayed articles will be kept in this group on the drafts server until | |
5937 | they are due. You probably don't need to change this. The default | |
5938 | value is @code{"delayed"}. | |
4009494e | 5939 | |
8a1cdce5 AC |
5940 | @item gnus-delay-header |
5941 | @vindex gnus-delay-header | |
5942 | The deadline for each article will be stored in a header. This variable | |
5943 | is a string and gives the header name. You probably don't need to | |
5944 | change this. The default value is @code{"X-Gnus-Delayed"}. | |
5945 | @end table | |
4009494e | 5946 | |
8a1cdce5 AC |
5947 | The way delaying works is like this: when you use the |
5948 | @code{gnus-delay-article} command, you give a certain delay. Gnus | |
5949 | calculates the deadline of the message and stores it in the | |
5950 | @code{X-Gnus-Delayed} header and puts the message in the | |
5951 | @code{nndraft:delayed} group. | |
4009494e | 5952 | |
8a1cdce5 AC |
5953 | @findex gnus-delay-send-queue |
5954 | And whenever you get new news, Gnus looks through the group for articles | |
5955 | which are due and sends them. It uses the @code{gnus-delay-send-queue} | |
5956 | function for this. By default, this function is added to the hook | |
5957 | @code{gnus-get-new-news-hook}. But of course, you can change this. | |
5958 | Maybe you want to use the demon to send drafts? Just tell the demon to | |
5959 | execute the @code{gnus-delay-send-queue} function. | |
4009494e | 5960 | |
8a1cdce5 AC |
5961 | @table @code |
5962 | @item gnus-delay-initialize | |
5963 | @findex gnus-delay-initialize | |
5964 | By default, this function installs @code{gnus-delay-send-queue} in | |
5965 | @code{gnus-get-new-news-hook}. But it accepts the optional second | |
5966 | argument @code{no-check}. If it is non-@code{nil}, | |
5967 | @code{gnus-get-new-news-hook} is not changed. The optional first | |
5968 | argument is ignored. | |
4009494e | 5969 | |
8a1cdce5 AC |
5970 | For example, @code{(gnus-delay-initialize nil t)} means to do nothing. |
5971 | Presumably, you want to use the demon for sending due delayed articles. | |
5972 | Just don't forget to set that up :-) | |
4009494e GM |
5973 | @end table |
5974 | ||
8a1cdce5 AC |
5975 | When delaying an article with @kbd{C-c C-j}, Message mode will |
5976 | automatically add a @code{"Date"} header with the current time. In | |
5977 | many cases you probably want the @code{"Date"} header to reflect the | |
5978 | time the message is sent instead. To do this, you have to delete | |
5979 | @code{Date} from @code{message-draft-headers}. | |
4009494e | 5980 | |
4009494e | 5981 | |
8a1cdce5 AC |
5982 | @node Marking Articles |
5983 | @section Marking Articles | |
5984 | @cindex article marking | |
5985 | @cindex article ticking | |
5986 | @cindex marks | |
4009494e | 5987 | |
8a1cdce5 | 5988 | There are several marks you can set on an article. |
4009494e | 5989 | |
8a1cdce5 AC |
5990 | You have marks that decide the @dfn{readedness} (whoo, neato-keano |
5991 | neologism ohoy!) of the article. Alphabetic marks generally mean | |
5992 | @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}. | |
4009494e | 5993 | |
8a1cdce5 | 5994 | In addition, you also have marks that do not affect readedness. |
4009494e | 5995 | |
8a1cdce5 AC |
5996 | @ifinfo |
5997 | There's a plethora of commands for manipulating these marks. | |
5998 | @end ifinfo | |
4009494e | 5999 | |
8a1cdce5 AC |
6000 | @menu |
6001 | * Unread Articles:: Marks for unread articles. | |
6002 | * Read Articles:: Marks for read articles. | |
6003 | * Other Marks:: Marks that do not affect readedness. | |
6004 | * Setting Marks:: How to set and remove marks. | |
6005 | * Generic Marking Commands:: How to customize the marking. | |
6006 | * Setting Process Marks:: How to mark articles for later processing. | |
6007 | @end menu | |
4009494e | 6008 | |
4009494e | 6009 | |
8a1cdce5 AC |
6010 | @node Unread Articles |
6011 | @subsection Unread Articles | |
85115796 | 6012 | |
8a1cdce5 AC |
6013 | The following marks mark articles as (kinda) unread, in one form or |
6014 | other. | |
4009494e | 6015 | |
8a1cdce5 AC |
6016 | @table @samp |
6017 | @item ! | |
6018 | @vindex gnus-ticked-mark | |
6019 | Marked as ticked (@code{gnus-ticked-mark}). | |
4009494e | 6020 | |
8a1cdce5 AC |
6021 | @dfn{Ticked articles} are articles that will remain visible always. If |
6022 | you see an article that you find interesting, or you want to put off | |
6023 | reading it, or replying to it, until sometime later, you'd typically | |
6024 | tick it. However, articles can be expired (from news servers by the | |
6025 | news server software, Gnus itself never expires ticked messages), so if | |
6026 | you want to keep an article forever, you'll have to make it persistent | |
6027 | (@pxref{Persistent Articles}). | |
4009494e | 6028 | |
8a1cdce5 AC |
6029 | @item ? |
6030 | @vindex gnus-dormant-mark | |
6031 | Marked as dormant (@code{gnus-dormant-mark}). | |
4009494e | 6032 | |
8a1cdce5 AC |
6033 | @dfn{Dormant articles} will only appear in the summary buffer if there |
6034 | are followups to it. If you want to see them even if they don't have | |
6035 | followups, you can use the @kbd{/ D} command (@pxref{Limiting}). | |
6036 | Otherwise (except for the visibility issue), they are just like ticked | |
6037 | messages. | |
4009494e | 6038 | |
8a1cdce5 AC |
6039 | @item SPACE |
6040 | @vindex gnus-unread-mark | |
6041 | Marked as unread (@code{gnus-unread-mark}). | |
4009494e | 6042 | |
8a1cdce5 AC |
6043 | @dfn{Unread articles} are articles that haven't been read at all yet. |
6044 | @end table | |
4009494e | 6045 | |
4009494e | 6046 | |
8a1cdce5 AC |
6047 | @node Read Articles |
6048 | @subsection Read Articles | |
6049 | @cindex expirable mark | |
4009494e | 6050 | |
8a1cdce5 | 6051 | All the following marks mark articles as read. |
4009494e | 6052 | |
8a1cdce5 | 6053 | @table @samp |
4009494e | 6054 | |
8a1cdce5 AC |
6055 | @item r |
6056 | @vindex gnus-del-mark | |
6057 | These are articles that the user has marked as read with the @kbd{d} | |
6058 | command manually, more or less (@code{gnus-del-mark}). | |
4009494e | 6059 | |
8a1cdce5 AC |
6060 | @item R |
6061 | @vindex gnus-read-mark | |
6062 | Articles that have actually been read (@code{gnus-read-mark}). | |
4009494e | 6063 | |
8a1cdce5 AC |
6064 | @item O |
6065 | @vindex gnus-ancient-mark | |
6066 | Articles that were marked as read in previous sessions and are now | |
6067 | @dfn{old} (@code{gnus-ancient-mark}). | |
4009494e | 6068 | |
8a1cdce5 AC |
6069 | @item K |
6070 | @vindex gnus-killed-mark | |
6071 | Marked as killed (@code{gnus-killed-mark}). | |
4009494e | 6072 | |
8a1cdce5 AC |
6073 | @item X |
6074 | @vindex gnus-kill-file-mark | |
6075 | Marked as killed by kill files (@code{gnus-kill-file-mark}). | |
4009494e | 6076 | |
8a1cdce5 AC |
6077 | @item Y |
6078 | @vindex gnus-low-score-mark | |
6079 | Marked as read by having too low a score (@code{gnus-low-score-mark}). | |
4009494e | 6080 | |
8a1cdce5 AC |
6081 | @item C |
6082 | @vindex gnus-catchup-mark | |
6083 | Marked as read by a catchup (@code{gnus-catchup-mark}). | |
4009494e | 6084 | |
8a1cdce5 AC |
6085 | @item G |
6086 | @vindex gnus-canceled-mark | |
6087 | Canceled article (@code{gnus-canceled-mark}) | |
4009494e | 6088 | |
8a1cdce5 AC |
6089 | @item Q |
6090 | @vindex gnus-sparse-mark | |
6091 | Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing | |
6092 | Threading}. | |
4009494e | 6093 | |
8a1cdce5 AC |
6094 | @item M |
6095 | @vindex gnus-duplicate-mark | |
6096 | Article marked as read by duplicate suppression | |
6097 | (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}. | |
4009494e GM |
6098 | |
6099 | @end table | |
6100 | ||
8a1cdce5 AC |
6101 | All these marks just mean that the article is marked as read, really. |
6102 | They are interpreted differently when doing adaptive scoring, though. | |
4009494e | 6103 | |
8a1cdce5 | 6104 | One more special mark, though: |
4009494e | 6105 | |
8a1cdce5 AC |
6106 | @table @samp |
6107 | @item E | |
6108 | @vindex gnus-expirable-mark | |
6109 | Marked as expirable (@code{gnus-expirable-mark}). | |
4009494e | 6110 | |
8a1cdce5 AC |
6111 | Marking articles as @dfn{expirable} (or have them marked as such |
6112 | automatically) doesn't make much sense in normal groups---a user doesn't | |
6113 | control expiring of news articles, but in mail groups, for instance, | |
6114 | articles marked as @dfn{expirable} can be deleted by Gnus at | |
6115 | any time. | |
6116 | @end table | |
4009494e | 6117 | |
4009494e | 6118 | |
8a1cdce5 AC |
6119 | @node Other Marks |
6120 | @subsection Other Marks | |
6121 | @cindex process mark | |
6122 | @cindex bookmarks | |
4009494e | 6123 | |
8a1cdce5 AC |
6124 | There are some marks that have nothing to do with whether the article is |
6125 | read or not. | |
4009494e | 6126 | |
8a1cdce5 | 6127 | @itemize @bullet |
4009494e | 6128 | |
8a1cdce5 AC |
6129 | @item |
6130 | You can set a bookmark in the current article. Say you are reading a | |
6131 | long thesis on cats' urinary tracts, and have to go home for dinner | |
6132 | before you've finished reading the thesis. You can then set a bookmark | |
6133 | in the article, and Gnus will jump to this bookmark the next time it | |
6134 | encounters the article. @xref{Setting Marks}. | |
4009494e | 6135 | |
8a1cdce5 AC |
6136 | @item |
6137 | @vindex gnus-replied-mark | |
6138 | All articles that you have replied to or made a followup to (i.e., have | |
6139 | answered) will be marked with an @samp{A} in the second column | |
6140 | (@code{gnus-replied-mark}). | |
4009494e | 6141 | |
8a1cdce5 AC |
6142 | @item |
6143 | @vindex gnus-forwarded-mark | |
6144 | All articles that you have forwarded will be marked with an @samp{F} in | |
6145 | the second column (@code{gnus-forwarded-mark}). | |
4009494e | 6146 | |
8a1cdce5 AC |
6147 | @item |
6148 | @vindex gnus-cached-mark | |
6149 | Articles stored in the article cache will be marked with an @samp{*} in | |
6150 | the second column (@code{gnus-cached-mark}). @xref{Article Caching}. | |
4009494e | 6151 | |
8a1cdce5 AC |
6152 | @item |
6153 | @vindex gnus-saved-mark | |
6154 | Articles ``saved'' (in some manner or other; not necessarily | |
6155 | religiously) are marked with an @samp{S} in the second column | |
6156 | (@code{gnus-saved-mark}). | |
4009494e | 6157 | |
8a1cdce5 AC |
6158 | @item |
6159 | @vindex gnus-unseen-mark | |
6160 | Articles that haven't been seen before in Gnus by the user are marked | |
6161 | with a @samp{.} in the second column (@code{gnus-unseen-mark}). | |
4009494e | 6162 | |
8a1cdce5 AC |
6163 | @item |
6164 | @vindex gnus-downloaded-mark | |
6165 | When using the Gnus agent (@pxref{Agent Basics}), articles may be | |
6166 | downloaded for unplugged (offline) viewing. If you are using the | |
6167 | @samp{%O} spec, these articles get the @samp{+} mark in that spec. | |
6168 | (The variable @code{gnus-downloaded-mark} controls which character to | |
6169 | use.) | |
4009494e | 6170 | |
8a1cdce5 AC |
6171 | @item |
6172 | @vindex gnus-undownloaded-mark | |
6173 | When using the Gnus agent (@pxref{Agent Basics}), some articles might | |
6174 | not have been downloaded. Such articles cannot be viewed while you | |
6175 | are unplugged (offline). If you are using the @samp{%O} spec, these | |
6176 | articles get the @samp{-} mark in that spec. (The variable | |
6177 | @code{gnus-undownloaded-mark} controls which character to use.) | |
4009494e | 6178 | |
8a1cdce5 AC |
6179 | @item |
6180 | @vindex gnus-downloadable-mark | |
6181 | The Gnus agent (@pxref{Agent Basics}) downloads some articles | |
6182 | automatically, but it is also possible to explicitly mark articles for | |
6183 | download, even if they would not be downloaded automatically. Such | |
6184 | explicitly-marked articles get the @samp{%} mark in the first column. | |
6185 | (The variable @code{gnus-downloadable-mark} controls which character to | |
6186 | use.) | |
4009494e | 6187 | |
8a1cdce5 AC |
6188 | @item |
6189 | @vindex gnus-not-empty-thread-mark | |
6190 | @vindex gnus-empty-thread-mark | |
6191 | If the @samp{%e} spec is used, the presence of threads or not will be | |
6192 | marked with @code{gnus-not-empty-thread-mark} and | |
6193 | @code{gnus-empty-thread-mark} in the third column, respectively. | |
4009494e | 6194 | |
8a1cdce5 AC |
6195 | @item |
6196 | @vindex gnus-process-mark | |
6197 | Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A | |
6198 | variety of commands react to the presence of the process mark. For | |
6199 | instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view | |
6200 | all articles that have been marked with the process mark. Articles | |
6201 | marked with the process mark have a @samp{#} in the second column. | |
4009494e | 6202 | |
8a1cdce5 | 6203 | @end itemize |
4009494e | 6204 | |
8a1cdce5 AC |
6205 | You might have noticed that most of these ``non-readedness'' marks |
6206 | appear in the second column by default. So if you have a cached, saved, | |
6207 | replied article that you have process-marked, what will that look like? | |
4009494e | 6208 | |
8a1cdce5 AC |
6209 | Nothing much. The precedence rules go as follows: process -> cache -> |
6210 | replied -> saved. So if the article is in the cache and is replied, | |
6211 | you'll only see the cache mark and not the replied mark. | |
4009494e | 6212 | |
4009494e | 6213 | |
8a1cdce5 AC |
6214 | @node Setting Marks |
6215 | @subsection Setting Marks | |
6216 | @cindex setting marks | |
6217 | ||
6218 | All the marking commands understand the numeric prefix. | |
4009494e | 6219 | |
8a1cdce5 AC |
6220 | @table @kbd |
6221 | @item M c | |
6222 | @itemx M-u | |
6223 | @kindex M c (Summary) | |
6224 | @kindex M-u (Summary) | |
6225 | @findex gnus-summary-clear-mark-forward | |
6226 | @cindex mark as unread | |
6227 | Clear all readedness-marks from the current article | |
6228 | (@code{gnus-summary-clear-mark-forward}). In other words, mark the | |
6229 | article as unread. | |
4009494e | 6230 | |
8a1cdce5 AC |
6231 | @item M t |
6232 | @itemx ! | |
6233 | @kindex ! (Summary) | |
6234 | @kindex M t (Summary) | |
6235 | @findex gnus-summary-tick-article-forward | |
6236 | Tick the current article (@code{gnus-summary-tick-article-forward}). | |
6237 | @xref{Article Caching}. | |
4009494e | 6238 | |
8a1cdce5 AC |
6239 | @item M ? |
6240 | @itemx ? | |
6241 | @kindex ? (Summary) | |
6242 | @kindex M ? (Summary) | |
6243 | @findex gnus-summary-mark-as-dormant | |
6244 | Mark the current article as dormant | |
6245 | (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}. | |
4009494e | 6246 | |
8a1cdce5 AC |
6247 | @item M d |
6248 | @itemx d | |
6249 | @kindex M d (Summary) | |
6250 | @kindex d (Summary) | |
6251 | @findex gnus-summary-mark-as-read-forward | |
6252 | Mark the current article as read | |
6253 | (@code{gnus-summary-mark-as-read-forward}). | |
4009494e | 6254 | |
8a1cdce5 AC |
6255 | @item D |
6256 | @kindex D (Summary) | |
6257 | @findex gnus-summary-mark-as-read-backward | |
6258 | Mark the current article as read and move point to the previous line | |
6259 | (@code{gnus-summary-mark-as-read-backward}). | |
4009494e | 6260 | |
8a1cdce5 AC |
6261 | @item M k |
6262 | @itemx k | |
6263 | @kindex k (Summary) | |
6264 | @kindex M k (Summary) | |
6265 | @findex gnus-summary-kill-same-subject-and-select | |
6266 | Mark all articles that have the same subject as the current one as read, | |
6267 | and then select the next unread article | |
6268 | (@code{gnus-summary-kill-same-subject-and-select}). | |
4009494e | 6269 | |
8a1cdce5 AC |
6270 | @item M K |
6271 | @itemx C-k | |
6272 | @kindex M K (Summary) | |
6273 | @kindex C-k (Summary) | |
6274 | @findex gnus-summary-kill-same-subject | |
6275 | Mark all articles that have the same subject as the current one as read | |
6276 | (@code{gnus-summary-kill-same-subject}). | |
4009494e | 6277 | |
8a1cdce5 AC |
6278 | @item M C |
6279 | @kindex M C (Summary) | |
6280 | @findex gnus-summary-catchup | |
6281 | @c @icon{gnus-summary-catchup} | |
6282 | Mark all unread articles as read (@code{gnus-summary-catchup}). | |
4009494e | 6283 | |
8a1cdce5 AC |
6284 | @item M C-c |
6285 | @kindex M C-c (Summary) | |
6286 | @findex gnus-summary-catchup-all | |
6287 | Mark all articles in the group as read---even the ticked and dormant | |
6288 | articles (@code{gnus-summary-catchup-all}). | |
4009494e | 6289 | |
8a1cdce5 AC |
6290 | @item M H |
6291 | @kindex M H (Summary) | |
6292 | @findex gnus-summary-catchup-to-here | |
6293 | Catchup the current group to point (before the point) | |
6294 | (@code{gnus-summary-catchup-to-here}). | |
4009494e | 6295 | |
8a1cdce5 AC |
6296 | @item M h |
6297 | @kindex M h (Summary) | |
6298 | @findex gnus-summary-catchup-from-here | |
6299 | Catchup the current group from point (after the point) | |
6300 | (@code{gnus-summary-catchup-from-here}). | |
4009494e | 6301 | |
8a1cdce5 AC |
6302 | @item C-w |
6303 | @kindex C-w (Summary) | |
6304 | @findex gnus-summary-mark-region-as-read | |
6305 | Mark all articles between point and mark as read | |
6306 | (@code{gnus-summary-mark-region-as-read}). | |
4009494e | 6307 | |
8a1cdce5 AC |
6308 | @item M V k |
6309 | @kindex M V k (Summary) | |
6310 | @findex gnus-summary-kill-below | |
6311 | Kill all articles with scores below the default score (or below the | |
6312 | numeric prefix) (@code{gnus-summary-kill-below}). | |
4009494e | 6313 | |
8a1cdce5 AC |
6314 | @item M e |
6315 | @itemx E | |
6316 | @kindex M e (Summary) | |
6317 | @kindex E (Summary) | |
6318 | @findex gnus-summary-mark-as-expirable | |
6319 | Mark the current article as expirable | |
6320 | (@code{gnus-summary-mark-as-expirable}). | |
4009494e | 6321 | |
8a1cdce5 AC |
6322 | @item M b |
6323 | @kindex M b (Summary) | |
6324 | @findex gnus-summary-set-bookmark | |
6325 | Set a bookmark in the current article | |
6326 | (@code{gnus-summary-set-bookmark}). | |
4009494e | 6327 | |
8a1cdce5 AC |
6328 | @item M B |
6329 | @kindex M B (Summary) | |
6330 | @findex gnus-summary-remove-bookmark | |
6331 | Remove the bookmark from the current article | |
6332 | (@code{gnus-summary-remove-bookmark}). | |
4009494e | 6333 | |
8a1cdce5 AC |
6334 | @item M V c |
6335 | @kindex M V c (Summary) | |
6336 | @findex gnus-summary-clear-above | |
6337 | Clear all marks from articles with scores over the default score (or | |
6338 | over the numeric prefix) (@code{gnus-summary-clear-above}). | |
4009494e | 6339 | |
8a1cdce5 AC |
6340 | @item M V u |
6341 | @kindex M V u (Summary) | |
6342 | @findex gnus-summary-tick-above | |
6343 | Tick all articles with scores over the default score (or over the | |
6344 | numeric prefix) (@code{gnus-summary-tick-above}). | |
4009494e | 6345 | |
8a1cdce5 AC |
6346 | @item M V m |
6347 | @kindex M V m (Summary) | |
6348 | @findex gnus-summary-mark-above | |
6349 | Prompt for a mark, and mark all articles with scores over the default | |
6350 | score (or over the numeric prefix) with this mark | |
6351 | (@code{gnus-summary-clear-above}). | |
6352 | @end table | |
4009494e | 6353 | |
8a1cdce5 AC |
6354 | @vindex gnus-summary-goto-unread |
6355 | The @code{gnus-summary-goto-unread} variable controls what action should | |
6356 | be taken after setting a mark. If non-@code{nil}, point will move to | |
6357 | the next/previous unread article. If @code{nil}, point will just move | |
6358 | one line up or down. As a special case, if this variable is | |
6359 | @code{never}, all the marking commands as well as other commands (like | |
6360 | @kbd{SPACE}) will move to the next article, whether it is unread or not. | |
6361 | The default is @code{t}. | |
4009494e | 6362 | |
4009494e | 6363 | |
8a1cdce5 AC |
6364 | @node Generic Marking Commands |
6365 | @subsection Generic Marking Commands | |
4009494e | 6366 | |
8a1cdce5 AC |
6367 | Some people would like the command that ticks an article (@kbd{!}) go to |
6368 | the next article. Others would like it to go to the next unread | |
6369 | article. Yet others would like it to stay on the current article. And | |
6370 | even though I haven't heard of anybody wanting it to go to the | |
6371 | previous (unread) article, I'm sure there are people that want that as | |
6372 | well. | |
4009494e | 6373 | |
8a1cdce5 AC |
6374 | Multiply these five behaviors with five different marking commands, and |
6375 | you get a potentially complex set of variable to control what each | |
6376 | command should do. | |
4009494e | 6377 | |
8a1cdce5 AC |
6378 | To sidestep that mess, Gnus provides commands that do all these |
6379 | different things. They can be found on the @kbd{M M} map in the summary | |
6380 | buffer. Type @kbd{M M C-h} to see them all---there are too many of them | |
6381 | to list in this manual. | |
4009494e | 6382 | |
8a1cdce5 AC |
6383 | While you can use these commands directly, most users would prefer |
6384 | altering the summary mode keymap. For instance, if you would like the | |
6385 | @kbd{!} command to go to the next article instead of the next unread | |
6386 | article, you could say something like: | |
4009494e | 6387 | |
8a1cdce5 AC |
6388 | @lisp |
6389 | @group | |
6390 | (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map) | |
6391 | (defun my-alter-summary-map () | |
6392 | (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next)) | |
6393 | @end group | |
6394 | @end lisp | |
4009494e | 6395 | |
8a1cdce5 AC |
6396 | @noindent |
6397 | or | |
4009494e | 6398 | |
8a1cdce5 AC |
6399 | @lisp |
6400 | (defun my-alter-summary-map () | |
6401 | (local-set-key "!" "MM!n")) | |
6402 | @end lisp | |
4009494e GM |
6403 | |
6404 | ||
8a1cdce5 AC |
6405 | @node Setting Process Marks |
6406 | @subsection Setting Process Marks | |
6407 | @cindex setting process marks | |
4009494e | 6408 | |
8a1cdce5 AC |
6409 | Process marks are displayed as @code{#} in the summary buffer, and are |
6410 | used for marking articles in such a way that other commands will | |
6411 | process these articles. For instance, if you process mark four | |
6412 | articles and then use the @kbd{*} command, Gnus will enter these four | |
6413 | articles into the cache. For more information, | |
6414 | @pxref{Process/Prefix}. | |
4009494e GM |
6415 | |
6416 | @table @kbd | |
4009494e | 6417 | |
8a1cdce5 AC |
6418 | @item M P p |
6419 | @itemx # | |
6420 | @kindex # (Summary) | |
6421 | @kindex M P p (Summary) | |
6422 | @findex gnus-summary-mark-as-processable | |
6423 | Mark the current article with the process mark | |
6424 | (@code{gnus-summary-mark-as-processable}). | |
6425 | @findex gnus-summary-unmark-as-processable | |
4009494e | 6426 | |
8a1cdce5 AC |
6427 | @item M P u |
6428 | @itemx M-# | |
6429 | @kindex M P u (Summary) | |
6430 | @kindex M-# (Summary) | |
6431 | Remove the process mark, if any, from the current article | |
6432 | (@code{gnus-summary-unmark-as-processable}). | |
4009494e | 6433 | |
8a1cdce5 AC |
6434 | @item M P U |
6435 | @kindex M P U (Summary) | |
6436 | @findex gnus-summary-unmark-all-processable | |
6437 | Remove the process mark from all articles | |
6438 | (@code{gnus-summary-unmark-all-processable}). | |
4009494e | 6439 | |
8a1cdce5 AC |
6440 | @item M P i |
6441 | @kindex M P i (Summary) | |
6442 | @findex gnus-uu-invert-processable | |
6443 | Invert the list of process marked articles | |
6444 | (@code{gnus-uu-invert-processable}). | |
4009494e | 6445 | |
8a1cdce5 AC |
6446 | @item M P R |
6447 | @kindex M P R (Summary) | |
6448 | @findex gnus-uu-mark-by-regexp | |
6449 | Mark articles that have a @code{Subject} header that matches a regular | |
6450 | expression (@code{gnus-uu-mark-by-regexp}). | |
4009494e | 6451 | |
8a1cdce5 AC |
6452 | @item M P G |
6453 | @kindex M P G (Summary) | |
6454 | @findex gnus-uu-unmark-by-regexp | |
6455 | Unmark articles that have a @code{Subject} header that matches a regular | |
6456 | expression (@code{gnus-uu-unmark-by-regexp}). | |
4009494e | 6457 | |
8a1cdce5 AC |
6458 | @item M P r |
6459 | @kindex M P r (Summary) | |
6460 | @findex gnus-uu-mark-region | |
6461 | Mark articles in region (@code{gnus-uu-mark-region}). | |
4009494e | 6462 | |
8a1cdce5 AC |
6463 | @item M P g |
6464 | @kindex M P g (Summary) | |
6465 | @findex gnus-uu-unmark-region | |
6466 | Unmark articles in region (@code{gnus-uu-unmark-region}). | |
4009494e | 6467 | |
8a1cdce5 AC |
6468 | @item M P t |
6469 | @kindex M P t (Summary) | |
6470 | @findex gnus-uu-mark-thread | |
6471 | Mark all articles in the current (sub)thread | |
6472 | (@code{gnus-uu-mark-thread}). | |
4009494e | 6473 | |
8a1cdce5 AC |
6474 | @item M P T |
6475 | @kindex M P T (Summary) | |
6476 | @findex gnus-uu-unmark-thread | |
6477 | Unmark all articles in the current (sub)thread | |
6478 | (@code{gnus-uu-unmark-thread}). | |
4009494e | 6479 | |
8a1cdce5 AC |
6480 | @item M P v |
6481 | @kindex M P v (Summary) | |
6482 | @findex gnus-uu-mark-over | |
6483 | Mark all articles that have a score above the prefix argument | |
6484 | (@code{gnus-uu-mark-over}). | |
4009494e | 6485 | |
8a1cdce5 AC |
6486 | @item M P s |
6487 | @kindex M P s (Summary) | |
6488 | @findex gnus-uu-mark-series | |
6489 | Mark all articles in the current series (@code{gnus-uu-mark-series}). | |
4009494e | 6490 | |
8a1cdce5 AC |
6491 | @item M P S |
6492 | @kindex M P S (Summary) | |
6493 | @findex gnus-uu-mark-sparse | |
6494 | Mark all series that have already had some articles marked | |
6495 | (@code{gnus-uu-mark-sparse}). | |
4009494e | 6496 | |
8a1cdce5 AC |
6497 | @item M P a |
6498 | @kindex M P a (Summary) | |
6499 | @findex gnus-uu-mark-all | |
6500 | Mark all articles in series order (@code{gnus-uu-mark-all}). | |
6501 | ||
6502 | @item M P b | |
6503 | @kindex M P b (Summary) | |
6504 | @findex gnus-uu-mark-buffer | |
6505 | Mark all articles in the buffer in the order they appear | |
6506 | (@code{gnus-uu-mark-buffer}). | |
6507 | ||
6508 | @item M P k | |
6509 | @kindex M P k (Summary) | |
6510 | @findex gnus-summary-kill-process-mark | |
6511 | Push the current process mark set onto the stack and unmark all articles | |
6512 | (@code{gnus-summary-kill-process-mark}). | |
6513 | ||
6514 | @item M P y | |
6515 | @kindex M P y (Summary) | |
6516 | @findex gnus-summary-yank-process-mark | |
6517 | Pop the previous process mark set from the stack and restore it | |
6518 | (@code{gnus-summary-yank-process-mark}). | |
4009494e | 6519 | |
8a1cdce5 AC |
6520 | @item M P w |
6521 | @kindex M P w (Summary) | |
6522 | @findex gnus-summary-save-process-mark | |
6523 | Push the current process mark set onto the stack | |
6524 | (@code{gnus-summary-save-process-mark}). | |
4009494e | 6525 | |
8a1cdce5 | 6526 | @end table |
4009494e | 6527 | |
8a1cdce5 AC |
6528 | Also see the @kbd{&} command in @ref{Searching for Articles}, for how to |
6529 | set process marks based on article body contents. | |
4009494e | 6530 | |
4009494e | 6531 | |
8a1cdce5 AC |
6532 | @node Limiting |
6533 | @section Limiting | |
6534 | @cindex limiting | |
4009494e | 6535 | |
8a1cdce5 AC |
6536 | It can be convenient to limit the summary buffer to just show some |
6537 | subset of the articles currently in the group. The effect most limit | |
6538 | commands have is to remove a few (or many) articles from the summary | |
6539 | buffer. | |
4009494e | 6540 | |
8a1cdce5 AC |
6541 | Limiting commands work on subsets of the articles already fetched from |
6542 | the servers. These commands don't query the server for additional | |
6543 | articles. | |
4009494e | 6544 | |
8a1cdce5 | 6545 | @table @kbd |
4009494e | 6546 | |
8a1cdce5 AC |
6547 | @item / / |
6548 | @itemx / s | |
6549 | @kindex / / (Summary) | |
6550 | @findex gnus-summary-limit-to-subject | |
6551 | Limit the summary buffer to articles that match some subject | |
6552 | (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude | |
6553 | matching articles. | |
4009494e | 6554 | |
8a1cdce5 AC |
6555 | @item / a |
6556 | @kindex / a (Summary) | |
6557 | @findex gnus-summary-limit-to-author | |
6558 | Limit the summary buffer to articles that match some author | |
6559 | (@code{gnus-summary-limit-to-author}). If given a prefix, exclude | |
6560 | matching articles. | |
4009494e | 6561 | |
8a1cdce5 AC |
6562 | @item / R |
6563 | @kindex / R (Summary) | |
6564 | @findex gnus-summary-limit-to-recipient | |
6565 | Limit the summary buffer to articles that match some recipient | |
6566 | (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude | |
6567 | matching articles. | |
4009494e | 6568 | |
8a1cdce5 AC |
6569 | @item / A |
6570 | @kindex / A (Summary) | |
6571 | @findex gnus-summary-limit-to-address | |
6572 | Limit the summary buffer to articles in which contents of From, To or Cc | |
6573 | header match a given address (@code{gnus-summary-limit-to-address}). If | |
6574 | given a prefix, exclude matching articles. | |
4009494e | 6575 | |
8a1cdce5 AC |
6576 | @item / S |
6577 | @kindex / S (Summary) | |
6578 | @findex gnus-summary-limit-to-singletons | |
6579 | Limit the summary buffer to articles that aren't part of any displayed | |
6580 | threads (@code{gnus-summary-limit-to-singletons}). If given a prefix, | |
6581 | limit to articles that are part of displayed threads. | |
4009494e | 6582 | |
8a1cdce5 AC |
6583 | @item / x |
6584 | @kindex / x (Summary) | |
6585 | @findex gnus-summary-limit-to-extra | |
6586 | Limit the summary buffer to articles that match one of the ``extra'' | |
6587 | headers (@pxref{To From Newsgroups}) | |
6588 | (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude | |
6589 | matching articles. | |
4009494e | 6590 | |
8a1cdce5 AC |
6591 | @item / u |
6592 | @itemx x | |
6593 | @kindex / u (Summary) | |
6594 | @kindex x (Summary) | |
6595 | @findex gnus-summary-limit-to-unread | |
6596 | Limit the summary buffer to articles not marked as read | |
6597 | (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the | |
6598 | buffer to articles strictly unread. This means that ticked and | |
6599 | dormant articles will also be excluded. | |
4009494e | 6600 | |
8a1cdce5 AC |
6601 | @item / m |
6602 | @kindex / m (Summary) | |
6603 | @findex gnus-summary-limit-to-marks | |
6604 | Ask for a mark and then limit to all articles that have been marked | |
6605 | with that mark (@code{gnus-summary-limit-to-marks}). | |
4009494e | 6606 | |
8a1cdce5 AC |
6607 | @item / t |
6608 | @kindex / t (Summary) | |
6609 | @findex gnus-summary-limit-to-age | |
6610 | Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days | |
6611 | (@code{gnus-summary-limit-to-age}). If given a prefix, limit to | |
6612 | articles younger than that number of days. | |
4009494e | 6613 | |
8a1cdce5 AC |
6614 | @item / n |
6615 | @kindex / n (Summary) | |
6616 | @findex gnus-summary-limit-to-articles | |
6617 | With prefix @samp{n}, limit the summary buffer to the next @samp{n} | |
6618 | articles. If not given a prefix, use the process marked articles | |
6619 | instead. (@code{gnus-summary-limit-to-articles}). | |
4009494e | 6620 | |
8a1cdce5 AC |
6621 | @item / w |
6622 | @kindex / w (Summary) | |
6623 | @findex gnus-summary-pop-limit | |
6624 | Pop the previous limit off the stack and restore it | |
6625 | (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off | |
6626 | the stack. | |
4009494e | 6627 | |
8a1cdce5 AC |
6628 | @item / . |
6629 | @kindex / . (Summary) | |
6630 | @findex gnus-summary-limit-to-unseen | |
6631 | Limit the summary buffer to the unseen articles | |
6632 | (@code{gnus-summary-limit-to-unseen}). | |
4009494e | 6633 | |
8a1cdce5 AC |
6634 | @item / v |
6635 | @kindex / v (Summary) | |
6636 | @findex gnus-summary-limit-to-score | |
6637 | Limit the summary buffer to articles that have a score at or above some | |
6638 | score (@code{gnus-summary-limit-to-score}). | |
4009494e | 6639 | |
8a1cdce5 AC |
6640 | @item / p |
6641 | @kindex / p (Summary) | |
6642 | @findex gnus-summary-limit-to-display-predicate | |
6643 | Limit the summary buffer to articles that satisfy the @code{display} | |
6644 | group parameter predicate | |
6645 | (@code{gnus-summary-limit-to-display-predicate}). @xref{Group | |
6646 | Parameters}, for more on this predicate. | |
4009494e | 6647 | |
8a1cdce5 AC |
6648 | @item / r |
6649 | @kindex / r (Summary) | |
6650 | @findex gnus-summary-limit-to-replied | |
6651 | Limit the summary buffer to replied articles | |
6652 | (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude | |
6653 | replied articles. | |
4009494e | 6654 | |
8a1cdce5 AC |
6655 | @item / E |
6656 | @itemx M S | |
6657 | @kindex M S (Summary) | |
6658 | @kindex / E (Summary) | |
6659 | @findex gnus-summary-limit-include-expunged | |
6660 | Include all expunged articles in the limit | |
6661 | (@code{gnus-summary-limit-include-expunged}). | |
4009494e | 6662 | |
8a1cdce5 AC |
6663 | @item / D |
6664 | @kindex / D (Summary) | |
6665 | @findex gnus-summary-limit-include-dormant | |
6666 | Include all dormant articles in the limit | |
6667 | (@code{gnus-summary-limit-include-dormant}). | |
4009494e | 6668 | |
8a1cdce5 AC |
6669 | @item / * |
6670 | @kindex / * (Summary) | |
6671 | @findex gnus-summary-limit-include-cached | |
6672 | Include all cached articles in the limit | |
6673 | (@code{gnus-summary-limit-include-cached}). | |
4009494e | 6674 | |
8a1cdce5 AC |
6675 | @item / d |
6676 | @kindex / d (Summary) | |
6677 | @findex gnus-summary-limit-exclude-dormant | |
6678 | Exclude all dormant articles from the limit | |
6679 | (@code{gnus-summary-limit-exclude-dormant}). | |
4009494e | 6680 | |
8a1cdce5 AC |
6681 | @item / M |
6682 | @kindex / M (Summary) | |
6683 | @findex gnus-summary-limit-exclude-marks | |
6684 | Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}). | |
e7842e69 | 6685 | |
8a1cdce5 AC |
6686 | @item / T |
6687 | @kindex / T (Summary) | |
6688 | @findex gnus-summary-limit-include-thread | |
6689 | Include all the articles in the current thread in the limit. | |
4009494e | 6690 | |
8a1cdce5 AC |
6691 | @item / c |
6692 | @kindex / c (Summary) | |
6693 | @findex gnus-summary-limit-exclude-childless-dormant | |
6694 | Exclude all dormant articles that have no children from the limit@* | |
6695 | (@code{gnus-summary-limit-exclude-childless-dormant}). | |
4009494e | 6696 | |
8a1cdce5 AC |
6697 | @item / C |
6698 | @kindex / C (Summary) | |
6699 | @findex gnus-summary-limit-mark-excluded-as-read | |
6700 | Mark all excluded unread articles as read | |
6701 | (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix, | |
6702 | also mark excluded ticked and dormant articles as read. | |
4009494e | 6703 | |
8a1cdce5 AC |
6704 | @item / b |
6705 | @kindex / b (Summary) | |
6706 | @findex gnus-summary-limit-to-bodies | |
6707 | Limit the summary buffer to articles that have bodies that match a | |
6708 | certain regexp (@code{gnus-summary-limit-to-bodies}). If given a | |
6709 | prefix, reverse the limit. This command is quite slow since it | |
6710 | requires selecting each article to find the matches. | |
4009494e | 6711 | |
8a1cdce5 AC |
6712 | @item / h |
6713 | @kindex / h (Summary) | |
6714 | @findex gnus-summary-limit-to-headers | |
6715 | Like the previous command, only limit to headers instead | |
6716 | (@code{gnus-summary-limit-to-headers}). | |
4009494e | 6717 | |
8a1cdce5 | 6718 | @end table |
4009494e | 6719 | |
4009494e | 6720 | |
8a1cdce5 AC |
6721 | The following commands aren't limiting commands, but use the @kbd{/} |
6722 | prefix as well. | |
4009494e | 6723 | |
8a1cdce5 AC |
6724 | @table @kbd |
6725 | @item / N | |
6726 | @kindex / N (Summary) | |
6727 | @findex gnus-summary-insert-new-articles | |
6728 | Insert all new articles in the summary buffer. It scans for new emails | |
6729 | if @var{back-end}@code{-get-new-mail} is non-@code{nil}. | |
4009494e | 6730 | |
8a1cdce5 AC |
6731 | @item / o |
6732 | @kindex / o (Summary) | |
6733 | @findex gnus-summary-insert-old-articles | |
6734 | Insert all old articles in the summary buffer. If given a numbered | |
6735 | prefix, fetch this number of articles. | |
4009494e | 6736 | |
8a1cdce5 | 6737 | @end table |
4009494e | 6738 | |
4009494e | 6739 | |
8a1cdce5 AC |
6740 | @node Threading |
6741 | @section Threading | |
6742 | @cindex threading | |
6743 | @cindex article threading | |
4009494e | 6744 | |
8a1cdce5 AC |
6745 | Gnus threads articles by default. @dfn{To thread} is to put responses |
6746 | to articles directly after the articles they respond to---in a | |
6747 | hierarchical fashion. | |
4009494e | 6748 | |
8a1cdce5 AC |
6749 | Threading is done by looking at the @code{References} headers of the |
6750 | articles. In a perfect world, this would be enough to build pretty | |
6751 | trees, but unfortunately, the @code{References} header is often broken | |
6752 | or simply missing. Weird news propagation exacerbates the problem, | |
6753 | so one has to employ other heuristics to get pleasing results. A | |
6754 | plethora of approaches exists, as detailed in horrible detail in | |
6755 | @ref{Customizing Threading}. | |
4009494e | 6756 | |
8a1cdce5 | 6757 | First, a quick overview of the concepts: |
4009494e | 6758 | |
8a1cdce5 AC |
6759 | @table @dfn |
6760 | @item root | |
6761 | The top-most article in a thread; the first article in the thread. | |
4009494e | 6762 | |
8a1cdce5 AC |
6763 | @item thread |
6764 | A tree-like article structure. | |
4009494e | 6765 | |
8a1cdce5 AC |
6766 | @item sub-thread |
6767 | A small(er) section of this tree-like structure. | |
4009494e | 6768 | |
8a1cdce5 AC |
6769 | @item loose threads |
6770 | Threads often lose their roots due to article expiry, or due to the root | |
6771 | already having been read in a previous session, and not displayed in the | |
6772 | summary buffer. We then typically have many sub-threads that really | |
6773 | belong to one thread, but are without connecting roots. These are | |
6774 | called loose threads. | |
4009494e | 6775 | |
8a1cdce5 AC |
6776 | @item thread gathering |
6777 | An attempt to gather loose threads into bigger threads. | |
4009494e | 6778 | |
8a1cdce5 AC |
6779 | @item sparse threads |
6780 | A thread where the missing articles have been ``guessed'' at, and are | |
6781 | displayed as empty lines in the summary buffer. | |
4009494e | 6782 | |
8a1cdce5 | 6783 | @end table |
4009494e | 6784 | |
4009494e | 6785 | |
8a1cdce5 AC |
6786 | @menu |
6787 | * Customizing Threading:: Variables you can change to affect the threading. | |
6788 | * Thread Commands:: Thread based commands in the summary buffer. | |
6789 | @end menu | |
4009494e | 6790 | |
4009494e | 6791 | |
8a1cdce5 AC |
6792 | @node Customizing Threading |
6793 | @subsection Customizing Threading | |
6794 | @cindex customizing threading | |
4009494e | 6795 | |
8a1cdce5 AC |
6796 | @menu |
6797 | * Loose Threads:: How Gnus gathers loose threads into bigger threads. | |
6798 | * Filling In Threads:: Making the threads displayed look fuller. | |
6799 | * More Threading:: Even more variables for fiddling with threads. | |
6800 | * Low-Level Threading:: You thought it was over@dots{} but you were wrong! | |
6801 | @end menu | |
4009494e | 6802 | |
4009494e | 6803 | |
8a1cdce5 AC |
6804 | @node Loose Threads |
6805 | @subsubsection Loose Threads | |
6806 | @cindex < | |
6807 | @cindex > | |
6808 | @cindex loose threads | |
4009494e | 6809 | |
8a1cdce5 AC |
6810 | @table @code |
6811 | @item gnus-summary-make-false-root | |
6812 | @vindex gnus-summary-make-false-root | |
6813 | If non-@code{nil}, Gnus will gather all loose subtrees into one big tree | |
6814 | and create a dummy root at the top. (Wait a minute. Root at the top? | |
6815 | Yup.) Loose subtrees occur when the real root has expired, or you've | |
6816 | read or killed the root in a previous session. | |
4009494e | 6817 | |
8a1cdce5 AC |
6818 | When there is no real root of a thread, Gnus will have to fudge |
6819 | something. This variable says what fudging method Gnus should use. | |
6820 | There are four possible values: | |
4009494e | 6821 | |
8a1cdce5 AC |
6822 | @iftex |
6823 | @iflatex | |
6824 | \gnusfigure{The Summary Buffer}{390}{ | |
6825 | \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}} | |
6826 | \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}} | |
6827 | \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}} | |
6828 | \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}} | |
6829 | } | |
6830 | @end iflatex | |
6831 | @end iftex | |
4009494e | 6832 | |
8a1cdce5 | 6833 | @cindex adopting articles |
4009494e | 6834 | |
8a1cdce5 | 6835 | @table @code |
4009494e | 6836 | |
8a1cdce5 AC |
6837 | @item adopt |
6838 | Gnus will make the first of the orphaned articles the parent. This | |
6839 | parent will adopt all the other articles. The adopted articles will be | |
6840 | marked as such by pointy brackets (@samp{<>}) instead of the standard | |
6841 | square brackets (@samp{[]}). This is the default method. | |
4009494e | 6842 | |
8a1cdce5 AC |
6843 | @item dummy |
6844 | @vindex gnus-summary-dummy-line-format | |
6845 | @vindex gnus-summary-make-false-root-always | |
6846 | Gnus will create a dummy summary line that will pretend to be the | |
6847 | parent. This dummy line does not correspond to any real article, so | |
6848 | selecting it will just select the first real article after the dummy | |
6849 | article. @code{gnus-summary-dummy-line-format} is used to specify the | |
6850 | format of the dummy roots. It accepts only one format spec: @samp{S}, | |
6851 | which is the subject of the article. @xref{Formatting Variables}. | |
6852 | If you want all threads to have a dummy root, even the non-gathered | |
6853 | ones, set @code{gnus-summary-make-false-root-always} to @code{t}. | |
4009494e | 6854 | |
8a1cdce5 AC |
6855 | @item empty |
6856 | Gnus won't actually make any article the parent, but simply leave the | |
6857 | subject field of all orphans except the first empty. (Actually, it will | |
6858 | use @code{gnus-summary-same-subject} as the subject (@pxref{Summary | |
6859 | Buffer Format}).) | |
4009494e | 6860 | |
8a1cdce5 AC |
6861 | @item none |
6862 | Don't make any article parent at all. Just gather the threads and | |
6863 | display them after one another. | |
4009494e | 6864 | |
8a1cdce5 AC |
6865 | @item nil |
6866 | Don't gather loose threads. | |
6867 | @end table | |
4009494e | 6868 | |
8a1cdce5 AC |
6869 | @item gnus-summary-gather-subject-limit |
6870 | @vindex gnus-summary-gather-subject-limit | |
6871 | Loose threads are gathered by comparing subjects of articles. If this | |
6872 | variable is @code{nil}, Gnus requires an exact match between the | |
6873 | subjects of the loose threads before gathering them into one big | |
6874 | super-thread. This might be too strict a requirement, what with the | |
6875 | presence of stupid newsreaders that chop off long subject lines. If | |
6876 | you think so, set this variable to, say, 20 to require that only the | |
6877 | first 20 characters of the subjects have to match. If you set this | |
6878 | variable to a really low number, you'll find that Gnus will gather | |
6879 | everything in sight into one thread, which isn't very helpful. | |
4009494e | 6880 | |
8a1cdce5 AC |
6881 | @cindex fuzzy article gathering |
6882 | If you set this variable to the special value @code{fuzzy}, Gnus will | |
6883 | use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy | |
6884 | Matching}). | |
4009494e | 6885 | |
8a1cdce5 AC |
6886 | @item gnus-simplify-subject-fuzzy-regexp |
6887 | @vindex gnus-simplify-subject-fuzzy-regexp | |
6888 | This can either be a regular expression or list of regular expressions | |
6889 | that match strings that will be removed from subjects if fuzzy subject | |
6890 | simplification is used. | |
4009494e | 6891 | |
8a1cdce5 AC |
6892 | @item gnus-simplify-ignored-prefixes |
6893 | @vindex gnus-simplify-ignored-prefixes | |
6894 | If you set @code{gnus-summary-gather-subject-limit} to something as low | |
6895 | as 10, you might consider setting this variable to something sensible: | |
4009494e | 6896 | |
8a1cdce5 AC |
6897 | @c Written by Michael Ernst <mernst@cs.rice.edu> |
6898 | @lisp | |
6899 | (setq gnus-simplify-ignored-prefixes | |
6900 | (concat | |
6901 | "\\`\\[?\\(" | |
6902 | (mapconcat | |
6903 | 'identity | |
6904 | '("looking" | |
6905 | "wanted" "followup" "summary\\( of\\)?" | |
6906 | "help" "query" "problem" "question" | |
6907 | "answer" "reference" "announce" | |
6908 | "How can I" "How to" "Comparison of" | |
6909 | ;; ... | |
6910 | ) | |
6911 | "\\|") | |
6912 | "\\)\\s *\\(" | |
6913 | (mapconcat 'identity | |
6914 | '("for" "for reference" "with" "about") | |
6915 | "\\|") | |
6916 | "\\)?\\]?:?[ \t]*")) | |
6917 | @end lisp | |
4009494e | 6918 | |
8a1cdce5 AC |
6919 | All words that match this regexp will be removed before comparing two |
6920 | subjects. | |
4009494e | 6921 | |
8a1cdce5 AC |
6922 | @item gnus-simplify-subject-functions |
6923 | @vindex gnus-simplify-subject-functions | |
6924 | If non-@code{nil}, this variable overrides | |
6925 | @code{gnus-summary-gather-subject-limit}. This variable should be a | |
6926 | list of functions to apply to the @code{Subject} string iteratively to | |
6927 | arrive at the simplified version of the string. | |
4009494e | 6928 | |
8a1cdce5 | 6929 | Useful functions to put in this list include: |
4009494e | 6930 | |
8a1cdce5 AC |
6931 | @table @code |
6932 | @item gnus-simplify-subject-re | |
6933 | @findex gnus-simplify-subject-re | |
6934 | Strip the leading @samp{Re:}. | |
4009494e | 6935 | |
8a1cdce5 AC |
6936 | @item gnus-simplify-subject-fuzzy |
6937 | @findex gnus-simplify-subject-fuzzy | |
6938 | Simplify fuzzily. | |
4009494e | 6939 | |
8a1cdce5 AC |
6940 | @item gnus-simplify-whitespace |
6941 | @findex gnus-simplify-whitespace | |
6942 | Remove excessive whitespace. | |
4009494e | 6943 | |
8a1cdce5 AC |
6944 | @item gnus-simplify-all-whitespace |
6945 | @findex gnus-simplify-all-whitespace | |
6946 | Remove all whitespace. | |
6947 | @end table | |
4009494e | 6948 | |
8a1cdce5 | 6949 | You may also write your own functions, of course. |
4009494e | 6950 | |
4009494e | 6951 | |
8a1cdce5 AC |
6952 | @item gnus-summary-gather-exclude-subject |
6953 | @vindex gnus-summary-gather-exclude-subject | |
6954 | Since loose thread gathering is done on subjects only, that might lead | |
6955 | to many false hits, especially with certain common subjects like | |
6956 | @samp{} and @samp{(none)}. To make the situation slightly better, | |
6957 | you can use the regexp @code{gnus-summary-gather-exclude-subject} to say | |
6958 | what subjects should be excluded from the gathering process.@* | |
6959 | The default is @samp{^ *$\\|^(none)$}. | |
4009494e | 6960 | |
8a1cdce5 AC |
6961 | @item gnus-summary-thread-gathering-function |
6962 | @vindex gnus-summary-thread-gathering-function | |
6963 | Gnus gathers threads by looking at @code{Subject} headers. This means | |
6964 | that totally unrelated articles may end up in the same ``thread'', which | |
6965 | is confusing. An alternate approach is to look at all the | |
6966 | @code{Message-ID}s in all the @code{References} headers to find matches. | |
6967 | This will ensure that no gathered threads ever include unrelated | |
6968 | articles, but it also means that people who have posted with broken | |
6969 | newsreaders won't be gathered properly. The choice is yours---plague or | |
6970 | cholera: | |
4009494e | 6971 | |
8a1cdce5 AC |
6972 | @table @code |
6973 | @item gnus-gather-threads-by-subject | |
6974 | @findex gnus-gather-threads-by-subject | |
6975 | This function is the default gathering function and looks at | |
6976 | @code{Subject}s exclusively. | |
4009494e | 6977 | |
8a1cdce5 AC |
6978 | @item gnus-gather-threads-by-references |
6979 | @findex gnus-gather-threads-by-references | |
6980 | This function looks at @code{References} headers exclusively. | |
6981 | @end table | |
4009494e | 6982 | |
8a1cdce5 AC |
6983 | If you want to test gathering by @code{References}, you could say |
6984 | something like: | |
4009494e | 6985 | |
8a1cdce5 AC |
6986 | @lisp |
6987 | (setq gnus-summary-thread-gathering-function | |
6988 | 'gnus-gather-threads-by-references) | |
6989 | @end lisp | |
4009494e | 6990 | |
8a1cdce5 | 6991 | @end table |
4009494e | 6992 | |
4009494e | 6993 | |
8a1cdce5 AC |
6994 | @node Filling In Threads |
6995 | @subsubsection Filling In Threads | |
4009494e | 6996 | |
8a1cdce5 AC |
6997 | @table @code |
6998 | @item gnus-fetch-old-headers | |
6999 | @vindex gnus-fetch-old-headers | |
7000 | If non-@code{nil}, Gnus will attempt to build old threads by fetching | |
7001 | more old headers---headers to articles marked as read. If you would | |
7002 | like to display as few summary lines as possible, but still connect as | |
7003 | many loose threads as possible, you should set this variable to | |
7004 | @code{some} or a number. If you set it to a number, no more than that | |
7005 | number of extra old headers will be fetched. In either case, fetching | |
7006 | old headers only works if the back end you are using carries overview | |
7007 | files---this would normally be @code{nntp}, @code{nnspool}, | |
7008 | @code{nnml}, and @code{nnmaildir}. Also remember that if the root of | |
7009 | the thread has been expired by the server, there's not much Gnus can | |
7010 | do about that. | |
4009494e | 7011 | |
8a1cdce5 AC |
7012 | This variable can also be set to @code{invisible}. This won't have any |
7013 | visible effects, but is useful if you use the @kbd{A T} command a lot | |
7014 | (@pxref{Finding the Parent}). | |
4009494e | 7015 | |
8a1cdce5 | 7016 | The server has to support @acronym{NOV} for any of this to work. |
4009494e | 7017 | |
8a1cdce5 AC |
7018 | @cindex Gmane, gnus-fetch-old-headers |
7019 | This feature can seriously impact performance it ignores all locally | |
7020 | cached header entries. Setting it to @code{t} for groups for a server | |
7021 | that doesn't expire articles (such as news.gmane.org), leads to very | |
7022 | slow summary generation. | |
4009494e | 7023 | |
8a1cdce5 AC |
7024 | @item gnus-fetch-old-ephemeral-headers |
7025 | @vindex gnus-fetch-old-ephemeral-headers | |
7026 | Same as @code{gnus-fetch-old-headers}, but only used for ephemeral | |
7027 | newsgroups. | |
4009494e | 7028 | |
8a1cdce5 AC |
7029 | @item gnus-build-sparse-threads |
7030 | @vindex gnus-build-sparse-threads | |
7031 | Fetching old headers can be slow. A low-rent similar effect can be | |
7032 | gotten by setting this variable to @code{some}. Gnus will then look at | |
7033 | the complete @code{References} headers of all articles and try to string | |
7034 | together articles that belong in the same thread. This will leave | |
7035 | @dfn{gaps} in the threading display where Gnus guesses that an article | |
7036 | is missing from the thread. (These gaps appear like normal summary | |
7037 | lines. If you select a gap, Gnus will try to fetch the article in | |
7038 | question.) If this variable is @code{t}, Gnus will display all these | |
7039 | ``gaps'' without regard for whether they are useful for completing the | |
7040 | thread or not. Finally, if this variable is @code{more}, Gnus won't cut | |
7041 | off sparse leaf nodes that don't lead anywhere. This variable is | |
7042 | @code{nil} by default. | |
4009494e | 7043 | |
8a1cdce5 AC |
7044 | @item gnus-read-all-available-headers |
7045 | @vindex gnus-read-all-available-headers | |
7046 | This is a rather obscure variable that few will find useful. It's | |
7047 | intended for those non-news newsgroups where the back end has to fetch | |
7048 | quite a lot to present the summary buffer, and where it's impossible to | |
7049 | go back to parents of articles. This is mostly the case in the | |
7050 | web-based groups. | |
4009494e | 7051 | |
8a1cdce5 AC |
7052 | If you don't use those, then it's safe to leave this as the default |
7053 | @code{nil}. If you want to use this variable, it should be a regexp | |
7054 | that matches the group name, or @code{t} for all groups. | |
4009494e | 7055 | |
8a1cdce5 | 7056 | @end table |
4009494e | 7057 | |
4009494e | 7058 | |
8a1cdce5 AC |
7059 | @node More Threading |
7060 | @subsubsection More Threading | |
4009494e | 7061 | |
8a1cdce5 AC |
7062 | @table @code |
7063 | @item gnus-show-threads | |
7064 | @vindex gnus-show-threads | |
7065 | If this variable is @code{nil}, no threading will be done, and all of | |
7066 | the rest of the variables here will have no effect. Turning threading | |
7067 | off will speed group selection up a bit, but it is sure to make reading | |
7068 | slower and more awkward. | |
4009494e | 7069 | |
8a1cdce5 AC |
7070 | @item gnus-thread-hide-subtree |
7071 | @vindex gnus-thread-hide-subtree | |
7072 | If non-@code{nil}, all threads will be hidden when the summary buffer is | |
7073 | generated. | |
4009494e | 7074 | |
8a1cdce5 AC |
7075 | This can also be a predicate specifier (@pxref{Predicate Specifiers}). |
7076 | Available predicates are @code{gnus-article-unread-p} and | |
7077 | @code{gnus-article-unseen-p}. | |
4009494e | 7078 | |
8a1cdce5 | 7079 | Here's an example: |
4009494e | 7080 | |
8a1cdce5 AC |
7081 | @lisp |
7082 | (setq gnus-thread-hide-subtree | |
7083 | '(or gnus-article-unread-p | |
7084 | gnus-article-unseen-p)) | |
7085 | @end lisp | |
4009494e | 7086 | |
8a1cdce5 AC |
7087 | (It's a pretty nonsensical example, since all unseen articles are also |
7088 | unread, but you get my drift.) | |
4009494e | 7089 | |
4009494e | 7090 | |
8a1cdce5 AC |
7091 | @item gnus-thread-expunge-below |
7092 | @vindex gnus-thread-expunge-below | |
7093 | All threads that have a total score (as defined by | |
7094 | @code{gnus-thread-score-function}) less than this number will be | |
7095 | expunged. This variable is @code{nil} by default, which means that no | |
7096 | threads are expunged. | |
4009494e | 7097 | |
8a1cdce5 AC |
7098 | @item gnus-thread-hide-killed |
7099 | @vindex gnus-thread-hide-killed | |
7100 | if you kill a thread and this variable is non-@code{nil}, the subtree | |
7101 | will be hidden. | |
4009494e | 7102 | |
8a1cdce5 AC |
7103 | @item gnus-thread-ignore-subject |
7104 | @vindex gnus-thread-ignore-subject | |
7105 | Sometimes somebody changes the subject in the middle of a thread. If | |
7106 | this variable is non-@code{nil}, which is the default, the subject | |
7107 | change is ignored. If it is @code{nil}, a change in the subject will | |
7108 | result in a new thread. | |
4009494e | 7109 | |
8a1cdce5 AC |
7110 | @item gnus-thread-indent-level |
7111 | @vindex gnus-thread-indent-level | |
7112 | This is a number that says how much each sub-thread should be indented. | |
7113 | The default is 4. | |
4009494e | 7114 | |
8a1cdce5 AC |
7115 | @item gnus-sort-gathered-threads-function |
7116 | @vindex gnus-sort-gathered-threads-function | |
7117 | Sometimes, particularly with mailing lists, the order in which mails | |
7118 | arrive locally is not necessarily the same as the order in which they | |
7119 | arrived on the mailing list. Consequently, when sorting sub-threads | |
7120 | using the default @code{gnus-thread-sort-by-number}, responses can end | |
7121 | up appearing before the article to which they are responding to. | |
7122 | Setting this variable to an alternate value | |
1df7defd PE |
7123 | (e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an |
7124 | appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a | |
8a1cdce5 | 7125 | more logical sub-thread ordering in such instances. |
4009494e | 7126 | |
8a1cdce5 | 7127 | @end table |
4009494e | 7128 | |
4009494e | 7129 | |
8a1cdce5 AC |
7130 | @node Low-Level Threading |
7131 | @subsubsection Low-Level Threading | |
4009494e | 7132 | |
8a1cdce5 | 7133 | @table @code |
4009494e | 7134 | |
8a1cdce5 AC |
7135 | @item gnus-parse-headers-hook |
7136 | @vindex gnus-parse-headers-hook | |
7137 | Hook run before parsing any headers. | |
4009494e | 7138 | |
8a1cdce5 AC |
7139 | @item gnus-alter-header-function |
7140 | @vindex gnus-alter-header-function | |
7141 | If non-@code{nil}, this function will be called to allow alteration of | |
7142 | article header structures. The function is called with one parameter, | |
7143 | the article header vector, which it may alter in any way. For instance, | |
7144 | if you have a mail-to-news gateway which alters the @code{Message-ID}s | |
7145 | in systematic ways (by adding prefixes and such), you can use this | |
7146 | variable to un-scramble the @code{Message-ID}s so that they are more | |
7147 | meaningful. Here's one example: | |
4009494e | 7148 | |
8a1cdce5 AC |
7149 | @lisp |
7150 | (setq gnus-alter-header-function 'my-alter-message-id) | |
7151 | ||
7152 | (defun my-alter-message-id (header) | |
7153 | (let ((id (mail-header-id header))) | |
7154 | (when (string-match | |
7155 | "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id) | |
7156 | (mail-header-set-id | |
7157 | (concat (match-string 1 id) "@@" (match-string 2 id)) | |
7158 | header)))) | |
7159 | @end lisp | |
4009494e | 7160 | |
8a1cdce5 | 7161 | @end table |
4009494e | 7162 | |
4009494e | 7163 | |
8a1cdce5 AC |
7164 | @node Thread Commands |
7165 | @subsection Thread Commands | |
7166 | @cindex thread commands | |
4009494e | 7167 | |
8a1cdce5 | 7168 | @table @kbd |
4009494e | 7169 | |
8a1cdce5 AC |
7170 | @item T k |
7171 | @itemx C-M-k | |
7172 | @kindex T k (Summary) | |
7173 | @kindex C-M-k (Summary) | |
7174 | @findex gnus-summary-kill-thread | |
7175 | Mark all articles in the current (sub-)thread as read | |
7176 | (@code{gnus-summary-kill-thread}). If the prefix argument is positive, | |
7177 | remove all marks instead. If the prefix argument is negative, tick | |
7178 | articles instead. | |
4009494e | 7179 | |
8a1cdce5 AC |
7180 | @item T l |
7181 | @itemx C-M-l | |
7182 | @kindex T l (Summary) | |
7183 | @kindex C-M-l (Summary) | |
7184 | @findex gnus-summary-lower-thread | |
7185 | Lower the score of the current (sub-)thread | |
7186 | (@code{gnus-summary-lower-thread}). | |
7187 | ||
7188 | @item T i | |
7189 | @kindex T i (Summary) | |
7190 | @findex gnus-summary-raise-thread | |
7191 | Increase the score of the current (sub-)thread | |
7192 | (@code{gnus-summary-raise-thread}). | |
7193 | ||
7194 | @item T # | |
7195 | @kindex T # (Summary) | |
4009494e | 7196 | @findex gnus-uu-mark-thread |
8a1cdce5 | 7197 | Set the process mark on the current (sub-)thread |
4009494e GM |
7198 | (@code{gnus-uu-mark-thread}). |
7199 | ||
8a1cdce5 AC |
7200 | @item T M-# |
7201 | @kindex T M-# (Summary) | |
4009494e | 7202 | @findex gnus-uu-unmark-thread |
8a1cdce5 | 7203 | Remove the process mark from the current (sub-)thread |
4009494e GM |
7204 | (@code{gnus-uu-unmark-thread}). |
7205 | ||
8a1cdce5 AC |
7206 | @item T T |
7207 | @kindex T T (Summary) | |
7208 | @findex gnus-summary-toggle-threads | |
7209 | Toggle threading (@code{gnus-summary-toggle-threads}). | |
4009494e | 7210 | |
8a1cdce5 AC |
7211 | @item T s |
7212 | @kindex T s (Summary) | |
7213 | @findex gnus-summary-show-thread | |
7214 | Expose the (sub-)thread hidden under the current article, if any@* | |
7215 | (@code{gnus-summary-show-thread}). | |
4009494e | 7216 | |
8a1cdce5 AC |
7217 | @item T h |
7218 | @kindex T h (Summary) | |
7219 | @findex gnus-summary-hide-thread | |
7220 | Hide the current (sub-)thread (@code{gnus-summary-hide-thread}). | |
4009494e | 7221 | |
8a1cdce5 AC |
7222 | @item T S |
7223 | @kindex T S (Summary) | |
7224 | @findex gnus-summary-show-all-threads | |
7225 | Expose all hidden threads (@code{gnus-summary-show-all-threads}). | |
4009494e | 7226 | |
8a1cdce5 AC |
7227 | @item T H |
7228 | @kindex T H (Summary) | |
7229 | @findex gnus-summary-hide-all-threads | |
7230 | Hide all threads (@code{gnus-summary-hide-all-threads}). | |
4009494e | 7231 | |
8a1cdce5 AC |
7232 | @item T t |
7233 | @kindex T t (Summary) | |
7234 | @findex gnus-summary-rethread-current | |
7235 | Re-thread the current article's thread | |
7236 | (@code{gnus-summary-rethread-current}). This works even when the | |
7237 | summary buffer is otherwise unthreaded. | |
4009494e | 7238 | |
8a1cdce5 AC |
7239 | @item T ^ |
7240 | @kindex T ^ (Summary) | |
7241 | @findex gnus-summary-reparent-thread | |
7242 | Make the current article the child of the marked (or previous) article | |
7243 | (@code{gnus-summary-reparent-thread}). | |
4009494e | 7244 | |
8a1cdce5 AC |
7245 | @item T M-^ |
7246 | @kindex T M-^ (Summary) | |
7247 | @findex gnus-summary-reparent-children | |
7248 | Make the current article the parent of the marked articles | |
7249 | (@code{gnus-summary-reparent-children}). | |
4009494e GM |
7250 | |
7251 | @end table | |
7252 | ||
8a1cdce5 AC |
7253 | The following commands are thread movement commands. They all |
7254 | understand the numeric prefix. | |
4009494e GM |
7255 | |
7256 | @table @kbd | |
7257 | ||
8a1cdce5 AC |
7258 | @item T n |
7259 | @kindex T n (Summary) | |
7260 | @itemx C-M-f | |
7261 | @kindex C-M-n (Summary) | |
7262 | @itemx M-down | |
7263 | @kindex M-down (Summary) | |
7264 | @findex gnus-summary-next-thread | |
7265 | Go to the next thread (@code{gnus-summary-next-thread}). | |
01c52d31 | 7266 | |
8a1cdce5 AC |
7267 | @item T p |
7268 | @kindex T p (Summary) | |
7269 | @itemx C-M-b | |
7270 | @kindex C-M-p (Summary) | |
7271 | @itemx M-up | |
7272 | @kindex M-up (Summary) | |
7273 | @findex gnus-summary-prev-thread | |
7274 | Go to the previous thread (@code{gnus-summary-prev-thread}). | |
01c52d31 | 7275 | |
8a1cdce5 AC |
7276 | @item T d |
7277 | @kindex T d (Summary) | |
7278 | @findex gnus-summary-down-thread | |
7279 | Descend the thread (@code{gnus-summary-down-thread}). | |
4009494e | 7280 | |
8a1cdce5 AC |
7281 | @item T u |
7282 | @kindex T u (Summary) | |
7283 | @findex gnus-summary-up-thread | |
7284 | Ascend the thread (@code{gnus-summary-up-thread}). | |
4009494e | 7285 | |
8a1cdce5 AC |
7286 | @item T o |
7287 | @kindex T o (Summary) | |
7288 | @findex gnus-summary-top-thread | |
7289 | Go to the top of the thread (@code{gnus-summary-top-thread}). | |
7290 | @end table | |
4009494e | 7291 | |
8a1cdce5 AC |
7292 | @vindex gnus-thread-operation-ignore-subject |
7293 | If you ignore subject while threading, you'll naturally end up with | |
7294 | threads that have several different subjects in them. If you then issue | |
7295 | a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not | |
7296 | wish to kill the entire thread, but just those parts of the thread that | |
7297 | have the same subject as the current article. If you like this idea, | |
7298 | you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it | |
7299 | is non-@code{nil} (which it is by default), subjects will be ignored | |
7300 | when doing thread commands. If this variable is @code{nil}, articles in | |
7301 | the same thread with different subjects will not be included in the | |
7302 | operation in question. If this variable is @code{fuzzy}, only articles | |
7303 | that have subjects fuzzily equal will be included (@pxref{Fuzzy | |
7304 | Matching}). | |
4009494e | 7305 | |
4009494e | 7306 | |
8a1cdce5 AC |
7307 | @node Sorting the Summary Buffer |
7308 | @section Sorting the Summary Buffer | |
4009494e | 7309 | |
8a1cdce5 AC |
7310 | @findex gnus-thread-sort-by-total-score |
7311 | @findex gnus-thread-sort-by-date | |
7312 | @findex gnus-thread-sort-by-score | |
7313 | @findex gnus-thread-sort-by-subject | |
7314 | @findex gnus-thread-sort-by-author | |
7315 | @findex gnus-thread-sort-by-recipient | |
7316 | @findex gnus-thread-sort-by-number | |
7317 | @findex gnus-thread-sort-by-random | |
7318 | @vindex gnus-thread-sort-functions | |
7319 | @findex gnus-thread-sort-by-most-recent-number | |
7320 | @findex gnus-thread-sort-by-most-recent-date | |
7321 | If you are using a threaded summary display, you can sort the threads by | |
7322 | setting @code{gnus-thread-sort-functions}, which can be either a single | |
7323 | function, a list of functions, or a list containing functions and | |
7324 | @code{(not some-function)} elements. | |
4009494e | 7325 | |
8a1cdce5 AC |
7326 | By default, sorting is done on article numbers. Ready-made sorting |
7327 | predicate functions include @code{gnus-thread-sort-by-number}, | |
7328 | @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient}, | |
7329 | @code{gnus-thread-sort-by-subject}, | |
7330 | @code{gnus-thread-sort-by-date}, | |
7331 | @code{gnus-thread-sort-by-score}, | |
7332 | @code{gnus-thread-sort-by-most-recent-number}, | |
7333 | @code{gnus-thread-sort-by-most-recent-date}, | |
7334 | @code{gnus-thread-sort-by-random} and | |
7335 | @code{gnus-thread-sort-by-total-score}. | |
4009494e | 7336 | |
8a1cdce5 AC |
7337 | Each function takes two threads and returns non-@code{nil} if the first |
7338 | thread should be sorted before the other. Note that sorting really is | |
c2f51e23 G |
7339 | normally done by looking only at the roots of each thread. Exceptions |
7340 | to this rule are @code{gnus-thread-sort-by-most-recent-number} and | |
7341 | @code{gnus-thread-sort-by-most-recent-date}. | |
4009494e | 7342 | |
8a1cdce5 AC |
7343 | If you use more than one function, the primary sort key should be the |
7344 | last function in the list. You should probably always include | |
7345 | @code{gnus-thread-sort-by-number} in the list of sorting | |
7346 | functions---preferably first. This will ensure that threads that are | |
7347 | equal with respect to the other sort criteria will be displayed in | |
7348 | ascending article order. | |
01c52d31 | 7349 | |
8a1cdce5 AC |
7350 | If you would like to sort by reverse score, then by subject, and finally |
7351 | by number, you could do something like: | |
4009494e | 7352 | |
8a1cdce5 AC |
7353 | @lisp |
7354 | (setq gnus-thread-sort-functions | |
7355 | '(gnus-thread-sort-by-number | |
7356 | gnus-thread-sort-by-subject | |
7357 | (not gnus-thread-sort-by-total-score))) | |
7358 | @end lisp | |
4009494e | 7359 | |
8a1cdce5 AC |
7360 | The threads that have highest score will be displayed first in the |
7361 | summary buffer. When threads have the same score, they will be sorted | |
7362 | alphabetically. The threads that have the same score and the same | |
7363 | subject will be sorted by number, which is (normally) the sequence in | |
7364 | which the articles arrived. | |
4009494e | 7365 | |
8a1cdce5 AC |
7366 | If you want to sort by score and then reverse arrival order, you could |
7367 | say something like: | |
4009494e | 7368 | |
8a1cdce5 AC |
7369 | @lisp |
7370 | (setq gnus-thread-sort-functions | |
7371 | '((not gnus-thread-sort-by-number) | |
7372 | gnus-thread-sort-by-score)) | |
7373 | @end lisp | |
4009494e | 7374 | |
8a1cdce5 AC |
7375 | @vindex gnus-thread-score-function |
7376 | The function in the @code{gnus-thread-score-function} variable (default | |
7377 | @code{+}) is used for calculating the total score of a thread. Useful | |
7378 | functions might be @code{max}, @code{min}, or squared means, or whatever | |
7379 | tickles your fancy. | |
4009494e | 7380 | |
8a1cdce5 AC |
7381 | @findex gnus-article-sort-functions |
7382 | @findex gnus-article-sort-by-date | |
7383 | @findex gnus-article-sort-by-most-recent-date | |
7384 | @findex gnus-article-sort-by-score | |
7385 | @findex gnus-article-sort-by-subject | |
7386 | @findex gnus-article-sort-by-author | |
7387 | @findex gnus-article-sort-by-random | |
7388 | @findex gnus-article-sort-by-number | |
7389 | @findex gnus-article-sort-by-most-recent-number | |
7390 | If you are using an unthreaded display for some strange reason or | |
7391 | other, you have to fiddle with the @code{gnus-article-sort-functions} | |
7392 | variable. It is very similar to the | |
7393 | @code{gnus-thread-sort-functions}, except that it uses slightly | |
7394 | different functions for article comparison. Available sorting | |
7395 | predicate functions are @code{gnus-article-sort-by-number}, | |
7396 | @code{gnus-article-sort-by-author}, | |
7397 | @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date}, | |
7398 | @code{gnus-article-sort-by-random}, and | |
7399 | @code{gnus-article-sort-by-score}. | |
4009494e | 7400 | |
8a1cdce5 AC |
7401 | If you want to sort an unthreaded summary display by subject, you could |
7402 | say something like: | |
4009494e | 7403 | |
8a1cdce5 AC |
7404 | @lisp |
7405 | (setq gnus-article-sort-functions | |
7406 | '(gnus-article-sort-by-number | |
7407 | gnus-article-sort-by-subject)) | |
7408 | @end lisp | |
01c52d31 | 7409 | |
8a1cdce5 AC |
7410 | You can define group specific sorting via @code{gnus-parameters}, |
7411 | @xref{Group Parameters}. | |
01c52d31 | 7412 | |
4009494e | 7413 | |
8a1cdce5 AC |
7414 | @node Asynchronous Fetching |
7415 | @section Asynchronous Article Fetching | |
7416 | @cindex asynchronous article fetching | |
7417 | @cindex article pre-fetch | |
7418 | @cindex pre-fetch | |
4009494e | 7419 | |
8a1cdce5 AC |
7420 | If you read your news from an @acronym{NNTP} server that's far away, the |
7421 | network latencies may make reading articles a chore. You have to wait | |
7422 | for a while after pressing @kbd{n} to go to the next article before the | |
7423 | article appears. Why can't Gnus just go ahead and fetch the article | |
7424 | while you are reading the previous one? Why not, indeed. | |
26b9f88d | 7425 | |
8a1cdce5 AC |
7426 | First, some caveats. There are some pitfalls to using asynchronous |
7427 | article fetching, especially the way Gnus does it. | |
26b9f88d | 7428 | |
8a1cdce5 AC |
7429 | Let's say you are reading article 1, which is short, and article 2 is |
7430 | quite long, and you are not interested in reading that. Gnus does not | |
7431 | know this, so it goes ahead and fetches article 2. You decide to read | |
7432 | article 3, but since Gnus is in the process of fetching article 2, the | |
7433 | connection is blocked. | |
26b9f88d | 7434 | |
8a1cdce5 AC |
7435 | To avoid these situations, Gnus will open two (count 'em two) |
7436 | connections to the server. Some people may think this isn't a very nice | |
7437 | thing to do, but I don't see any real alternatives. Setting up that | |
7438 | extra connection takes some time, so Gnus startup will be slower. | |
26b9f88d | 7439 | |
8a1cdce5 AC |
7440 | Gnus will fetch more articles than you will read. This will mean that |
7441 | the link between your machine and the @acronym{NNTP} server will become more | |
7442 | loaded than if you didn't use article pre-fetch. The server itself will | |
7443 | also become more loaded---both with the extra article requests, and the | |
7444 | extra connection. | |
26b9f88d | 7445 | |
8a1cdce5 AC |
7446 | Ok, so now you know that you shouldn't really use this thing@dots{} unless |
7447 | you really want to. | |
4009494e | 7448 | |
8a1cdce5 AC |
7449 | @vindex gnus-asynchronous |
7450 | Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should | |
7451 | happen automatically. | |
4009494e | 7452 | |
8a1cdce5 AC |
7453 | @vindex gnus-use-article-prefetch |
7454 | You can control how many articles are to be pre-fetched by setting | |
7455 | @code{gnus-use-article-prefetch}. This is 30 by default, which means | |
7456 | that when you read an article in the group, the back end will pre-fetch | |
7457 | the next 30 articles. If this variable is @code{t}, the back end will | |
7458 | pre-fetch all the articles it can without bound. If it is | |
7459 | @code{nil}, no pre-fetching will be done. | |
7460 | ||
7461 | @vindex gnus-async-prefetch-article-p | |
7462 | @findex gnus-async-unread-p | |
7463 | There are probably some articles that you don't want to pre-fetch---read | |
7464 | articles, for instance. The @code{gnus-async-prefetch-article-p} | |
7465 | variable controls whether an article is to be pre-fetched. This | |
7466 | function should return non-@code{nil} when the article in question is | |
7467 | to be pre-fetched. The default is @code{gnus-async-unread-p}, which | |
7468 | returns @code{nil} on read articles. The function is called with an | |
7469 | article data structure as the only parameter. | |
4009494e | 7470 | |
8a1cdce5 AC |
7471 | If, for instance, you wish to pre-fetch only unread articles shorter |
7472 | than 100 lines, you could say something like: | |
4009494e | 7473 | |
8a1cdce5 AC |
7474 | @lisp |
7475 | (defun my-async-short-unread-p (data) | |
7476 | "Return non-nil for short, unread articles." | |
7477 | (and (gnus-data-unread-p data) | |
7478 | (< (mail-header-lines (gnus-data-header data)) | |
7479 | 100))) | |
4009494e | 7480 | |
8a1cdce5 AC |
7481 | (setq gnus-async-prefetch-article-p 'my-async-short-unread-p) |
7482 | @end lisp | |
4009494e | 7483 | |
8a1cdce5 AC |
7484 | These functions will be called many, many times, so they should |
7485 | preferably be short and sweet to avoid slowing down Gnus too much. | |
7486 | It's probably a good idea to byte-compile things like this. | |
4009494e | 7487 | |
8a1cdce5 AC |
7488 | @vindex gnus-async-post-fetch-function |
7489 | @findex gnus-html-prefetch-images | |
7490 | After an article has been prefetched, this | |
7491 | @code{gnus-async-post-fetch-function} will be called. The buffer will | |
7492 | be narrowed to the region of the article that was fetched. A useful | |
7493 | value would be @code{gnus-html-prefetch-images}, which will prefetch | |
7494 | and store images referenced in the article, so that you don't have to | |
7495 | wait for them to be fetched when you read the article. This is useful | |
7496 | for @acronym{HTML} messages that have external images. | |
4009494e | 7497 | |
8a1cdce5 AC |
7498 | @vindex gnus-prefetched-article-deletion-strategy |
7499 | Articles have to be removed from the asynch buffer sooner or later. The | |
7500 | @code{gnus-prefetched-article-deletion-strategy} says when to remove | |
7501 | articles. This is a list that may contain the following elements: | |
4009494e | 7502 | |
8a1cdce5 AC |
7503 | @table @code |
7504 | @item read | |
7505 | Remove articles when they are read. | |
4009494e | 7506 | |
8a1cdce5 AC |
7507 | @item exit |
7508 | Remove articles when exiting the group. | |
4009494e GM |
7509 | @end table |
7510 | ||
8a1cdce5 | 7511 | The default value is @code{(read exit)}. |
4009494e | 7512 | |
8a1cdce5 AC |
7513 | @c @vindex gnus-use-header-prefetch |
7514 | @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles | |
7515 | @c from the next group. | |
4009494e | 7516 | |
4009494e | 7517 | |
8a1cdce5 AC |
7518 | @node Article Caching |
7519 | @section Article Caching | |
7520 | @cindex article caching | |
7521 | @cindex caching | |
4009494e | 7522 | |
8a1cdce5 AC |
7523 | If you have an @emph{extremely} slow @acronym{NNTP} connection, you may |
7524 | consider turning article caching on. Each article will then be stored | |
7525 | locally under your home directory. As you may surmise, this could | |
7526 | potentially use @emph{huge} amounts of disk space, as well as eat up all | |
7527 | your inodes so fast it will make your head swim. In vodka. | |
4009494e | 7528 | |
8a1cdce5 | 7529 | Used carefully, though, it could be just an easier way to save articles. |
4009494e | 7530 | |
8a1cdce5 AC |
7531 | @vindex gnus-use-long-file-name |
7532 | @vindex gnus-cache-directory | |
7533 | @vindex gnus-use-cache | |
7534 | To turn caching on, set @code{gnus-use-cache} to @code{t}. By default, | |
7535 | all articles ticked or marked as dormant will then be copied | |
7536 | over to your local cache (@code{gnus-cache-directory}). Whether this | |
7537 | cache is flat or hierarchical is controlled by the | |
7538 | @code{gnus-use-long-file-name} variable, as usual. | |
4009494e | 7539 | |
8a1cdce5 AC |
7540 | When re-selecting a ticked or dormant article, it will be fetched from the |
7541 | cache instead of from the server. As articles in your cache will never | |
7542 | expire, this might serve as a method of saving articles while still | |
7543 | keeping them where they belong. Just mark all articles you want to save | |
7544 | as dormant, and don't worry. | |
4009494e | 7545 | |
8a1cdce5 | 7546 | When an article is marked as read, is it removed from the cache. |
4009494e | 7547 | |
8a1cdce5 AC |
7548 | @vindex gnus-cache-remove-articles |
7549 | @vindex gnus-cache-enter-articles | |
7550 | The entering/removal of articles from the cache is controlled by the | |
7551 | @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles} | |
7552 | variables. Both are lists of symbols. The first is @code{(ticked | |
7553 | dormant)} by default, meaning that ticked and dormant articles will be | |
7554 | put in the cache. The latter is @code{(read)} by default, meaning that | |
7555 | articles marked as read are removed from the cache. Possibly | |
7556 | symbols in these two lists are @code{ticked}, @code{dormant}, | |
7557 | @code{unread} and @code{read}. | |
4009494e | 7558 | |
8a1cdce5 AC |
7559 | @findex gnus-jog-cache |
7560 | So where does the massive article-fetching and storing come into the | |
7561 | picture? The @code{gnus-jog-cache} command will go through all | |
7562 | subscribed newsgroups, request all unread articles, score them, and | |
7563 | store them in the cache. You should only ever, ever ever ever, use this | |
7564 | command if 1) your connection to the @acronym{NNTP} server is really, really, | |
7565 | really slow and 2) you have a really, really, really huge disk. | |
7566 | Seriously. One way to cut down on the number of articles downloaded is | |
7567 | to score unwanted articles down and have them marked as read. They will | |
7568 | not then be downloaded by this command. | |
4009494e | 7569 | |
8a1cdce5 AC |
7570 | @vindex gnus-uncacheable-groups |
7571 | @vindex gnus-cacheable-groups | |
7572 | It is likely that you do not want caching on all groups. For instance, | |
7573 | if your @code{nnml} mail is located under your home directory, it makes no | |
7574 | sense to cache it somewhere else under your home directory. Unless you | |
7575 | feel that it's neat to use twice as much space. | |
4009494e | 7576 | |
8a1cdce5 AC |
7577 | To limit the caching, you could set @code{gnus-cacheable-groups} to a |
7578 | regexp of groups to cache, @samp{^nntp} for instance, or set the | |
7579 | @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance. | |
7580 | Both variables are @code{nil} by default. If a group matches both | |
7581 | variables, the group is not cached. | |
4009494e | 7582 | |
8a1cdce5 AC |
7583 | @findex gnus-cache-generate-nov-databases |
7584 | @findex gnus-cache-generate-active | |
7585 | @vindex gnus-cache-active-file | |
7586 | The cache stores information on what articles it contains in its active | |
7587 | file (@code{gnus-cache-active-file}). If this file (or any other parts | |
7588 | of the cache) becomes all messed up for some reason or other, Gnus | |
7589 | offers two functions that will try to set things right. @kbd{M-x | |
7590 | gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV} | |
7591 | files, and @kbd{gnus-cache-generate-active} will (re)generate the active | |
7592 | file. | |
4009494e | 7593 | |
8a1cdce5 AC |
7594 | @findex gnus-cache-move-cache |
7595 | @code{gnus-cache-move-cache} will move your whole | |
7596 | @code{gnus-cache-directory} to some other location. You get asked to | |
7597 | where, isn't that cool? | |
4009494e | 7598 | |
8a1cdce5 AC |
7599 | @node Persistent Articles |
7600 | @section Persistent Articles | |
7601 | @cindex persistent articles | |
4009494e | 7602 | |
8a1cdce5 AC |
7603 | Closely related to article caching, we have @dfn{persistent articles}. |
7604 | In fact, it's just a different way of looking at caching, and much more | |
7605 | useful in my opinion. | |
4009494e | 7606 | |
8a1cdce5 AC |
7607 | Say you're reading a newsgroup, and you happen on to some valuable gem |
7608 | that you want to keep and treasure forever. You'd normally just save it | |
7609 | (using one of the many saving commands) in some file. The problem with | |
7610 | that is that it's just, well, yucky. Ideally you'd prefer just having | |
7611 | the article remain in the group where you found it forever; untouched by | |
7612 | the expiry going on at the news server. | |
4009494e | 7613 | |
8a1cdce5 AC |
7614 | This is what a @dfn{persistent article} is---an article that just won't |
7615 | be deleted. It's implemented using the normal cache functions, but | |
7616 | you use two explicit commands for managing persistent articles: | |
4009494e | 7617 | |
8a1cdce5 | 7618 | @table @kbd |
4009494e | 7619 | |
8a1cdce5 AC |
7620 | @item * |
7621 | @kindex * (Summary) | |
7622 | @findex gnus-cache-enter-article | |
7623 | Make the current article persistent (@code{gnus-cache-enter-article}). | |
7624 | ||
7625 | @item M-* | |
7626 | @kindex M-* (Summary) | |
7627 | @findex gnus-cache-remove-article | |
7628 | Remove the current article from the persistent articles | |
7629 | (@code{gnus-cache-remove-article}). This will normally delete the | |
7630 | article. | |
7631 | @end table | |
7632 | ||
7633 | Both these commands understand the process/prefix convention. | |
7634 | ||
7635 | To avoid having all ticked articles (and stuff) entered into the cache, | |
7636 | you should set @code{gnus-use-cache} to @code{passive} if you're just | |
7637 | interested in persistent articles: | |
7638 | ||
7639 | @lisp | |
7640 | (setq gnus-use-cache 'passive) | |
4009494e GM |
7641 | @end lisp |
7642 | ||
8a1cdce5 AC |
7643 | @node Sticky Articles |
7644 | @section Sticky Articles | |
7645 | @cindex sticky articles | |
4009494e | 7646 | |
8a1cdce5 AC |
7647 | When you select an article the current article buffer will be reused |
7648 | according to the value of the variable | |
7649 | @code{gnus-single-article-buffer}. If its value is non-@code{nil} (the | |
7650 | default) all articles reuse the same article buffer. Else each group | |
7651 | has its own article buffer. | |
4009494e | 7652 | |
8a1cdce5 AC |
7653 | This implies that it's not possible to have more than one article buffer |
7654 | in a group at a time. But sometimes you might want to display all the | |
7655 | latest emails from your mother, your father, your aunt, your uncle and | |
da6062e6 | 7656 | your 17 cousins to coordinate the next Christmas party. |
4009494e | 7657 | |
8a1cdce5 AC |
7658 | That's where sticky articles come in handy. A sticky article buffer |
7659 | basically is a normal article buffer, but it won't be reused when you | |
7660 | select another article. You can make an article sticky with: | |
4009494e | 7661 | |
8a1cdce5 AC |
7662 | @table @kbd |
7663 | @item A S | |
7664 | @kindex A S (Summary) | |
7665 | @findex gnus-sticky-article | |
7666 | Make the current article sticky. If a prefix arg is given, ask for a | |
7667 | name for this sticky article buffer. | |
7668 | @end table | |
4009494e | 7669 | |
8a1cdce5 | 7670 | To close a sticky article buffer you can use these commands: |
4009494e | 7671 | |
8a1cdce5 AC |
7672 | @table @kbd |
7673 | @item q | |
7674 | @kindex q (Article) | |
7675 | @findex bury-buffer | |
7676 | Puts this sticky article buffer at the end of the list of all buffers. | |
7677 | ||
7678 | @item k | |
7679 | @kindex k (Article) | |
7680 | @findex gnus-kill-sticky-article-buffer | |
7681 | Kills this sticky article buffer. | |
4009494e GM |
7682 | @end table |
7683 | ||
8a1cdce5 | 7684 | To kill all sticky article buffers you can use: |
4009494e | 7685 | |
8a1cdce5 AC |
7686 | @defun gnus-kill-sticky-article-buffers ARG |
7687 | Kill all sticky article buffers. | |
7688 | If a prefix ARG is given, ask for confirmation. | |
7689 | @end defun | |
4009494e | 7690 | |
8a1cdce5 AC |
7691 | @node Article Backlog |
7692 | @section Article Backlog | |
7693 | @cindex backlog | |
7694 | @cindex article backlog | |
4009494e | 7695 | |
8a1cdce5 AC |
7696 | If you have a slow connection, but the idea of using caching seems |
7697 | unappealing to you (and it is, really), you can help the situation some | |
7698 | by switching on the @dfn{backlog}. This is where Gnus will buffer | |
7699 | already read articles so that it doesn't have to re-fetch articles | |
7700 | you've already read. This only helps if you are in the habit of | |
7701 | re-selecting articles you've recently read, of course. If you never do | |
7702 | that, turning the backlog on will slow Gnus down a little bit, and | |
7703 | increase memory usage some. | |
4009494e | 7704 | |
8a1cdce5 AC |
7705 | @vindex gnus-keep-backlog |
7706 | If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store | |
7707 | at most @var{n} old articles in a buffer for later re-fetching. If this | |
7708 | variable is non-@code{nil} and is not a number, Gnus will store | |
7709 | @emph{all} read articles, which means that your Emacs will grow without | |
7710 | bound before exploding and taking your machine down with you. I put | |
7711 | that in there just to keep y'all on your toes. | |
4009494e | 7712 | |
8a1cdce5 | 7713 | The default value is 20. |
4009494e | 7714 | |
4009494e | 7715 | |
8a1cdce5 AC |
7716 | @node Saving Articles |
7717 | @section Saving Articles | |
7718 | @cindex saving articles | |
4009494e | 7719 | |
8a1cdce5 AC |
7720 | Gnus can save articles in a number of ways. Below is the documentation |
7721 | for saving articles in a fairly straight-forward fashion (i.e., little | |
7722 | processing of the article is done before it is saved). For a different | |
7723 | approach (uudecoding, unsharing) you should use @code{gnus-uu} | |
7724 | (@pxref{Decoding Articles}). | |
4009494e | 7725 | |
8a1cdce5 AC |
7726 | For the commands listed here, the target is a file. If you want to |
7727 | save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article}) | |
7728 | command (@pxref{Mail Group Commands}). | |
4009494e | 7729 | |
8a1cdce5 AC |
7730 | @vindex gnus-save-all-headers |
7731 | If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete | |
7732 | unwanted headers before saving the article. | |
4009494e | 7733 | |
8a1cdce5 AC |
7734 | @vindex gnus-saved-headers |
7735 | If the preceding variable is @code{nil}, all headers that match the | |
7736 | @code{gnus-saved-headers} regexp will be kept, while the rest will be | |
7737 | deleted before saving. | |
4009494e | 7738 | |
8a1cdce5 | 7739 | @table @kbd |
4009494e | 7740 | |
8a1cdce5 AC |
7741 | @item O o |
7742 | @itemx o | |
7743 | @kindex O o (Summary) | |
7744 | @kindex o (Summary) | |
7745 | @findex gnus-summary-save-article | |
7746 | @c @icon{gnus-summary-save-article} | |
7747 | Save the current article using the default article saver | |
7748 | (@code{gnus-summary-save-article}). | |
f394fa25 | 7749 | |
8a1cdce5 AC |
7750 | @item O m |
7751 | @kindex O m (Summary) | |
7752 | @findex gnus-summary-save-article-mail | |
7753 | Save the current article in a Unix mail box (mbox) file | |
7754 | (@code{gnus-summary-save-article-mail}). | |
f394fa25 | 7755 | |
8a1cdce5 AC |
7756 | @item O r |
7757 | @kindex O r (Summary) | |
7758 | @findex gnus-summary-save-article-rmail | |
7759 | Save the current article in Rmail format | |
7760 | (@code{gnus-summary-save-article-rmail}). This is mbox since Emacs 23, | |
7761 | Babyl in older versions. | |
4009494e | 7762 | |
8a1cdce5 AC |
7763 | @item O f |
7764 | @kindex O f (Summary) | |
7765 | @findex gnus-summary-save-article-file | |
7766 | @c @icon{gnus-summary-save-article-file} | |
7767 | Save the current article in plain file format | |
7768 | (@code{gnus-summary-save-article-file}). | |
4009494e | 7769 | |
8a1cdce5 AC |
7770 | @item O F |
7771 | @kindex O F (Summary) | |
7772 | @findex gnus-summary-write-article-file | |
7773 | Write the current article in plain file format, overwriting any previous | |
7774 | file contents (@code{gnus-summary-write-article-file}). | |
7775 | ||
7776 | @item O b | |
7777 | @kindex O b (Summary) | |
7778 | @findex gnus-summary-save-article-body-file | |
7779 | Save the current article body in plain file format | |
7780 | (@code{gnus-summary-save-article-body-file}). | |
7781 | ||
7782 | @item O h | |
7783 | @kindex O h (Summary) | |
7784 | @findex gnus-summary-save-article-folder | |
7785 | Save the current article in mh folder format | |
7786 | (@code{gnus-summary-save-article-folder}). | |
7787 | ||
7788 | @item O v | |
7789 | @kindex O v (Summary) | |
7790 | @findex gnus-summary-save-article-vm | |
7791 | Save the current article in a VM folder | |
7792 | (@code{gnus-summary-save-article-vm}). | |
7793 | ||
7794 | @item O p | |
7795 | @itemx | | |
7796 | @kindex O p (Summary) | |
7797 | @kindex | (Summary) | |
7798 | @findex gnus-summary-pipe-output | |
7799 | @vindex gnus-summary-pipe-output-default-command | |
7800 | Save the current article in a pipe. Uhm, like, what I mean is---Pipe | |
7801 | the current article to a process (@code{gnus-summary-pipe-output}). | |
7802 | If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the | |
7803 | complete headers in the piped output. The symbolic prefix @code{r} is | |
7804 | special; it lets this command pipe a raw article including all headers. | |
7805 | The @code{gnus-summary-pipe-output-default-command} variable can be set | |
7806 | to a string containing the default command and options (default | |
7807 | @code{nil}). | |
4009494e | 7808 | |
8a1cdce5 AC |
7809 | @item O P |
7810 | @kindex O P (Summary) | |
7811 | @findex gnus-summary-muttprint | |
7812 | @vindex gnus-summary-muttprint-program | |
7813 | Save the current article into muttprint. That is, print it using the | |
7814 | external program @uref{http://muttprint.sourceforge.net/, | |
7815 | Muttprint}. The program name and options to use is controlled by the | |
7816 | variable @code{gnus-summary-muttprint-program}. | |
7817 | (@code{gnus-summary-muttprint}). | |
4009494e GM |
7818 | |
7819 | @end table | |
7820 | ||
8a1cdce5 AC |
7821 | @vindex gnus-prompt-before-saving |
7822 | All these commands use the process/prefix convention | |
7823 | (@pxref{Process/Prefix}). If you save bunches of articles using these | |
7824 | functions, you might get tired of being prompted for files to save each | |
7825 | and every article in. The prompting action is controlled by | |
7826 | the @code{gnus-prompt-before-saving} variable, which is @code{always} by | |
7827 | default, giving you that excessive prompting action you know and | |
7828 | loathe. If you set this variable to @code{t} instead, you'll be prompted | |
7829 | just once for each series of articles you save. If you like to really | |
7830 | have Gnus do all your thinking for you, you can even set this variable | |
7831 | to @code{nil}, which means that you will never be prompted for files to | |
7832 | save articles in. Gnus will simply save all the articles in the default | |
7833 | files. | |
7834 | ||
4009494e | 7835 | |
8a1cdce5 AC |
7836 | @vindex gnus-default-article-saver |
7837 | You can customize the @code{gnus-default-article-saver} variable to make | |
7838 | Gnus do what you want it to. You can use any of the eight ready-made | |
7839 | functions below, or you can create your own. | |
4009494e GM |
7840 | |
7841 | @table @code | |
4009494e | 7842 | |
8a1cdce5 AC |
7843 | @item gnus-summary-save-in-rmail |
7844 | @findex gnus-summary-save-in-rmail | |
7845 | @vindex gnus-rmail-save-name | |
7846 | @findex gnus-plain-save-name | |
7847 | This is the default format, that used by the Rmail package. Since Emacs | |
7848 | 23, Rmail uses standard mbox format. Before this, it used the | |
7849 | @dfn{Babyl} format. Accordingly, this command writes mbox format since | |
7850 | Emacs 23, unless appending to an existing Babyl file. In older versions | |
7851 | of Emacs, it always uses Babyl format. Uses the function in the | |
7852 | @code{gnus-rmail-save-name} variable to get a file name to save the | |
7853 | article in. The default is @code{gnus-plain-save-name}. | |
4009494e | 7854 | |
8a1cdce5 AC |
7855 | @item gnus-summary-save-in-mail |
7856 | @findex gnus-summary-save-in-mail | |
7857 | @vindex gnus-mail-save-name | |
7858 | Save in a Unix mail (mbox) file. Uses the function in the | |
7859 | @code{gnus-mail-save-name} variable to get a file name to save the | |
7860 | article in. The default is @code{gnus-plain-save-name}. | |
4009494e | 7861 | |
8a1cdce5 AC |
7862 | @item gnus-summary-save-in-file |
7863 | @findex gnus-summary-save-in-file | |
7864 | @vindex gnus-file-save-name | |
7865 | @findex gnus-numeric-save-name | |
7866 | Append the article straight to an ordinary file. Uses the function in | |
7867 | the @code{gnus-file-save-name} variable to get a file name to save the | |
7868 | article in. The default is @code{gnus-numeric-save-name}. | |
4009494e | 7869 | |
8a1cdce5 AC |
7870 | @item gnus-summary-write-to-file |
7871 | @findex gnus-summary-write-to-file | |
7872 | Write the article straight to an ordinary file. The file is | |
7873 | overwritten if it exists. Uses the function in the | |
7874 | @code{gnus-file-save-name} variable to get a file name to save the | |
7875 | article in. The default is @code{gnus-numeric-save-name}. | |
4009494e | 7876 | |
8a1cdce5 AC |
7877 | @item gnus-summary-save-body-in-file |
7878 | @findex gnus-summary-save-body-in-file | |
7879 | Append the article body to an ordinary file. Uses the function in the | |
7880 | @code{gnus-file-save-name} variable to get a file name to save the | |
7881 | article in. The default is @code{gnus-numeric-save-name}. | |
4009494e | 7882 | |
8a1cdce5 AC |
7883 | @item gnus-summary-write-body-to-file |
7884 | @findex gnus-summary-write-body-to-file | |
7885 | Write the article body straight to an ordinary file. The file is | |
7886 | overwritten if it exists. Uses the function in the | |
7887 | @code{gnus-file-save-name} variable to get a file name to save the | |
7888 | article in. The default is @code{gnus-numeric-save-name}. | |
4009494e | 7889 | |
8a1cdce5 AC |
7890 | @item gnus-summary-save-in-folder |
7891 | @findex gnus-summary-save-in-folder | |
7892 | @findex gnus-folder-save-name | |
7893 | @findex gnus-Folder-save-name | |
7894 | @vindex gnus-folder-save-name | |
7895 | @cindex rcvstore | |
7896 | @cindex MH folders | |
7897 | Save the article to an MH folder using @code{rcvstore} from the MH | |
7898 | library. Uses the function in the @code{gnus-folder-save-name} variable | |
7899 | to get a file name to save the article in. The default is | |
7900 | @code{gnus-folder-save-name}, but you can also use | |
7901 | @code{gnus-Folder-save-name}, which creates capitalized names. | |
4009494e | 7902 | |
8a1cdce5 AC |
7903 | @item gnus-summary-save-in-vm |
7904 | @findex gnus-summary-save-in-vm | |
7905 | Save the article in a VM folder. You have to have the VM mail | |
7906 | reader to use this setting. | |
4009494e | 7907 | |
8a1cdce5 AC |
7908 | @item gnus-summary-save-in-pipe |
7909 | @findex gnus-summary-save-in-pipe | |
7910 | Pipe the article to a shell command. This function takes optional two | |
1df7defd | 7911 | arguments COMMAND and RAW@. Valid values for COMMAND include: |
4009494e | 7912 | |
8a1cdce5 AC |
7913 | @itemize @bullet |
7914 | @item a string@* | |
7915 | The executable command name and possibly arguments. | |
7916 | @item @code{nil}@* | |
7917 | You will be prompted for the command in the minibuffer. | |
7918 | @item the symbol @code{default}@* | |
7919 | It will be replaced with the command which the variable | |
7920 | @code{gnus-summary-pipe-output-default-command} holds or the command | |
7921 | last used for saving. | |
7922 | @end itemize | |
4009494e | 7923 | |
8a1cdce5 AC |
7924 | Non-@code{nil} value for RAW overrides @code{:decode} and |
7925 | @code{:headers} properties (see below) and the raw article including all | |
7926 | headers will be piped. | |
4009494e GM |
7927 | @end table |
7928 | ||
8a1cdce5 | 7929 | The symbol of each function may have the following properties: |
4009494e GM |
7930 | |
7931 | @table @code | |
8a1cdce5 AC |
7932 | @item :decode |
7933 | The value non-@code{nil} means save decoded articles. This is | |
7934 | meaningful only with @code{gnus-summary-save-in-file}, | |
7935 | @code{gnus-summary-save-body-in-file}, | |
7936 | @code{gnus-summary-write-to-file}, | |
7937 | @code{gnus-summary-write-body-to-file}, and | |
7938 | @code{gnus-summary-save-in-pipe}. | |
4009494e | 7939 | |
8a1cdce5 AC |
7940 | @item :function |
7941 | The value specifies an alternative function which appends, not | |
7942 | overwrites, articles to a file. This implies that when saving many | |
7943 | articles at a time, @code{gnus-prompt-before-saving} is bound to | |
7944 | @code{t} and all articles are saved in a single file. This is | |
7945 | meaningful only with @code{gnus-summary-write-to-file} and | |
7946 | @code{gnus-summary-write-body-to-file}. | |
4009494e | 7947 | |
8a1cdce5 AC |
7948 | @item :headers |
7949 | The value specifies the symbol of a variable of which the value | |
7950 | specifies headers to be saved. If it is omitted, | |
7951 | @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what | |
7952 | headers should be saved. | |
4009494e GM |
7953 | @end table |
7954 | ||
8a1cdce5 AC |
7955 | @vindex gnus-article-save-directory |
7956 | All of these functions, except for the last one, will save the article | |
7957 | in the @code{gnus-article-save-directory}, which is initialized from the | |
7958 | @env{SAVEDIR} environment variable. This is @file{~/News/} by | |
7959 | default. | |
4009494e | 7960 | |
8a1cdce5 AC |
7961 | As you can see above, the functions use different functions to find a |
7962 | suitable name of a file to save the article in. Below is a list of | |
7963 | available functions that generate names: | |
4009494e | 7964 | |
8a1cdce5 | 7965 | @table @code |
4009494e | 7966 | |
8a1cdce5 AC |
7967 | @item gnus-Numeric-save-name |
7968 | @findex gnus-Numeric-save-name | |
7969 | File names like @file{~/News/Alt.andrea-dworkin/45}. | |
4009494e | 7970 | |
8a1cdce5 AC |
7971 | @item gnus-numeric-save-name |
7972 | @findex gnus-numeric-save-name | |
7973 | File names like @file{~/News/alt.andrea-dworkin/45}. | |
4009494e | 7974 | |
8a1cdce5 AC |
7975 | @item gnus-Plain-save-name |
7976 | @findex gnus-Plain-save-name | |
7977 | File names like @file{~/News/Alt.andrea-dworkin}. | |
4009494e | 7978 | |
8a1cdce5 AC |
7979 | @item gnus-plain-save-name |
7980 | @findex gnus-plain-save-name | |
7981 | File names like @file{~/News/alt.andrea-dworkin}. | |
4009494e | 7982 | |
8a1cdce5 AC |
7983 | @item gnus-sender-save-name |
7984 | @findex gnus-sender-save-name | |
7985 | File names like @file{~/News/larsi}. | |
7986 | @end table | |
4009494e | 7987 | |
8a1cdce5 AC |
7988 | @vindex gnus-split-methods |
7989 | You can have Gnus suggest where to save articles by plonking a regexp into | |
7990 | the @code{gnus-split-methods} alist. For instance, if you would like to | |
7991 | save articles related to Gnus in the file @file{gnus-stuff}, and articles | |
7992 | related to VM in @file{vm-stuff}, you could set this variable to something | |
7993 | like: | |
4009494e | 7994 | |
8a1cdce5 AC |
7995 | @lisp |
7996 | (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff") | |
7997 | ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff") | |
7998 | (my-choosing-function "../other-dir/my-stuff") | |
7999 | ((equal gnus-newsgroup-name "mail.misc") "mail-stuff")) | |
8000 | @end lisp | |
4009494e | 8001 | |
8a1cdce5 AC |
8002 | We see that this is a list where each element is a list that has two |
8003 | elements---the @dfn{match} and the @dfn{file}. The match can either be | |
8004 | a string (in which case it is used as a regexp to match on the article | |
8005 | head); it can be a symbol (which will be called as a function with the | |
8006 | group name as a parameter); or it can be a list (which will be | |
8007 | @code{eval}ed). If any of these actions have a non-@code{nil} result, | |
8008 | the @dfn{file} will be used as a default prompt. In addition, the | |
8009 | result of the operation itself will be used if the function or form | |
8010 | called returns a string or a list of strings. | |
01c52d31 | 8011 | |
8a1cdce5 AC |
8012 | You basically end up with a list of file names that might be used when |
8013 | saving the current article. (All ``matches'' will be used.) You will | |
8014 | then be prompted for what you really want to use as a name, with file | |
8015 | name completion over the results from applying this variable. | |
4009494e | 8016 | |
8a1cdce5 AC |
8017 | This variable is @code{((gnus-article-archive-name))} by default, which |
8018 | means that Gnus will look at the articles it saves for an | |
8019 | @code{Archive-name} line and use that as a suggestion for the file | |
8020 | name. | |
4009494e | 8021 | |
8a1cdce5 AC |
8022 | Here's an example function to clean up file names somewhat. If you have |
8023 | lots of mail groups called things like | |
8024 | @samp{nnml:mail.whatever}, you may want to chop off the beginning of | |
8025 | these group names before creating the file name to save to. The | |
8026 | following will do just that: | |
4009494e | 8027 | |
8a1cdce5 AC |
8028 | @lisp |
8029 | (defun my-save-name (group) | |
8030 | (when (string-match "^nnml:mail." group) | |
8031 | (substring group (match-end 0)))) | |
4009494e | 8032 | |
8a1cdce5 AC |
8033 | (setq gnus-split-methods |
8034 | '((gnus-article-archive-name) | |
8035 | (my-save-name))) | |
8036 | @end lisp | |
4009494e | 8037 | |
4009494e | 8038 | |
8a1cdce5 AC |
8039 | @vindex gnus-use-long-file-name |
8040 | Finally, you have the @code{gnus-use-long-file-name} variable. If it is | |
8041 | @code{nil}, all the preceding functions will replace all periods | |
8042 | (@samp{.}) in the group names with slashes (@samp{/})---which means that | |
8043 | the functions will generate hierarchies of directories instead of having | |
8044 | all the files in the top level directory | |
8045 | (@file{~/News/alt/andrea-dworkin} instead of | |
8046 | @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default | |
8047 | on most systems. However, for historical reasons, this is @code{nil} on | |
8048 | Xenix and usg-unix-v machines by default. | |
4009494e | 8049 | |
8a1cdce5 AC |
8050 | This function also affects kill and score file names. If this variable |
8051 | is a list, and the list contains the element @code{not-score}, long file | |
8052 | names will not be used for score files, if it contains the element | |
8053 | @code{not-save}, long file names will not be used for saving, and if it | |
8054 | contains the element @code{not-kill}, long file names will not be used | |
8055 | for kill files. | |
4009494e | 8056 | |
8a1cdce5 AC |
8057 | If you'd like to save articles in a hierarchy that looks something like |
8058 | a spool, you could | |
4009494e | 8059 | |
8a1cdce5 AC |
8060 | @lisp |
8061 | (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy} | |
8062 | (setq gnus-default-article-saver | |
8063 | 'gnus-summary-save-in-file) ; @r{no encoding} | |
8064 | @end lisp | |
4009494e | 8065 | |
8a1cdce5 AC |
8066 | Then just save with @kbd{o}. You'd then read this hierarchy with |
8067 | ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and | |
8068 | the top level directory as the argument (@file{~/News/}). Then just walk | |
8069 | around to the groups/directories with @code{nneething}. | |
4009494e | 8070 | |
4009494e | 8071 | |
8a1cdce5 AC |
8072 | @node Decoding Articles |
8073 | @section Decoding Articles | |
8074 | @cindex decoding articles | |
4009494e | 8075 | |
8a1cdce5 AC |
8076 | Sometime users post articles (or series of articles) that have been |
8077 | encoded in some way or other. Gnus can decode them for you. | |
4009494e | 8078 | |
8a1cdce5 AC |
8079 | @menu |
8080 | * Uuencoded Articles:: Uudecode articles. | |
8081 | * Shell Archives:: Unshar articles. | |
8082 | * PostScript Files:: Split PostScript. | |
8083 | * Other Files:: Plain save and binhex. | |
8084 | * Decoding Variables:: Variables for a happy decoding. | |
8085 | * Viewing Files:: You want to look at the result of the decoding? | |
8086 | @end menu | |
4009494e | 8087 | |
8a1cdce5 AC |
8088 | @cindex series |
8089 | @cindex article series | |
8090 | All these functions use the process/prefix convention | |
8091 | (@pxref{Process/Prefix}) for finding out what articles to work on, with | |
8092 | the extension that a ``single article'' means ``a single series''. Gnus | |
8093 | can find out by itself what articles belong to a series, decode all the | |
8094 | articles and unpack/view/save the resulting file(s). | |
4009494e | 8095 | |
8a1cdce5 AC |
8096 | Gnus guesses what articles are in the series according to the following |
8097 | simplish rule: The subjects must be (nearly) identical, except for the | |
8098 | last two numbers of the line. (Spaces are largely ignored, however.) | |
4009494e | 8099 | |
8a1cdce5 AC |
8100 | For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus |
8101 | will find all the articles that match the regexp @samp{^cat.gif | |
8102 | ([0-9]+/[0-9]+).*$}. | |
4009494e | 8103 | |
8a1cdce5 AC |
8104 | Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a |
8105 | series}, will not be properly recognized by any of the automatic viewing | |
8106 | commands, and you have to mark the articles manually with @kbd{#}. | |
4009494e | 8107 | |
4009494e | 8108 | |
8a1cdce5 AC |
8109 | @node Uuencoded Articles |
8110 | @subsection Uuencoded Articles | |
8111 | @cindex uudecode | |
8112 | @cindex uuencoded articles | |
4009494e | 8113 | |
8a1cdce5 | 8114 | @table @kbd |
4009494e | 8115 | |
8a1cdce5 AC |
8116 | @item X u |
8117 | @kindex X u (Summary) | |
8118 | @findex gnus-uu-decode-uu | |
8119 | @c @icon{gnus-uu-decode-uu} | |
8120 | Uudecodes the current series (@code{gnus-uu-decode-uu}). | |
4009494e | 8121 | |
8a1cdce5 AC |
8122 | @item X U |
8123 | @kindex X U (Summary) | |
8124 | @findex gnus-uu-decode-uu-and-save | |
8125 | Uudecodes and saves the current series | |
8126 | (@code{gnus-uu-decode-uu-and-save}). | |
4009494e | 8127 | |
8a1cdce5 AC |
8128 | @item X v u |
8129 | @kindex X v u (Summary) | |
8130 | @findex gnus-uu-decode-uu-view | |
8131 | Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}). | |
4009494e | 8132 | |
8a1cdce5 AC |
8133 | @item X v U |
8134 | @kindex X v U (Summary) | |
8135 | @findex gnus-uu-decode-uu-and-save-view | |
8136 | Uudecodes, views and saves the current series | |
8137 | (@code{gnus-uu-decode-uu-and-save-view}). | |
4009494e | 8138 | |
8a1cdce5 | 8139 | @end table |
4009494e | 8140 | |
8a1cdce5 AC |
8141 | Remember that these all react to the presence of articles marked with |
8142 | the process mark. If, for instance, you'd like to decode and save an | |
8143 | entire newsgroup, you'd typically do @kbd{M P a} | |
8144 | (@code{gnus-uu-mark-all}) and then @kbd{X U} | |
8145 | (@code{gnus-uu-decode-uu-and-save}). | |
4009494e | 8146 | |
8a1cdce5 AC |
8147 | All this is very much different from how @code{gnus-uu} worked with |
8148 | @sc{gnus 4.1}, where you had explicit keystrokes for everything under | |
8149 | the sun. This version of @code{gnus-uu} generally assumes that you mark | |
8150 | articles in some way (@pxref{Setting Process Marks}) and then press | |
8151 | @kbd{X u}. | |
4009494e | 8152 | |
8a1cdce5 AC |
8153 | @vindex gnus-uu-notify-files |
8154 | Note: When trying to decode articles that have names matching | |
8155 | @code{gnus-uu-notify-files}, which is hard-coded to | |
8156 | @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will | |
8157 | automatically post an article on @samp{comp.unix.wizards} saying that | |
8158 | you have just viewed the file in question. This feature can't be turned | |
8159 | off. | |
4009494e | 8160 | |
4009494e | 8161 | |
8a1cdce5 AC |
8162 | @node Shell Archives |
8163 | @subsection Shell Archives | |
8164 | @cindex unshar | |
8165 | @cindex shell archives | |
8166 | @cindex shared articles | |
4009494e | 8167 | |
8a1cdce5 AC |
8168 | Shell archives (``shar files'') used to be a popular way to distribute |
8169 | sources, but it isn't used all that much today. In any case, we have | |
8170 | some commands to deal with these: | |
4009494e | 8171 | |
8a1cdce5 | 8172 | @table @kbd |
4009494e | 8173 | |
8a1cdce5 AC |
8174 | @item X s |
8175 | @kindex X s (Summary) | |
8176 | @findex gnus-uu-decode-unshar | |
8177 | Unshars the current series (@code{gnus-uu-decode-unshar}). | |
4009494e | 8178 | |
8a1cdce5 AC |
8179 | @item X S |
8180 | @kindex X S (Summary) | |
8181 | @findex gnus-uu-decode-unshar-and-save | |
8182 | Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}). | |
4009494e | 8183 | |
8a1cdce5 AC |
8184 | @item X v s |
8185 | @kindex X v s (Summary) | |
8186 | @findex gnus-uu-decode-unshar-view | |
8187 | Unshars and views the current series (@code{gnus-uu-decode-unshar-view}). | |
4009494e | 8188 | |
8a1cdce5 AC |
8189 | @item X v S |
8190 | @kindex X v S (Summary) | |
8191 | @findex gnus-uu-decode-unshar-and-save-view | |
8192 | Unshars, views and saves the current series | |
8193 | (@code{gnus-uu-decode-unshar-and-save-view}). | |
8194 | @end table | |
4009494e | 8195 | |
4009494e | 8196 | |
8a1cdce5 AC |
8197 | @node PostScript Files |
8198 | @subsection PostScript Files | |
8199 | @cindex PostScript | |
4009494e | 8200 | |
8a1cdce5 | 8201 | @table @kbd |
85115796 | 8202 | |
8a1cdce5 AC |
8203 | @item X p |
8204 | @kindex X p (Summary) | |
8205 | @findex gnus-uu-decode-postscript | |
8206 | Unpack the current PostScript series (@code{gnus-uu-decode-postscript}). | |
4009494e | 8207 | |
8a1cdce5 AC |
8208 | @item X P |
8209 | @kindex X P (Summary) | |
8210 | @findex gnus-uu-decode-postscript-and-save | |
8211 | Unpack and save the current PostScript series | |
8212 | (@code{gnus-uu-decode-postscript-and-save}). | |
4009494e | 8213 | |
8a1cdce5 AC |
8214 | @item X v p |
8215 | @kindex X v p (Summary) | |
8216 | @findex gnus-uu-decode-postscript-view | |
8217 | View the current PostScript series | |
8218 | (@code{gnus-uu-decode-postscript-view}). | |
4009494e | 8219 | |
8a1cdce5 AC |
8220 | @item X v P |
8221 | @kindex X v P (Summary) | |
8222 | @findex gnus-uu-decode-postscript-and-save-view | |
8223 | View and save the current PostScript series | |
8224 | (@code{gnus-uu-decode-postscript-and-save-view}). | |
8225 | @end table | |
4009494e | 8226 | |
4009494e | 8227 | |
8a1cdce5 AC |
8228 | @node Other Files |
8229 | @subsection Other Files | |
4009494e | 8230 | |
8a1cdce5 AC |
8231 | @table @kbd |
8232 | @item X o | |
8233 | @kindex X o (Summary) | |
8234 | @findex gnus-uu-decode-save | |
8235 | Save the current series | |
8236 | (@code{gnus-uu-decode-save}). | |
4009494e | 8237 | |
8a1cdce5 AC |
8238 | @item X b |
8239 | @kindex X b (Summary) | |
8240 | @findex gnus-uu-decode-binhex | |
8241 | Unbinhex the current series (@code{gnus-uu-decode-binhex}). This | |
8242 | doesn't really work yet. | |
4009494e | 8243 | |
8a1cdce5 AC |
8244 | @item X Y |
8245 | @kindex X Y (Summary) | |
8246 | @findex gnus-uu-decode-yenc | |
8247 | yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}). | |
8248 | @end table | |
4009494e | 8249 | |
4009494e | 8250 | |
8a1cdce5 AC |
8251 | @node Decoding Variables |
8252 | @subsection Decoding Variables | |
4009494e | 8253 | |
8a1cdce5 | 8254 | Adjective, not verb. |
4009494e | 8255 | |
8a1cdce5 AC |
8256 | @menu |
8257 | * Rule Variables:: Variables that say how a file is to be viewed. | |
8258 | * Other Decode Variables:: Other decode variables. | |
8259 | * Uuencoding and Posting:: Variables for customizing uuencoding. | |
8260 | @end menu | |
4009494e | 8261 | |
4009494e | 8262 | |
8a1cdce5 AC |
8263 | @node Rule Variables |
8264 | @subsubsection Rule Variables | |
8265 | @cindex rule variables | |
4009494e | 8266 | |
8a1cdce5 AC |
8267 | Gnus uses @dfn{rule variables} to decide how to view a file. All these |
8268 | variables are of the form | |
4009494e | 8269 | |
8a1cdce5 AC |
8270 | @lisp |
8271 | (list '(regexp1 command2) | |
8272 | '(regexp2 command2) | |
8273 | ...) | |
8274 | @end lisp | |
4009494e | 8275 | |
8a1cdce5 | 8276 | @table @code |
4009494e | 8277 | |
8a1cdce5 AC |
8278 | @item gnus-uu-user-view-rules |
8279 | @vindex gnus-uu-user-view-rules | |
8280 | @cindex sox | |
8281 | This variable is consulted first when viewing files. If you wish to use, | |
8282 | for instance, @code{sox} to convert an @file{.au} sound file, you could | |
8283 | say something like: | |
8284 | @lisp | |
8285 | (setq gnus-uu-user-view-rules | |
8286 | (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio"))) | |
8287 | @end lisp | |
4009494e | 8288 | |
8a1cdce5 AC |
8289 | @item gnus-uu-user-view-rules-end |
8290 | @vindex gnus-uu-user-view-rules-end | |
8291 | This variable is consulted if Gnus couldn't make any matches from the | |
8292 | user and default view rules. | |
4009494e | 8293 | |
8a1cdce5 AC |
8294 | @item gnus-uu-user-archive-rules |
8295 | @vindex gnus-uu-user-archive-rules | |
8296 | This variable can be used to say what commands should be used to unpack | |
8297 | archives. | |
8298 | @end table | |
4009494e | 8299 | |
4009494e | 8300 | |
8a1cdce5 AC |
8301 | @node Other Decode Variables |
8302 | @subsubsection Other Decode Variables | |
4009494e | 8303 | |
8a1cdce5 AC |
8304 | @table @code |
8305 | @vindex gnus-uu-grabbed-file-functions | |
4009494e | 8306 | |
8a1cdce5 AC |
8307 | @item gnus-uu-grabbed-file-functions |
8308 | All functions in this list will be called right after each file has been | |
8309 | successfully decoded---so that you can move or view files right away, | |
8310 | and don't have to wait for all files to be decoded before you can do | |
8311 | anything. Ready-made functions you can put in this list are: | |
4009494e | 8312 | |
8a1cdce5 | 8313 | @table @code |
4009494e | 8314 | |
8a1cdce5 AC |
8315 | @item gnus-uu-grab-view |
8316 | @findex gnus-uu-grab-view | |
8317 | View the file. | |
4009494e | 8318 | |
8a1cdce5 AC |
8319 | @item gnus-uu-grab-move |
8320 | @findex gnus-uu-grab-move | |
8321 | Move the file (if you're using a saving function.) | |
8322 | @end table | |
4009494e | 8323 | |
8a1cdce5 AC |
8324 | @item gnus-uu-be-dangerous |
8325 | @vindex gnus-uu-be-dangerous | |
8326 | Specifies what to do if unusual situations arise during decoding. If | |
8327 | @code{nil}, be as conservative as possible. If @code{t}, ignore things | |
8328 | that didn't work, and overwrite existing files. Otherwise, ask each | |
8329 | time. | |
01c52d31 | 8330 | |
8a1cdce5 AC |
8331 | @item gnus-uu-ignore-files-by-name |
8332 | @vindex gnus-uu-ignore-files-by-name | |
8333 | Files with name matching this regular expression won't be viewed. | |
01c52d31 | 8334 | |
8a1cdce5 AC |
8335 | @item gnus-uu-ignore-files-by-type |
8336 | @vindex gnus-uu-ignore-files-by-type | |
8337 | Files with a @acronym{MIME} type matching this variable won't be viewed. | |
8338 | Note that Gnus tries to guess what type the file is based on the name. | |
8339 | @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly | |
333f9019 | 8340 | kludgy. |
01c52d31 | 8341 | |
8a1cdce5 AC |
8342 | @item gnus-uu-tmp-dir |
8343 | @vindex gnus-uu-tmp-dir | |
8344 | Where @code{gnus-uu} does its work. | |
01c52d31 | 8345 | |
8a1cdce5 AC |
8346 | @item gnus-uu-do-not-unpack-archives |
8347 | @vindex gnus-uu-do-not-unpack-archives | |
8348 | Non-@code{nil} means that @code{gnus-uu} won't peek inside archives | |
8349 | looking for files to display. | |
01c52d31 | 8350 | |
8a1cdce5 AC |
8351 | @item gnus-uu-view-and-save |
8352 | @vindex gnus-uu-view-and-save | |
8353 | Non-@code{nil} means that the user will always be asked to save a file | |
8354 | after viewing it. | |
01c52d31 | 8355 | |
8a1cdce5 AC |
8356 | @item gnus-uu-ignore-default-view-rules |
8357 | @vindex gnus-uu-ignore-default-view-rules | |
8358 | Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing | |
8359 | rules. | |
01c52d31 | 8360 | |
8a1cdce5 AC |
8361 | @item gnus-uu-ignore-default-archive-rules |
8362 | @vindex gnus-uu-ignore-default-archive-rules | |
8363 | Non-@code{nil} means that @code{gnus-uu} will ignore the default archive | |
8364 | unpacking commands. | |
01c52d31 | 8365 | |
8a1cdce5 AC |
8366 | @item gnus-uu-kill-carriage-return |
8367 | @vindex gnus-uu-kill-carriage-return | |
8368 | Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns | |
8369 | from articles. | |
01c52d31 | 8370 | |
8a1cdce5 AC |
8371 | @item gnus-uu-unmark-articles-not-decoded |
8372 | @vindex gnus-uu-unmark-articles-not-decoded | |
8373 | Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully | |
8374 | decoded articles as unread. | |
4009494e | 8375 | |
8a1cdce5 AC |
8376 | @item gnus-uu-correct-stripped-uucode |
8377 | @vindex gnus-uu-correct-stripped-uucode | |
8378 | Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix | |
8379 | uuencoded files that have had trailing spaces deleted. | |
4009494e | 8380 | |
8a1cdce5 AC |
8381 | @item gnus-uu-pre-uudecode-hook |
8382 | @vindex gnus-uu-pre-uudecode-hook | |
8383 | Hook run before sending a message to @code{uudecode}. | |
4009494e | 8384 | |
8a1cdce5 AC |
8385 | @item gnus-uu-view-with-metamail |
8386 | @vindex gnus-uu-view-with-metamail | |
8387 | @cindex metamail | |
8388 | Non-@code{nil} means that @code{gnus-uu} will ignore the viewing | |
8389 | commands defined by the rule variables and just fudge a @acronym{MIME} | |
8390 | content type based on the file name. The result will be fed to | |
8391 | @code{metamail} for viewing. | |
4009494e | 8392 | |
8a1cdce5 AC |
8393 | @item gnus-uu-save-in-digest |
8394 | @vindex gnus-uu-save-in-digest | |
8395 | Non-@code{nil} means that @code{gnus-uu}, when asked to save without | |
8396 | decoding, will save in digests. If this variable is @code{nil}, | |
8397 | @code{gnus-uu} will just save everything in a file without any | |
8398 | embellishments. The digesting almost conforms to RFC 1153---no easy way | |
8399 | to specify any meaningful volume and issue numbers were found, so I | |
8400 | simply dropped them. | |
4009494e | 8401 | |
8a1cdce5 | 8402 | @end table |
4009494e | 8403 | |
4009494e | 8404 | |
8a1cdce5 AC |
8405 | @node Uuencoding and Posting |
8406 | @subsubsection Uuencoding and Posting | |
4009494e | 8407 | |
8a1cdce5 | 8408 | @table @code |
4009494e | 8409 | |
8a1cdce5 AC |
8410 | @item gnus-uu-post-include-before-composing |
8411 | @vindex gnus-uu-post-include-before-composing | |
8412 | Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode | |
8413 | before you compose the article. If this variable is @code{t}, you can | |
8414 | either include an encoded file with @kbd{C-c C-i} or have one included | |
8415 | for you when you post the article. | |
4009494e | 8416 | |
8a1cdce5 AC |
8417 | @item gnus-uu-post-length |
8418 | @vindex gnus-uu-post-length | |
8419 | Maximum length of an article. The encoded file will be split into how | |
8420 | many articles it takes to post the entire file. | |
4009494e | 8421 | |
8a1cdce5 AC |
8422 | @item gnus-uu-post-threaded |
8423 | @vindex gnus-uu-post-threaded | |
8424 | Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a | |
8425 | thread. This may not be smart, as no other decoder I have seen is able | |
8426 | to follow threads when collecting uuencoded articles. (Well, I have | |
8427 | seen one package that does that---@code{gnus-uu}, but somehow, I don't | |
8428 | think that counts@dots{}) Default is @code{nil}. | |
4009494e | 8429 | |
8a1cdce5 AC |
8430 | @item gnus-uu-post-separate-description |
8431 | @vindex gnus-uu-post-separate-description | |
8432 | Non-@code{nil} means that the description will be posted in a separate | |
8433 | article. The first article will typically be numbered (0/x). If this | |
8434 | variable is @code{nil}, the description the user enters will be included | |
8435 | at the beginning of the first article, which will be numbered (1/x). | |
8436 | Default is @code{t}. | |
4009494e | 8437 | |
8a1cdce5 | 8438 | @end table |
4009494e | 8439 | |
4009494e | 8440 | |
8a1cdce5 AC |
8441 | @node Viewing Files |
8442 | @subsection Viewing Files | |
8443 | @cindex viewing files | |
8444 | @cindex pseudo-articles | |
4009494e | 8445 | |
8a1cdce5 AC |
8446 | After decoding, if the file is some sort of archive, Gnus will attempt |
8447 | to unpack the archive and see if any of the files in the archive can be | |
8448 | viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz} | |
8449 | containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will | |
8450 | uncompress and de-tar the main file, and then view the two pictures. | |
8451 | This unpacking process is recursive, so if the archive contains archives | |
8452 | of archives, it'll all be unpacked. | |
4009494e | 8453 | |
8a1cdce5 AC |
8454 | Finally, Gnus will normally insert a @dfn{pseudo-article} for each |
8455 | extracted file into the summary buffer. If you go to these | |
8456 | ``articles'', you will be prompted for a command to run (usually Gnus | |
8457 | will make a suggestion), and then the command will be run. | |
4009494e | 8458 | |
8a1cdce5 AC |
8459 | @vindex gnus-view-pseudo-asynchronously |
8460 | If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait | |
8461 | until the viewing is done before proceeding. | |
4009494e | 8462 | |
8a1cdce5 AC |
8463 | @vindex gnus-view-pseudos |
8464 | If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert | |
8465 | the pseudo-articles into the summary buffer, but view them | |
8466 | immediately. If this variable is @code{not-confirm}, the user won't even | |
8467 | be asked for a confirmation before viewing is done. | |
4009494e | 8468 | |
8a1cdce5 AC |
8469 | @vindex gnus-view-pseudos-separately |
8470 | If @code{gnus-view-pseudos-separately} is non-@code{nil}, one | |
8471 | pseudo-article will be created for each file to be viewed. If | |
8472 | @code{nil}, all files that use the same viewing command will be given as | |
8473 | a list of parameters to that command. | |
4009494e | 8474 | |
8a1cdce5 AC |
8475 | @vindex gnus-insert-pseudo-articles |
8476 | If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert | |
8477 | pseudo-articles when decoding. It is @code{t} by default. | |
4009494e | 8478 | |
8a1cdce5 AC |
8479 | So; there you are, reading your @emph{pseudo-articles} in your |
8480 | @emph{virtual newsgroup} from the @emph{virtual server}; and you think: | |
8481 | Why isn't anything real anymore? How did we get here? | |
4009494e | 8482 | |
4009494e | 8483 | |
8a1cdce5 AC |
8484 | @node Article Treatment |
8485 | @section Article Treatment | |
4009494e | 8486 | |
8a1cdce5 AC |
8487 | Reading through this huge manual, you may have quite forgotten that the |
8488 | object of newsreaders is to actually, like, read what people have | |
8489 | written. Reading articles. Unfortunately, people are quite bad at | |
8490 | writing, so there are tons of functions and variables to make reading | |
8491 | these articles easier. | |
4009494e | 8492 | |
8a1cdce5 AC |
8493 | @menu |
8494 | * Article Highlighting:: You want to make the article look like fruit salad. | |
8495 | * Article Fontisizing:: Making emphasized text look nice. | |
8496 | * Article Hiding:: You also want to make certain info go away. | |
8497 | * Article Washing:: Lots of way-neat functions to make life better. | |
8498 | * Article Header:: Doing various header transformations. | |
8499 | * Article Buttons:: Click on URLs, Message-IDs, addresses and the like. | |
8500 | * Article Button Levels:: Controlling appearance of buttons. | |
8501 | * Article Date:: Grumble, UT! | |
8502 | * Article Display:: Display various stuff: | |
8503 | X-Face, Picons, Gravatars, Smileys. | |
8504 | * Article Signature:: What is a signature? | |
8505 | * Article Miscellanea:: Various other stuff. | |
8506 | @end menu | |
4009494e | 8507 | |
4009494e | 8508 | |
8a1cdce5 AC |
8509 | @node Article Highlighting |
8510 | @subsection Article Highlighting | |
8511 | @cindex highlighting | |
4009494e | 8512 | |
8a1cdce5 AC |
8513 | Not only do you want your article buffer to look like fruit salad, but |
8514 | you want it to look like technicolor fruit salad. | |
4009494e | 8515 | |
8a1cdce5 | 8516 | @table @kbd |
4009494e | 8517 | |
8a1cdce5 AC |
8518 | @item W H a |
8519 | @kindex W H a (Summary) | |
8520 | @findex gnus-article-highlight | |
8521 | @findex gnus-article-maybe-highlight | |
8522 | Do much highlighting of the current article | |
8523 | (@code{gnus-article-highlight}). This function highlights header, cited | |
8524 | text, the signature, and adds buttons to the body and the head. | |
4009494e | 8525 | |
8a1cdce5 AC |
8526 | @item W H h |
8527 | @kindex W H h (Summary) | |
8528 | @findex gnus-article-highlight-headers | |
8529 | @vindex gnus-header-face-alist | |
8530 | Highlight the headers (@code{gnus-article-highlight-headers}). The | |
8531 | highlighting will be done according to the @code{gnus-header-face-alist} | |
8532 | variable, which is a list where each element has the form | |
8533 | @code{(@var{regexp} @var{name} @var{content})}. | |
8534 | @var{regexp} is a regular expression for matching the | |
8535 | header, @var{name} is the face used for highlighting the header name | |
8536 | (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting | |
8537 | the header value. The first match made will be used. Note that | |
8538 | @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one. | |
4009494e | 8539 | |
8a1cdce5 AC |
8540 | @item W H c |
8541 | @kindex W H c (Summary) | |
8542 | @findex gnus-article-highlight-citation | |
8543 | Highlight cited text (@code{gnus-article-highlight-citation}). | |
4009494e | 8544 | |
8a1cdce5 | 8545 | Some variables to customize the citation highlights: |
89167438 | 8546 | |
8a1cdce5 AC |
8547 | @table @code |
8548 | @vindex gnus-cite-parse-max-size | |
d62672f3 | 8549 | |
8a1cdce5 AC |
8550 | @item gnus-cite-parse-max-size |
8551 | If the article size in bytes is bigger than this variable (which is | |
8552 | 25000 by default), no citation highlighting will be performed. | |
d62672f3 | 8553 | |
8a1cdce5 AC |
8554 | @item gnus-cite-max-prefix |
8555 | @vindex gnus-cite-max-prefix | |
8556 | Maximum possible length for a citation prefix (default 20). | |
4009494e | 8557 | |
8a1cdce5 AC |
8558 | @item gnus-cite-face-list |
8559 | @vindex gnus-cite-face-list | |
8560 | List of faces used for highlighting citations (@pxref{Faces and Fonts}). | |
8561 | When there are citations from multiple articles in the same message, | |
8562 | Gnus will try to give each citation from each article its own face. | |
8563 | This should make it easier to see who wrote what. | |
4009494e | 8564 | |
8a1cdce5 AC |
8565 | @item gnus-supercite-regexp |
8566 | @vindex gnus-supercite-regexp | |
8567 | Regexp matching normal Supercite attribution lines. | |
4009494e | 8568 | |
8a1cdce5 AC |
8569 | @item gnus-supercite-secondary-regexp |
8570 | @vindex gnus-supercite-secondary-regexp | |
8571 | Regexp matching mangled Supercite attribution lines. | |
4009494e | 8572 | |
8a1cdce5 AC |
8573 | @item gnus-cite-minimum-match-count |
8574 | @vindex gnus-cite-minimum-match-count | |
8575 | Minimum number of identical prefixes we have to see before we believe | |
8576 | that it's a citation. | |
4009494e | 8577 | |
8a1cdce5 AC |
8578 | @item gnus-cite-attribution-prefix |
8579 | @vindex gnus-cite-attribution-prefix | |
8580 | Regexp matching the beginning of an attribution line. | |
4009494e | 8581 | |
8a1cdce5 AC |
8582 | @item gnus-cite-attribution-suffix |
8583 | @vindex gnus-cite-attribution-suffix | |
8584 | Regexp matching the end of an attribution line. | |
4009494e | 8585 | |
8a1cdce5 AC |
8586 | @item gnus-cite-attribution-face |
8587 | @vindex gnus-cite-attribution-face | |
8588 | Face used for attribution lines. It is merged with the face for the | |
8589 | cited text belonging to the attribution. | |
4009494e | 8590 | |
8a1cdce5 AC |
8591 | @item gnus-cite-ignore-quoted-from |
8592 | @vindex gnus-cite-ignore-quoted-from | |
8593 | If non-@code{nil}, no citation highlighting will be performed on lines | |
8594 | beginning with @samp{>From }. Those lines may have been quoted by MTAs | |
8595 | in order not to mix up with the envelope From line. The default value | |
8596 | is @code{t}. | |
4009494e | 8597 | |
8a1cdce5 | 8598 | @end table |
4009494e | 8599 | |
4009494e | 8600 | |
8a1cdce5 AC |
8601 | @item W H s |
8602 | @kindex W H s (Summary) | |
8603 | @vindex gnus-signature-separator | |
8604 | @vindex gnus-signature-face | |
8605 | @findex gnus-article-highlight-signature | |
8606 | Highlight the signature (@code{gnus-article-highlight-signature}). | |
8607 | Everything after @code{gnus-signature-separator} (@pxref{Article | |
8608 | Signature}) in an article will be considered a signature and will be | |
8609 | highlighted with @code{gnus-signature-face}, which is @code{italic} by | |
8610 | default. | |
4009494e | 8611 | |
4009494e GM |
8612 | @end table |
8613 | ||
8a1cdce5 | 8614 | @xref{Customizing Articles}, for how to highlight articles automatically. |
4009494e | 8615 | |
4009494e | 8616 | |
8a1cdce5 AC |
8617 | @node Article Fontisizing |
8618 | @subsection Article Fontisizing | |
8619 | @cindex emphasis | |
8620 | @cindex article emphasis | |
4009494e | 8621 | |
8a1cdce5 AC |
8622 | @findex gnus-article-emphasize |
8623 | @kindex W e (Summary) | |
8624 | People commonly add emphasis to words in news articles by writing things | |
8625 | like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make | |
8626 | this look nicer by running the article through the @kbd{W e} | |
8627 | (@code{gnus-article-emphasize}) command. | |
4009494e | 8628 | |
8a1cdce5 AC |
8629 | @vindex gnus-emphasis-alist |
8630 | How the emphasis is computed is controlled by the | |
8631 | @code{gnus-emphasis-alist} variable. This is an alist where the first | |
8632 | element is a regular expression to be matched. The second is a number | |
8633 | that says what regular expression grouping is used to find the entire | |
8634 | emphasized word. The third is a number that says what regexp grouping | |
8635 | should be displayed and highlighted. (The text between these two | |
8636 | groupings will be hidden.) The fourth is the face used for | |
8637 | highlighting. | |
4009494e GM |
8638 | |
8639 | @lisp | |
8a1cdce5 AC |
8640 | (setq gnus-emphasis-alist |
8641 | '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline) | |
8642 | ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold))) | |
4009494e GM |
8643 | @end lisp |
8644 | ||
8a1cdce5 AC |
8645 | @cindex slash |
8646 | @cindex asterisk | |
8647 | @cindex underline | |
8648 | @cindex / | |
8649 | @cindex * | |
4009494e | 8650 | |
8a1cdce5 AC |
8651 | @vindex gnus-emphasis-underline |
8652 | @vindex gnus-emphasis-bold | |
8653 | @vindex gnus-emphasis-italic | |
8654 | @vindex gnus-emphasis-underline-bold | |
8655 | @vindex gnus-emphasis-underline-italic | |
8656 | @vindex gnus-emphasis-bold-italic | |
8657 | @vindex gnus-emphasis-underline-bold-italic | |
8658 | By default, there are seven rules, and they use the following faces: | |
8659 | @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic}, | |
8660 | @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic}, | |
8661 | @code{gnus-emphasis-underline-italic}, | |
8662 | @code{gnus-emphasis-underline-bold}, and | |
8663 | @code{gnus-emphasis-underline-bold-italic}. | |
4009494e | 8664 | |
8a1cdce5 AC |
8665 | If you want to change these faces, you can either use @kbd{M-x |
8666 | customize}, or you can use @code{copy-face}. For instance, if you want | |
8667 | to make @code{gnus-emphasis-italic} use a red face instead, you could | |
8668 | say something like: | |
4009494e GM |
8669 | |
8670 | @lisp | |
8a1cdce5 | 8671 | (copy-face 'red 'gnus-emphasis-italic) |
4009494e GM |
8672 | @end lisp |
8673 | ||
8a1cdce5 | 8674 | @vindex gnus-group-highlight-words-alist |
4009494e | 8675 | |
8a1cdce5 AC |
8676 | If you want to highlight arbitrary words, you can use the |
8677 | @code{gnus-group-highlight-words-alist} variable, which uses the same | |
8678 | syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group | |
8679 | parameter (@pxref{Group Parameters}) can also be used. | |
4009494e | 8680 | |
8a1cdce5 | 8681 | @xref{Customizing Articles}, for how to fontize articles automatically. |
4009494e | 8682 | |
4009494e | 8683 | |
8a1cdce5 AC |
8684 | @node Article Hiding |
8685 | @subsection Article Hiding | |
8686 | @cindex article hiding | |
4009494e | 8687 | |
8a1cdce5 AC |
8688 | Or rather, hiding certain things in each article. There usually is much |
8689 | too much cruft in most articles. | |
4009494e | 8690 | |
8a1cdce5 | 8691 | @table @kbd |
4009494e | 8692 | |
8a1cdce5 AC |
8693 | @item W W a |
8694 | @kindex W W a (Summary) | |
8695 | @findex gnus-article-hide | |
8696 | Do quite a lot of hiding on the article buffer | |
8697 | (@kbd{gnus-article-hide}). In particular, this function will hide | |
8698 | headers, @acronym{PGP}, cited text and the signature. | |
4009494e | 8699 | |
8a1cdce5 AC |
8700 | @item W W h |
8701 | @kindex W W h (Summary) | |
8702 | @findex gnus-article-hide-headers | |
8703 | Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding | |
8704 | Headers}. | |
4009494e | 8705 | |
8a1cdce5 AC |
8706 | @item W W b |
8707 | @kindex W W b (Summary) | |
8708 | @findex gnus-article-hide-boring-headers | |
8709 | Hide headers that aren't particularly interesting | |
8710 | (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}. | |
4009494e | 8711 | |
8a1cdce5 AC |
8712 | @item W W s |
8713 | @kindex W W s (Summary) | |
8714 | @findex gnus-article-hide-signature | |
8715 | Hide signature (@code{gnus-article-hide-signature}). @xref{Article | |
8716 | Signature}. | |
4009494e | 8717 | |
8a1cdce5 AC |
8718 | @item W W l |
8719 | @kindex W W l (Summary) | |
8720 | @findex gnus-article-hide-list-identifiers | |
8721 | @vindex gnus-list-identifiers | |
8722 | Strip list identifiers specified in @code{gnus-list-identifiers}. These | |
8723 | are strings some mailing list servers add to the beginning of all | |
8724 | @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading | |
8725 | @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers} | |
8726 | may not contain @code{\\(..\\)}. | |
4009494e | 8727 | |
8a1cdce5 | 8728 | @table @code |
4009494e | 8729 | |
8a1cdce5 AC |
8730 | @item gnus-list-identifiers |
8731 | @vindex gnus-list-identifiers | |
8732 | A regular expression that matches list identifiers to be removed from | |
8733 | subject. This can also be a list of regular expressions. | |
4009494e | 8734 | |
8a1cdce5 | 8735 | @end table |
4009494e | 8736 | |
8a1cdce5 AC |
8737 | @item W W P |
8738 | @kindex W W P (Summary) | |
8739 | @findex gnus-article-hide-pem | |
8740 | Hide @acronym{PEM} (privacy enhanced messages) cruft | |
8741 | (@code{gnus-article-hide-pem}). | |
4009494e | 8742 | |
8a1cdce5 AC |
8743 | @item W W B |
8744 | @kindex W W B (Summary) | |
8745 | @findex gnus-article-strip-banner | |
8746 | @vindex gnus-article-banner-alist | |
8747 | @vindex gnus-article-address-banner-alist | |
8748 | @cindex banner | |
8749 | @cindex OneList | |
8750 | @cindex stripping advertisements | |
8751 | @cindex advertisements | |
8752 | Strip the banner specified by the @code{banner} group parameter | |
8753 | (@code{gnus-article-strip-banner}). This is mainly used to hide those | |
8754 | annoying banners and/or signatures that some mailing lists and moderated | |
8755 | groups adds to all the messages. The way to use this function is to add | |
8756 | the @code{banner} group parameter (@pxref{Group Parameters}) to the | |
8757 | group you want banners stripped from. The parameter either be a string, | |
8758 | which will be interpreted as a regular expression matching text to be | |
8759 | removed, or the symbol @code{signature}, meaning that the (last) | |
8760 | signature should be removed, or other symbol, meaning that the | |
8761 | corresponding regular expression in @code{gnus-article-banner-alist} is | |
8762 | used. | |
4009494e | 8763 | |
8a1cdce5 | 8764 | For instance: |
4009494e | 8765 | |
8a1cdce5 AC |
8766 | @lisp |
8767 | (setq gnus-article-banner-alist | |
8768 | ((googleGroups . | |
8769 | "^\n*--~--~---------\\(.+\n\\)+"))) | |
8770 | @end lisp | |
4009494e | 8771 | |
8a1cdce5 AC |
8772 | Regardless of a group, you can hide things like advertisements only when |
8773 | the sender of an article has a certain mail address specified in | |
8774 | @code{gnus-article-address-banner-alist}. | |
4009494e | 8775 | |
8a1cdce5 | 8776 | @table @code |
4009494e | 8777 | |
8a1cdce5 AC |
8778 | @item gnus-article-address-banner-alist |
8779 | @vindex gnus-article-address-banner-alist | |
8780 | Alist of mail addresses and banners. Each element has the form | |
8781 | @code{(@var{address} . @var{banner})}, where @var{address} is a regexp | |
8782 | matching a mail address in the From header, @var{banner} is one of a | |
8783 | symbol @code{signature}, an item in @code{gnus-article-banner-alist}, | |
8784 | a regexp and @code{nil}. If @var{address} matches author's mail | |
8785 | address, it will remove things like advertisements. For example, if a | |
8786 | sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a | |
8787 | banner something like @samp{Do You Yoo-hoo!?} in all articles he | |
8788 | sends, you can use the following element to remove them: | |
4009494e | 8789 | |
8a1cdce5 AC |
8790 | @lisp |
8791 | ("@@yoo-hoo\\.co\\.jp\\'" . | |
8792 | "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n") | |
8793 | @end lisp | |
4009494e | 8794 | |
8a1cdce5 | 8795 | @end table |
4009494e | 8796 | |
8a1cdce5 AC |
8797 | @item W W c |
8798 | @kindex W W c (Summary) | |
8799 | @findex gnus-article-hide-citation | |
8800 | Hide citation (@code{gnus-article-hide-citation}). Some variables for | |
8801 | customizing the hiding: | |
4009494e | 8802 | |
8a1cdce5 | 8803 | @table @code |
4009494e | 8804 | |
8a1cdce5 AC |
8805 | @item gnus-cited-opened-text-button-line-format |
8806 | @itemx gnus-cited-closed-text-button-line-format | |
8807 | @vindex gnus-cited-closed-text-button-line-format | |
8808 | @vindex gnus-cited-opened-text-button-line-format | |
8809 | Gnus adds buttons to show where the cited text has been hidden, and to | |
8810 | allow toggle hiding the text. The format of the variable is specified | |
8811 | by these format-like variable (@pxref{Formatting Variables}). These | |
8812 | specs are valid: | |
4009494e | 8813 | |
8a1cdce5 AC |
8814 | @table @samp |
8815 | @item b | |
8816 | Starting point of the hidden text. | |
8817 | @item e | |
8818 | Ending point of the hidden text. | |
8819 | @item l | |
8820 | Number of characters in the hidden region. | |
8821 | @item n | |
8822 | Number of lines of hidden text. | |
4009494e GM |
8823 | @end table |
8824 | ||
8a1cdce5 AC |
8825 | @item gnus-cited-lines-visible |
8826 | @vindex gnus-cited-lines-visible | |
8827 | The number of lines at the beginning of the cited text to leave | |
8828 | shown. This can also be a cons cell with the number of lines at the top | |
8829 | and bottom of the text, respectively, to remain visible. | |
4009494e | 8830 | |
8a1cdce5 | 8831 | @end table |
4009494e | 8832 | |
8a1cdce5 AC |
8833 | @item W W C-c |
8834 | @kindex W W C-c (Summary) | |
8835 | @findex gnus-article-hide-citation-maybe | |
4009494e | 8836 | |
8a1cdce5 AC |
8837 | Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the |
8838 | following two variables: | |
4009494e | 8839 | |
8a1cdce5 AC |
8840 | @table @code |
8841 | @item gnus-cite-hide-percentage | |
8842 | @vindex gnus-cite-hide-percentage | |
8843 | If the cited text is of a bigger percentage than this variable (default | |
8844 | 50), hide the cited text. | |
4009494e | 8845 | |
8a1cdce5 AC |
8846 | @item gnus-cite-hide-absolute |
8847 | @vindex gnus-cite-hide-absolute | |
8848 | The cited text must have at least this length (default 10) before it | |
8849 | is hidden. | |
4009494e GM |
8850 | @end table |
8851 | ||
8a1cdce5 AC |
8852 | @item W W C |
8853 | @kindex W W C (Summary) | |
8854 | @findex gnus-article-hide-citation-in-followups | |
8855 | Hide cited text in articles that aren't roots | |
8856 | (@code{gnus-article-hide-citation-in-followups}). This isn't very | |
8857 | useful as an interactive command, but might be a handy function to stick | |
8858 | have happen automatically (@pxref{Customizing Articles}). | |
4009494e | 8859 | |
8a1cdce5 | 8860 | @end table |
4009494e | 8861 | |
8a1cdce5 AC |
8862 | All these ``hiding'' commands are toggles, but if you give a negative |
8863 | prefix to these commands, they will show what they have previously | |
8864 | hidden. If you give a positive prefix, they will always hide. | |
b890d447 | 8865 | |
8a1cdce5 AC |
8866 | Also @pxref{Article Highlighting} for further variables for |
8867 | citation customization. | |
4009494e | 8868 | |
8a1cdce5 AC |
8869 | @xref{Customizing Articles}, for how to hide article elements |
8870 | automatically. | |
4009494e | 8871 | |
4009494e | 8872 | |
8a1cdce5 AC |
8873 | @node Article Washing |
8874 | @subsection Article Washing | |
8875 | @cindex washing | |
8876 | @cindex article washing | |
4009494e | 8877 | |
8a1cdce5 AC |
8878 | We call this ``article washing'' for a really good reason. Namely, the |
8879 | @kbd{A} key was taken, so we had to use the @kbd{W} key instead. | |
4009494e | 8880 | |
8a1cdce5 AC |
8881 | @dfn{Washing} is defined by us as ``changing something from something to |
8882 | something else'', but normally results in something looking better. | |
8883 | Cleaner, perhaps. | |
4009494e | 8884 | |
8a1cdce5 AC |
8885 | @xref{Customizing Articles}, if you want to change how Gnus displays |
8886 | articles by default. | |
4009494e | 8887 | |
8a1cdce5 | 8888 | @table @kbd |
4009494e | 8889 | |
8a1cdce5 AC |
8890 | @item C-u g |
8891 | This is not really washing, it's sort of the opposite of washing. If | |
8892 | you type this, you see the article exactly as it exists on disk or on | |
8893 | the server. | |
4009494e | 8894 | |
8a1cdce5 AC |
8895 | @item g |
8896 | Force redisplaying of the current article | |
8897 | (@code{gnus-summary-show-article}). This is also not really washing. | |
8898 | If you type this, you see the article without any previously applied | |
8899 | interactive Washing functions but with all default treatments | |
8900 | (@pxref{Customizing Articles}). | |
4009494e | 8901 | |
8a1cdce5 AC |
8902 | @item W l |
8903 | @kindex W l (Summary) | |
8904 | @findex gnus-summary-stop-page-breaking | |
8905 | Remove page breaks from the current article | |
8906 | (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page | |
8907 | delimiters. | |
4009494e | 8908 | |
8a1cdce5 AC |
8909 | @item W r |
8910 | @kindex W r (Summary) | |
8911 | @findex gnus-summary-caesar-message | |
8912 | @c @icon{gnus-summary-caesar-message} | |
8913 | Do a Caesar rotate (rot13) on the article buffer | |
8914 | (@code{gnus-summary-caesar-message}). | |
8915 | Unreadable articles that tell you to read them with Caesar rotate or rot13. | |
8916 | (Typically offensive jokes and such.) | |
4009494e | 8917 | |
8a1cdce5 | 8918 | It's commonly called ``rot13'' because each letter is rotated 13 |
1df7defd | 8919 | positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter |
8a1cdce5 AC |
8920 | #15). It is sometimes referred to as ``Caesar rotate'' because Caesar |
8921 | is rumored to have employed this form of, uh, somewhat weak encryption. | |
4009494e | 8922 | |
8a1cdce5 AC |
8923 | @item W m |
8924 | @kindex W m (Summary) | |
8925 | @findex gnus-summary-morse-message | |
8926 | Morse decode the article buffer (@code{gnus-summary-morse-message}). | |
4009494e | 8927 | |
8a1cdce5 AC |
8928 | @item W i |
8929 | @kindex W i (Summary) | |
8930 | @findex gnus-summary-idna-message | |
8931 | Decode IDNA encoded domain names in the current articles. IDNA | |
8932 | encoded domain names looks like @samp{xn--bar}. If a string remain | |
8933 | unencoded after running invoking this, it is likely an invalid IDNA | |
8934 | string (@samp{xn--bar} is invalid). You must have GNU Libidn | |
8935 | (@url{http://www.gnu.org/software/libidn/}) installed for this command | |
8936 | to work. | |
4009494e | 8937 | |
8a1cdce5 AC |
8938 | @item W t |
8939 | @item t | |
8940 | @kindex W t (Summary) | |
8941 | @kindex t (Summary) | |
8942 | @findex gnus-summary-toggle-header | |
8943 | Toggle whether to display all headers in the article buffer | |
8944 | (@code{gnus-summary-toggle-header}). | |
4009494e | 8945 | |
8a1cdce5 AC |
8946 | @item W v |
8947 | @kindex W v (Summary) | |
8948 | @findex gnus-summary-verbose-headers | |
8949 | Toggle whether to display all headers in the article buffer permanently | |
8950 | (@code{gnus-summary-verbose-headers}). | |
4009494e | 8951 | |
8a1cdce5 AC |
8952 | @item W o |
8953 | @kindex W o (Summary) | |
8954 | @findex gnus-article-treat-overstrike | |
8955 | Treat overstrike (@code{gnus-article-treat-overstrike}). | |
4009494e | 8956 | |
8a1cdce5 AC |
8957 | @item W d |
8958 | @kindex W d (Summary) | |
8959 | @findex gnus-article-treat-dumbquotes | |
8960 | @vindex gnus-article-dumbquotes-map | |
8961 | @cindex Smartquotes | |
8962 | @cindex M****s*** sm*rtq**t*s | |
8963 | @cindex Latin 1 | |
8964 | Treat M****s*** sm*rtq**t*s according to | |
8965 | @code{gnus-article-dumbquotes-map} | |
8966 | (@code{gnus-article-treat-dumbquotes}). Note that this function guesses | |
8967 | whether a character is a sm*rtq**t* or not, so it should only be used | |
8968 | interactively. | |
4009494e | 8969 | |
8a1cdce5 AC |
8970 | Sm*rtq**t*s are M****s***'s unilateral extension to the character map in |
8971 | an attempt to provide more quoting characters. If you see something | |
8972 | like @code{\222} or @code{\264} where you're expecting some kind of | |
8973 | apostrophe or quotation mark, then try this wash. | |
4009494e | 8974 | |
8a1cdce5 AC |
8975 | @item W U |
8976 | @kindex W U (Summary) | |
8977 | @findex gnus-article-treat-non-ascii | |
8978 | @cindex Unicode | |
8979 | @cindex Non-@acronym{ASCII} | |
8980 | Translate many non-@acronym{ASCII} characters into their | |
8981 | @acronym{ASCII} equivalents (@code{gnus-article-treat-non-ascii}). | |
8982 | This is mostly useful if you're on a terminal that has a limited font | |
fe7a3057 | 8983 | and doesn't show accented characters, ``advanced'' punctuation, and the |
89b163db | 8984 | like. For instance, @samp{»} is translated into @samp{>>}, and so on. |
4009494e | 8985 | |
8a1cdce5 AC |
8986 | @item W Y f |
8987 | @kindex W Y f (Summary) | |
8988 | @findex gnus-article-outlook-deuglify-article | |
8989 | @cindex Outlook Express | |
8990 | Full deuglify of broken Outlook (Express) articles: Treat dumbquotes, | |
8991 | unwrap lines, repair attribution and rearrange citation. | |
8992 | (@code{gnus-article-outlook-deuglify-article}). | |
4009494e | 8993 | |
8a1cdce5 AC |
8994 | @item W Y u |
8995 | @kindex W Y u (Summary) | |
8996 | @findex gnus-article-outlook-unwrap-lines | |
8997 | @vindex gnus-outlook-deuglify-unwrap-min | |
8998 | @vindex gnus-outlook-deuglify-unwrap-max | |
8999 | Unwrap lines that appear to be wrapped citation lines. You can control | |
9000 | what lines will be unwrapped by frobbing | |
9001 | @code{gnus-outlook-deuglify-unwrap-min} and | |
9002 | @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and | |
9003 | maximum length of an unwrapped citation line. | |
9004 | (@code{gnus-article-outlook-unwrap-lines}). | |
4009494e | 9005 | |
8a1cdce5 AC |
9006 | @item W Y a |
9007 | @kindex W Y a (Summary) | |
9008 | @findex gnus-article-outlook-repair-attribution | |
9009 | Repair a broken attribution line.@* | |
9010 | (@code{gnus-article-outlook-repair-attribution}). | |
4009494e | 9011 | |
8a1cdce5 AC |
9012 | @item W Y c |
9013 | @kindex W Y c (Summary) | |
9014 | @findex gnus-article-outlook-rearrange-citation | |
9015 | Repair broken citations by rearranging the text. | |
9016 | (@code{gnus-article-outlook-rearrange-citation}). | |
4009494e | 9017 | |
8a1cdce5 AC |
9018 | @item W w |
9019 | @kindex W w (Summary) | |
9020 | @findex gnus-article-fill-cited-article | |
9021 | Do word wrap (@code{gnus-article-fill-cited-article}). | |
4009494e | 9022 | |
8a1cdce5 AC |
9023 | You can give the command a numerical prefix to specify the width to use |
9024 | when filling. | |
4009494e | 9025 | |
8a1cdce5 AC |
9026 | @item W Q |
9027 | @kindex W Q (Summary) | |
9028 | @findex gnus-article-fill-long-lines | |
9029 | Fill long lines (@code{gnus-article-fill-long-lines}). | |
4009494e | 9030 | |
8a1cdce5 AC |
9031 | @item W C |
9032 | @kindex W C (Summary) | |
9033 | @findex gnus-article-capitalize-sentences | |
9034 | Capitalize the first word in each sentence | |
9035 | (@code{gnus-article-capitalize-sentences}). | |
4009494e | 9036 | |
8a1cdce5 AC |
9037 | @item W c |
9038 | @kindex W c (Summary) | |
9039 | @findex gnus-article-remove-cr | |
1df7defd | 9040 | Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF |
8a1cdce5 AC |
9041 | (this takes care of DOS line endings), and then translate any remaining |
9042 | CRs into LF (this takes care of Mac line endings) | |
9043 | (@code{gnus-article-remove-cr}). | |
4009494e | 9044 | |
8a1cdce5 AC |
9045 | @item W q |
9046 | @kindex W q (Summary) | |
9047 | @findex gnus-article-de-quoted-unreadable | |
9048 | Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}). | |
9049 | Quoted-Printable is one common @acronym{MIME} encoding employed when | |
9050 | sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically | |
9051 | makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu}, | |
9052 | which doesn't look very readable to me. Note that this is usually | |
9053 | done automatically by Gnus if the message in question has a | |
9054 | @code{Content-Transfer-Encoding} header that says that this encoding | |
9055 | has been done. If a prefix is given, a charset will be asked for. | |
4009494e | 9056 | |
8a1cdce5 AC |
9057 | @item W 6 |
9058 | @kindex W 6 (Summary) | |
9059 | @findex gnus-article-de-base64-unreadable | |
9060 | Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is | |
9061 | one common @acronym{MIME} encoding employed when sending | |
9062 | non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is | |
9063 | usually done automatically by Gnus if the message in question has a | |
9064 | @code{Content-Transfer-Encoding} header that says that this encoding | |
9065 | has been done. If a prefix is given, a charset will be asked for. | |
4009494e | 9066 | |
8a1cdce5 AC |
9067 | @item W Z |
9068 | @kindex W Z (Summary) | |
9069 | @findex gnus-article-decode-HZ | |
9070 | Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one | |
9071 | common encoding employed when sending Chinese articles. It typically | |
9072 | makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}. | |
4009494e | 9073 | |
8a1cdce5 AC |
9074 | @item W A |
9075 | @kindex W A (Summary) | |
9076 | @findex gnus-article-treat-ansi-sequences | |
9077 | @cindex @acronym{ANSI} control sequences | |
9078 | Translate @acronym{ANSI} SGR control sequences into overlays or | |
9079 | extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI} | |
9080 | sequences are used in some Chinese hierarchies for highlighting. | |
4009494e | 9081 | |
8a1cdce5 AC |
9082 | @item W u |
9083 | @kindex W u (Summary) | |
9084 | @findex gnus-article-unsplit-urls | |
9085 | Remove newlines from within URLs. Some mailers insert newlines into | |
9086 | outgoing email messages to keep lines short. This reformatting can | |
9087 | split long URLs onto multiple lines. Repair those URLs by removing | |
9088 | the newlines (@code{gnus-article-unsplit-urls}). | |
4009494e | 9089 | |
8a1cdce5 AC |
9090 | @item W h |
9091 | @kindex W h (Summary) | |
9092 | @findex gnus-article-wash-html | |
9093 | Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is | |
9094 | usually done automatically by Gnus if the message in question has a | |
9095 | @code{Content-Type} header that says that the message is @acronym{HTML}. | |
4009494e | 9096 | |
8a1cdce5 AC |
9097 | If a prefix is given, a charset will be asked for. If it is a number, |
9098 | the charset defined in @code{gnus-summary-show-article-charset-alist} | |
9099 | (@pxref{Paging the Article}) will be used. | |
9100 | ||
9101 | The default is to use the function specified by | |
9102 | @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display | |
9103 | Customization, emacs-mime, The Emacs MIME Manual}) to convert the | |
9104 | @acronym{HTML}. Pre-defined functions you can use include: | |
4009494e GM |
9105 | |
9106 | @table @code | |
8a1cdce5 AC |
9107 | @item shr |
9108 | Use Gnus simple html renderer. | |
4009494e | 9109 | |
8a1cdce5 AC |
9110 | @item gnus-w3m |
9111 | Use Gnus rendered based on w3m. | |
4009494e | 9112 | |
8a1cdce5 AC |
9113 | @item w3 |
9114 | Use Emacs/W3. | |
4009494e | 9115 | |
8a1cdce5 AC |
9116 | @item w3m |
9117 | Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}. | |
4009494e | 9118 | |
8a1cdce5 AC |
9119 | @item w3m-standalone |
9120 | Use @uref{http://w3m.sourceforge.net/, w3m}. | |
4009494e | 9121 | |
8a1cdce5 AC |
9122 | @item links |
9123 | Use @uref{http://links.sf.net/, Links}. | |
4009494e | 9124 | |
8a1cdce5 AC |
9125 | @item lynx |
9126 | Use @uref{http://lynx.isc.org/, Lynx}. | |
4009494e | 9127 | |
8a1cdce5 AC |
9128 | @item html2text |
9129 | Use html2text---a simple @acronym{HTML} converter included with Gnus. | |
4009494e | 9130 | |
8a1cdce5 | 9131 | @end table |
4009494e | 9132 | |
8a1cdce5 AC |
9133 | @item W b |
9134 | @kindex W b (Summary) | |
9135 | @findex gnus-article-add-buttons | |
9136 | Add clickable buttons to the article (@code{gnus-article-add-buttons}). | |
9137 | @xref{Article Buttons}. | |
4009494e | 9138 | |
8a1cdce5 AC |
9139 | @item W B |
9140 | @kindex W B (Summary) | |
9141 | @findex gnus-article-add-buttons-to-head | |
9142 | Add clickable buttons to the article headers | |
9143 | (@code{gnus-article-add-buttons-to-head}). | |
4009494e | 9144 | |
8a1cdce5 AC |
9145 | @item W p |
9146 | @kindex W p (Summary) | |
9147 | @findex gnus-article-verify-x-pgp-sig | |
9148 | Verify a signed control message | |
9149 | (@code{gnus-article-verify-x-pgp-sig}). Control messages such as | |
9150 | @code{newgroup} and @code{checkgroups} are usually signed by the | |
9151 | hierarchy maintainer. You need to add the @acronym{PGP} public key of | |
9152 | the maintainer to your keyring to verify the | |
9153 | message.@footnote{@acronym{PGP} keys for many hierarchies are | |
9154 | available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}} | |
4009494e | 9155 | |
8a1cdce5 AC |
9156 | @item W s |
9157 | @kindex W s (Summary) | |
9158 | @findex gnus-summary-force-verify-and-decrypt | |
9159 | Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or | |
9160 | @acronym{S/MIME}) message | |
9161 | (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}. | |
4009494e | 9162 | |
8a1cdce5 AC |
9163 | @item W a |
9164 | @kindex W a (Summary) | |
9165 | @findex gnus-article-strip-headers-in-body | |
9166 | Strip headers like the @code{X-No-Archive} header from the beginning of | |
9167 | article bodies (@code{gnus-article-strip-headers-in-body}). | |
4009494e | 9168 | |
8a1cdce5 AC |
9169 | @item W E l |
9170 | @kindex W E l (Summary) | |
9171 | @findex gnus-article-strip-leading-blank-lines | |
9172 | Remove all blank lines from the beginning of the article | |
9173 | (@code{gnus-article-strip-leading-blank-lines}). | |
4009494e | 9174 | |
8a1cdce5 AC |
9175 | @item W E m |
9176 | @kindex W E m (Summary) | |
9177 | @findex gnus-article-strip-multiple-blank-lines | |
9178 | Replace all blank lines with empty lines and then all multiple empty | |
9179 | lines with a single empty line. | |
9180 | (@code{gnus-article-strip-multiple-blank-lines}). | |
4009494e | 9181 | |
8a1cdce5 AC |
9182 | @item W E t |
9183 | @kindex W E t (Summary) | |
9184 | @findex gnus-article-remove-trailing-blank-lines | |
9185 | Remove all blank lines at the end of the article | |
9186 | (@code{gnus-article-remove-trailing-blank-lines}). | |
4009494e | 9187 | |
8a1cdce5 AC |
9188 | @item W E a |
9189 | @kindex W E a (Summary) | |
9190 | @findex gnus-article-strip-blank-lines | |
9191 | Do all the three commands above | |
9192 | (@code{gnus-article-strip-blank-lines}). | |
4009494e | 9193 | |
8a1cdce5 AC |
9194 | @item W E A |
9195 | @kindex W E A (Summary) | |
9196 | @findex gnus-article-strip-all-blank-lines | |
9197 | Remove all blank lines | |
9198 | (@code{gnus-article-strip-all-blank-lines}). | |
9199 | ||
9200 | @item W E s | |
9201 | @kindex W E s (Summary) | |
9202 | @findex gnus-article-strip-leading-space | |
9203 | Remove all white space from the beginning of all lines of the article | |
9204 | body (@code{gnus-article-strip-leading-space}). | |
4009494e | 9205 | |
8a1cdce5 AC |
9206 | @item W E e |
9207 | @kindex W E e (Summary) | |
9208 | @findex gnus-article-strip-trailing-space | |
9209 | Remove all white space from the end of all lines of the article | |
9210 | body (@code{gnus-article-strip-trailing-space}). | |
4009494e | 9211 | |
8a1cdce5 | 9212 | @end table |
4009494e | 9213 | |
8a1cdce5 | 9214 | @xref{Customizing Articles}, for how to wash articles automatically. |
4009494e | 9215 | |
4009494e | 9216 | |
8a1cdce5 AC |
9217 | @node Article Header |
9218 | @subsection Article Header | |
4009494e | 9219 | |
8a1cdce5 | 9220 | These commands perform various transformations of article header. |
4009494e | 9221 | |
8a1cdce5 | 9222 | @table @kbd |
4009494e | 9223 | |
8a1cdce5 AC |
9224 | @item W G u |
9225 | @kindex W G u (Summary) | |
9226 | @findex gnus-article-treat-unfold-headers | |
9227 | Unfold folded header lines (@code{gnus-article-treat-unfold-headers}). | |
4009494e | 9228 | |
8a1cdce5 AC |
9229 | @item W G n |
9230 | @kindex W G n (Summary) | |
9231 | @findex gnus-article-treat-fold-newsgroups | |
9232 | Fold the @code{Newsgroups} and @code{Followup-To} headers | |
9233 | (@code{gnus-article-treat-fold-newsgroups}). | |
4009494e | 9234 | |
8a1cdce5 AC |
9235 | @item W G f |
9236 | @kindex W G f (Summary) | |
9237 | @findex gnus-article-treat-fold-headers | |
9238 | Fold all the message headers | |
9239 | (@code{gnus-article-treat-fold-headers}). | |
4009494e | 9240 | |
8a1cdce5 AC |
9241 | @item W E w |
9242 | @kindex W E w (Summary) | |
9243 | @findex gnus-article-remove-leading-whitespace | |
9244 | Remove excessive whitespace from all headers | |
9245 | (@code{gnus-article-remove-leading-whitespace}). | |
4009494e | 9246 | |
8a1cdce5 | 9247 | @end table |
4009494e | 9248 | |
4009494e | 9249 | |
8a1cdce5 AC |
9250 | @node Article Buttons |
9251 | @subsection Article Buttons | |
9252 | @cindex buttons | |
4009494e | 9253 | |
8a1cdce5 AC |
9254 | People often include references to other stuff in articles, and it would |
9255 | be nice if Gnus could just fetch whatever it is that people talk about | |
9256 | with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse | |
9257 | button on these references. | |
4009494e | 9258 | |
8a1cdce5 AC |
9259 | @vindex gnus-button-man-handler |
9260 | Gnus adds @dfn{buttons} to certain standard references by default: | |
9261 | Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and | |
9262 | Emacs or Gnus related references. This is controlled by two variables, | |
9263 | one that handles article bodies and one that handles article heads: | |
4009494e | 9264 | |
8a1cdce5 | 9265 | @table @code |
4009494e | 9266 | |
8a1cdce5 AC |
9267 | @item gnus-button-alist |
9268 | @vindex gnus-button-alist | |
9269 | This is an alist where each entry has this form: | |
4009494e | 9270 | |
8a1cdce5 AC |
9271 | @lisp |
9272 | (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par}) | |
9273 | @end lisp | |
4009494e | 9274 | |
8a1cdce5 | 9275 | @table @var |
4009494e | 9276 | |
8a1cdce5 AC |
9277 | @item regexp |
9278 | All text that match this regular expression (case insensitive) will be | |
9279 | considered an external reference. Here's a typical regexp that matches | |
9280 | embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a | |
9281 | variable containing a regexp, useful variables to use include | |
9282 | @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}. | |
4009494e | 9283 | |
8a1cdce5 AC |
9284 | @item button-par |
9285 | Gnus has to know which parts of the matches is to be highlighted. This | |
9286 | is a number that says what sub-expression of the regexp is to be | |
9287 | highlighted. If you want it all highlighted, you use 0 here. | |
4009494e | 9288 | |
8a1cdce5 AC |
9289 | @item use-p |
9290 | This form will be @code{eval}ed, and if the result is non-@code{nil}, | |
9291 | this is considered a match. This is useful if you want extra sifting to | |
9292 | avoid false matches. Often variables named | |
9293 | @code{gnus-button-@var{*}-level} are used here, @xref{Article Button | |
9294 | Levels}, but any other form may be used too. | |
4009494e | 9295 | |
8a1cdce5 | 9296 | @c @code{use-p} is @code{eval}ed only if @code{regexp} matches. |
4009494e | 9297 | |
8a1cdce5 AC |
9298 | @item function |
9299 | This function will be called when you click on this button. | |
4009494e | 9300 | |
8a1cdce5 AC |
9301 | @item data-par |
9302 | As with @var{button-par}, this is a sub-expression number, but this one | |
9303 | says which part of the match is to be sent as data to @var{function}. | |
4009494e | 9304 | |
8a1cdce5 | 9305 | @end table |
4009494e | 9306 | |
8a1cdce5 | 9307 | So the full entry for buttonizing URLs is then |
4009494e GM |
9308 | |
9309 | @lisp | |
8a1cdce5 | 9310 | ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1) |
4009494e GM |
9311 | @end lisp |
9312 | ||
8a1cdce5 AC |
9313 | @item gnus-header-button-alist |
9314 | @vindex gnus-header-button-alist | |
9315 | This is just like the other alist, except that it is applied to the | |
9316 | article head only, and that each entry has an additional element that is | |
9317 | used to say what headers to apply the buttonize coding to: | |
4009494e GM |
9318 | |
9319 | @lisp | |
8a1cdce5 | 9320 | (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par}) |
4009494e GM |
9321 | @end lisp |
9322 | ||
8a1cdce5 AC |
9323 | @var{header} is a regular expression. |
9324 | @end table | |
4009494e | 9325 | |
8a1cdce5 | 9326 | @subsubsection Related variables and functions |
4009494e | 9327 | |
8a1cdce5 AC |
9328 | @table @code |
9329 | @item gnus-button-@var{*}-level | |
9330 | @xref{Article Button Levels}. | |
4009494e | 9331 | |
8a1cdce5 | 9332 | @c Stuff related to gnus-button-browse-level |
4009494e | 9333 | |
8a1cdce5 AC |
9334 | @item gnus-button-url-regexp |
9335 | @vindex gnus-button-url-regexp | |
9336 | A regular expression that matches embedded URLs. It is used in the | |
9337 | default values of the variables above. | |
4009494e | 9338 | |
8a1cdce5 | 9339 | @c Stuff related to gnus-button-man-level |
4009494e | 9340 | |
8a1cdce5 AC |
9341 | @item gnus-button-man-handler |
9342 | @vindex gnus-button-man-handler | |
9343 | The function to use for displaying man pages. It must take at least one | |
9344 | argument with a string naming the man page. | |
4009494e | 9345 | |
8a1cdce5 AC |
9346 | @c Stuff related to gnus-button-message-level |
9347 | ||
9348 | @item gnus-button-mid-or-mail-regexp | |
9349 | @vindex gnus-button-mid-or-mail-regexp | |
9350 | Regular expression that matches a message ID or a mail address. | |
4009494e | 9351 | |
8a1cdce5 AC |
9352 | @item gnus-button-prefer-mid-or-mail |
9353 | @vindex gnus-button-prefer-mid-or-mail | |
9354 | This variable determines what to do when the button on a string as | |
9355 | @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a | |
9356 | message ID or a mail address. If it is one of the symbols @code{mid} or | |
9357 | @code{mail}, Gnus will always assume that the string is a message ID or | |
9358 | a mail address, respectively. If this variable is set to the symbol | |
9359 | @code{ask}, always query the user what to do. If it is a function, this | |
9360 | function will be called with the string as its only argument. The | |
9361 | function must return @code{mid}, @code{mail}, @code{invalid} or | |
9362 | @code{ask}. The default value is the function | |
9363 | @code{gnus-button-mid-or-mail-heuristic}. | |
4009494e | 9364 | |
8a1cdce5 AC |
9365 | @item gnus-button-mid-or-mail-heuristic |
9366 | @findex gnus-button-mid-or-mail-heuristic | |
9367 | Function that guesses whether its argument is a message ID or a mail | |
9368 | address. Returns @code{mid} if it's a message IDs, @code{mail} if | |
9369 | it's a mail address, @code{ask} if unsure and @code{invalid} if the | |
9370 | string is invalid. | |
4009494e | 9371 | |
8a1cdce5 AC |
9372 | @item gnus-button-mid-or-mail-heuristic-alist |
9373 | @vindex gnus-button-mid-or-mail-heuristic-alist | |
9374 | An alist of @code{(RATE . REGEXP)} pairs used by the function | |
9375 | @code{gnus-button-mid-or-mail-heuristic}. | |
4009494e | 9376 | |
8a1cdce5 | 9377 | @c Misc stuff |
4009494e | 9378 | |
8a1cdce5 AC |
9379 | @item gnus-article-button-face |
9380 | @vindex gnus-article-button-face | |
9381 | Face used on buttons. | |
4009494e | 9382 | |
8a1cdce5 AC |
9383 | @item gnus-article-mouse-face |
9384 | @vindex gnus-article-mouse-face | |
9385 | Face used when the mouse cursor is over a button. | |
4009494e GM |
9386 | |
9387 | @end table | |
9388 | ||
8a1cdce5 | 9389 | @xref{Customizing Articles}, for how to buttonize articles automatically. |
4009494e | 9390 | |
4009494e | 9391 | |
8a1cdce5 AC |
9392 | @node Article Button Levels |
9393 | @subsection Article button levels | |
9394 | @cindex button levels | |
9395 | The higher the value of the variables @code{gnus-button-@var{*}-level}, | |
9396 | the more buttons will appear. If the level is zero, no corresponding | |
9397 | buttons are displayed. With the default value (which is 5) you should | |
9398 | already see quite a lot of buttons. With higher levels, you will see | |
9399 | more buttons, but you may also get more false positives. To avoid them, | |
9400 | you can set the variables @code{gnus-button-@var{*}-level} local to | |
9401 | specific groups (@pxref{Group Parameters}). Here's an example for the | |
9402 | variable @code{gnus-parameters}: | |
a3f57c41 G |
9403 | |
9404 | @lisp | |
8a1cdce5 AC |
9405 | ;; @r{increase @code{gnus-button-*-level} in some groups:} |
9406 | (setq gnus-parameters | |
9407 | '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10)) | |
9408 | ("\\<unix\\>" (gnus-button-man-level 10)) | |
9409 | ("\\<tex\\>" (gnus-button-tex-level 10)))) | |
a3f57c41 G |
9410 | @end lisp |
9411 | ||
4009494e GM |
9412 | @table @code |
9413 | ||
8a1cdce5 AC |
9414 | @item gnus-button-browse-level |
9415 | @vindex gnus-button-browse-level | |
9416 | Controls the display of references to message IDs, mail addresses and | |
9417 | news URLs. Related variables and functions include | |
9418 | @code{gnus-button-url-regexp}, @code{browse-url}, and | |
9419 | @code{browse-url-browser-function}. | |
4009494e | 9420 | |
8a1cdce5 AC |
9421 | @item gnus-button-emacs-level |
9422 | @vindex gnus-button-emacs-level | |
9423 | Controls the display of Emacs or Gnus references. Related functions are | |
9424 | @code{gnus-button-handle-custom}, | |
9425 | @code{gnus-button-handle-describe-function}, | |
9426 | @code{gnus-button-handle-describe-variable}, | |
9427 | @code{gnus-button-handle-symbol}, | |
9428 | @code{gnus-button-handle-describe-key}, | |
9429 | @code{gnus-button-handle-apropos}, | |
9430 | @code{gnus-button-handle-apropos-command}, | |
9431 | @code{gnus-button-handle-apropos-variable}, | |
9432 | @code{gnus-button-handle-apropos-documentation}, and | |
9433 | @code{gnus-button-handle-library}. | |
9434 | ||
9435 | @item gnus-button-man-level | |
9436 | @vindex gnus-button-man-level | |
9437 | Controls the display of references to (Unix) man pages. | |
9438 | See @code{gnus-button-man-handler}. | |
9439 | ||
9440 | @item gnus-button-message-level | |
9441 | @vindex gnus-button-message-level | |
9442 | Controls the display of message IDs, mail addresses and news URLs. | |
9443 | Related variables and functions include | |
9444 | @code{gnus-button-mid-or-mail-regexp}, | |
9445 | @code{gnus-button-prefer-mid-or-mail}, | |
9446 | @code{gnus-button-mid-or-mail-heuristic}, and | |
9447 | @code{gnus-button-mid-or-mail-heuristic-alist}. | |
4009494e GM |
9448 | |
9449 | @end table | |
9450 | ||
4009494e | 9451 | |
8a1cdce5 AC |
9452 | @node Article Date |
9453 | @subsection Article Date | |
4009494e | 9454 | |
8a1cdce5 AC |
9455 | The date is most likely generated in some obscure timezone you've never |
9456 | heard of, so it's quite nice to be able to find out what the time was | |
9457 | when the article was sent. | |
4009494e | 9458 | |
8a1cdce5 | 9459 | @table @kbd |
4009494e | 9460 | |
8a1cdce5 AC |
9461 | @item W T u |
9462 | @kindex W T u (Summary) | |
9463 | @findex gnus-article-date-ut | |
9464 | Display the date in UT (aka. GMT, aka ZULU) | |
9465 | (@code{gnus-article-date-ut}). | |
4009494e | 9466 | |
8a1cdce5 AC |
9467 | @item W T i |
9468 | @kindex W T i (Summary) | |
9469 | @findex gnus-article-date-iso8601 | |
9470 | @cindex ISO 8601 | |
9471 | Display the date in international format, aka. ISO 8601 | |
9472 | (@code{gnus-article-date-iso8601}). | |
4009494e | 9473 | |
8a1cdce5 AC |
9474 | @item W T l |
9475 | @kindex W T l (Summary) | |
9476 | @findex gnus-article-date-local | |
9477 | Display the date in the local timezone (@code{gnus-article-date-local}). | |
4009494e | 9478 | |
8a1cdce5 AC |
9479 | @item W T p |
9480 | @kindex W T p (Summary) | |
9481 | @findex gnus-article-date-english | |
9482 | Display the date in a format that's easily pronounceable in English | |
9483 | (@code{gnus-article-date-english}). | |
4009494e | 9484 | |
8a1cdce5 AC |
9485 | @item W T s |
9486 | @kindex W T s (Summary) | |
9487 | @vindex gnus-article-time-format | |
9488 | @findex gnus-article-date-user | |
9489 | @findex format-time-string | |
9490 | Display the date using a user-defined format | |
9491 | (@code{gnus-article-date-user}). The format is specified by the | |
9492 | @code{gnus-article-time-format} variable, and is a string that's passed | |
9493 | to @code{format-time-string}. See the documentation of that variable | |
9494 | for a list of possible format specs. | |
4009494e | 9495 | |
8a1cdce5 AC |
9496 | @item W T e |
9497 | @kindex W T e (Summary) | |
9498 | @findex gnus-article-date-lapsed | |
9499 | @findex gnus-start-date-timer | |
9500 | @findex gnus-stop-date-timer | |
9501 | Say how much time has elapsed between the article was posted and now | |
9502 | (@code{gnus-article-date-lapsed}). It looks something like: | |
9503 | ||
9504 | @example | |
12e3ca0a | 9505 | Date: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago |
8a1cdce5 AC |
9506 | @end example |
9507 | ||
8e22bee0 G |
9508 | This line is updated continually by default. The frequency (in |
9509 | seconds) is controlled by the @code{gnus-article-update-date-headers} | |
9510 | variable. | |
9511 | ||
9512 | If you wish to switch updating off, say: | |
4009494e | 9513 | |
12e3ca0a | 9514 | @vindex gnus-article-update-date-headers |
8a1cdce5 | 9515 | @lisp |
12e3ca0a | 9516 | (setq gnus-article-update-date-headers nil) |
8a1cdce5 | 9517 | @end lisp |
4009494e | 9518 | |
7f13c2e2 | 9519 | in your @file{~/.gnus.el} file. |
4009494e | 9520 | |
8a1cdce5 AC |
9521 | @item W T o |
9522 | @kindex W T o (Summary) | |
9523 | @findex gnus-article-date-original | |
9524 | Display the original date (@code{gnus-article-date-original}). This can | |
9525 | be useful if you normally use some other conversion function and are | |
9526 | worried that it might be doing something totally wrong. Say, claiming | |
9527 | that the article was posted in 1854. Although something like that is | |
9528 | @emph{totally} impossible. Don't you trust me? *titter* | |
4009494e | 9529 | |
8a1cdce5 | 9530 | @end table |
4009494e | 9531 | |
8a1cdce5 AC |
9532 | @xref{Customizing Articles}, for how to display the date in your |
9533 | preferred format automatically. | |
4009494e | 9534 | |
4009494e | 9535 | |
8a1cdce5 AC |
9536 | @node Article Display |
9537 | @subsection Article Display | |
9538 | @cindex picons | |
9539 | @cindex x-face | |
9540 | @cindex smileys | |
9541 | @cindex gravatars | |
4009494e | 9542 | |
8a1cdce5 AC |
9543 | These commands add various frivolous display gimmicks to the article |
9544 | buffer in Emacs versions that support them. | |
4009494e | 9545 | |
8a1cdce5 AC |
9546 | @code{X-Face} headers are small black-and-white images supplied by the |
9547 | message headers (@pxref{X-Face}). | |
4009494e | 9548 | |
8a1cdce5 AC |
9549 | @code{Face} headers are small colored images supplied by the message |
9550 | headers (@pxref{Face}). | |
4009494e | 9551 | |
8a1cdce5 AC |
9552 | Smileys are those little @samp{:-)} symbols that people like to litter |
9553 | their messages with (@pxref{Smileys}). | |
4009494e | 9554 | |
8a1cdce5 AC |
9555 | Picons, on the other hand, reside on your own system, and Gnus will |
9556 | try to match the headers to what you have (@pxref{Picons}). | |
4009494e | 9557 | |
8a1cdce5 AC |
9558 | Gravatars reside on-line and are fetched from |
9559 | @uref{http://www.gravatar.com/} (@pxref{Gravatars}). | |
4009494e | 9560 | |
8a1cdce5 AC |
9561 | All these functions are toggles---if the elements already exist, |
9562 | they'll be removed. | |
4009494e | 9563 | |
8a1cdce5 AC |
9564 | @table @kbd |
9565 | @item W D x | |
9566 | @kindex W D x (Summary) | |
9567 | @findex gnus-article-display-x-face | |
9568 | Display an @code{X-Face} in the @code{From} header. | |
9569 | (@code{gnus-article-display-x-face}). | |
4009494e | 9570 | |
8a1cdce5 AC |
9571 | @item W D d |
9572 | @kindex W D d (Summary) | |
9573 | @findex gnus-article-display-face | |
9574 | Display a @code{Face} in the @code{From} header. | |
9575 | (@code{gnus-article-display-face}). | |
4009494e | 9576 | |
8a1cdce5 AC |
9577 | @item W D s |
9578 | @kindex W D s (Summary) | |
9579 | @findex gnus-treat-smiley | |
9580 | Display smileys (@code{gnus-treat-smiley}). | |
01c52d31 | 9581 | |
8a1cdce5 AC |
9582 | @item W D f |
9583 | @kindex W D f (Summary) | |
9584 | @findex gnus-treat-from-picon | |
9585 | Piconify the @code{From} header (@code{gnus-treat-from-picon}). | |
4009494e | 9586 | |
8a1cdce5 AC |
9587 | @item W D m |
9588 | @kindex W D m (Summary) | |
9589 | @findex gnus-treat-mail-picon | |
1df7defd | 9590 | Piconify all mail headers (i.e., @code{Cc}, @code{To}) |
8a1cdce5 | 9591 | (@code{gnus-treat-mail-picon}). |
4009494e | 9592 | |
8a1cdce5 AC |
9593 | @item W D n |
9594 | @kindex W D n (Summary) | |
9595 | @findex gnus-treat-newsgroups-picon | |
1df7defd | 9596 | Piconify all news headers (i.e., @code{Newsgroups} and |
8a1cdce5 | 9597 | @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}). |
4009494e | 9598 | |
8a1cdce5 AC |
9599 | @item W D g |
9600 | @kindex W D g (Summary) | |
9601 | @findex gnus-treat-from-gravatar | |
9602 | Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}). | |
4009494e | 9603 | |
8a1cdce5 AC |
9604 | @item W D h |
9605 | @kindex W D h (Summary) | |
9606 | @findex gnus-treat-mail-gravatar | |
1df7defd | 9607 | Gravatarify all mail headers (i.e., @code{Cc}, @code{To}) |
8a1cdce5 | 9608 | (@code{gnus-treat-from-gravatar}). |
4009494e | 9609 | |
8a1cdce5 AC |
9610 | @item W D D |
9611 | @kindex W D D (Summary) | |
9612 | @findex gnus-article-remove-images | |
9613 | Remove all images from the article buffer | |
9614 | (@code{gnus-article-remove-images}). | |
be3c11b3 | 9615 | |
8a1cdce5 AC |
9616 | @item W D W |
9617 | @kindex W D W (Summary) | |
9618 | @findex gnus-html-show-images | |
9619 | If you're reading an @acronym{HTML} article rendered with | |
9620 | @code{gnus-article-html}, then you can insert any blocked images in | |
9621 | the buffer with this command. | |
9622 | (@code{gnus-html-show-images}). | |
4009494e | 9623 | |
8a1cdce5 | 9624 | @end table |
4009494e | 9625 | |
4009494e | 9626 | |
4009494e | 9627 | |
8a1cdce5 AC |
9628 | @node Article Signature |
9629 | @subsection Article Signature | |
9630 | @cindex signatures | |
9631 | @cindex article signature | |
4009494e | 9632 | |
8a1cdce5 AC |
9633 | @vindex gnus-signature-separator |
9634 | Each article is divided into two parts---the head and the body. The | |
9635 | body can be divided into a signature part and a text part. The variable | |
9636 | that says what is to be considered a signature is | |
9637 | @code{gnus-signature-separator}. This is normally the standard | |
9638 | @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use | |
9639 | non-standard signature separators, so this variable can also be a list | |
9640 | of regular expressions to be tested, one by one. (Searches are done | |
9641 | from the end of the body towards the beginning.) One likely value is: | |
4009494e | 9642 | |
8a1cdce5 AC |
9643 | @lisp |
9644 | (setq gnus-signature-separator | |
9645 | '("^-- $" ; @r{The standard} | |
9646 | "^-- *$" ; @r{A common mangling} | |
9647 | "^-------*$" ; @r{Many people just use a looong} | |
9648 | ; @r{line of dashes. Shame!} | |
9649 | "^ *--------*$" ; @r{Double-shame!} | |
9650 | "^________*$" ; @r{Underscores are also popular} | |
9651 | "^========*$")) ; @r{Pervert!} | |
9652 | @end lisp | |
4009494e | 9653 | |
8a1cdce5 AC |
9654 | The more permissive you are, the more likely it is that you'll get false |
9655 | positives. | |
4009494e | 9656 | |
8a1cdce5 AC |
9657 | @vindex gnus-signature-limit |
9658 | @code{gnus-signature-limit} provides a limit to what is considered a | |
9659 | signature when displaying articles. | |
4009494e | 9660 | |
8a1cdce5 AC |
9661 | @enumerate |
9662 | @item | |
9663 | If it is an integer, no signature may be longer (in characters) than | |
9664 | that integer. | |
9665 | @item | |
9666 | If it is a floating point number, no signature may be longer (in lines) | |
9667 | than that number. | |
9668 | @item | |
9669 | If it is a function, the function will be called without any parameters, | |
9670 | and if it returns @code{nil}, there is no signature in the buffer. | |
9671 | @item | |
9672 | If it is a string, it will be used as a regexp. If it matches, the text | |
9673 | in question is not a signature. | |
9674 | @end enumerate | |
4009494e | 9675 | |
8a1cdce5 AC |
9676 | This variable can also be a list where the elements may be of the types |
9677 | listed above. Here's an example: | |
4009494e | 9678 | |
8a1cdce5 AC |
9679 | @lisp |
9680 | (setq gnus-signature-limit | |
9681 | '(200.0 "^---*Forwarded article")) | |
9682 | @end lisp | |
4009494e | 9683 | |
8a1cdce5 AC |
9684 | This means that if there are more than 200 lines after the signature |
9685 | separator, or the text after the signature separator is matched by | |
9686 | the regular expression @samp{^---*Forwarded article}, then it isn't a | |
9687 | signature after all. | |
01c52d31 | 9688 | |
4009494e | 9689 | |
8a1cdce5 AC |
9690 | @node Article Miscellanea |
9691 | @subsection Article Miscellanea | |
4009494e | 9692 | |
8a1cdce5 AC |
9693 | @table @kbd |
9694 | @item A t | |
9695 | @kindex A t (Summary) | |
9696 | @findex gnus-article-babel | |
9697 | Translate the article from one language to another | |
9698 | (@code{gnus-article-babel}). | |
4009494e | 9699 | |
8a1cdce5 | 9700 | @end table |
4009494e | 9701 | |
36d3245f | 9702 | |
8a1cdce5 AC |
9703 | @node MIME Commands |
9704 | @section MIME Commands | |
9705 | @cindex MIME decoding | |
9706 | @cindex attachments | |
9707 | @cindex viewing attachments | |
0e6b7ca0 | 9708 | |
8a1cdce5 AC |
9709 | The following commands all understand the numerical prefix. For |
9710 | instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''. | |
4009494e | 9711 | |
8a1cdce5 AC |
9712 | @table @kbd |
9713 | @item b | |
9714 | @itemx K v | |
9715 | @kindex b (Summary) | |
9716 | @kindex K v (Summary) | |
9717 | View the @acronym{MIME} part. | |
4009494e | 9718 | |
8a1cdce5 AC |
9719 | @item K o |
9720 | @kindex K o (Summary) | |
9721 | Save the @acronym{MIME} part. | |
4009494e | 9722 | |
8a1cdce5 AC |
9723 | @item K O |
9724 | @kindex K O (Summary) | |
9725 | Prompt for a file name, then save the @acronym{MIME} part and strip it | |
9726 | from the article. The stripped @acronym{MIME} object will be referred | |
9727 | via the message/external-body @acronym{MIME} type. | |
4009494e | 9728 | |
8a1cdce5 AC |
9729 | @item K r |
9730 | @kindex K r (Summary) | |
9731 | Replace the @acronym{MIME} part with an external body. | |
4009494e | 9732 | |
8a1cdce5 AC |
9733 | @item K d |
9734 | @kindex K d (Summary) | |
9735 | Delete the @acronym{MIME} part and add some information about the | |
9736 | removed part. | |
4009494e | 9737 | |
8a1cdce5 AC |
9738 | @item K c |
9739 | @kindex K c (Summary) | |
9740 | Copy the @acronym{MIME} part. | |
4009494e | 9741 | |
8a1cdce5 AC |
9742 | @item K e |
9743 | @kindex K e (Summary) | |
9744 | View the @acronym{MIME} part externally. | |
4009494e | 9745 | |
8a1cdce5 AC |
9746 | @item K i |
9747 | @kindex K i (Summary) | |
9748 | View the @acronym{MIME} part internally. | |
4009494e | 9749 | |
8a1cdce5 AC |
9750 | @item K | |
9751 | @kindex K | (Summary) | |
9752 | Pipe the @acronym{MIME} part to an external command. | |
9753 | @end table | |
4009494e | 9754 | |
8a1cdce5 AC |
9755 | The rest of these @acronym{MIME} commands do not use the numerical prefix in |
9756 | the same manner: | |
4009494e | 9757 | |
8a1cdce5 AC |
9758 | @table @kbd |
9759 | @item K H | |
9760 | @kindex K H (Summary) | |
9761 | @findex gnus-article-browse-html-article | |
9762 | View @samp{text/html} parts of the current article with a WWW browser. | |
9763 | Inline images embedded in a message using the @code{cid} scheme, as they | |
9764 | are generally considered to be safe, will be processed properly. The | |
9765 | message header is added to the beginning of every @acronym{HTML} part | |
9766 | unless the prefix argument is given. | |
4009494e | 9767 | |
8a1cdce5 AC |
9768 | Warning: Spammers use links to images (using the @code{http} scheme) in |
9769 | @acronym{HTML} articles to verify whether you have read the message. As | |
9770 | this command passes the @acronym{HTML} content to the browser without | |
9771 | eliminating these ``web bugs'' you should only use it for mails from | |
9772 | trusted senders. | |
4009494e | 9773 | |
8a1cdce5 AC |
9774 | If you always want to display @acronym{HTML} parts in the browser, set |
9775 | @code{mm-text-html-renderer} to @code{nil}. | |
4009494e | 9776 | |
8a1cdce5 AC |
9777 | This command creates temporary files to pass @acronym{HTML} contents |
9778 | including images if any to the browser, and deletes them when exiting | |
9779 | the group (if you want). | |
4009494e | 9780 | |
8a1cdce5 AC |
9781 | @item K b |
9782 | @kindex K b (Summary) | |
9783 | Make all the @acronym{MIME} parts have buttons in front of them. This is | |
9784 | mostly useful if you wish to save (or perform other actions) on inlined | |
9785 | parts. | |
4009494e | 9786 | |
8a1cdce5 AC |
9787 | @item K m |
9788 | @kindex K m (Summary) | |
9789 | @findex gnus-summary-repair-multipart | |
9790 | Some multipart messages are transmitted with missing or faulty headers. | |
9791 | This command will attempt to ``repair'' these messages so that they can | |
9792 | be viewed in a more pleasant manner | |
9793 | (@code{gnus-summary-repair-multipart}). | |
4009494e | 9794 | |
8a1cdce5 AC |
9795 | @item X m |
9796 | @kindex X m (Summary) | |
9797 | @findex gnus-summary-save-parts | |
9798 | Save all parts matching a @acronym{MIME} type to a directory | |
9799 | (@code{gnus-summary-save-parts}). Understands the process/prefix | |
9800 | convention (@pxref{Process/Prefix}). | |
4009494e | 9801 | |
8a1cdce5 AC |
9802 | @item M-t |
9803 | @kindex M-t (Summary) | |
9804 | @findex gnus-summary-toggle-display-buttonized | |
9805 | Toggle the buttonized display of the article buffer | |
9806 | (@code{gnus-summary-toggle-display-buttonized}). | |
4009494e | 9807 | |
8a1cdce5 AC |
9808 | @item W M w |
9809 | @kindex W M w (Summary) | |
9810 | @findex gnus-article-decode-mime-words | |
9811 | Decode RFC 2047-encoded words in the article headers | |
9812 | (@code{gnus-article-decode-mime-words}). | |
4009494e | 9813 | |
8a1cdce5 AC |
9814 | @item W M c |
9815 | @kindex W M c (Summary) | |
9816 | @findex gnus-article-decode-charset | |
9817 | Decode encoded article bodies as well as charsets | |
9818 | (@code{gnus-article-decode-charset}). | |
4009494e | 9819 | |
8a1cdce5 AC |
9820 | This command looks in the @code{Content-Type} header to determine the |
9821 | charset. If there is no such header in the article, you can give it a | |
9822 | prefix, which will prompt for the charset to decode as. In regional | |
9823 | groups where people post using some common encoding (but do not | |
9824 | include @acronym{MIME} headers), you can set the @code{charset} group/topic | |
9825 | parameter to the required charset (@pxref{Group Parameters}). | |
4009494e | 9826 | |
8a1cdce5 AC |
9827 | @item W M v |
9828 | @kindex W M v (Summary) | |
9829 | @findex gnus-mime-view-all-parts | |
9830 | View all the @acronym{MIME} parts in the current article | |
9831 | (@code{gnus-mime-view-all-parts}). | |
4009494e | 9832 | |
8a1cdce5 | 9833 | @end table |
4009494e | 9834 | |
8a1cdce5 | 9835 | Relevant variables: |
4009494e | 9836 | |
8a1cdce5 AC |
9837 | @table @code |
9838 | @item gnus-ignored-mime-types | |
9839 | @vindex gnus-ignored-mime-types | |
9840 | This is a list of regexps. @acronym{MIME} types that match a regexp from | |
9841 | this list will be completely ignored by Gnus. The default value is | |
9842 | @code{nil}. | |
4009494e | 9843 | |
8a1cdce5 | 9844 | To have all Vcards be ignored, you'd say something like this: |
4009494e | 9845 | |
8a1cdce5 AC |
9846 | @lisp |
9847 | (setq gnus-ignored-mime-types | |
9848 | '("text/x-vcard")) | |
9849 | @end lisp | |
4009494e | 9850 | |
8a1cdce5 AC |
9851 | @item gnus-article-loose-mime |
9852 | @vindex gnus-article-loose-mime | |
9853 | If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header | |
9854 | before interpreting the message as a @acronym{MIME} message. This helps | |
9855 | when reading messages from certain broken mail user agents. The | |
9856 | default is @code{t}. | |
4009494e | 9857 | |
8a1cdce5 AC |
9858 | @item gnus-article-emulate-mime |
9859 | @vindex gnus-article-emulate-mime | |
9860 | @cindex uuencode | |
9861 | @cindex yEnc | |
9862 | There are other, non-@acronym{MIME} encoding methods used. The most common | |
9863 | is @samp{uuencode}, but yEncode is also getting to be popular. If | |
9864 | this variable is non-@code{nil}, Gnus will look in message bodies to | |
9865 | see if it finds these encodings, and if so, it'll run them through the | |
9866 | Gnus @acronym{MIME} machinery. The default is @code{t}. Only | |
9867 | single-part yEnc encoded attachments can be decoded. There's no support | |
9868 | for encoding in Gnus. | |
4009494e | 9869 | |
8a1cdce5 AC |
9870 | @item gnus-unbuttonized-mime-types |
9871 | @vindex gnus-unbuttonized-mime-types | |
9872 | This is a list of regexps. @acronym{MIME} types that match a regexp from | |
9873 | this list won't have @acronym{MIME} buttons inserted unless they aren't | |
9874 | displayed or this variable is overridden by | |
9875 | @code{gnus-buttonized-mime-types}. The default value is | |
9876 | @code{(".*/.*")}. This variable is only used when | |
9877 | @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}. | |
4009494e | 9878 | |
8a1cdce5 AC |
9879 | @item gnus-buttonized-mime-types |
9880 | @vindex gnus-buttonized-mime-types | |
9881 | This is a list of regexps. @acronym{MIME} types that match a regexp from | |
9882 | this list will have @acronym{MIME} buttons inserted unless they aren't | |
9883 | displayed. This variable overrides | |
9884 | @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}. | |
9885 | This variable is only used when @code{gnus-inhibit-mime-unbuttonizing} | |
9886 | is @code{nil}. | |
4009494e | 9887 | |
1df7defd | 9888 | E.g., to see security buttons but no other buttons, you could set this |
8a1cdce5 AC |
9889 | variable to @code{("multipart/signed")} and leave |
9890 | @code{gnus-unbuttonized-mime-types} at the default value. | |
4009494e | 9891 | |
8a1cdce5 AC |
9892 | You could also add @code{"multipart/alternative"} to this list to |
9893 | display radio buttons that allow you to choose one of two media types | |
9894 | those mails include. See also @code{mm-discouraged-alternatives} | |
9895 | (@pxref{Display Customization, ,Display Customization, emacs-mime, The | |
9896 | Emacs MIME Manual}). | |
4009494e | 9897 | |
8a1cdce5 AC |
9898 | @item gnus-inhibit-mime-unbuttonizing |
9899 | @vindex gnus-inhibit-mime-unbuttonizing | |
9900 | If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The | |
9901 | default value is @code{nil}. | |
4009494e | 9902 | |
8a1cdce5 AC |
9903 | @item gnus-article-mime-part-function |
9904 | @vindex gnus-article-mime-part-function | |
9905 | For each @acronym{MIME} part, this function will be called with the @acronym{MIME} | |
9906 | handle as the parameter. The function is meant to be used to allow | |
1df7defd PE |
9907 | users to gather information from the article (e.g., add Vcard info to |
9908 | the bbdb database) or to do actions based on parts (e.g., automatically | |
8a1cdce5 AC |
9909 | save all jpegs into some directory). |
9910 | ||
9911 | Here's an example function the does the latter: | |
4009494e GM |
9912 | |
9913 | @lisp | |
8a1cdce5 AC |
9914 | (defun my-save-all-jpeg-parts (handle) |
9915 | (when (equal (car (mm-handle-type handle)) "image/jpeg") | |
9916 | (with-temp-buffer | |
9917 | (insert (mm-get-part handle)) | |
9918 | (write-region (point-min) (point-max) | |
9919 | (read-file-name "Save jpeg to: "))))) | |
9920 | (setq gnus-article-mime-part-function | |
9921 | 'my-save-all-jpeg-parts) | |
4009494e GM |
9922 | @end lisp |
9923 | ||
8a1cdce5 AC |
9924 | @vindex gnus-mime-multipart-functions |
9925 | @item gnus-mime-multipart-functions | |
9926 | Alist of @acronym{MIME} multipart types and functions to handle them. | |
4009494e | 9927 | |
8a1cdce5 AC |
9928 | @vindex gnus-mime-display-multipart-alternative-as-mixed |
9929 | @item gnus-mime-display-multipart-alternative-as-mixed | |
9930 | Display "multipart/alternative" parts as "multipart/mixed". | |
4009494e | 9931 | |
8a1cdce5 AC |
9932 | @vindex gnus-mime-display-multipart-related-as-mixed |
9933 | @item gnus-mime-display-multipart-related-as-mixed | |
9934 | Display "multipart/related" parts as "multipart/mixed". | |
4009494e | 9935 | |
8a1cdce5 AC |
9936 | If displaying @samp{text/html} is discouraged, see |
9937 | @code{mm-discouraged-alternatives}, images or other material inside a | |
9938 | "multipart/related" part might be overlooked when this variable is | |
9939 | @code{nil}. @ref{Display Customization, Display Customization, , | |
9940 | emacs-mime, Emacs-Mime Manual}. | |
4009494e | 9941 | |
8a1cdce5 AC |
9942 | @vindex gnus-mime-display-multipart-as-mixed |
9943 | @item gnus-mime-display-multipart-as-mixed | |
9944 | Display "multipart" parts as "multipart/mixed". If @code{t}, it | |
9945 | overrides @code{nil} values of | |
9946 | @code{gnus-mime-display-multipart-alternative-as-mixed} and | |
9947 | @code{gnus-mime-display-multipart-related-as-mixed}. | |
4009494e | 9948 | |
8a1cdce5 AC |
9949 | @vindex mm-file-name-rewrite-functions |
9950 | @item mm-file-name-rewrite-functions | |
9951 | List of functions used for rewriting file names of @acronym{MIME} parts. | |
9952 | Each function takes a file name as input and returns a file name. | |
4009494e | 9953 | |
8a1cdce5 AC |
9954 | Ready-made functions include@* |
9955 | @code{mm-file-name-delete-whitespace}, | |
9956 | @code{mm-file-name-trim-whitespace}, | |
9957 | @code{mm-file-name-collapse-whitespace}, and | |
9958 | @code{mm-file-name-replace-whitespace}. The later uses the value of | |
9959 | the variable @code{mm-file-name-replace-whitespace} to replace each | |
9960 | whitespace character in a file name with that string; default value | |
9961 | is @code{"_"} (a single underscore). | |
9962 | @findex mm-file-name-delete-whitespace | |
9963 | @findex mm-file-name-trim-whitespace | |
9964 | @findex mm-file-name-collapse-whitespace | |
9965 | @findex mm-file-name-replace-whitespace | |
9966 | @vindex mm-file-name-replace-whitespace | |
4009494e | 9967 | |
8a1cdce5 AC |
9968 | The standard functions @code{capitalize}, @code{downcase}, |
9969 | @code{upcase}, and @code{upcase-initials} may be useful, too. | |
4009494e | 9970 | |
8a1cdce5 AC |
9971 | Everybody knows that whitespace characters in file names are evil, |
9972 | except those who don't know. If you receive lots of attachments from | |
9973 | such unenlightened users, you can make live easier by adding | |
4009494e GM |
9974 | |
9975 | @lisp | |
8a1cdce5 AC |
9976 | (setq mm-file-name-rewrite-functions |
9977 | '(mm-file-name-trim-whitespace | |
9978 | mm-file-name-collapse-whitespace | |
9979 | mm-file-name-replace-whitespace)) | |
4009494e GM |
9980 | @end lisp |
9981 | ||
8a1cdce5 AC |
9982 | @noindent |
9983 | to your @file{~/.gnus.el} file. | |
4009494e | 9984 | |
4009494e GM |
9985 | @end table |
9986 | ||
4009494e | 9987 | |
8a1cdce5 AC |
9988 | @node Charsets |
9989 | @section Charsets | |
9990 | @cindex charsets | |
4009494e | 9991 | |
8a1cdce5 AC |
9992 | People use different charsets, and we have @acronym{MIME} to let us know what |
9993 | charsets they use. Or rather, we wish we had. Many people use | |
9994 | newsreaders and mailers that do not understand or use @acronym{MIME}, and | |
9995 | just send out messages without saying what character sets they use. To | |
9996 | help a bit with this, some local news hierarchies have policies that say | |
9997 | what character set is the default. For instance, the @samp{fj} | |
9998 | hierarchy uses @code{iso-2022-jp}. | |
4009494e | 9999 | |
8a1cdce5 AC |
10000 | @vindex gnus-group-charset-alist |
10001 | This knowledge is encoded in the @code{gnus-group-charset-alist} | |
10002 | variable, which is an alist of regexps (use the first item to match full | |
10003 | group names) and default charsets to be used when reading these groups. | |
4009494e | 10004 | |
8a1cdce5 AC |
10005 | @vindex gnus-newsgroup-ignored-charsets |
10006 | In addition, some people do use soi-disant @acronym{MIME}-aware agents that | |
10007 | aren't. These blithely mark messages as being in @code{iso-8859-1} | |
10008 | even if they really are in @code{koi-8}. To help here, the | |
10009 | @code{gnus-newsgroup-ignored-charsets} variable can be used. The | |
10010 | charsets that are listed here will be ignored. The variable can be | |
10011 | set on a group-by-group basis using the group parameters (@pxref{Group | |
10012 | Parameters}). The default value is @code{(unknown-8bit x-unknown)}, | |
10013 | which includes values some agents insist on having in there. | |
4009494e | 10014 | |
8a1cdce5 AC |
10015 | @vindex gnus-group-posting-charset-alist |
10016 | When posting, @code{gnus-group-posting-charset-alist} is used to | |
10017 | determine which charsets should not be encoded using the @acronym{MIME} | |
10018 | encodings. For instance, some hierarchies discourage using | |
10019 | quoted-printable header encoding. | |
4009494e | 10020 | |
8a1cdce5 AC |
10021 | This variable is an alist of regexps and permitted unencoded charsets |
10022 | for posting. Each element of the alist has the form @code{(}@var{test | |
10023 | header body-list}@code{)}, where: | |
4009494e | 10024 | |
8a1cdce5 AC |
10025 | @table @var |
10026 | @item test | |
10027 | is either a regular expression matching the newsgroup header or a | |
10028 | variable to query, | |
10029 | @item header | |
10030 | is the charset which may be left unencoded in the header (@code{nil} | |
10031 | means encode all charsets), | |
10032 | @item body-list | |
10033 | is a list of charsets which may be encoded using 8bit content-transfer | |
10034 | encoding in the body, or one of the special values @code{nil} (always | |
10035 | encode using quoted-printable) or @code{t} (always use 8bit). | |
10036 | @end table | |
4009494e | 10037 | |
8a1cdce5 AC |
10038 | @cindex Russian |
10039 | @cindex koi8-r | |
10040 | @cindex koi8-u | |
10041 | @cindex iso-8859-5 | |
10042 | @cindex coding system aliases | |
10043 | @cindex preferred charset | |
4009494e | 10044 | |
8a1cdce5 AC |
10045 | @xref{Encoding Customization, , Encoding Customization, emacs-mime, |
10046 | The Emacs MIME Manual}, for additional variables that control which | |
10047 | MIME charsets are used when sending messages. | |
4009494e | 10048 | |
8a1cdce5 | 10049 | Other charset tricks that may be useful, although not Gnus-specific: |
4009494e | 10050 | |
8a1cdce5 AC |
10051 | If there are several @acronym{MIME} charsets that encode the same Emacs |
10052 | charset, you can choose what charset to use by saying the following: | |
4009494e | 10053 | |
8a1cdce5 AC |
10054 | @lisp |
10055 | (put-charset-property 'cyrillic-iso8859-5 | |
10056 | 'preferred-coding-system 'koi8-r) | |
10057 | @end lisp | |
4009494e | 10058 | |
8a1cdce5 AC |
10059 | This means that Russian will be encoded using @code{koi8-r} instead of |
10060 | the default @code{iso-8859-5} @acronym{MIME} charset. | |
4009494e | 10061 | |
8a1cdce5 | 10062 | If you want to read messages in @code{koi8-u}, you can cheat and say |
4009494e | 10063 | |
8a1cdce5 AC |
10064 | @lisp |
10065 | (define-coding-system-alias 'koi8-u 'koi8-r) | |
10066 | @end lisp | |
4009494e | 10067 | |
8a1cdce5 | 10068 | This will almost do the right thing. |
4009494e | 10069 | |
8a1cdce5 AC |
10070 | And finally, to read charsets like @code{windows-1251}, you can say |
10071 | something like | |
4009494e GM |
10072 | |
10073 | @lisp | |
8a1cdce5 AC |
10074 | (codepage-setup 1251) |
10075 | (define-coding-system-alias 'windows-1251 'cp1251) | |
4009494e GM |
10076 | @end lisp |
10077 | ||
4009494e | 10078 | |
8a1cdce5 AC |
10079 | @node Article Commands |
10080 | @section Article Commands | |
4009494e | 10081 | |
8a1cdce5 | 10082 | @table @kbd |
4009494e | 10083 | |
8a1cdce5 AC |
10084 | @item A P |
10085 | @cindex PostScript | |
10086 | @cindex printing | |
10087 | @kindex A P (Summary) | |
10088 | @vindex gnus-ps-print-hook | |
10089 | @findex gnus-summary-print-article | |
10090 | Generate and print a PostScript image of the article buffer | |
10091 | (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will | |
10092 | be run just before printing the buffer. An alternative way to print | |
10093 | article is to use Muttprint (@pxref{Saving Articles}). | |
4009494e | 10094 | |
8a1cdce5 AC |
10095 | @item A C |
10096 | @vindex gnus-fetch-partial-articles | |
10097 | @findex gnus-summary-show-complete-article | |
10098 | If @code{<backend>-fetch-partial-articles} is non-@code{nil}, Gnus will | |
10099 | fetch partial articles, if the backend it fetches them from supports | |
10100 | it. Currently only @code{nnimap} does. If you're looking at a | |
10101 | partial article, and want to see the complete article instead, then | |
10102 | the @kbd{A C} command (@code{gnus-summary-show-complete-article}) will | |
10103 | do so. | |
4009494e | 10104 | |
4009494e GM |
10105 | @end table |
10106 | ||
10107 | ||
8a1cdce5 AC |
10108 | @node Summary Sorting |
10109 | @section Summary Sorting | |
10110 | @cindex summary sorting | |
4009494e | 10111 | |
8a1cdce5 AC |
10112 | You can have the summary buffer sorted in various ways, even though I |
10113 | can't really see why you'd want that. | |
4009494e GM |
10114 | |
10115 | @table @kbd | |
10116 | ||
8a1cdce5 AC |
10117 | @item C-c C-s C-n |
10118 | @kindex C-c C-s C-n (Summary) | |
10119 | @findex gnus-summary-sort-by-number | |
10120 | Sort by article number (@code{gnus-summary-sort-by-number}). | |
4009494e | 10121 | |
8a1cdce5 AC |
10122 | @item C-c C-s C-m C-n |
10123 | @kindex C-c C-s C-n (Summary) | |
10124 | @findex gnus-summary-sort-by-most-recent-number | |
10125 | Sort by most recent article number | |
10126 | (@code{gnus-summary-sort-by-most-recent-number}). | |
4009494e | 10127 | |
8a1cdce5 AC |
10128 | @item C-c C-s C-a |
10129 | @kindex C-c C-s C-a (Summary) | |
10130 | @findex gnus-summary-sort-by-author | |
10131 | Sort by author (@code{gnus-summary-sort-by-author}). | |
4009494e | 10132 | |
8a1cdce5 AC |
10133 | @item C-c C-s C-t |
10134 | @kindex C-c C-s C-t (Summary) | |
10135 | @findex gnus-summary-sort-by-recipient | |
10136 | Sort by recipient (@code{gnus-summary-sort-by-recipient}). | |
4009494e | 10137 | |
8a1cdce5 AC |
10138 | @item C-c C-s C-s |
10139 | @kindex C-c C-s C-s (Summary) | |
10140 | @findex gnus-summary-sort-by-subject | |
10141 | Sort by subject (@code{gnus-summary-sort-by-subject}). | |
4009494e | 10142 | |
8a1cdce5 AC |
10143 | @item C-c C-s C-d |
10144 | @kindex C-c C-s C-d (Summary) | |
10145 | @findex gnus-summary-sort-by-date | |
10146 | Sort by date (@code{gnus-summary-sort-by-date}). | |
4009494e | 10147 | |
8a1cdce5 AC |
10148 | @item C-c C-s C-m C-d |
10149 | @kindex C-c C-s C-m C-d (Summary) | |
10150 | @findex gnus-summary-sort-by-most-recent-date | |
10151 | Sort by most recent date (@code{gnus-summary-sort-by-most-recent-date}). | |
4009494e | 10152 | |
8a1cdce5 AC |
10153 | @item C-c C-s C-l |
10154 | @kindex C-c C-s C-l (Summary) | |
10155 | @findex gnus-summary-sort-by-lines | |
10156 | Sort by lines (@code{gnus-summary-sort-by-lines}). | |
4009494e | 10157 | |
8a1cdce5 AC |
10158 | @item C-c C-s C-c |
10159 | @kindex C-c C-s C-c (Summary) | |
10160 | @findex gnus-summary-sort-by-chars | |
10161 | Sort by article length (@code{gnus-summary-sort-by-chars}). | |
4009494e | 10162 | |
8a1cdce5 AC |
10163 | @item C-c C-s C-i |
10164 | @kindex C-c C-s C-i (Summary) | |
10165 | @findex gnus-summary-sort-by-score | |
10166 | Sort by score (@code{gnus-summary-sort-by-score}). | |
4009494e | 10167 | |
8a1cdce5 AC |
10168 | @item C-c C-s C-r |
10169 | @kindex C-c C-s C-r (Summary) | |
10170 | @findex gnus-summary-sort-by-random | |
10171 | Randomize (@code{gnus-summary-sort-by-random}). | |
4009494e | 10172 | |
8a1cdce5 AC |
10173 | @item C-c C-s C-o |
10174 | @kindex C-c C-s C-o (Summary) | |
10175 | @findex gnus-summary-sort-by-original | |
10176 | Sort using the default sorting method | |
10177 | (@code{gnus-summary-sort-by-original}). | |
4009494e GM |
10178 | @end table |
10179 | ||
8a1cdce5 AC |
10180 | These functions will work both when you use threading and when you don't |
10181 | use threading. In the latter case, all summary lines will be sorted, | |
10182 | line by line. In the former case, sorting will be done on a | |
10183 | root-by-root basis, which might not be what you were looking for. To | |
10184 | toggle whether to use threading, type @kbd{T T} (@pxref{Thread | |
10185 | Commands}). | |
4009494e | 10186 | |
8a1cdce5 | 10187 | If a prefix argument if given, the sort order is reversed. |
4009494e | 10188 | |
4009494e | 10189 | |
8a1cdce5 AC |
10190 | @node Finding the Parent |
10191 | @section Finding the Parent | |
10192 | @cindex parent articles | |
10193 | @cindex referring articles | |
4009494e | 10194 | |
8a1cdce5 AC |
10195 | @table @kbd |
10196 | @item ^ | |
10197 | @kindex ^ (Summary) | |
10198 | @findex gnus-summary-refer-parent-article | |
10199 | If you'd like to read the parent of the current article, and it is not | |
10200 | displayed in the summary buffer, you might still be able to. That is, | |
10201 | if the current group is fetched by @acronym{NNTP}, the parent hasn't expired | |
10202 | and the @code{References} in the current article are not mangled, you | |
10203 | can just press @kbd{^} or @kbd{A r} | |
10204 | (@code{gnus-summary-refer-parent-article}). If everything goes well, | |
10205 | you'll get the parent. If the parent is already displayed in the | |
10206 | summary buffer, point will just move to this article. | |
4009494e | 10207 | |
8a1cdce5 AC |
10208 | If given a positive numerical prefix, fetch that many articles back into |
10209 | the ancestry. If given a negative numerical prefix, fetch just that | |
10210 | ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the | |
10211 | grandparent and the grandgrandparent of the current article. If you say | |
10212 | @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current | |
10213 | article. | |
4009494e | 10214 | |
8a1cdce5 AC |
10215 | @item A R (Summary) |
10216 | @findex gnus-summary-refer-references | |
10217 | @kindex A R (Summary) | |
10218 | Fetch all articles mentioned in the @code{References} header of the | |
10219 | article (@code{gnus-summary-refer-references}). | |
4009494e | 10220 | |
8a1cdce5 AC |
10221 | @item A T (Summary) |
10222 | @findex gnus-summary-refer-thread | |
10223 | @kindex A T (Summary) | |
10224 | Display the full thread where the current article appears | |
10225 | (@code{gnus-summary-refer-thread}). This command has to fetch all the | |
10226 | headers in the current group to work, so it usually takes a while. If | |
10227 | you do it often, you may consider setting @code{gnus-fetch-old-headers} | |
10228 | to @code{invisible} (@pxref{Filling In Threads}). This won't have any | |
10229 | visible effects normally, but it'll make this command work a whole lot | |
10230 | faster. Of course, it'll make group entry somewhat slow. | |
4009494e | 10231 | |
8a1cdce5 | 10232 | @vindex gnus-refer-thread-limit |
1df7defd | 10233 | The @code{gnus-refer-thread-limit} variable says how many old (i.e., |
8a1cdce5 AC |
10234 | articles before the first displayed in the current group) headers to |
10235 | fetch when doing this command. The default is 200. If @code{t}, all | |
10236 | the available headers will be fetched. This variable can be overridden | |
10237 | by giving the @kbd{A T} command a numerical prefix. | |
61b1af82 | 10238 | |
8a1cdce5 AC |
10239 | @item M-^ (Summary) |
10240 | @findex gnus-summary-refer-article | |
10241 | @kindex M-^ (Summary) | |
10242 | @cindex Message-ID | |
10243 | @cindex fetching by Message-ID | |
10244 | You can also ask Gnus for an arbitrary article, no matter what group it | |
10245 | belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you | |
10246 | for a @code{Message-ID}, which is one of those long, hard-to-read | |
10247 | thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. | |
10248 | You have to get it all exactly right. No fuzzy searches, I'm afraid. | |
4009494e | 10249 | |
8a1cdce5 AC |
10250 | Gnus looks for the @code{Message-ID} in the headers that have already |
10251 | been fetched, but also tries all the select methods specified by | |
10252 | @code{gnus-refer-article-method} if it is not found. | |
10253 | @end table | |
4009494e | 10254 | |
8a1cdce5 AC |
10255 | @vindex gnus-refer-article-method |
10256 | If the group you are reading is located on a back end that does not | |
10257 | support fetching by @code{Message-ID} very well (like @code{nnspool}), | |
10258 | you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It | |
10259 | would, perhaps, be best if the @acronym{NNTP} server you consult is the one | |
10260 | updating the spool you are reading from, but that's not really | |
10261 | necessary. | |
4009494e | 10262 | |
8a1cdce5 AC |
10263 | It can also be a list of select methods, as well as the special symbol |
10264 | @code{current}, which means to use the current select method. If it | |
10265 | is a list, Gnus will try all the methods in the list until it finds a | |
10266 | match. | |
4009494e | 10267 | |
8a1cdce5 AC |
10268 | Here's an example setting that will first try the current method, and |
10269 | then ask Google if that fails: | |
4009494e | 10270 | |
8a1cdce5 AC |
10271 | @lisp |
10272 | (setq gnus-refer-article-method | |
10273 | '(current | |
10274 | (nnweb "google" (nnweb-type google)))) | |
10275 | @end lisp | |
4009494e | 10276 | |
8a1cdce5 AC |
10277 | Most of the mail back ends support fetching by @code{Message-ID}, but |
10278 | do not do a particularly excellent job at it. That is, @code{nnmbox}, | |
10279 | @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate | |
10280 | articles from any groups, while @code{nnfolder}, and @code{nnimap} are | |
10281 | only able to locate articles that have been posted to the current | |
10282 | group. @code{nnmh} does not support this at all. | |
4009494e | 10283 | |
8a1cdce5 AC |
10284 | Fortunately, the special @code{nnregistry} back end is able to locate |
10285 | articles in any groups, regardless of their back end (@pxref{Registry | |
10286 | Article Refer Method, fetching by @code{Message-ID} using the | |
10287 | registry}). | |
61b1af82 | 10288 | |
8a1cdce5 AC |
10289 | @node Alternative Approaches |
10290 | @section Alternative Approaches | |
61b1af82 | 10291 | |
8a1cdce5 AC |
10292 | Different people like to read news using different methods. This being |
10293 | Gnus, we offer a small selection of minor modes for the summary buffers. | |
4009494e | 10294 | |
8a1cdce5 AC |
10295 | @menu |
10296 | * Pick and Read:: First mark articles and then read them. | |
10297 | * Binary Groups:: Auto-decode all articles. | |
10298 | @end menu | |
25f28806 | 10299 | |
4009494e | 10300 | |
8a1cdce5 AC |
10301 | @node Pick and Read |
10302 | @subsection Pick and Read | |
10303 | @cindex pick and read | |
10304 | ||
10305 | Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use | |
10306 | a two-phased reading interface. The user first marks in a summary | |
10307 | buffer the articles she wants to read. Then she starts reading the | |
10308 | articles with just an article buffer displayed. | |
4009494e | 10309 | |
8a1cdce5 AC |
10310 | @findex gnus-pick-mode |
10311 | @kindex M-x gnus-pick-mode | |
10312 | Gnus provides a summary buffer minor mode that allows | |
10313 | this---@code{gnus-pick-mode}. This basically means that a few process | |
10314 | mark commands become one-keystroke commands to allow easy marking, and | |
10315 | it provides one additional command for switching to the summary buffer. | |
4009494e | 10316 | |
8a1cdce5 | 10317 | Here are the available keystrokes when using pick mode: |
4009494e | 10318 | |
8a1cdce5 AC |
10319 | @table @kbd |
10320 | @item . | |
10321 | @kindex . (Pick) | |
10322 | @findex gnus-pick-article-or-thread | |
10323 | Pick the article or thread on the current line | |
10324 | (@code{gnus-pick-article-or-thread}). If the variable | |
10325 | @code{gnus-thread-hide-subtree} is true, then this key selects the | |
10326 | entire thread when used at the first article of the thread. Otherwise, | |
10327 | it selects just the article. If given a numerical prefix, go to that | |
10328 | thread or article and pick it. (The line number is normally displayed | |
10329 | at the beginning of the summary pick lines.) | |
4009494e | 10330 | |
8a1cdce5 AC |
10331 | @item SPACE |
10332 | @kindex SPACE (Pick) | |
10333 | @findex gnus-pick-next-page | |
10334 | Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If | |
10335 | at the end of the buffer, start reading the picked articles. | |
4009494e | 10336 | |
8a1cdce5 AC |
10337 | @item u |
10338 | @kindex u (Pick) | |
10339 | @findex gnus-pick-unmark-article-or-thread. | |
10340 | Unpick the thread or article | |
10341 | (@code{gnus-pick-unmark-article-or-thread}). If the variable | |
10342 | @code{gnus-thread-hide-subtree} is true, then this key unpicks the | |
10343 | thread if used at the first article of the thread. Otherwise it unpicks | |
10344 | just the article. You can give this key a numerical prefix to unpick | |
10345 | the thread or article at that line. | |
4009494e | 10346 | |
8a1cdce5 AC |
10347 | @item RET |
10348 | @kindex RET (Pick) | |
10349 | @findex gnus-pick-start-reading | |
10350 | @vindex gnus-pick-display-summary | |
10351 | Start reading the picked articles (@code{gnus-pick-start-reading}). If | |
10352 | given a prefix, mark all unpicked articles as read first. If | |
10353 | @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer | |
10354 | will still be visible when you are reading. | |
4009494e | 10355 | |
8a1cdce5 | 10356 | @end table |
4009494e | 10357 | |
8a1cdce5 AC |
10358 | All the normal summary mode commands are still available in the |
10359 | pick-mode, with the exception of @kbd{u}. However @kbd{!} is available | |
10360 | which is mapped to the same function | |
10361 | @code{gnus-summary-tick-article-forward}. | |
10362 | ||
10363 | If this sounds like a good idea to you, you could say: | |
4009494e GM |
10364 | |
10365 | @lisp | |
8a1cdce5 | 10366 | (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode) |
4009494e GM |
10367 | @end lisp |
10368 | ||
8a1cdce5 AC |
10369 | @vindex gnus-pick-mode-hook |
10370 | @code{gnus-pick-mode-hook} is run in pick minor mode buffers. | |
4009494e | 10371 | |
8a1cdce5 AC |
10372 | @vindex gnus-mark-unpicked-articles-as-read |
10373 | If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark | |
10374 | all unpicked articles as read. The default is @code{nil}. | |
4009494e | 10375 | |
8a1cdce5 AC |
10376 | @vindex gnus-summary-pick-line-format |
10377 | The summary line format in pick mode is slightly different from the | |
10378 | standard format. At the beginning of each line the line number is | |
10379 | displayed. The pick mode line format is controlled by the | |
10380 | @code{gnus-summary-pick-line-format} variable (@pxref{Formatting | |
10381 | Variables}). It accepts the same format specs that | |
10382 | @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). | |
4009494e | 10383 | |
4009494e | 10384 | |
8a1cdce5 AC |
10385 | @node Binary Groups |
10386 | @subsection Binary Groups | |
10387 | @cindex binary groups | |
4009494e | 10388 | |
8a1cdce5 AC |
10389 | @findex gnus-binary-mode |
10390 | @kindex M-x gnus-binary-mode | |
10391 | If you spend much time in binary groups, you may grow tired of hitting | |
10392 | @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode} | |
10393 | is a minor mode for summary buffers that makes all ordinary Gnus article | |
10394 | selection functions uudecode series of articles and display the result | |
10395 | instead of just displaying the articles the normal way. | |
4009494e | 10396 | |
8a1cdce5 AC |
10397 | @kindex g (Binary) |
10398 | @findex gnus-binary-show-article | |
10399 | The only way, in fact, to see the actual articles is the @kbd{g} | |
10400 | command, when you have turned on this mode | |
10401 | (@code{gnus-binary-show-article}). | |
4009494e | 10402 | |
8a1cdce5 AC |
10403 | @vindex gnus-binary-mode-hook |
10404 | @code{gnus-binary-mode-hook} is called in binary minor mode buffers. | |
4009494e | 10405 | |
4009494e | 10406 | |
8a1cdce5 AC |
10407 | @node Tree Display |
10408 | @section Tree Display | |
10409 | @cindex trees | |
01c52d31 | 10410 | |
8a1cdce5 AC |
10411 | @vindex gnus-use-trees |
10412 | If you don't like the normal Gnus summary display, you might try setting | |
10413 | @code{gnus-use-trees} to @code{t}. This will create (by default) an | |
10414 | additional @dfn{tree buffer}. You can execute all summary mode commands | |
10415 | in the tree buffer. | |
01c52d31 | 10416 | |
8a1cdce5 | 10417 | There are a few variables to customize the tree display, of course: |
01c52d31 | 10418 | |
8a1cdce5 AC |
10419 | @table @code |
10420 | @item gnus-tree-mode-hook | |
10421 | @vindex gnus-tree-mode-hook | |
10422 | A hook called in all tree mode buffers. | |
4009494e | 10423 | |
8a1cdce5 AC |
10424 | @item gnus-tree-mode-line-format |
10425 | @vindex gnus-tree-mode-line-format | |
10426 | A format string for the mode bar in the tree mode buffers (@pxref{Mode | |
10427 | Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list | |
10428 | of valid specs, @pxref{Summary Buffer Mode Line}. | |
4009494e | 10429 | |
8a1cdce5 AC |
10430 | @item gnus-selected-tree-face |
10431 | @vindex gnus-selected-tree-face | |
10432 | Face used for highlighting the selected article in the tree buffer. The | |
10433 | default is @code{modeline}. | |
4009494e | 10434 | |
8a1cdce5 AC |
10435 | @item gnus-tree-line-format |
10436 | @vindex gnus-tree-line-format | |
10437 | A format string for the tree nodes. The name is a bit of a misnomer, | |
10438 | though---it doesn't define a line, but just the node. The default value | |
10439 | is @samp{%(%[%3,3n%]%)}, which displays the first three characters of | |
10440 | the name of the poster. It is vital that all nodes are of the same | |
10441 | length, so you @emph{must} use @samp{%4,4n}-like specifiers. | |
4009494e | 10442 | |
8a1cdce5 | 10443 | Valid specs are: |
4009494e | 10444 | |
8a1cdce5 AC |
10445 | @table @samp |
10446 | @item n | |
10447 | The name of the poster. | |
10448 | @item f | |
10449 | The @code{From} header. | |
10450 | @item N | |
10451 | The number of the article. | |
10452 | @item [ | |
10453 | The opening bracket. | |
10454 | @item ] | |
10455 | The closing bracket. | |
10456 | @item s | |
10457 | The subject. | |
10458 | @end table | |
9b3ebcb6 | 10459 | |
8a1cdce5 | 10460 | @xref{Formatting Variables}. |
9b3ebcb6 | 10461 | |
8a1cdce5 | 10462 | Variables related to the display are: |
9b3ebcb6 | 10463 | |
8a1cdce5 AC |
10464 | @table @code |
10465 | @item gnus-tree-brackets | |
10466 | @vindex gnus-tree-brackets | |
10467 | This is used for differentiating between ``real'' articles and | |
10468 | ``sparse'' articles. The format is | |
10469 | @example | |
10470 | ((@var{real-open} . @var{real-close}) | |
10471 | (@var{sparse-open} . @var{sparse-close}) | |
10472 | (@var{dummy-open} . @var{dummy-close})) | |
10473 | @end example | |
10474 | and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}. | |
1d4d7664 | 10475 | |
8a1cdce5 AC |
10476 | @item gnus-tree-parent-child-edges |
10477 | @vindex gnus-tree-parent-child-edges | |
10478 | This is a list that contains the characters used for connecting parent | |
10479 | nodes to their children. The default is @code{(?- ?\\ ?|)}. | |
4009494e | 10480 | |
8a1cdce5 | 10481 | @end table |
4009494e | 10482 | |
8a1cdce5 AC |
10483 | @item gnus-tree-minimize-window |
10484 | @vindex gnus-tree-minimize-window | |
10485 | If this variable is non-@code{nil}, Gnus will try to keep the tree | |
10486 | buffer as small as possible to allow more room for the other Gnus | |
10487 | windows. If this variable is a number, the tree buffer will never be | |
10488 | higher than that number. The default is @code{t}. Note that if you | |
10489 | have several windows displayed side-by-side in a frame and the tree | |
10490 | buffer is one of these, minimizing the tree window will also resize all | |
10491 | other windows displayed next to it. | |
4009494e | 10492 | |
8a1cdce5 AC |
10493 | You may also wish to add the following hook to keep the window minimized |
10494 | at all times: | |
4009494e | 10495 | |
8a1cdce5 AC |
10496 | @lisp |
10497 | (add-hook 'gnus-configure-windows-hook | |
10498 | 'gnus-tree-perhaps-minimize) | |
10499 | @end lisp | |
4009494e | 10500 | |
8a1cdce5 AC |
10501 | @item gnus-generate-tree-function |
10502 | @vindex gnus-generate-tree-function | |
10503 | @findex gnus-generate-horizontal-tree | |
10504 | @findex gnus-generate-vertical-tree | |
10505 | The function that actually generates the thread tree. Two predefined | |
10506 | functions are available: @code{gnus-generate-horizontal-tree} and | |
10507 | @code{gnus-generate-vertical-tree} (which is the default). | |
4009494e | 10508 | |
8a1cdce5 | 10509 | @end table |
4009494e | 10510 | |
8a1cdce5 | 10511 | Here's an example from a horizontal tree buffer: |
4009494e | 10512 | |
8a1cdce5 AC |
10513 | @example |
10514 | @{***@}-(***)-[odd]-[Gun] | |
10515 | | \[Jan] | |
10516 | | \[odd]-[Eri] | |
10517 | | \(***)-[Eri] | |
10518 | | \[odd]-[Paa] | |
10519 | \[Bjo] | |
10520 | \[Gun] | |
10521 | \[Gun]-[Jor] | |
10522 | @end example | |
4009494e | 10523 | |
8a1cdce5 | 10524 | Here's the same thread displayed in a vertical tree buffer: |
4009494e | 10525 | |
8a1cdce5 AC |
10526 | @example |
10527 | @group | |
10528 | @{***@} | |
10529 | |--------------------------\-----\-----\ | |
10530 | (***) [Bjo] [Gun] [Gun] | |
10531 | |--\-----\-----\ | | |
10532 | [odd] [Jan] [odd] (***) [Jor] | |
10533 | | | |--\ | |
10534 | [Gun] [Eri] [Eri] [odd] | |
10535 | | | |
10536 | [Paa] | |
10537 | @end group | |
10538 | @end example | |
4009494e | 10539 | |
8a1cdce5 AC |
10540 | If you're using horizontal trees, it might be nice to display the trees |
10541 | side-by-side with the summary buffer. You could add something like the | |
10542 | following to your @file{~/.gnus.el} file: | |
4009494e GM |
10543 | |
10544 | @lisp | |
8a1cdce5 AC |
10545 | (setq gnus-use-trees t |
10546 | gnus-generate-tree-function 'gnus-generate-horizontal-tree | |
10547 | gnus-tree-minimize-window nil) | |
10548 | (gnus-add-configuration | |
10549 | '(article | |
10550 | (vertical 1.0 | |
10551 | (horizontal 0.25 | |
10552 | (summary 0.75 point) | |
10553 | (tree 1.0)) | |
10554 | (article 1.0)))) | |
4009494e GM |
10555 | @end lisp |
10556 | ||
8a1cdce5 | 10557 | @xref{Window Layout}. |
4009494e | 10558 | |
4009494e | 10559 | |
8a1cdce5 AC |
10560 | @node Mail Group Commands |
10561 | @section Mail Group Commands | |
10562 | @cindex mail group commands | |
4009494e | 10563 | |
8a1cdce5 AC |
10564 | Some commands only make sense in mail groups. If these commands are |
10565 | invalid in the current group, they will raise a hell and let you know. | |
4009494e | 10566 | |
8a1cdce5 AC |
10567 | All these commands (except the expiry and edit commands) use the |
10568 | process/prefix convention (@pxref{Process/Prefix}). | |
4009494e | 10569 | |
8a1cdce5 | 10570 | @table @kbd |
4009494e | 10571 | |
8a1cdce5 AC |
10572 | @item B e |
10573 | @kindex B e (Summary) | |
10574 | @findex gnus-summary-expire-articles | |
10575 | @cindex expiring mail | |
10576 | Run all expirable articles in the current group through the expiry | |
10577 | process (@code{gnus-summary-expire-articles}). That is, delete all | |
10578 | expirable articles in the group that have been around for a while. | |
10579 | (@pxref{Expiring Mail}). | |
4009494e | 10580 | |
8a1cdce5 AC |
10581 | @item B C-M-e |
10582 | @kindex B C-M-e (Summary) | |
10583 | @findex gnus-summary-expire-articles-now | |
10584 | @cindex expiring mail | |
10585 | Delete all the expirable articles in the group | |
10586 | (@code{gnus-summary-expire-articles-now}). This means that @strong{all} | |
10587 | articles eligible for expiry in the current group will | |
10588 | disappear forever into that big @file{/dev/null} in the sky. | |
4009494e | 10589 | |
8a1cdce5 AC |
10590 | @item B DEL |
10591 | @kindex B DEL (Summary) | |
10592 | @cindex deleting mail | |
10593 | @findex gnus-summary-delete-article | |
10594 | @c @icon{gnus-summary-mail-delete} | |
10595 | Delete the mail article. This is ``delete'' as in ``delete it from your | |
10596 | disk forever and ever, never to return again.'' Use with caution. | |
10597 | (@code{gnus-summary-delete-article}). | |
4009494e | 10598 | |
8a1cdce5 AC |
10599 | @item B m |
10600 | @kindex B m (Summary) | |
10601 | @cindex move mail | |
10602 | @findex gnus-summary-move-article | |
10603 | @vindex gnus-preserve-marks | |
10604 | Move the article from one mail group to another | |
10605 | (@code{gnus-summary-move-article}). Marks will be preserved if | |
10606 | @code{gnus-preserve-marks} is non-@code{nil} (which is the default). | |
4009494e | 10607 | |
8a1cdce5 AC |
10608 | @item B c |
10609 | @kindex B c (Summary) | |
10610 | @cindex copy mail | |
10611 | @findex gnus-summary-copy-article | |
10612 | @c @icon{gnus-summary-mail-copy} | |
10613 | Copy the article from one group (mail group or not) to a mail group | |
10614 | (@code{gnus-summary-copy-article}). Marks will be preserved if | |
10615 | @code{gnus-preserve-marks} is non-@code{nil} (which is the default). | |
4009494e | 10616 | |
8a1cdce5 AC |
10617 | @item B B |
10618 | @kindex B B (Summary) | |
10619 | @cindex crosspost mail | |
10620 | @findex gnus-summary-crosspost-article | |
10621 | Crosspost the current article to some other group | |
10622 | (@code{gnus-summary-crosspost-article}). This will create a new copy of | |
10623 | the article in the other group, and the Xref headers of the article will | |
10624 | be properly updated. | |
4009494e | 10625 | |
8a1cdce5 AC |
10626 | @item B i |
10627 | @kindex B i (Summary) | |
10628 | @findex gnus-summary-import-article | |
10629 | Import an arbitrary file into the current mail newsgroup | |
10630 | (@code{gnus-summary-import-article}). You will be prompted for a file | |
10631 | name, a @code{From} header and a @code{Subject} header. | |
10632 | ||
10633 | @item B I | |
10634 | @kindex B I (Summary) | |
10635 | @findex gnus-summary-create-article | |
10636 | Create an empty article in the current mail newsgroups | |
10637 | (@code{gnus-summary-create-article}). You will be prompted for a | |
10638 | @code{From} header and a @code{Subject} header. | |
10639 | ||
10640 | @item B r | |
10641 | @kindex B r (Summary) | |
10642 | @findex gnus-summary-respool-article | |
10643 | @vindex gnus-summary-respool-default-method | |
10644 | Respool the mail article (@code{gnus-summary-respool-article}). | |
10645 | @code{gnus-summary-respool-default-method} will be used as the default | |
10646 | select method when respooling. This variable is @code{nil} by default, | |
10647 | which means that the current group select method will be used instead. | |
10648 | Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil} | |
10649 | (which is the default). | |
10650 | ||
10651 | @item B w | |
10652 | @itemx e | |
10653 | @kindex B w (Summary) | |
10654 | @kindex e (Summary) | |
10655 | @findex gnus-summary-edit-article | |
10656 | @kindex C-c C-c (Article) | |
10657 | @findex gnus-summary-edit-article-done | |
10658 | Edit the current article (@code{gnus-summary-edit-article}). To finish | |
10659 | editing and make the changes permanent, type @kbd{C-c C-c} | |
10660 | (@code{gnus-summary-edit-article-done}). If you give a prefix to the | |
10661 | @kbd{C-c C-c} command, Gnus won't re-highlight the article. | |
4009494e | 10662 | |
8a1cdce5 AC |
10663 | @item B q |
10664 | @kindex B q (Summary) | |
10665 | @findex gnus-summary-respool-query | |
10666 | If you want to re-spool an article, you might be curious as to what group | |
10667 | the article will end up in before you do the re-spooling. This command | |
10668 | will tell you (@code{gnus-summary-respool-query}). | |
4009494e | 10669 | |
8a1cdce5 AC |
10670 | @item B t |
10671 | @kindex B t (Summary) | |
10672 | @findex gnus-summary-respool-trace | |
10673 | Similarly, this command will display all fancy splitting patterns used | |
10674 | when respooling, if any (@code{gnus-summary-respool-trace}). | |
4009494e | 10675 | |
8a1cdce5 AC |
10676 | @item B p |
10677 | @kindex B p (Summary) | |
10678 | @findex gnus-summary-article-posted-p | |
10679 | Some people have a tendency to send you ``courtesy'' copies when they | |
10680 | follow up to articles you have posted. These usually have a | |
10681 | @code{Newsgroups} header in them, but not always. This command | |
10682 | (@code{gnus-summary-article-posted-p}) will try to fetch the current | |
10683 | article from your news server (or rather, from | |
10684 | @code{gnus-refer-article-method} or @code{gnus-select-method}) and will | |
10685 | report back whether it found the article or not. Even if it says that | |
10686 | it didn't find the article, it may have been posted anyway---mail | |
10687 | propagation is much faster than news propagation, and the news copy may | |
10688 | just not have arrived yet. | |
4009494e | 10689 | |
8a1cdce5 AC |
10690 | @item K E |
10691 | @kindex K E (Summary) | |
10692 | @findex gnus-article-encrypt-body | |
10693 | @vindex gnus-article-encrypt-protocol | |
10694 | Encrypt the body of an article (@code{gnus-article-encrypt-body}). | |
10695 | The body is encrypted with the encryption protocol specified by the | |
10696 | variable @code{gnus-article-encrypt-protocol}. | |
4009494e | 10697 | |
8a1cdce5 | 10698 | @end table |
4009494e | 10699 | |
8a1cdce5 AC |
10700 | @vindex gnus-move-split-methods |
10701 | @cindex moving articles | |
10702 | If you move (or copy) articles regularly, you might wish to have Gnus | |
10703 | suggest where to put the articles. @code{gnus-move-split-methods} is a | |
10704 | variable that uses the same syntax as @code{gnus-split-methods} | |
10705 | (@pxref{Saving Articles}). You may customize that variable to create | |
10706 | suggestions you find reasonable. (Note that | |
10707 | @code{gnus-move-split-methods} uses group names where | |
10708 | @code{gnus-split-methods} uses file names.) | |
4009494e GM |
10709 | |
10710 | @lisp | |
8a1cdce5 AC |
10711 | (setq gnus-move-split-methods |
10712 | '(("^From:.*Lars Magne" "nnml:junk") | |
10713 | ("^Subject:.*gnus" "nnfolder:important") | |
10714 | (".*" "nnml:misc"))) | |
4009494e GM |
10715 | @end lisp |
10716 | ||
4009494e | 10717 | |
8a1cdce5 AC |
10718 | @node Various Summary Stuff |
10719 | @section Various Summary Stuff | |
4009494e | 10720 | |
8a1cdce5 AC |
10721 | @menu |
10722 | * Summary Group Information:: Information oriented commands. | |
10723 | * Searching for Articles:: Multiple article commands. | |
10724 | * Summary Generation Commands:: | |
10725 | * Really Various Summary Commands:: Those pesky non-conformant commands. | |
10726 | @end menu | |
4009494e | 10727 | |
8a1cdce5 AC |
10728 | @table @code |
10729 | @vindex gnus-summary-display-while-building | |
10730 | @item gnus-summary-display-while-building | |
10731 | If non-@code{nil}, show and update the summary buffer as it's being | |
10732 | built. If @code{t}, update the buffer after every line is inserted. | |
10733 | If the value is an integer, @var{n}, update the display every @var{n} | |
10734 | lines. The default is @code{nil}. | |
4009494e | 10735 | |
8a1cdce5 AC |
10736 | @vindex gnus-summary-display-arrow |
10737 | @item gnus-summary-display-arrow | |
10738 | If non-@code{nil}, display an arrow in the fringe to indicate the | |
10739 | current article. | |
4009494e | 10740 | |
8a1cdce5 AC |
10741 | @vindex gnus-summary-mode-hook |
10742 | @item gnus-summary-mode-hook | |
10743 | This hook is called when creating a summary mode buffer. | |
4009494e | 10744 | |
8a1cdce5 AC |
10745 | @vindex gnus-summary-generate-hook |
10746 | @item gnus-summary-generate-hook | |
10747 | This is called as the last thing before doing the threading and the | |
10748 | generation of the summary buffer. It's quite convenient for customizing | |
10749 | the threading variables based on what data the newsgroup has. This hook | |
10750 | is called from the summary buffer after most summary buffer variables | |
10751 | have been set. | |
4009494e | 10752 | |
8a1cdce5 AC |
10753 | @vindex gnus-summary-prepare-hook |
10754 | @item gnus-summary-prepare-hook | |
10755 | It is called after the summary buffer has been generated. You might use | |
10756 | it to, for instance, highlight lines or modify the look of the buffer in | |
10757 | some other ungodly manner. I don't care. | |
4009494e | 10758 | |
8a1cdce5 AC |
10759 | @vindex gnus-summary-prepared-hook |
10760 | @item gnus-summary-prepared-hook | |
10761 | A hook called as the very last thing after the summary buffer has been | |
10762 | generated. | |
4009494e | 10763 | |
8a1cdce5 AC |
10764 | @vindex gnus-summary-ignore-duplicates |
10765 | @item gnus-summary-ignore-duplicates | |
10766 | When Gnus discovers two articles that have the same @code{Message-ID}, | |
10767 | it has to do something drastic. No articles are allowed to have the | |
10768 | same @code{Message-ID}, but this may happen when reading mail from some | |
10769 | sources. Gnus allows you to customize what happens with this variable. | |
10770 | If it is @code{nil} (which is the default), Gnus will rename the | |
10771 | @code{Message-ID} (for display purposes only) and display the article as | |
10772 | any other article. If this variable is @code{t}, it won't display the | |
10773 | article---it'll be as if it never existed. | |
4009494e | 10774 | |
8a1cdce5 AC |
10775 | @vindex gnus-alter-articles-to-read-function |
10776 | @item gnus-alter-articles-to-read-function | |
10777 | This function, which takes two parameters (the group name and the list | |
10778 | of articles to be selected), is called to allow the user to alter the | |
10779 | list of articles to be selected. | |
4009494e | 10780 | |
8a1cdce5 AC |
10781 | For instance, the following function adds the list of cached articles to |
10782 | the list in one particular group: | |
4009494e GM |
10783 | |
10784 | @lisp | |
8a1cdce5 AC |
10785 | (defun my-add-cached-articles (group articles) |
10786 | (if (string= group "some.group") | |
10787 | (append gnus-newsgroup-cached articles) | |
10788 | articles)) | |
4009494e GM |
10789 | @end lisp |
10790 | ||
8a1cdce5 AC |
10791 | @vindex gnus-newsgroup-variables |
10792 | @item gnus-newsgroup-variables | |
10793 | A list of newsgroup (summary buffer) local variables, or cons of | |
10794 | variables and their default expressions to be evalled (when the default | |
10795 | values are not @code{nil}), that should be made global while the summary | |
10796 | buffer is active. | |
4009494e | 10797 | |
8a1cdce5 AC |
10798 | Note: The default expressions will be evaluated (using function |
10799 | @code{eval}) before assignment to the local variable rather than just | |
10800 | assigned to it. If the default expression is the symbol @code{global}, | |
10801 | that symbol will not be evaluated but the global value of the local | |
10802 | variable will be used instead. | |
10803 | ||
10804 | These variables can be used to set variables in the group parameters | |
10805 | while still allowing them to affect operations done in other | |
10806 | buffers. For example: | |
4009494e GM |
10807 | |
10808 | @lisp | |
8a1cdce5 AC |
10809 | (setq gnus-newsgroup-variables |
10810 | '(message-use-followup-to | |
10811 | (gnus-visible-headers . | |
10812 | "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:"))) | |
4009494e GM |
10813 | @end lisp |
10814 | ||
8a1cdce5 | 10815 | Also @pxref{Group Parameters}. |
4009494e | 10816 | |
8a1cdce5 | 10817 | @end table |
4009494e GM |
10818 | |
10819 | ||
8a1cdce5 AC |
10820 | @node Summary Group Information |
10821 | @subsection Summary Group Information | |
4009494e GM |
10822 | |
10823 | @table @kbd | |
10824 | ||
8a1cdce5 AC |
10825 | @item H d |
10826 | @kindex H d (Summary) | |
10827 | @findex gnus-summary-describe-group | |
10828 | Give a brief description of the current group | |
10829 | (@code{gnus-summary-describe-group}). If given a prefix, force | |
10830 | rereading the description from the server. | |
4009494e | 10831 | |
8a1cdce5 AC |
10832 | @item H h |
10833 | @kindex H h (Summary) | |
10834 | @findex gnus-summary-describe-briefly | |
10835 | Give an extremely brief description of the most important summary | |
10836 | keystrokes (@code{gnus-summary-describe-briefly}). | |
8ccbef23 | 10837 | |
8a1cdce5 AC |
10838 | @item H i |
10839 | @kindex H i (Summary) | |
10840 | @findex gnus-info-find-node | |
10841 | Go to the Gnus info node (@code{gnus-info-find-node}). | |
4009494e GM |
10842 | @end table |
10843 | ||
10844 | ||
8a1cdce5 AC |
10845 | @node Searching for Articles |
10846 | @subsection Searching for Articles | |
4009494e GM |
10847 | |
10848 | @table @kbd | |
10849 | ||
8a1cdce5 AC |
10850 | @item M-s |
10851 | @kindex M-s (Summary) | |
10852 | @findex gnus-summary-search-article-forward | |
10853 | Search through all subsequent (raw) articles for a regexp | |
10854 | (@code{gnus-summary-search-article-forward}). | |
4009494e | 10855 | |
8a1cdce5 AC |
10856 | @item M-r |
10857 | @kindex M-r (Summary) | |
10858 | @findex gnus-summary-search-article-backward | |
10859 | Search through all previous (raw) articles for a regexp | |
10860 | (@code{gnus-summary-search-article-backward}). | |
6ecfe5c2 | 10861 | |
8a1cdce5 AC |
10862 | @item M-S |
10863 | @kindex M-S (Summary) | |
10864 | @findex gnus-summary-repeat-search-article-forward | |
10865 | Repeat the previous search forwards | |
10866 | (@code{gnus-summary-repeat-search-article-forward}). | |
4009494e | 10867 | |
8a1cdce5 AC |
10868 | @item M-R |
10869 | @kindex M-R (Summary) | |
10870 | @findex gnus-summary-repeat-search-article-backward | |
10871 | Repeat the previous search backwards | |
10872 | (@code{gnus-summary-repeat-search-article-backward}). | |
01c52d31 | 10873 | |
8a1cdce5 AC |
10874 | @item & |
10875 | @kindex & (Summary) | |
10876 | @findex gnus-summary-execute-command | |
10877 | This command will prompt you for a header, a regular expression to match | |
10878 | on this field, and a command to be executed if the match is made | |
10879 | (@code{gnus-summary-execute-command}). If the header is an empty | |
10880 | string, the match is done on the entire article. If given a prefix, | |
10881 | search backward instead. | |
4009494e | 10882 | |
8a1cdce5 AC |
10883 | For instance, @kbd{& RET some.*string RET #} will put the process mark on |
10884 | all articles that have heads or bodies that match @samp{some.*string}. | |
4009494e | 10885 | |
8a1cdce5 AC |
10886 | @item M-& |
10887 | @kindex M-& (Summary) | |
10888 | @findex gnus-summary-universal-argument | |
10889 | Perform any operation on all articles that have been marked with | |
10890 | the process mark (@code{gnus-summary-universal-argument}). | |
10891 | @end table | |
6ecfe5c2 | 10892 | |
8a1cdce5 AC |
10893 | @node Summary Generation Commands |
10894 | @subsection Summary Generation Commands | |
4009494e | 10895 | |
8a1cdce5 | 10896 | @table @kbd |
4009494e | 10897 | |
8a1cdce5 AC |
10898 | @item Y g |
10899 | @kindex Y g (Summary) | |
10900 | @findex gnus-summary-prepare | |
10901 | Regenerate the current summary buffer (@code{gnus-summary-prepare}). | |
4009494e | 10902 | |
8a1cdce5 AC |
10903 | @item Y c |
10904 | @kindex Y c (Summary) | |
10905 | @findex gnus-summary-insert-cached-articles | |
10906 | Pull all cached articles (for the current group) into the summary buffer | |
10907 | (@code{gnus-summary-insert-cached-articles}). | |
4009494e | 10908 | |
8a1cdce5 AC |
10909 | @item Y d |
10910 | @kindex Y d (Summary) | |
10911 | @findex gnus-summary-insert-dormant-articles | |
10912 | Pull all dormant articles (for the current group) into the summary buffer | |
10913 | (@code{gnus-summary-insert-dormant-articles}). | |
4009494e | 10914 | |
8a1cdce5 AC |
10915 | @item Y t |
10916 | @kindex Y t (Summary) | |
10917 | @findex gnus-summary-insert-ticked-articles | |
10918 | Pull all ticked articles (for the current group) into the summary buffer | |
10919 | (@code{gnus-summary-insert-ticked-articles}). | |
4009494e | 10920 | |
8a1cdce5 | 10921 | @end table |
6ecfe5c2 | 10922 | |
4009494e | 10923 | |
8a1cdce5 AC |
10924 | @node Really Various Summary Commands |
10925 | @subsection Really Various Summary Commands | |
4009494e GM |
10926 | |
10927 | @table @kbd | |
4009494e | 10928 | |
8a1cdce5 AC |
10929 | @item A D |
10930 | @itemx C-d | |
10931 | @kindex C-d (Summary) | |
10932 | @kindex A D (Summary) | |
10933 | @findex gnus-summary-enter-digest-group | |
10934 | If the current article is a collection of other articles (for instance, | |
10935 | a digest), you might use this command to enter a group based on the that | |
10936 | article (@code{gnus-summary-enter-digest-group}). Gnus will try to | |
10937 | guess what article type is currently displayed unless you give a prefix | |
10938 | to this command, which forces a ``digest'' interpretation. Basically, | |
10939 | whenever you see a message that is a collection of other messages of | |
10940 | some format, you @kbd{C-d} and read these messages in a more convenient | |
10941 | fashion. | |
4009494e | 10942 | |
8a1cdce5 AC |
10943 | @vindex gnus-auto-select-on-ephemeral-exit |
10944 | The variable @code{gnus-auto-select-on-ephemeral-exit} controls what | |
10945 | article should be selected after exiting a digest group. Valid values | |
10946 | include: | |
4009494e | 10947 | |
8a1cdce5 AC |
10948 | @table @code |
10949 | @item next | |
10950 | Select the next article. | |
4009494e | 10951 | |
8a1cdce5 AC |
10952 | @item next-unread |
10953 | Select the next unread article. | |
4009494e | 10954 | |
8a1cdce5 AC |
10955 | @item next-noselect |
10956 | Move the cursor to the next article. This is the default. | |
4009494e | 10957 | |
8a1cdce5 AC |
10958 | @item next-unread-noselect |
10959 | Move the cursor to the next unread article. | |
4009494e GM |
10960 | @end table |
10961 | ||
8a1cdce5 AC |
10962 | If it has any other value or there is no next (unread) article, the |
10963 | article selected before entering to the digest group will appear. | |
4009494e | 10964 | |
8a1cdce5 AC |
10965 | @item C-M-d |
10966 | @kindex C-M-d (Summary) | |
10967 | @findex gnus-summary-read-document | |
10968 | This command is very similar to the one above, but lets you gather | |
10969 | several documents into one biiig group | |
10970 | (@code{gnus-summary-read-document}). It does this by opening several | |
10971 | @code{nndoc} groups for each document, and then opening an | |
10972 | @code{nnvirtual} group on top of these @code{nndoc} groups. This | |
10973 | command understands the process/prefix convention | |
10974 | (@pxref{Process/Prefix}). | |
4009494e | 10975 | |
8a1cdce5 AC |
10976 | @item C-t |
10977 | @kindex C-t (Summary) | |
10978 | @findex gnus-summary-toggle-truncation | |
10979 | Toggle truncation of summary lines | |
10980 | (@code{gnus-summary-toggle-truncation}). This will probably confuse the | |
10981 | line centering function in the summary buffer, so it's not a good idea | |
10982 | to have truncation switched off while reading articles. | |
4009494e | 10983 | |
8a1cdce5 AC |
10984 | @item = |
10985 | @kindex = (Summary) | |
10986 | @findex gnus-summary-expand-window | |
10987 | Expand the summary buffer window (@code{gnus-summary-expand-window}). | |
10988 | If given a prefix, force an @code{article} window configuration. | |
4009494e | 10989 | |
8a1cdce5 AC |
10990 | @item C-M-e |
10991 | @kindex C-M-e (Summary) | |
10992 | @findex gnus-summary-edit-parameters | |
10993 | Edit the group parameters (@pxref{Group Parameters}) of the current | |
10994 | group (@code{gnus-summary-edit-parameters}). | |
4009494e | 10995 | |
8a1cdce5 AC |
10996 | @item C-M-a |
10997 | @kindex C-M-a (Summary) | |
10998 | @findex gnus-summary-customize-parameters | |
10999 | Customize the group parameters (@pxref{Group Parameters}) of the current | |
11000 | group (@code{gnus-summary-customize-parameters}). | |
4009494e | 11001 | |
8a1cdce5 | 11002 | @end table |
4009494e | 11003 | |
4009494e | 11004 | |
8a1cdce5 AC |
11005 | @node Exiting the Summary Buffer |
11006 | @section Exiting the Summary Buffer | |
11007 | @cindex summary exit | |
11008 | @cindex exiting groups | |
4009494e | 11009 | |
8a1cdce5 AC |
11010 | Exiting from the summary buffer will normally update all info on the |
11011 | group and return you to the group buffer. | |
4009494e | 11012 | |
8a1cdce5 | 11013 | @table @kbd |
4009494e | 11014 | |
8a1cdce5 AC |
11015 | @item Z Z |
11016 | @itemx Z Q | |
11017 | @itemx q | |
11018 | @kindex Z Z (Summary) | |
11019 | @kindex Z Q (Summary) | |
11020 | @kindex q (Summary) | |
11021 | @findex gnus-summary-exit | |
11022 | @vindex gnus-summary-exit-hook | |
11023 | @vindex gnus-summary-prepare-exit-hook | |
11024 | @vindex gnus-group-no-more-groups-hook | |
11025 | @c @icon{gnus-summary-exit} | |
11026 | Exit the current group and update all information on the group | |
11027 | (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is | |
11028 | called before doing much of the exiting, which calls | |
11029 | @code{gnus-summary-expire-articles} by default. | |
11030 | @code{gnus-summary-exit-hook} is called after finishing the exit | |
11031 | process. @code{gnus-group-no-more-groups-hook} is run when returning to | |
11032 | group mode having no more (unread) groups. | |
4009494e | 11033 | |
8a1cdce5 AC |
11034 | @item Z E |
11035 | @itemx Q | |
11036 | @kindex Z E (Summary) | |
11037 | @kindex Q (Summary) | |
11038 | @findex gnus-summary-exit-no-update | |
11039 | Exit the current group without updating any information on the group | |
11040 | (@code{gnus-summary-exit-no-update}). | |
4009494e | 11041 | |
8a1cdce5 AC |
11042 | @item Z c |
11043 | @itemx c | |
11044 | @kindex Z c (Summary) | |
11045 | @kindex c (Summary) | |
11046 | @findex gnus-summary-catchup-and-exit | |
11047 | @c @icon{gnus-summary-catchup-and-exit} | |
11048 | Mark all unticked articles in the group as read and then exit | |
11049 | (@code{gnus-summary-catchup-and-exit}). | |
4009494e | 11050 | |
8a1cdce5 AC |
11051 | @item Z C |
11052 | @kindex Z C (Summary) | |
11053 | @findex gnus-summary-catchup-all-and-exit | |
11054 | Mark all articles, even the ticked ones, as read and then exit | |
11055 | (@code{gnus-summary-catchup-all-and-exit}). | |
4009494e | 11056 | |
8a1cdce5 AC |
11057 | @item Z n |
11058 | @kindex Z n (Summary) | |
11059 | @findex gnus-summary-catchup-and-goto-next-group | |
11060 | Mark all articles as read and go to the next group | |
11061 | (@code{gnus-summary-catchup-and-goto-next-group}). | |
4009494e | 11062 | |
8a1cdce5 AC |
11063 | @item Z p |
11064 | @kindex Z p (Summary) | |
11065 | @findex gnus-summary-catchup-and-goto-prev-group | |
11066 | Mark all articles as read and go to the previous group | |
11067 | (@code{gnus-summary-catchup-and-goto-prev-group}). | |
4009494e | 11068 | |
8a1cdce5 AC |
11069 | @item Z R |
11070 | @itemx C-x C-s | |
11071 | @kindex Z R (Summary) | |
11072 | @kindex C-x C-s (Summary) | |
11073 | @findex gnus-summary-reselect-current-group | |
11074 | Exit this group, and then enter it again | |
11075 | (@code{gnus-summary-reselect-current-group}). If given a prefix, select | |
11076 | all articles, both read and unread. | |
4009494e | 11077 | |
8a1cdce5 AC |
11078 | @item Z G |
11079 | @itemx M-g | |
11080 | @kindex Z G (Summary) | |
11081 | @kindex M-g (Summary) | |
11082 | @findex gnus-summary-rescan-group | |
11083 | @c @icon{gnus-summary-mail-get} | |
11084 | Exit the group, check for new articles in the group, and select the | |
11085 | group (@code{gnus-summary-rescan-group}). If given a prefix, select all | |
11086 | articles, both read and unread. | |
4009494e | 11087 | |
8a1cdce5 AC |
11088 | @item Z N |
11089 | @kindex Z N (Summary) | |
11090 | @findex gnus-summary-next-group | |
11091 | Exit the group and go to the next group | |
11092 | (@code{gnus-summary-next-group}). | |
4009494e | 11093 | |
8a1cdce5 AC |
11094 | @item Z P |
11095 | @kindex Z P (Summary) | |
11096 | @findex gnus-summary-prev-group | |
11097 | Exit the group and go to the previous group | |
11098 | (@code{gnus-summary-prev-group}). | |
4009494e | 11099 | |
8a1cdce5 AC |
11100 | @item Z s |
11101 | @kindex Z s (Summary) | |
11102 | @findex gnus-summary-save-newsrc | |
11103 | Save the current number of read/marked articles in the dribble buffer | |
11104 | and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If | |
11105 | given a prefix, also save the @file{.newsrc} file(s). Using this | |
11106 | command will make exit without updating (the @kbd{Q} command) worthless. | |
11107 | @end table | |
4009494e | 11108 | |
8a1cdce5 AC |
11109 | @vindex gnus-exit-group-hook |
11110 | @code{gnus-exit-group-hook} is called when you exit the current group | |
11111 | with an ``updating'' exit. For instance @kbd{Q} | |
11112 | (@code{gnus-summary-exit-no-update}) does not call this hook. | |
4009494e | 11113 | |
8a1cdce5 AC |
11114 | @findex gnus-summary-wake-up-the-dead |
11115 | @findex gnus-dead-summary-mode | |
11116 | @vindex gnus-kill-summary-on-exit | |
11117 | If you're in the habit of exiting groups, and then changing your mind | |
11118 | about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}. | |
11119 | If you do that, Gnus won't kill the summary buffer when you exit it. | |
11120 | (Quelle surprise!) Instead it will change the name of the buffer to | |
11121 | something like @samp{*Dead Summary ... *} and install a minor mode | |
11122 | called @code{gnus-dead-summary-mode}. Now, if you switch back to this | |
11123 | buffer, you'll find that all keys are mapped to a function called | |
11124 | @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead | |
11125 | summary buffer will result in a live, normal summary buffer. | |
4009494e | 11126 | |
8a1cdce5 | 11127 | There will never be more than one dead summary buffer at any one time. |
4009494e | 11128 | |
8a1cdce5 AC |
11129 | @vindex gnus-use-cross-reference |
11130 | The data on the current group will be updated (which articles you have | |
11131 | read, which articles you have replied to, etc.) when you exit the | |
11132 | summary buffer. If the @code{gnus-use-cross-reference} variable is | |
11133 | @code{t} (which is the default), articles that are cross-referenced to | |
11134 | this group and are marked as read, will also be marked as read in the | |
11135 | other subscribed groups they were cross-posted to. If this variable is | |
11136 | neither @code{nil} nor @code{t}, the article will be marked as read in | |
11137 | both subscribed and unsubscribed groups (@pxref{Crosspost Handling}). | |
4009494e | 11138 | |
4009494e | 11139 | |
8a1cdce5 AC |
11140 | @node Crosspost Handling |
11141 | @section Crosspost Handling | |
4009494e | 11142 | |
8a1cdce5 AC |
11143 | @cindex velveeta |
11144 | @cindex spamming | |
11145 | Marking cross-posted articles as read ensures that you'll never have to | |
11146 | read the same article more than once. Unless, of course, somebody has | |
11147 | posted it to several groups separately. Posting the same article to | |
11148 | several groups (not cross-posting) is called @dfn{spamming}, and you are | |
11149 | by law required to send nasty-grams to anyone who perpetrates such a | |
11150 | heinous crime. | |
4009494e | 11151 | |
8a1cdce5 AC |
11152 | Remember: Cross-posting is kinda ok, but posting the same article |
11153 | separately to several groups is not. Massive cross-posting (aka. | |
11154 | @dfn{velveeta}) is to be avoided at all costs, and you can even use the | |
11155 | @code{gnus-summary-mail-crosspost-complaint} command to complain about | |
11156 | excessive crossposting (@pxref{Summary Mail Commands}). | |
4009494e | 11157 | |
8a1cdce5 AC |
11158 | @cindex cross-posting |
11159 | @cindex Xref | |
11160 | @cindex @acronym{NOV} | |
11161 | One thing that may cause Gnus to not do the cross-posting thing | |
11162 | correctly is if you use an @acronym{NNTP} server that supports @sc{xover} | |
11163 | (which is very nice, because it speeds things up considerably) which | |
11164 | does not include the @code{Xref} header in its @acronym{NOV} lines. This is | |
11165 | Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing | |
11166 | even with @sc{xover} by registering the @code{Xref} lines of all | |
11167 | articles you actually read, but if you kill the articles, or just mark | |
11168 | them as read without reading them, Gnus will not get a chance to snoop | |
11169 | the @code{Xref} lines out of these articles, and will be unable to use | |
11170 | the cross reference mechanism. | |
4009494e | 11171 | |
8a1cdce5 AC |
11172 | @cindex LIST overview.fmt |
11173 | @cindex overview.fmt | |
11174 | To check whether your @acronym{NNTP} server includes the @code{Xref} header | |
11175 | in its overview files, try @samp{telnet your.nntp.server nntp}, | |
11176 | @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST | |
11177 | overview.fmt}. This may not work, but if it does, and the last line you | |
11178 | get does not read @samp{Xref:full}, then you should shout and whine at | |
11179 | your news admin until she includes the @code{Xref} header in the | |
11180 | overview files. | |
4009494e | 11181 | |
8a1cdce5 AC |
11182 | If you want Gnus to get the @code{Xref}s right all the time, you have to |
11183 | set @code{nntp-nov-is-evil} to @code{t}, which slows things down | |
11184 | considerably. Also @pxref{Slow/Expensive Connection}. | |
4009494e | 11185 | |
8a1cdce5 | 11186 | C'est la vie. |
4009494e | 11187 | |
8a1cdce5 | 11188 | For an alternative approach, @pxref{Duplicate Suppression}. |
4009494e | 11189 | |
4009494e | 11190 | |
8a1cdce5 AC |
11191 | @node Duplicate Suppression |
11192 | @section Duplicate Suppression | |
4009494e | 11193 | |
8a1cdce5 AC |
11194 | By default, Gnus tries to make sure that you don't have to read the same |
11195 | article more than once by utilizing the crossposting mechanism | |
11196 | (@pxref{Crosspost Handling}). However, that simple and efficient | |
11197 | approach may not work satisfactory for some users for various | |
11198 | reasons. | |
4009494e | 11199 | |
8a1cdce5 AC |
11200 | @enumerate |
11201 | @item | |
11202 | The @acronym{NNTP} server may fail to generate the @code{Xref} header. This | |
11203 | is evil and not very common. | |
4009494e | 11204 | |
8a1cdce5 AC |
11205 | @item |
11206 | The @acronym{NNTP} server may fail to include the @code{Xref} header in the | |
11207 | @file{.overview} data bases. This is evil and all too common, alas. | |
4009494e | 11208 | |
8a1cdce5 AC |
11209 | @item |
11210 | You may be reading the same group (or several related groups) from | |
11211 | different @acronym{NNTP} servers. | |
4009494e | 11212 | |
8a1cdce5 AC |
11213 | @item |
11214 | You may be getting mail that duplicates articles posted to groups. | |
11215 | @end enumerate | |
4009494e | 11216 | |
8a1cdce5 AC |
11217 | I'm sure there are other situations where @code{Xref} handling fails as |
11218 | well, but these four are the most common situations. | |
4009494e | 11219 | |
8a1cdce5 AC |
11220 | If, and only if, @code{Xref} handling fails for you, then you may |
11221 | consider switching on @dfn{duplicate suppression}. If you do so, Gnus | |
11222 | will remember the @code{Message-ID}s of all articles you have read or | |
11223 | otherwise marked as read, and then, as if by magic, mark them as read | |
11224 | all subsequent times you see them---in @emph{all} groups. Using this | |
11225 | mechanism is quite likely to be somewhat inefficient, but not overly | |
11226 | so. It's certainly preferable to reading the same articles more than | |
11227 | once. | |
4009494e | 11228 | |
8a1cdce5 AC |
11229 | Duplicate suppression is not a very subtle instrument. It's more like a |
11230 | sledge hammer than anything else. It works in a very simple | |
11231 | fashion---if you have marked an article as read, it adds this Message-ID | |
11232 | to a cache. The next time it sees this Message-ID, it will mark the | |
11233 | article as read with the @samp{M} mark. It doesn't care what group it | |
11234 | saw the article in. | |
4009494e | 11235 | |
8a1cdce5 AC |
11236 | @table @code |
11237 | @item gnus-suppress-duplicates | |
11238 | @vindex gnus-suppress-duplicates | |
11239 | If non-@code{nil}, suppress duplicates. | |
4009494e | 11240 | |
8a1cdce5 AC |
11241 | @item gnus-save-duplicate-list |
11242 | @vindex gnus-save-duplicate-list | |
11243 | If non-@code{nil}, save the list of duplicates to a file. This will | |
11244 | make startup and shutdown take longer, so the default is @code{nil}. | |
11245 | However, this means that only duplicate articles read in a single Gnus | |
11246 | session are suppressed. | |
4009494e | 11247 | |
8a1cdce5 AC |
11248 | @item gnus-duplicate-list-length |
11249 | @vindex gnus-duplicate-list-length | |
11250 | This variable says how many @code{Message-ID}s to keep in the duplicate | |
11251 | suppression list. The default is 10000. | |
4009494e | 11252 | |
8a1cdce5 AC |
11253 | @item gnus-duplicate-file |
11254 | @vindex gnus-duplicate-file | |
11255 | The name of the file to store the duplicate suppression list in. The | |
11256 | default is @file{~/News/suppression}. | |
4009494e GM |
11257 | @end table |
11258 | ||
8a1cdce5 AC |
11259 | If you have a tendency to stop and start Gnus often, setting |
11260 | @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If | |
11261 | you leave Gnus running for weeks on end, you may have it @code{nil}. On | |
11262 | the other hand, saving the list makes startup and shutdown much slower, | |
11263 | so that means that if you stop and start Gnus often, you should set | |
11264 | @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up | |
11265 | to you to figure out, I think. | |
4009494e | 11266 | |
8a1cdce5 AC |
11267 | @node Security |
11268 | @section Security | |
4009494e | 11269 | |
8a1cdce5 AC |
11270 | Gnus is able to verify signed messages or decrypt encrypted messages. |
11271 | The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME} | |
11272 | and @acronym{S/MIME}, however you need some external programs to get | |
11273 | things to work: | |
4009494e | 11274 | |
8a1cdce5 AC |
11275 | @enumerate |
11276 | @item | |
11277 | To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to | |
1df7defd | 11278 | install an OpenPGP implementation such as GnuPG@. The Lisp interface |
8a1cdce5 AC |
11279 | to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG, |
11280 | epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg, | |
11281 | PGG Manual}), and Mailcrypt are also supported. | |
4009494e | 11282 | |
8a1cdce5 | 11283 | @item |
1df7defd | 11284 | To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6 |
8a1cdce5 | 11285 | or newer is recommended. |
4009494e | 11286 | |
8a1cdce5 | 11287 | @end enumerate |
4009494e | 11288 | |
8a1cdce5 AC |
11289 | The variables that control security functionality on reading/composing |
11290 | messages include: | |
11291 | ||
11292 | @table @code | |
11293 | @item mm-verify-option | |
11294 | @vindex mm-verify-option | |
11295 | Option of verifying signed parts. @code{never}, not verify; | |
11296 | @code{always}, always verify; @code{known}, only verify known | |
11297 | protocols. Otherwise, ask user. | |
4009494e | 11298 | |
8a1cdce5 AC |
11299 | @item mm-decrypt-option |
11300 | @vindex mm-decrypt-option | |
11301 | Option of decrypting encrypted parts. @code{never}, no decryption; | |
11302 | @code{always}, always decrypt; @code{known}, only decrypt known | |
11303 | protocols. Otherwise, ask user. | |
4009494e | 11304 | |
8a1cdce5 AC |
11305 | @item mm-sign-option |
11306 | @vindex mm-sign-option | |
11307 | Option of creating signed parts. @code{nil}, use default signing | |
11308 | keys; @code{guided}, ask user to select signing keys from the menu. | |
4009494e | 11309 | |
8a1cdce5 AC |
11310 | @item mm-encrypt-option |
11311 | @vindex mm-encrypt-option | |
11312 | Option of creating encrypted parts. @code{nil}, use the first | |
11313 | public-key matching the @samp{From:} header as the recipient; | |
11314 | @code{guided}, ask user to select recipient keys from the menu. | |
4009494e | 11315 | |
8a1cdce5 AC |
11316 | @item mml1991-use |
11317 | @vindex mml1991-use | |
11318 | Symbol indicating elisp interface to OpenPGP implementation for | |
11319 | @acronym{PGP} messages. The default is @code{epg}, but @code{pgg}, | |
11320 | and @code{mailcrypt} are also supported although | |
11321 | deprecated. By default, Gnus uses the first available interface in | |
11322 | this order. | |
4009494e | 11323 | |
8a1cdce5 AC |
11324 | @item mml2015-use |
11325 | @vindex mml2015-use | |
11326 | Symbol indicating elisp interface to OpenPGP implementation for | |
11327 | @acronym{PGP/MIME} messages. The default is @code{epg}, but | |
11328 | @code{pgg}, and @code{mailcrypt} are also supported | |
11329 | although deprecated. By default, Gnus uses the first available | |
11330 | interface in this order. | |
4009494e | 11331 | |
8a1cdce5 | 11332 | @end table |
4009494e | 11333 | |
8a1cdce5 AC |
11334 | By default the buttons that display security information are not |
11335 | shown, because they clutter reading the actual e-mail. You can type | |
11336 | @kbd{K b} manually to display the information. Use the | |
11337 | @code{gnus-buttonized-mime-types} and | |
11338 | @code{gnus-unbuttonized-mime-types} variables to control this | |
11339 | permanently. @ref{MIME Commands} for further details, and hints on | |
11340 | how to customize these variables to always display security | |
11341 | information. | |
4009494e | 11342 | |
8a1cdce5 AC |
11343 | @cindex snarfing keys |
11344 | @cindex importing PGP keys | |
11345 | @cindex PGP key ring import | |
11346 | Snarfing OpenPGP keys (i.e., importing keys from articles into your | |
11347 | key ring) is not supported explicitly through a menu item or command, | |
11348 | rather Gnus do detect and label keys as @samp{application/pgp-keys}, | |
11349 | allowing you to specify whatever action you think is appropriate | |
11350 | through the usual @acronym{MIME} infrastructure. You can use a | |
11351 | @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The | |
11352 | Emacs MIME Manual}) such as the following to import keys using GNU | |
11353 | Privacy Guard when you click on the @acronym{MIME} button | |
11354 | (@pxref{Using MIME}). | |
4009494e | 11355 | |
8a1cdce5 AC |
11356 | @example |
11357 | application/pgp-keys; gpg --import --interactive --verbose; needsterminal | |
11358 | @end example | |
11359 | @noindent | |
11360 | This happens to also be the default action defined in | |
11361 | @code{mailcap-mime-data}. | |
4009494e | 11362 | |
8a1cdce5 AC |
11363 | More information on how to set things for sending outgoing signed and |
11364 | encrypted messages up can be found in the message manual | |
11365 | (@pxref{Security, ,Security, message, Message Manual}). | |
4009494e | 11366 | |
8a1cdce5 AC |
11367 | @node Mailing List |
11368 | @section Mailing List | |
11369 | @cindex mailing list | |
11370 | @cindex RFC 2396 | |
4009494e | 11371 | |
8a1cdce5 AC |
11372 | @kindex A M (summary) |
11373 | @findex gnus-mailing-list-insinuate | |
11374 | Gnus understands some mailing list fields of RFC 2369. To enable it, | |
11375 | add a @code{to-list} group parameter (@pxref{Group Parameters}), | |
11376 | possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the | |
11377 | summary buffer. | |
4009494e | 11378 | |
8a1cdce5 | 11379 | That enables the following commands to the summary buffer: |
4009494e | 11380 | |
8a1cdce5 | 11381 | @table @kbd |
4009494e | 11382 | |
8a1cdce5 AC |
11383 | @item C-c C-n h |
11384 | @kindex C-c C-n h (Summary) | |
11385 | @findex gnus-mailing-list-help | |
11386 | Send a message to fetch mailing list help, if List-Help field exists. | |
4009494e | 11387 | |
8a1cdce5 AC |
11388 | @item C-c C-n s |
11389 | @kindex C-c C-n s (Summary) | |
11390 | @findex gnus-mailing-list-subscribe | |
11391 | Send a message to subscribe the mailing list, if List-Subscribe field exists. | |
4009494e | 11392 | |
8a1cdce5 AC |
11393 | @item C-c C-n u |
11394 | @kindex C-c C-n u (Summary) | |
11395 | @findex gnus-mailing-list-unsubscribe | |
11396 | Send a message to unsubscribe the mailing list, if List-Unsubscribe | |
11397 | field exists. | |
4009494e | 11398 | |
8a1cdce5 AC |
11399 | @item C-c C-n p |
11400 | @kindex C-c C-n p (Summary) | |
11401 | @findex gnus-mailing-list-post | |
11402 | Post to the mailing list, if List-Post field exists. | |
4009494e | 11403 | |
8a1cdce5 AC |
11404 | @item C-c C-n o |
11405 | @kindex C-c C-n o (Summary) | |
11406 | @findex gnus-mailing-list-owner | |
11407 | Send a message to the mailing list owner, if List-Owner field exists. | |
4009494e | 11408 | |
8a1cdce5 AC |
11409 | @item C-c C-n a |
11410 | @kindex C-c C-n a (Summary) | |
11411 | @findex gnus-mailing-list-archive | |
11412 | Browse the mailing list archive, if List-Archive field exists. | |
4009494e | 11413 | |
8a1cdce5 | 11414 | @end table |
4009494e | 11415 | |
4009494e | 11416 | |
8a1cdce5 AC |
11417 | @node Article Buffer |
11418 | @chapter Article Buffer | |
11419 | @cindex article buffer | |
4009494e | 11420 | |
8a1cdce5 AC |
11421 | The articles are displayed in the article buffer, of which there is only |
11422 | one. All the summary buffers share the same article buffer unless you | |
11423 | tell Gnus otherwise. | |
4009494e GM |
11424 | |
11425 | @menu | |
8a1cdce5 AC |
11426 | * Hiding Headers:: Deciding what headers should be displayed. |
11427 | * Using MIME:: Pushing articles through @acronym{MIME} before reading them. | |
11428 | * HTML:: Reading @acronym{HTML} messages. | |
11429 | * Customizing Articles:: Tailoring the look of the articles. | |
11430 | * Article Keymap:: Keystrokes available in the article buffer. | |
11431 | * Misc Article:: Other stuff. | |
4009494e GM |
11432 | @end menu |
11433 | ||
4009494e | 11434 | |
8a1cdce5 AC |
11435 | @node Hiding Headers |
11436 | @section Hiding Headers | |
11437 | @cindex hiding headers | |
11438 | @cindex deleting headers | |
4009494e | 11439 | |
8a1cdce5 AC |
11440 | The top section of each article is the @dfn{head}. (The rest is the |
11441 | @dfn{body}, but you may have guessed that already.) | |
4009494e | 11442 | |
8a1cdce5 AC |
11443 | @vindex gnus-show-all-headers |
11444 | There is a lot of useful information in the head: the name of the person | |
11445 | who wrote the article, the date it was written and the subject of the | |
11446 | article. That's well and nice, but there's also lots of information | |
11447 | most people do not want to see---what systems the article has passed | |
11448 | through before reaching you, the @code{Message-ID}, the | |
11449 | @code{References}, etc. ad nauseam---and you'll probably want to get rid | |
11450 | of some of those lines. If you want to keep all those lines in the | |
11451 | article buffer, you can set @code{gnus-show-all-headers} to @code{t}. | |
4009494e | 11452 | |
8a1cdce5 | 11453 | Gnus provides you with two variables for sifting headers: |
4009494e | 11454 | |
8a1cdce5 | 11455 | @table @code |
4009494e | 11456 | |
8a1cdce5 AC |
11457 | @item gnus-visible-headers |
11458 | @vindex gnus-visible-headers | |
11459 | If this variable is non-@code{nil}, it should be a regular expression | |
11460 | that says what headers you wish to keep in the article buffer. All | |
11461 | headers that do not match this variable will be hidden. | |
4009494e | 11462 | |
8a1cdce5 AC |
11463 | For instance, if you only want to see the name of the person who wrote |
11464 | the article and the subject, you'd say: | |
4009494e GM |
11465 | |
11466 | @lisp | |
8a1cdce5 | 11467 | (setq gnus-visible-headers "^From:\\|^Subject:") |
4009494e GM |
11468 | @end lisp |
11469 | ||
8a1cdce5 AC |
11470 | This variable can also be a list of regexps to match headers to |
11471 | remain visible. | |
4009494e | 11472 | |
8a1cdce5 AC |
11473 | @item gnus-ignored-headers |
11474 | @vindex gnus-ignored-headers | |
11475 | This variable is the reverse of @code{gnus-visible-headers}. If this | |
11476 | variable is set (and @code{gnus-visible-headers} is @code{nil}), it | |
11477 | should be a regular expression that matches all lines that you want to | |
11478 | hide. All lines that do not match this variable will remain visible. | |
4009494e | 11479 | |
8a1cdce5 AC |
11480 | For instance, if you just want to get rid of the @code{References} line |
11481 | and the @code{Xref} line, you might say: | |
4009494e GM |
11482 | |
11483 | @lisp | |
8a1cdce5 | 11484 | (setq gnus-ignored-headers "^References:\\|^Xref:") |
4009494e GM |
11485 | @end lisp |
11486 | ||
8a1cdce5 AC |
11487 | This variable can also be a list of regexps to match headers to |
11488 | be removed. | |
3a23a519 | 11489 | |
8a1cdce5 AC |
11490 | Note that if @code{gnus-visible-headers} is non-@code{nil}, this |
11491 | variable will have no effect. | |
3a23a519 | 11492 | |
4009494e GM |
11493 | @end table |
11494 | ||
8a1cdce5 AC |
11495 | @vindex gnus-sorted-header-list |
11496 | Gnus can also sort the headers for you. (It does this by default.) You | |
11497 | can control the sorting by setting the @code{gnus-sorted-header-list} | |
11498 | variable. It is a list of regular expressions that says in what order | |
11499 | the headers are to be displayed. | |
4009494e | 11500 | |
8a1cdce5 AC |
11501 | For instance, if you want the name of the author of the article first, |
11502 | and then the subject, you might say something like: | |
4009494e | 11503 | |
8a1cdce5 AC |
11504 | @lisp |
11505 | (setq gnus-sorted-header-list '("^From:" "^Subject:")) | |
11506 | @end lisp | |
4009494e | 11507 | |
8a1cdce5 AC |
11508 | Any headers that are to remain visible, but are not listed in this |
11509 | variable, will be displayed in random order after all the headers listed in this variable. | |
4009494e | 11510 | |
8a1cdce5 AC |
11511 | @findex gnus-article-hide-boring-headers |
11512 | @vindex gnus-boring-article-headers | |
11513 | You can hide further boring headers by setting | |
11514 | @code{gnus-treat-hide-boring-headers} to @code{head}. What this function | |
11515 | does depends on the @code{gnus-boring-article-headers} variable. It's a | |
11516 | list, but this list doesn't actually contain header names. Instead it | |
11517 | lists various @dfn{boring conditions} that Gnus can check and remove | |
11518 | from sight. | |
4009494e | 11519 | |
8a1cdce5 AC |
11520 | These conditions are: |
11521 | @table @code | |
11522 | @item empty | |
11523 | Remove all empty headers. | |
11524 | @item followup-to | |
11525 | Remove the @code{Followup-To} header if it is identical to the | |
11526 | @code{Newsgroups} header. | |
11527 | @item reply-to | |
11528 | Remove the @code{Reply-To} header if it lists the same addresses as | |
11529 | the @code{From} header, or if the @code{broken-reply-to} group | |
11530 | parameter is set. | |
11531 | @item newsgroups | |
11532 | Remove the @code{Newsgroups} header if it only contains the current group | |
11533 | name. | |
11534 | @item to-address | |
11535 | Remove the @code{To} header if it only contains the address identical to | |
11536 | the current group's @code{to-address} parameter. | |
11537 | @item to-list | |
11538 | Remove the @code{To} header if it only contains the address identical to | |
11539 | the current group's @code{to-list} parameter. | |
11540 | @item cc-list | |
11541 | Remove the @code{Cc} header if it only contains the address identical to | |
11542 | the current group's @code{to-list} parameter. | |
11543 | @item date | |
11544 | Remove the @code{Date} header if the article is less than three days | |
11545 | old. | |
11546 | @item long-to | |
11547 | Remove the @code{To} and/or @code{Cc} header if it is very long. | |
11548 | @item many-to | |
11549 | Remove all @code{To} and/or @code{Cc} headers if there are more than one. | |
4009494e GM |
11550 | @end table |
11551 | ||
8a1cdce5 | 11552 | To include these three elements, you could say something like: |
4009494e | 11553 | |
8a1cdce5 AC |
11554 | @lisp |
11555 | (setq gnus-boring-article-headers | |
11556 | '(empty followup-to reply-to)) | |
11557 | @end lisp | |
4009494e | 11558 | |
8a1cdce5 | 11559 | This is also the default value for this variable. |
4009494e | 11560 | |
4009494e | 11561 | |
8a1cdce5 AC |
11562 | @node Using MIME |
11563 | @section Using MIME | |
11564 | @cindex @acronym{MIME} | |
4009494e | 11565 | |
8a1cdce5 AC |
11566 | Mime is a standard for waving your hands through the air, aimlessly, |
11567 | while people stand around yawning. | |
01c52d31 | 11568 | |
8a1cdce5 AC |
11569 | @acronym{MIME}, however, is a standard for encoding your articles, aimlessly, |
11570 | while all newsreaders die of fear. | |
01c52d31 | 11571 | |
8a1cdce5 AC |
11572 | @acronym{MIME} may specify what character set the article uses, the encoding |
11573 | of the characters, and it also makes it possible to embed pictures and | |
11574 | other naughty stuff in innocent-looking articles. | |
4009494e | 11575 | |
8a1cdce5 AC |
11576 | @vindex gnus-display-mime-function |
11577 | @findex gnus-display-mime | |
11578 | Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function} | |
11579 | to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by | |
11580 | default, which creates a bundle of clickable buttons that can be used to | |
11581 | display, save and manipulate the @acronym{MIME} objects. | |
4009494e | 11582 | |
8a1cdce5 AC |
11583 | The following commands are available when you have placed point over a |
11584 | @acronym{MIME} button: | |
11585 | ||
11586 | @table @kbd | |
11587 | @findex gnus-article-press-button | |
11588 | @item RET (Article) | |
11589 | @kindex RET (Article) | |
11590 | @itemx BUTTON-2 (Article) | |
11591 | Toggle displaying of the @acronym{MIME} object | |
11592 | (@code{gnus-article-press-button}). If built-in viewers can not display | |
11593 | the object, Gnus resorts to external viewers in the @file{mailcap} | |
11594 | files. If a viewer has the @samp{copiousoutput} specification, the | |
11595 | object is displayed inline. | |
11596 | ||
11597 | @findex gnus-mime-view-part | |
11598 | @item M-RET (Article) | |
11599 | @kindex M-RET (Article) | |
11600 | @itemx v (Article) | |
11601 | Prompt for a method, and then view the @acronym{MIME} object using this | |
11602 | method (@code{gnus-mime-view-part}). | |
11603 | ||
11604 | @findex gnus-mime-view-part-as-type | |
11605 | @item t (Article) | |
11606 | @kindex t (Article) | |
11607 | View the @acronym{MIME} object as if it were a different @acronym{MIME} media type | |
11608 | (@code{gnus-mime-view-part-as-type}). | |
11609 | ||
11610 | @findex gnus-mime-view-part-as-charset | |
11611 | @item C (Article) | |
11612 | @kindex C (Article) | |
11613 | Prompt for a charset, and then view the @acronym{MIME} object using this | |
11614 | charset (@code{gnus-mime-view-part-as-charset}). | |
4009494e | 11615 | |
8a1cdce5 AC |
11616 | @findex gnus-mime-save-part |
11617 | @item o (Article) | |
11618 | @kindex o (Article) | |
11619 | Prompt for a file name, and then save the @acronym{MIME} object | |
11620 | (@code{gnus-mime-save-part}). | |
4009494e | 11621 | |
8a1cdce5 AC |
11622 | @findex gnus-mime-save-part-and-strip |
11623 | @item C-o (Article) | |
11624 | @kindex C-o (Article) | |
11625 | Prompt for a file name, then save the @acronym{MIME} object and strip it from | |
11626 | the article. Then proceed to article editing, where a reasonable | |
11627 | suggestion is being made on how the altered article should look | |
11628 | like. The stripped @acronym{MIME} object will be referred via the | |
11629 | message/external-body @acronym{MIME} type. | |
11630 | (@code{gnus-mime-save-part-and-strip}). | |
4009494e | 11631 | |
8a1cdce5 AC |
11632 | @findex gnus-mime-replace-part |
11633 | @item r (Article) | |
11634 | @kindex r (Article) | |
11635 | Prompt for a file name, replace the @acronym{MIME} object with an | |
fac916bf | 11636 | external body referring to the file via the message/external-body |
8a1cdce5 | 11637 | @acronym{MIME} type. (@code{gnus-mime-replace-part}). |
4009494e | 11638 | |
8a1cdce5 AC |
11639 | @findex gnus-mime-delete-part |
11640 | @item d (Article) | |
11641 | @kindex d (Article) | |
11642 | Delete the @acronym{MIME} object from the article and replace it with some | |
11643 | information about the removed @acronym{MIME} object | |
11644 | (@code{gnus-mime-delete-part}). | |
4009494e | 11645 | |
8a1cdce5 | 11646 | @c FIXME: gnus-auto-select-part should be documented here |
4009494e | 11647 | |
8a1cdce5 AC |
11648 | @findex gnus-mime-copy-part |
11649 | @item c (Article) | |
11650 | @kindex c (Article) | |
11651 | Copy the @acronym{MIME} object to a fresh buffer and display this buffer | |
11652 | (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents | |
11653 | without decoding. If given a numerical prefix, you can do semi-manual | |
11654 | charset stuff (see @code{gnus-summary-show-article-charset-alist} in | |
11655 | @ref{Paging the Article}). Compressed files like @file{.gz} and | |
11656 | @file{.bz2} are automatically decompressed if | |
11657 | @code{auto-compression-mode} is enabled (@pxref{Compressed Files,, | |
11658 | Accessing Compressed Files, emacs, The Emacs Editor}). | |
01c52d31 | 11659 | |
8a1cdce5 AC |
11660 | @findex gnus-mime-print-part |
11661 | @item p (Article) | |
11662 | @kindex p (Article) | |
11663 | Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This | |
11664 | command respects the @samp{print=} specifications in the | |
11665 | @file{.mailcap} file. | |
4009494e | 11666 | |
8a1cdce5 AC |
11667 | @findex gnus-mime-inline-part |
11668 | @item i (Article) | |
11669 | @kindex i (Article) | |
11670 | Insert the contents of the @acronym{MIME} object into the buffer | |
11671 | (@code{gnus-mime-inline-part}) as @samp{text/plain}. If given a prefix, insert | |
11672 | the raw contents without decoding. If given a numerical prefix, you can | |
11673 | do semi-manual charset stuff (see | |
11674 | @code{gnus-summary-show-article-charset-alist} in @ref{Paging the | |
11675 | Article}). Compressed files like @file{.gz} and @file{.bz2} are | |
11676 | automatically decompressed depending on @code{jka-compr} regardless of | |
11677 | @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing | |
11678 | Compressed Files, emacs, The Emacs Editor}). | |
4009494e | 11679 | |
8a1cdce5 AC |
11680 | @findex gnus-mime-view-part-internally |
11681 | @item E (Article) | |
11682 | @kindex E (Article) | |
11683 | View the @acronym{MIME} object with an internal viewer. If no internal | |
11684 | viewer is available, use an external viewer | |
11685 | (@code{gnus-mime-view-part-internally}). | |
4009494e | 11686 | |
8a1cdce5 AC |
11687 | @findex gnus-mime-view-part-externally |
11688 | @item e (Article) | |
11689 | @kindex e (Article) | |
11690 | View the @acronym{MIME} object with an external viewer. | |
11691 | (@code{gnus-mime-view-part-externally}). | |
4009494e | 11692 | |
8a1cdce5 AC |
11693 | @findex gnus-mime-pipe-part |
11694 | @item | (Article) | |
11695 | @kindex | (Article) | |
11696 | Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}). | |
4009494e | 11697 | |
8a1cdce5 AC |
11698 | @findex gnus-mime-action-on-part |
11699 | @item . (Article) | |
11700 | @kindex . (Article) | |
11701 | Interactively run an action on the @acronym{MIME} object | |
11702 | (@code{gnus-mime-action-on-part}). | |
01c52d31 | 11703 | |
8a1cdce5 | 11704 | @end table |
01c52d31 | 11705 | |
8a1cdce5 AC |
11706 | Gnus will display some @acronym{MIME} objects automatically. The way Gnus |
11707 | determines which parts to do this with is described in the Emacs | |
11708 | @acronym{MIME} manual. | |
01c52d31 | 11709 | |
8a1cdce5 AC |
11710 | It might be best to just use the toggling functions from the article |
11711 | buffer to avoid getting nasty surprises. (For instance, you enter the | |
11712 | group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has | |
11713 | decoded the sound file in the article and some horrible sing-a-long song | |
11714 | comes screaming out your speakers, and you can't find the volume button, | |
11715 | because there isn't one, and people are starting to look at you, and you | |
11716 | try to stop the program, but you can't, and you can't find the program | |
11717 | to control the volume, and everybody else in the room suddenly decides | |
11718 | to look at you disdainfully, and you'll feel rather stupid.) | |
01c52d31 | 11719 | |
8a1cdce5 | 11720 | Any similarity to real events and people is purely coincidental. Ahem. |
01c52d31 | 11721 | |
8a1cdce5 | 11722 | Also @pxref{MIME Commands}. |
01c52d31 | 11723 | |
4009494e | 11724 | |
8a1cdce5 AC |
11725 | @node HTML |
11726 | @section @acronym{HTML} | |
11727 | @cindex @acronym{HTML} | |
4009494e | 11728 | |
8a1cdce5 AC |
11729 | If you have @code{w3m} installed on your system, Gnus can display |
11730 | @acronym{HTML} articles in the article buffer. There are many Gnus | |
11731 | add-ons for doing this, using various approaches, but there's one | |
11732 | (sort of) built-in method that's used by default. | |
4009494e | 11733 | |
8a1cdce5 AC |
11734 | For a complete overview, consult @xref{Display Customization, |
11735 | ,Display Customization, emacs-mime, The Emacs MIME Manual}. This | |
11736 | section only describes the default method. | |
4009494e | 11737 | |
8a1cdce5 AC |
11738 | @table @code |
11739 | @item mm-text-html-renderer | |
11740 | @vindex mm-text-html-renderer | |
11741 | If set to @code{gnus-article-html}, Gnus will use the built-in method, | |
11742 | that's based on @code{w3m}. | |
4009494e | 11743 | |
8a1cdce5 AC |
11744 | @item gnus-blocked-images |
11745 | @vindex gnus-blocked-images | |
11746 | External images that have @acronym{URL}s that match this regexp won't | |
11747 | be fetched and displayed. For instance, do block all @acronym{URL}s | |
11748 | that have the string ``ads'' in them, do the following: | |
4009494e | 11749 | |
8a1cdce5 AC |
11750 | @lisp |
11751 | (setq gnus-blocked-images "ads") | |
11752 | @end lisp | |
4009494e | 11753 | |
8a1cdce5 AC |
11754 | This can also be a function to be evaluated. If so, it will be |
11755 | called with the group name as the parameter. The default value is | |
11756 | @code{gnus-block-private-groups}, which will return @samp{"."} for | |
11757 | anything that isn't a newsgroup. This means that no external images | |
11758 | will be fetched as a result of reading mail, so that nobody can use | |
11759 | web bugs (and the like) to track whether you've read email. | |
4009494e | 11760 | |
8a1cdce5 | 11761 | Also @pxref{Misc Article} for @code{gnus-inhibit-images}. |
4009494e | 11762 | |
8a1cdce5 AC |
11763 | @item gnus-html-cache-directory |
11764 | @vindex gnus-html-cache-directory | |
11765 | Gnus will download and cache images according to how | |
11766 | @code{gnus-blocked-images} is set. These images will be stored in | |
11767 | this directory. | |
4009494e | 11768 | |
8a1cdce5 AC |
11769 | @item gnus-html-cache-size |
11770 | @vindex gnus-html-cache-size | |
11771 | When @code{gnus-html-cache-size} bytes have been used in that | |
11772 | directory, the oldest files will be deleted. The default is 500MB. | |
4009494e | 11773 | |
8a1cdce5 AC |
11774 | @item gnus-html-frame-width |
11775 | @vindex gnus-html-frame-width | |
1df7defd | 11776 | The width to use when rendering HTML@. The default is 70. |
4009494e | 11777 | |
8a1cdce5 AC |
11778 | @item gnus-max-image-proportion |
11779 | @vindex gnus-max-image-proportion | |
11780 | How big pictures displayed are in relation to the window they're in. | |
11781 | A value of 0.7 (the default) means that they are allowed to take up | |
11782 | 70% of the width and height of the window. If they are larger than | |
11783 | this, and Emacs supports it, then the images will be rescaled down to | |
11784 | fit these criteria. | |
4009494e | 11785 | |
8a1cdce5 | 11786 | @end table |
4009494e | 11787 | |
8a1cdce5 AC |
11788 | To use this, make sure that you have @code{w3m} and @code{curl} |
11789 | installed. If you have, then Gnus should display @acronym{HTML} | |
fe3c5669 | 11790 | automatically. |
4009494e | 11791 | |
01c52d31 | 11792 | |
4009494e | 11793 | |
8a1cdce5 AC |
11794 | @node Customizing Articles |
11795 | @section Customizing Articles | |
11796 | @cindex article customization | |
4009494e | 11797 | |
8a1cdce5 AC |
11798 | A slew of functions for customizing how the articles are to look like |
11799 | exist. You can call these functions interactively | |
11800 | (@pxref{Article Washing}), or you can have them | |
11801 | called automatically when you select the articles. | |
4009494e | 11802 | |
8a1cdce5 AC |
11803 | To have them called automatically, you should set the corresponding |
11804 | ``treatment'' variable. For instance, to have headers hidden, you'd set | |
11805 | @code{gnus-treat-hide-headers}. Below is a list of variables that can | |
11806 | be set, but first we discuss the values these variables can have. | |
4009494e | 11807 | |
8a1cdce5 AC |
11808 | Note: Some values, while valid, make little sense. Check the list below |
11809 | for sensible values. | |
4009494e | 11810 | |
8a1cdce5 AC |
11811 | @enumerate |
11812 | @item | |
11813 | @code{nil}: Don't do this treatment. | |
4009494e | 11814 | |
8a1cdce5 AC |
11815 | @item |
11816 | @code{t}: Do this treatment on all body parts. | |
4009494e | 11817 | |
8a1cdce5 AC |
11818 | @item |
11819 | @code{head}: Do the treatment on the headers. | |
4009494e | 11820 | |
8a1cdce5 AC |
11821 | @item |
11822 | @code{first}: Do this treatment on the first body part. | |
4009494e | 11823 | |
8a1cdce5 AC |
11824 | @item |
11825 | @code{last}: Do this treatment on the last body part. | |
4009494e | 11826 | |
8a1cdce5 AC |
11827 | @item |
11828 | An integer: Do this treatment on all body parts that have a length less | |
11829 | than this number. | |
4009494e | 11830 | |
8a1cdce5 AC |
11831 | @item |
11832 | A list of strings: Do this treatment on all body parts that are in | |
11833 | articles that are read in groups that have names that match one of the | |
11834 | regexps in the list. | |
4009494e | 11835 | |
8a1cdce5 AC |
11836 | @item |
11837 | A list where the first element is not a string: | |
4009494e | 11838 | |
8a1cdce5 AC |
11839 | The list is evaluated recursively. The first element of the list is a |
11840 | predicate. The following predicates are recognized: @code{or}, | |
11841 | @code{and}, @code{not} and @code{typep}. Here's an example: | |
4009494e | 11842 | |
8a1cdce5 AC |
11843 | @lisp |
11844 | (or last | |
11845 | (typep "text/x-vcard")) | |
11846 | @end lisp | |
4009494e | 11847 | |
8a1cdce5 | 11848 | @end enumerate |
4009494e | 11849 | |
8a1cdce5 AC |
11850 | You may have noticed that the word @dfn{part} is used here. This refers |
11851 | to the fact that some messages are @acronym{MIME} multipart articles that may | |
11852 | be divided into several parts. Articles that are not multiparts are | |
11853 | considered to contain just a single part. | |
4009494e | 11854 | |
8a1cdce5 AC |
11855 | @vindex gnus-article-treat-types |
11856 | Are the treatments applied to all sorts of multipart parts? Yes, if you | |
11857 | want to, but by default, only @samp{text/plain} parts are given the | |
11858 | treatment. This is controlled by the @code{gnus-article-treat-types} | |
11859 | variable, which is a list of regular expressions that are matched to the | |
11860 | type of the part. This variable is ignored if the value of the | |
11861 | controlling variable is a predicate list, as described above. | |
4009494e | 11862 | |
8a1cdce5 AC |
11863 | @ifinfo |
11864 | @c Avoid sort of redundant entries in the same section for the printed | |
11865 | @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or | |
11866 | @c `i foo-bar'. | |
11867 | @vindex gnus-treat-buttonize | |
11868 | @vindex gnus-treat-buttonize-head | |
11869 | @vindex gnus-treat-capitalize-sentences | |
11870 | @vindex gnus-treat-overstrike | |
11871 | @vindex gnus-treat-strip-cr | |
11872 | @vindex gnus-treat-strip-headers-in-body | |
11873 | @vindex gnus-treat-strip-leading-blank-lines | |
11874 | @vindex gnus-treat-strip-multiple-blank-lines | |
11875 | @vindex gnus-treat-strip-pem | |
11876 | @vindex gnus-treat-strip-trailing-blank-lines | |
11877 | @vindex gnus-treat-unsplit-urls | |
11878 | @vindex gnus-treat-wash-html | |
12e3ca0a | 11879 | @vindex gnus-treat-date |
8a1cdce5 AC |
11880 | @vindex gnus-treat-from-picon |
11881 | @vindex gnus-treat-mail-picon | |
11882 | @vindex gnus-treat-newsgroups-picon | |
11883 | @vindex gnus-treat-from-gravatar | |
11884 | @vindex gnus-treat-mail-gravatar | |
11885 | @vindex gnus-treat-display-smileys | |
11886 | @vindex gnus-treat-body-boundary | |
11887 | @vindex gnus-treat-display-x-face | |
11888 | @vindex gnus-treat-display-face | |
11889 | @vindex gnus-treat-emphasize | |
11890 | @vindex gnus-treat-fill-article | |
11891 | @vindex gnus-treat-fill-long-lines | |
11892 | @vindex gnus-treat-hide-boring-headers | |
11893 | @vindex gnus-treat-hide-citation | |
11894 | @vindex gnus-treat-hide-citation-maybe | |
11895 | @vindex gnus-treat-hide-headers | |
11896 | @vindex gnus-treat-hide-signature | |
11897 | @vindex gnus-treat-strip-banner | |
11898 | @vindex gnus-treat-strip-list-identifiers | |
11899 | @vindex gnus-treat-highlight-citation | |
11900 | @vindex gnus-treat-highlight-headers | |
11901 | @vindex gnus-treat-highlight-signature | |
11902 | @vindex gnus-treat-play-sounds | |
11903 | @vindex gnus-treat-x-pgp-sig | |
11904 | @vindex gnus-treat-unfold-headers | |
11905 | @vindex gnus-treat-fold-headers | |
11906 | @vindex gnus-treat-fold-newsgroups | |
11907 | @vindex gnus-treat-leading-whitespace | |
11908 | @end ifinfo | |
4009494e | 11909 | |
8a1cdce5 AC |
11910 | The following treatment options are available. The easiest way to |
11911 | customize this is to examine the @code{gnus-article-treat} customization | |
11912 | group. Values in parenthesis are suggested sensible values. Others are | |
11913 | possible but those listed are probably sufficient for most people. | |
4009494e | 11914 | |
8a1cdce5 AC |
11915 | @table @code |
11916 | @item gnus-treat-buttonize (t, integer) | |
11917 | @item gnus-treat-buttonize-head (head) | |
4009494e | 11918 | |
8a1cdce5 | 11919 | @xref{Article Buttons}. |
4009494e | 11920 | |
8a1cdce5 AC |
11921 | @item gnus-treat-capitalize-sentences (t, integer) |
11922 | @item gnus-treat-overstrike (t, integer) | |
11923 | @item gnus-treat-strip-cr (t, integer) | |
11924 | @item gnus-treat-strip-headers-in-body (t, integer) | |
11925 | @item gnus-treat-strip-leading-blank-lines (t, first, integer) | |
11926 | @item gnus-treat-strip-multiple-blank-lines (t, integer) | |
11927 | @item gnus-treat-strip-pem (t, last, integer) | |
11928 | @item gnus-treat-strip-trailing-blank-lines (t, last, integer) | |
11929 | @item gnus-treat-unsplit-urls (t, integer) | |
11930 | @item gnus-treat-wash-html (t, integer) | |
4009494e | 11931 | |
8a1cdce5 | 11932 | @xref{Article Washing}. |
4009494e | 11933 | |
12e3ca0a LI |
11934 | @item gnus-treat-date (head) |
11935 | ||
11936 | This will transform/add date headers according to the | |
11937 | @code{gnus-article-date-headers} variable. This is a list of Date | |
11938 | headers to display. The formats available are: | |
11939 | ||
11940 | @table @code | |
11941 | @item ut | |
11942 | Universal time, aka GMT, aka ZULU. | |
11943 | ||
11944 | @item local | |
11945 | The user's local time zone. | |
11946 | ||
11947 | @item english | |
11948 | A semi-readable English sentence. | |
11949 | ||
11950 | @item lapsed | |
11951 | The time elapsed since the message was posted. | |
11952 | ||
d76c843e | 11953 | @item combined-lapsed |
12e3ca0a LI |
11954 | Both the original date header and a (shortened) elapsed time. |
11955 | ||
11956 | @item original | |
11957 | The original date header. | |
11958 | ||
11959 | @item iso8601 | |
11960 | ISO8601 format, i.e., ``2010-11-23T22:05:21''. | |
11961 | ||
11962 | @item user-defined | |
11963 | A format done according to the @code{gnus-article-time-format} | |
11964 | variable. | |
11965 | ||
11966 | @end table | |
4009494e | 11967 | |
8a1cdce5 | 11968 | @xref{Article Date}. |
4009494e | 11969 | |
8a1cdce5 AC |
11970 | @item gnus-treat-from-picon (head) |
11971 | @item gnus-treat-mail-picon (head) | |
11972 | @item gnus-treat-newsgroups-picon (head) | |
4009494e | 11973 | |
8a1cdce5 | 11974 | @xref{Picons}. |
4009494e | 11975 | |
8a1cdce5 AC |
11976 | @item gnus-treat-from-gravatar (head) |
11977 | @item gnus-treat-mail-gravatar (head) | |
4009494e | 11978 | |
8a1cdce5 | 11979 | @xref{Gravatars}. |
4009494e | 11980 | |
8a1cdce5 | 11981 | @item gnus-treat-display-smileys (t, integer) |
4009494e | 11982 | |
8a1cdce5 | 11983 | @item gnus-treat-body-boundary (head) |
4009494e | 11984 | |
8a1cdce5 AC |
11985 | @vindex gnus-body-boundary-delimiter |
11986 | Adds a delimiter between header and body, the string used as delimiter | |
11987 | is controlled by @code{gnus-body-boundary-delimiter}. | |
4009494e | 11988 | |
8a1cdce5 | 11989 | @xref{Smileys}. |
4009494e | 11990 | |
8a1cdce5 AC |
11991 | @vindex gnus-treat-display-x-face |
11992 | @item gnus-treat-display-x-face (head) | |
4009494e | 11993 | |
8a1cdce5 | 11994 | @xref{X-Face}. |
4009494e | 11995 | |
8a1cdce5 AC |
11996 | @vindex gnus-treat-display-face |
11997 | @item gnus-treat-display-face (head) | |
4009494e | 11998 | |
8a1cdce5 | 11999 | @xref{Face}. |
4009494e | 12000 | |
8a1cdce5 AC |
12001 | @vindex gnus-treat-emphasize |
12002 | @item gnus-treat-emphasize (t, head, integer) | |
12003 | @vindex gnus-treat-fill-article | |
12004 | @item gnus-treat-fill-article (t, integer) | |
12005 | @vindex gnus-treat-fill-long-lines | |
12006 | @item gnus-treat-fill-long-lines (t, integer) | |
12007 | @vindex gnus-treat-hide-boring-headers | |
12008 | @item gnus-treat-hide-boring-headers (head) | |
12009 | @vindex gnus-treat-hide-citation | |
12010 | @item gnus-treat-hide-citation (t, integer) | |
12011 | @vindex gnus-treat-hide-citation-maybe | |
12012 | @item gnus-treat-hide-citation-maybe (t, integer) | |
12013 | @vindex gnus-treat-hide-headers | |
12014 | @item gnus-treat-hide-headers (head) | |
12015 | @vindex gnus-treat-hide-signature | |
12016 | @item gnus-treat-hide-signature (t, last) | |
12017 | @vindex gnus-treat-strip-banner | |
12018 | @item gnus-treat-strip-banner (t, last) | |
12019 | @vindex gnus-treat-strip-list-identifiers | |
12020 | @item gnus-treat-strip-list-identifiers (head) | |
4009494e | 12021 | |
8a1cdce5 | 12022 | @xref{Article Hiding}. |
4009494e | 12023 | |
8a1cdce5 AC |
12024 | @vindex gnus-treat-highlight-citation |
12025 | @item gnus-treat-highlight-citation (t, integer) | |
12026 | @vindex gnus-treat-highlight-headers | |
12027 | @item gnus-treat-highlight-headers (head) | |
12028 | @vindex gnus-treat-highlight-signature | |
12029 | @item gnus-treat-highlight-signature (t, last, integer) | |
4009494e | 12030 | |
8a1cdce5 | 12031 | @xref{Article Highlighting}. |
4146636e | 12032 | |
8a1cdce5 AC |
12033 | @vindex gnus-treat-play-sounds |
12034 | @item gnus-treat-play-sounds | |
12035 | @item gnus-treat-ansi-sequences (t) | |
12036 | @vindex gnus-treat-x-pgp-sig | |
12037 | @item gnus-treat-x-pgp-sig (head) | |
4146636e | 12038 | |
8a1cdce5 AC |
12039 | @vindex gnus-treat-unfold-headers |
12040 | @item gnus-treat-unfold-headers (head) | |
12041 | @vindex gnus-treat-fold-headers | |
12042 | @item gnus-treat-fold-headers (head) | |
12043 | @vindex gnus-treat-fold-newsgroups | |
12044 | @item gnus-treat-fold-newsgroups (head) | |
12045 | @vindex gnus-treat-leading-whitespace | |
12046 | @item gnus-treat-leading-whitespace (head) | |
12047 | ||
12048 | @xref{Article Header}. | |
4009494e | 12049 | |
4009494e GM |
12050 | |
12051 | @end table | |
12052 | ||
8a1cdce5 AC |
12053 | @vindex gnus-part-display-hook |
12054 | You can, of course, write your own functions to be called from | |
12055 | @code{gnus-part-display-hook}. The functions are called narrowed to the | |
12056 | part, and you can do anything you like, pretty much. There is no | |
12057 | information that you have to keep in the buffer---you can change | |
12058 | everything. | |
4009494e | 12059 | |
4009494e | 12060 | |
8a1cdce5 AC |
12061 | @node Article Keymap |
12062 | @section Article Keymap | |
4009494e | 12063 | |
8a1cdce5 AC |
12064 | Most of the keystrokes in the summary buffer can also be used in the |
12065 | article buffer. They should behave as if you typed them in the summary | |
12066 | buffer, which means that you don't actually have to have a summary | |
12067 | buffer displayed while reading. You can do it all from the article | |
12068 | buffer. | |
4009494e | 12069 | |
8a1cdce5 AC |
12070 | @kindex v (Article) |
12071 | @cindex keys, reserved for users (Article) | |
12072 | The key @kbd{v} is reserved for users. You can bind it to some | |
12073 | command or better use it as a prefix key. | |
4009494e | 12074 | |
8a1cdce5 | 12075 | A few additional keystrokes are available: |
4009494e | 12076 | |
8a1cdce5 AC |
12077 | @table @kbd |
12078 | ||
12079 | @item SPACE | |
12080 | @kindex SPACE (Article) | |
12081 | @findex gnus-article-next-page | |
12082 | Scroll forwards one page (@code{gnus-article-next-page}). | |
12083 | This is exactly the same as @kbd{h SPACE h}. | |
12084 | ||
12085 | @item DEL | |
12086 | @kindex DEL (Article) | |
12087 | @findex gnus-article-prev-page | |
12088 | Scroll backwards one page (@code{gnus-article-prev-page}). | |
12089 | This is exactly the same as @kbd{h DEL h}. | |
4009494e | 12090 | |
8a1cdce5 AC |
12091 | @item C-c ^ |
12092 | @kindex C-c ^ (Article) | |
12093 | @findex gnus-article-refer-article | |
12094 | If point is in the neighborhood of a @code{Message-ID} and you press | |
12095 | @kbd{C-c ^}, Gnus will try to get that article from the server | |
12096 | (@code{gnus-article-refer-article}). | |
4009494e | 12097 | |
8a1cdce5 AC |
12098 | @item C-c C-m |
12099 | @kindex C-c C-m (Article) | |
12100 | @findex gnus-article-mail | |
12101 | Send a reply to the address near point (@code{gnus-article-mail}). If | |
12102 | given a prefix, include the mail. | |
4009494e | 12103 | |
8a1cdce5 AC |
12104 | @item s |
12105 | @kindex s (Article) | |
12106 | @findex gnus-article-show-summary | |
12107 | Reconfigure the buffers so that the summary buffer becomes visible | |
12108 | (@code{gnus-article-show-summary}). | |
4009494e | 12109 | |
8a1cdce5 AC |
12110 | @item ? |
12111 | @kindex ? (Article) | |
12112 | @findex gnus-article-describe-briefly | |
12113 | Give a very brief description of the available keystrokes | |
12114 | (@code{gnus-article-describe-briefly}). | |
4009494e | 12115 | |
8a1cdce5 AC |
12116 | @item TAB |
12117 | @kindex TAB (Article) | |
12118 | @findex gnus-article-next-button | |
12119 | Go to the next button, if any (@code{gnus-article-next-button}). This | |
12120 | only makes sense if you have buttonizing turned on. | |
4009494e | 12121 | |
8a1cdce5 AC |
12122 | @item M-TAB |
12123 | @kindex M-TAB (Article) | |
12124 | @findex gnus-article-prev-button | |
12125 | Go to the previous button, if any (@code{gnus-article-prev-button}). | |
4009494e | 12126 | |
8a1cdce5 AC |
12127 | @item R |
12128 | @kindex R (Article) | |
12129 | @findex gnus-article-reply-with-original | |
12130 | Send a reply to the current article and yank the current article | |
12131 | (@code{gnus-article-reply-with-original}). If the region is active, | |
12132 | only yank the text in the region. | |
4009494e | 12133 | |
8a1cdce5 AC |
12134 | @item S W |
12135 | @kindex S W (Article) | |
12136 | @findex gnus-article-wide-reply-with-original | |
12137 | Send a wide reply to the current article and yank the current article | |
12138 | (@code{gnus-article-wide-reply-with-original}). If the region is | |
12139 | active, only yank the text in the region. | |
4009494e | 12140 | |
8a1cdce5 AC |
12141 | @item F |
12142 | @kindex F (Article) | |
12143 | @findex gnus-article-followup-with-original | |
12144 | Send a followup to the current article and yank the current article | |
12145 | (@code{gnus-article-followup-with-original}). If the region is active, | |
12146 | only yank the text in the region. | |
4009494e | 12147 | |
4009494e | 12148 | |
8a1cdce5 | 12149 | @end table |
4009494e | 12150 | |
4009494e | 12151 | |
8a1cdce5 AC |
12152 | @node Misc Article |
12153 | @section Misc Article | |
4009494e | 12154 | |
8a1cdce5 | 12155 | @table @code |
4009494e | 12156 | |
8a1cdce5 AC |
12157 | @item gnus-single-article-buffer |
12158 | @vindex gnus-single-article-buffer | |
12159 | @cindex article buffers, several | |
12160 | If non-@code{nil}, use the same article buffer for all the groups. | |
12161 | (This is the default.) If @code{nil}, each group will have its own | |
12162 | article buffer. | |
4009494e | 12163 | |
8a1cdce5 AC |
12164 | @item gnus-widen-article-window |
12165 | @cindex gnus-widen-article-window | |
12166 | If non-@code{nil}, selecting the article buffer with the @kbd{h} | |
12167 | command will ``widen'' the article window to take the entire frame. | |
4009494e | 12168 | |
8a1cdce5 AC |
12169 | @vindex gnus-article-decode-hook |
12170 | @item gnus-article-decode-hook | |
12171 | @cindex @acronym{MIME} | |
12172 | Hook used to decode @acronym{MIME} articles. The default value is | |
12173 | @code{(article-decode-charset article-decode-encoded-words)} | |
4009494e | 12174 | |
8a1cdce5 AC |
12175 | @vindex gnus-article-prepare-hook |
12176 | @item gnus-article-prepare-hook | |
12177 | This hook is called right after the article has been inserted into the | |
12178 | article buffer. It is mainly intended for functions that do something | |
12179 | depending on the contents; it should probably not be used for changing | |
12180 | the contents of the article buffer. | |
4009494e | 12181 | |
8a1cdce5 AC |
12182 | @item gnus-article-mode-hook |
12183 | @vindex gnus-article-mode-hook | |
12184 | Hook called in article mode buffers. | |
4009494e | 12185 | |
8a1cdce5 AC |
12186 | @item gnus-article-mode-syntax-table |
12187 | @vindex gnus-article-mode-syntax-table | |
12188 | Syntax table used in article buffers. It is initialized from | |
12189 | @code{text-mode-syntax-table}. | |
4009494e | 12190 | |
8a1cdce5 AC |
12191 | @vindex gnus-article-over-scroll |
12192 | @item gnus-article-over-scroll | |
12193 | If non-@code{nil}, allow scrolling the article buffer even when there | |
12194 | no more new text to scroll in. The default is @code{nil}. | |
4009494e | 12195 | |
8a1cdce5 AC |
12196 | @vindex gnus-article-mode-line-format |
12197 | @item gnus-article-mode-line-format | |
12198 | This variable is a format string along the same lines as | |
12199 | @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode | |
12200 | Line}). It accepts the same format specifications as that variable, | |
12201 | with two extensions: | |
4009494e | 12202 | |
8a1cdce5 | 12203 | @table @samp |
4009494e | 12204 | |
8a1cdce5 AC |
12205 | @item w |
12206 | The @dfn{wash status} of the article. This is a short string with one | |
12207 | character for each possible article wash operation that may have been | |
12208 | performed. The characters and their meaning: | |
4009494e | 12209 | |
8a1cdce5 | 12210 | @table @samp |
4009494e | 12211 | |
8a1cdce5 AC |
12212 | @item c |
12213 | Displayed when cited text may be hidden in the article buffer. | |
4009494e | 12214 | |
8a1cdce5 AC |
12215 | @item h |
12216 | Displayed when headers are hidden in the article buffer. | |
4009494e | 12217 | |
8a1cdce5 AC |
12218 | @item p |
12219 | Displayed when article is digitally signed or encrypted, and Gnus has | |
12220 | hidden the security headers. (N.B. does not tell anything about | |
1df7defd | 12221 | security status, i.e., good or bad signature.) |
4009494e | 12222 | |
8a1cdce5 AC |
12223 | @item s |
12224 | Displayed when the signature has been hidden in the Article buffer. | |
4009494e | 12225 | |
8a1cdce5 AC |
12226 | @item o |
12227 | Displayed when Gnus has treated overstrike characters in the article buffer. | |
4009494e | 12228 | |
8a1cdce5 AC |
12229 | @item e |
12230 | Displayed when Gnus has treated emphasized strings in the article buffer. | |
4009494e | 12231 | |
8a1cdce5 | 12232 | @end table |
4009494e | 12233 | |
8a1cdce5 AC |
12234 | @item m |
12235 | The number of @acronym{MIME} parts in the article. | |
4009494e | 12236 | |
4009494e GM |
12237 | @end table |
12238 | ||
8a1cdce5 AC |
12239 | @vindex gnus-break-pages |
12240 | ||
12241 | @item gnus-break-pages | |
12242 | Controls whether @dfn{page breaking} is to take place. If this variable | |
12243 | is non-@code{nil}, the articles will be divided into pages whenever a | |
12244 | page delimiter appears in the article. If this variable is @code{nil}, | |
12245 | paging will not be done. | |
4009494e | 12246 | |
8a1cdce5 AC |
12247 | @item gnus-page-delimiter |
12248 | @vindex gnus-page-delimiter | |
12249 | This is the delimiter mentioned above. By default, it is @samp{^L} | |
12250 | (formfeed). | |
4009494e | 12251 | |
8a1cdce5 AC |
12252 | @cindex IDNA |
12253 | @cindex internationalized domain names | |
12254 | @vindex gnus-use-idna | |
12255 | @item gnus-use-idna | |
12256 | This variable controls whether Gnus performs IDNA decoding of | |
12257 | internationalized domain names inside @samp{From}, @samp{To} and | |
12258 | @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual}, | |
12259 | for how to compose such messages. This requires | |
12260 | @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this | |
12261 | variable is only enabled if you have installed it. | |
4009494e | 12262 | |
8a1cdce5 AC |
12263 | @vindex gnus-inhibit-images |
12264 | @item gnus-inhibit-images | |
12265 | If this is non-@code{nil}, inhibit displaying of images inline in the | |
12266 | article body. It is effective to images that are in articles as | |
12267 | @acronym{MIME} parts, and images in @acronym{HTML} articles rendered | |
12268 | when @code{mm-text-html-renderer} (@pxref{Display Customization, | |
12269 | ,Display Customization, emacs-mime, The Emacs MIME Manual}) is | |
12270 | @code{shr} or @code{gnus-w3m}. | |
4009494e | 12271 | |
8a1cdce5 | 12272 | @end table |
4009494e | 12273 | |
4009494e | 12274 | |
8a1cdce5 AC |
12275 | @node Composing Messages |
12276 | @chapter Composing Messages | |
12277 | @cindex composing messages | |
12278 | @cindex messages | |
12279 | @cindex mail | |
12280 | @cindex sending mail | |
12281 | @cindex reply | |
12282 | @cindex followup | |
12283 | @cindex post | |
12284 | @cindex using gpg | |
12285 | @cindex using s/mime | |
12286 | @cindex using smime | |
4009494e | 12287 | |
8a1cdce5 AC |
12288 | @kindex C-c C-c (Post) |
12289 | All commands for posting and mailing will put you in a message buffer | |
12290 | where you can edit the article all you like, before you send the | |
12291 | article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message, | |
12292 | Message Manual}. Where the message will be posted/mailed to depends | |
12293 | on your setup (@pxref{Posting Server}). | |
4009494e | 12294 | |
8a1cdce5 AC |
12295 | @menu |
12296 | * Mail:: Mailing and replying. | |
12297 | * Posting Server:: What server should you post and mail via? | |
12298 | * POP before SMTP:: You cannot send a mail unless you read a mail. | |
12299 | * Mail and Post:: Mailing and posting at the same time. | |
12300 | * Archived Messages:: Where Gnus stores the messages you've sent. | |
12301 | * Posting Styles:: An easier way to specify who you are. | |
12302 | * Drafts:: Postponing messages and rejected messages. | |
12303 | * Rejected Articles:: What happens if the server doesn't like your article? | |
12304 | * Signing and encrypting:: How to compose secure messages. | |
12305 | @end menu | |
4009494e | 12306 | |
8a1cdce5 AC |
12307 | Also @pxref{Canceling and Superseding} for information on how to |
12308 | remove articles you shouldn't have posted. | |
4009494e | 12309 | |
4009494e | 12310 | |
8a1cdce5 AC |
12311 | @node Mail |
12312 | @section Mail | |
4009494e | 12313 | |
8a1cdce5 | 12314 | Variables for customizing outgoing mail: |
4009494e | 12315 | |
8a1cdce5 AC |
12316 | @table @code |
12317 | @item gnus-uu-digest-headers | |
12318 | @vindex gnus-uu-digest-headers | |
12319 | List of regexps to match headers included in digested messages. The | |
12320 | headers will be included in the sequence they are matched. If | |
12321 | @code{nil} include all headers. | |
4009494e | 12322 | |
8a1cdce5 AC |
12323 | @item gnus-add-to-list |
12324 | @vindex gnus-add-to-list | |
12325 | If non-@code{nil}, add a @code{to-list} group parameter to mail groups | |
12326 | that have none when you do a @kbd{a}. | |
4009494e | 12327 | |
8a1cdce5 AC |
12328 | @item gnus-confirm-mail-reply-to-news |
12329 | @vindex gnus-confirm-mail-reply-to-news | |
12330 | If non-@code{nil}, Gnus will ask you for a confirmation when you are | |
12331 | about to reply to news articles by mail. If it is @code{nil}, nothing | |
12332 | interferes in what you want to do. This can also be a function | |
12333 | receiving the group name as the only parameter which should return | |
12334 | non-@code{nil} if a confirmation is needed, or a regular expression | |
12335 | matching group names, where confirmation should be asked for. | |
4009494e | 12336 | |
8a1cdce5 AC |
12337 | If you find yourself never wanting to reply to mail, but occasionally |
12338 | press @kbd{R} anyway, this variable might be for you. | |
01c52d31 | 12339 | |
8a1cdce5 AC |
12340 | @item gnus-confirm-treat-mail-like-news |
12341 | @vindex gnus-confirm-treat-mail-like-news | |
12342 | If non-@code{nil}, Gnus also requests confirmation according to | |
12343 | @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is | |
12344 | useful for treating mailing lists like newsgroups. | |
4009494e | 12345 | |
8a1cdce5 | 12346 | @end table |
01c52d31 | 12347 | |
4009494e | 12348 | |
8a1cdce5 AC |
12349 | @node Posting Server |
12350 | @section Posting Server | |
4009494e | 12351 | |
8a1cdce5 AC |
12352 | When you press those magical @kbd{C-c C-c} keys to ship off your latest |
12353 | (extremely intelligent, of course) article, where does it go? | |
4009494e | 12354 | |
8a1cdce5 | 12355 | Thank you for asking. I hate you. |
4009494e | 12356 | |
8a1cdce5 | 12357 | It can be quite complicated. |
4009494e | 12358 | |
8a1cdce5 AC |
12359 | @vindex gnus-post-method |
12360 | When posting news, Message usually invokes @code{message-send-news} | |
12361 | (@pxref{News Variables, , News Variables, message, Message Manual}). | |
12362 | Normally, Gnus will post using the same select method as you're | |
12363 | reading from (which might be convenient if you're reading lots of | |
12364 | groups from different private servers). However. If the server | |
12365 | you're reading from doesn't allow posting, just reading, you probably | |
12366 | want to use some other server to post your (extremely intelligent and | |
12367 | fabulously interesting) articles. You can then set the | |
12368 | @code{gnus-post-method} to some other method: | |
4009494e | 12369 | |
8a1cdce5 AC |
12370 | @lisp |
12371 | (setq gnus-post-method '(nnspool "")) | |
12372 | @end lisp | |
4009494e | 12373 | |
8a1cdce5 AC |
12374 | Now, if you've done this, and then this server rejects your article, or |
12375 | this server is down, what do you do then? To override this variable you | |
12376 | can use a non-zero prefix to the @kbd{C-c C-c} command to force using | |
12377 | the ``current'' server, to get back the default behavior, for posting. | |
4009494e | 12378 | |
8a1cdce5 AC |
12379 | If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command, |
12380 | Gnus will prompt you for what method to use for posting. | |
4009494e | 12381 | |
8a1cdce5 AC |
12382 | You can also set @code{gnus-post-method} to a list of select methods. |
12383 | If that's the case, Gnus will always prompt you for what method to use | |
12384 | for posting. | |
12385 | ||
12386 | Finally, if you want to always post using the native select method, | |
12387 | you can set this variable to @code{native}. | |
4009494e | 12388 | |
8a1cdce5 AC |
12389 | @vindex message-send-mail-function |
12390 | When sending mail, Message invokes the function specified by the | |
12391 | variable @code{message-send-mail-function}. Gnus tries to set it to a | |
12392 | value suitable for your system. | |
12393 | @xref{Mail Variables, ,Mail Variables,message,Message manual}, for more | |
12394 | information. | |
4009494e | 12395 | |
89b163db | 12396 | |
8a1cdce5 AC |
12397 | @node POP before SMTP |
12398 | @section POP before SMTP | |
12399 | @cindex pop before smtp | |
8a1cdce5 | 12400 | @findex mail-source-touch-pop |
4009494e | 12401 | |
89b163db G |
12402 | Does your @acronym{ISP} use @acronym{POP}-before-@acronym{SMTP} |
12403 | authentication? This authentication method simply requires you to | |
12404 | contact the @acronym{POP} server before sending email. To do that, | |
12405 | put the following lines in your @file{~/.gnus.el} file: | |
4009494e | 12406 | |
8a1cdce5 | 12407 | @lisp |
8a1cdce5 AC |
12408 | (add-hook 'message-send-mail-hook 'mail-source-touch-pop) |
12409 | @end lisp | |
85115796 | 12410 | |
8a1cdce5 | 12411 | @noindent |
89b163db G |
12412 | The @code{mail-source-touch-pop} function does @acronym{POP} |
12413 | authentication according to the value of @code{mail-sources} without | |
12414 | fetching mails, just before sending a mail. @xref{Mail Sources}. | |
85115796 | 12415 | |
8a1cdce5 AC |
12416 | If you have two or more @acronym{POP} mail servers set in |
12417 | @code{mail-sources}, you may want to specify one of them to | |
12418 | @code{mail-source-primary-source} as the @acronym{POP} mail server to be | |
12419 | used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it | |
12420 | is your primary @acronym{POP} mail server (i.e., you are fetching mails | |
12421 | mainly from that server), you can set it permanently as follows: | |
85115796 | 12422 | |
8a1cdce5 AC |
12423 | @lisp |
12424 | (setq mail-source-primary-source | |
12425 | '(pop :server "pop3.mail.server" | |
12426 | :password "secret")) | |
12427 | @end lisp | |
85115796 | 12428 | |
8a1cdce5 AC |
12429 | @noindent |
12430 | Otherwise, bind it dynamically only when performing the | |
12431 | @acronym{POP}-before-@acronym{SMTP} authentication as follows: | |
51dee5ef KY |
12432 | |
12433 | @lisp | |
8a1cdce5 AC |
12434 | (add-hook 'message-send-mail-hook |
12435 | (lambda () | |
12436 | (let ((mail-source-primary-source | |
12437 | '(pop :server "pop3.mail.server" | |
12438 | :password "secret"))) | |
12439 | (mail-source-touch-pop)))) | |
51dee5ef KY |
12440 | @end lisp |
12441 | ||
89b163db | 12442 | |
8a1cdce5 AC |
12443 | @node Mail and Post |
12444 | @section Mail and Post | |
51dee5ef | 12445 | |
8a1cdce5 AC |
12446 | Here's a list of variables relevant to both mailing and |
12447 | posting: | |
239661c0 | 12448 | |
8a1cdce5 AC |
12449 | @table @code |
12450 | @item gnus-mailing-list-groups | |
12451 | @findex gnus-mailing-list-groups | |
12452 | @cindex mailing lists | |
85115796 | 12453 | |
8a1cdce5 AC |
12454 | If your news server offers groups that are really mailing lists |
12455 | gatewayed to the @acronym{NNTP} server, you can read those groups without | |
12456 | problems, but you can't post/followup to them without some difficulty. | |
12457 | One solution is to add a @code{to-address} to the group parameters | |
12458 | (@pxref{Group Parameters}). An easier thing to do is set the | |
12459 | @code{gnus-mailing-list-groups} to a regexp that matches the groups that | |
12460 | really are mailing lists. Then, at least, followups to the mailing | |
12461 | lists will work most of the time. Posting to these groups (@kbd{a}) is | |
12462 | still a pain, though. | |
85115796 | 12463 | |
8a1cdce5 AC |
12464 | @item gnus-user-agent |
12465 | @vindex gnus-user-agent | |
12466 | @cindex User-Agent | |
85115796 | 12467 | |
8a1cdce5 AC |
12468 | This variable controls which information should be exposed in the |
12469 | User-Agent header. It can be a list of symbols or a string. Valid | |
12470 | symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs | |
12471 | version). In addition to the Emacs version, you can add @code{codename} | |
12472 | (show (S)XEmacs codename) or either @code{config} (show system | |
12473 | configuration) or @code{type} (show system type). If you set it to a | |
12474 | string, be sure to use a valid format, see RFC 2616. | |
59d09f15 | 12475 | |
85115796 KY |
12476 | @end table |
12477 | ||
8a1cdce5 AC |
12478 | You may want to do spell-checking on messages that you send out. Or, if |
12479 | you don't want to spell-check by hand, you could add automatic | |
12480 | spell-checking via the @code{ispell} package: | |
85115796 | 12481 | |
8a1cdce5 AC |
12482 | @cindex ispell |
12483 | @findex ispell-message | |
12484 | @lisp | |
12485 | (add-hook 'message-send-hook 'ispell-message) | |
12486 | @end lisp | |
85115796 | 12487 | |
8a1cdce5 AC |
12488 | If you want to change the @code{ispell} dictionary based on what group |
12489 | you're in, you could say something like the following: | |
85115796 | 12490 | |
8a1cdce5 AC |
12491 | @lisp |
12492 | (add-hook 'gnus-select-group-hook | |
12493 | (lambda () | |
12494 | (cond | |
12495 | ((string-match | |
12496 | "^de\\." (gnus-group-real-name gnus-newsgroup-name)) | |
12497 | (ispell-change-dictionary "deutsch")) | |
12498 | (t | |
12499 | (ispell-change-dictionary "english"))))) | |
12500 | @end lisp | |
4009494e | 12501 | |
8a1cdce5 | 12502 | Modify to suit your needs. |
4009494e | 12503 | |
8a1cdce5 AC |
12504 | @vindex gnus-message-highlight-citation |
12505 | If @code{gnus-message-highlight-citation} is t, different levels of | |
12506 | citations are highlighted like in Gnus article buffers also in message | |
12507 | mode buffers. | |
4009494e | 12508 | |
8a1cdce5 AC |
12509 | @node Archived Messages |
12510 | @section Archived Messages | |
12511 | @cindex archived messages | |
12512 | @cindex sent messages | |
4009494e | 12513 | |
8a1cdce5 AC |
12514 | Gnus provides a few different methods for storing the mail and news you |
12515 | send. The default method is to use the @dfn{archive virtual server} to | |
12516 | store the messages. If you want to disable this completely, the | |
005a89ff G |
12517 | @code{gnus-message-archive-group} variable should be @code{nil}. The |
12518 | default is "sent.%Y-%m", which gives you one archive group per month. | |
4009494e | 12519 | |
8a1cdce5 AC |
12520 | For archiving interesting messages in a group you read, see the |
12521 | @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail | |
12522 | Group Commands}). | |
4009494e | 12523 | |
8a1cdce5 AC |
12524 | @vindex gnus-message-archive-method |
12525 | @code{gnus-message-archive-method} says what virtual server Gnus is to | |
12526 | use to store sent messages. The default is @code{"archive"}, and when | |
12527 | actually being used it is expanded into: | |
4009494e | 12528 | |
8a1cdce5 AC |
12529 | @lisp |
12530 | (nnfolder "archive" | |
12531 | (nnfolder-directory "~/Mail/archive") | |
12532 | (nnfolder-active-file "~/Mail/archive/active") | |
12533 | (nnfolder-get-new-mail nil) | |
12534 | (nnfolder-inhibit-expiry t)) | |
12535 | @end lisp | |
01c52d31 | 12536 | |
8a1cdce5 AC |
12537 | @quotation |
12538 | @vindex gnus-update-message-archive-method | |
12539 | Note: a server like this is saved in the @file{~/.newsrc.eld} file first | |
12540 | so that it may be used as a real method of the server which is named | |
12541 | @code{"archive"} (that is, for the case where | |
12542 | @code{gnus-message-archive-method} is set to @code{"archive"}) ever | |
12543 | since. If it once has been saved, it will never be updated by default | |
12544 | even if you change the value of @code{gnus-message-archive-method} | |
12545 | afterward. Therefore, the server @code{"archive"} doesn't necessarily | |
12546 | mean the @code{nnfolder} server like this at all times. If you want the | |
12547 | saved method to reflect always the value of | |
12548 | @code{gnus-message-archive-method}, set the | |
12549 | @code{gnus-update-message-archive-method} variable to a non-@code{nil} | |
12550 | value. The default value of this variable is @code{nil}. | |
12551 | @end quotation | |
4009494e | 12552 | |
8a1cdce5 AC |
12553 | You can, however, use any mail select method (@code{nnml}, |
12554 | @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method | |
12555 | for doing this sort of thing, though. If you don't like the default | |
12556 | directory chosen, you could say something like: | |
4009494e | 12557 | |
8a1cdce5 AC |
12558 | @lisp |
12559 | (setq gnus-message-archive-method | |
12560 | '(nnfolder "archive" | |
12561 | (nnfolder-inhibit-expiry t) | |
12562 | (nnfolder-active-file "~/News/sent-mail/active") | |
12563 | (nnfolder-directory "~/News/sent-mail/"))) | |
12564 | @end lisp | |
4009494e | 12565 | |
8a1cdce5 AC |
12566 | @vindex gnus-message-archive-group |
12567 | @cindex Gcc | |
12568 | Gnus will insert @code{Gcc} headers in all outgoing messages that point | |
12569 | to one or more group(s) on that server. Which group to use is | |
12570 | determined by the @code{gnus-message-archive-group} variable. | |
4009494e | 12571 | |
8a1cdce5 AC |
12572 | This variable can be used to do the following: |
12573 | ||
12574 | @table @asis | |
12575 | @item a string | |
12576 | Messages will be saved in that group. | |
12577 | ||
12578 | Note that you can include a select method in the group name, then the | |
12579 | message will not be stored in the select method given by | |
12580 | @code{gnus-message-archive-method}, but in the select method specified | |
12581 | by the group name, instead. Suppose @code{gnus-message-archive-method} | |
12582 | has the default value shown above. Then setting | |
12583 | @code{gnus-message-archive-group} to @code{"foo"} means that outgoing | |
12584 | messages are stored in @samp{nnfolder+archive:foo}, but if you use the | |
12585 | value @code{"nnml:foo"}, then outgoing messages will be stored in | |
12586 | @samp{nnml:foo}. | |
4009494e | 12587 | |
8a1cdce5 AC |
12588 | @item a list of strings |
12589 | Messages will be saved in all those groups. | |
4009494e | 12590 | |
8a1cdce5 AC |
12591 | @item an alist of regexps, functions and forms |
12592 | When a key ``matches'', the result is used. | |
4009494e | 12593 | |
8a1cdce5 | 12594 | @item @code{nil} |
a5166359 | 12595 | No message archiving will take place. |
8a1cdce5 | 12596 | @end table |
4009494e | 12597 | |
8a1cdce5 | 12598 | Let's illustrate: |
4009494e | 12599 | |
8a1cdce5 AC |
12600 | Just saving to a single group called @samp{MisK}: |
12601 | @lisp | |
12602 | (setq gnus-message-archive-group "MisK") | |
12603 | @end lisp | |
4009494e | 12604 | |
8a1cdce5 AC |
12605 | Saving to two groups, @samp{MisK} and @samp{safe}: |
12606 | @lisp | |
12607 | (setq gnus-message-archive-group '("MisK" "safe")) | |
12608 | @end lisp | |
4009494e | 12609 | |
8a1cdce5 AC |
12610 | Save to different groups based on what group you are in: |
12611 | @lisp | |
12612 | (setq gnus-message-archive-group | |
12613 | '(("^alt" "sent-to-alt") | |
12614 | ("mail" "sent-to-mail") | |
12615 | (".*" "sent-to-misc"))) | |
12616 | @end lisp | |
4009494e | 12617 | |
8a1cdce5 AC |
12618 | More complex stuff: |
12619 | @lisp | |
12620 | (setq gnus-message-archive-group | |
12621 | '((if (message-news-p) | |
12622 | "misc-news" | |
12623 | "misc-mail"))) | |
12624 | @end lisp | |
4009494e | 12625 | |
8a1cdce5 AC |
12626 | How about storing all news messages in one file, but storing all mail |
12627 | messages in one file per month: | |
4009494e | 12628 | |
8a1cdce5 AC |
12629 | @lisp |
12630 | (setq gnus-message-archive-group | |
12631 | '((if (message-news-p) | |
12632 | "misc-news" | |
12633 | (concat "mail." (format-time-string "%Y-%m"))))) | |
12634 | @end lisp | |
4009494e | 12635 | |
8a1cdce5 AC |
12636 | Now, when you send a message off, it will be stored in the appropriate |
12637 | group. (If you want to disable storing for just one particular message, | |
12638 | you can just remove the @code{Gcc} header that has been inserted.) The | |
12639 | archive group will appear in the group buffer the next time you start | |
12640 | Gnus, or the next time you press @kbd{F} in the group buffer. You can | |
12641 | enter it and read the articles in it just like you'd read any other | |
12642 | group. If the group gets really big and annoying, you can simply rename | |
12643 | if (using @kbd{G r} in the group buffer) to something | |
12644 | nice---@samp{misc-mail-september-1995}, or whatever. New messages will | |
12645 | continue to be stored in the old (now empty) group. | |
4009494e | 12646 | |
8a1cdce5 AC |
12647 | @table @code |
12648 | @item gnus-gcc-mark-as-read | |
12649 | @vindex gnus-gcc-mark-as-read | |
12650 | If non-@code{nil}, automatically mark @code{Gcc} articles as read. | |
4009494e | 12651 | |
8a1cdce5 AC |
12652 | @item gnus-gcc-externalize-attachments |
12653 | @vindex gnus-gcc-externalize-attachments | |
12654 | If @code{nil}, attach files as normal parts in Gcc copies; if a regexp | |
12655 | and matches the Gcc group name, attach files as external parts; if it is | |
12656 | @code{all}, attach local files as external parts; if it is other | |
12657 | non-@code{nil}, the behavior is the same as @code{all}, but it may be | |
12658 | changed in the future. | |
61b1af82 | 12659 | |
89b163db G |
12660 | @item gnus-gcc-self-resent-messages |
12661 | @vindex gnus-gcc-self-resent-messages | |
12662 | Like the @code{gcc-self} group parameter, applied only for unmodified | |
12663 | messages that @code{gnus-summary-resend-message} (@pxref{Summary Mail | |
12664 | Commands}) resends. Non-@code{nil} value of this variable takes | |
12665 | precedence over any existing @code{Gcc} header. | |
12666 | ||
12667 | If this is @code{none}, no @code{Gcc} copy will be made. If this is | |
12668 | @code{t}, messages resent will be @code{Gcc} copied to the current | |
12669 | group. If this is a string, it specifies a group to which resent | |
12670 | messages will be @code{Gcc} copied. If this is @code{nil}, @code{Gcc} | |
12671 | will be done according to existing @code{Gcc} header(s), if any. If | |
12672 | this is @code{no-gcc-self}, that is the default, resent messages will be | |
12673 | @code{Gcc} copied to groups that existing @code{Gcc} header specifies, | |
12674 | except for the current group. | |
12675 | ||
12676 | @item gnus-gcc-pre-body-encode-hook | |
12677 | @vindex gnus-gcc-pre-body-encode-hook | |
12678 | @itemx gnus-gcc-post-body-encode-hook | |
12679 | @vindex gnus-gcc-post-body-encode-hook | |
12680 | ||
12681 | These hooks are run before/after encoding the message body of the Gcc | |
12682 | copy of a sent message. The current buffer (when the hook is run) | |
12683 | contains the message including the message header. Changes made to | |
12684 | the message will only affect the Gcc copy, but not the original | |
12685 | message. You can use these hooks to edit the copy (and influence | |
1df7defd | 12686 | subsequent transformations), e.g., remove MML secure tags |
89b163db G |
12687 | (@pxref{Signing and encrypting}). |
12688 | ||
8a1cdce5 | 12689 | @end table |
61b1af82 | 12690 | |
4009494e | 12691 | |
8a1cdce5 AC |
12692 | @node Posting Styles |
12693 | @section Posting Styles | |
12694 | @cindex posting styles | |
12695 | @cindex styles | |
4009494e | 12696 | |
8a1cdce5 | 12697 | All them variables, they make my head swim. |
4009494e | 12698 | |
8a1cdce5 AC |
12699 | So what if you want a different @code{Organization} and signature based |
12700 | on what groups you post to? And you post both from your home machine | |
12701 | and your work machine, and you want different @code{From} lines, and so | |
12702 | on? | |
4009494e | 12703 | |
8a1cdce5 AC |
12704 | @vindex gnus-posting-styles |
12705 | One way to do stuff like that is to write clever hooks that change the | |
12706 | variables you need to have changed. That's a bit boring, so somebody | |
12707 | came up with the bright idea of letting the user specify these things in | |
12708 | a handy alist. Here's an example of a @code{gnus-posting-styles} | |
12709 | variable: | |
4009494e | 12710 | |
8a1cdce5 AC |
12711 | @lisp |
12712 | ((".*" | |
12713 | (signature "Peace and happiness") | |
12714 | (organization "What me?")) | |
12715 | ("^comp" | |
12716 | (signature "Death to everybody")) | |
12717 | ("comp.emacs.i-love-it" | |
12718 | (organization "Emacs is it"))) | |
12719 | @end lisp | |
4009494e | 12720 | |
8a1cdce5 AC |
12721 | As you might surmise from this example, this alist consists of several |
12722 | @dfn{styles}. Each style will be applicable if the first element | |
12723 | ``matches'', in some form or other. The entire alist will be iterated | |
12724 | over, from the beginning towards the end, and each match will be | |
12725 | applied, which means that attributes in later styles that match override | |
12726 | the same attributes in earlier matching styles. So | |
12727 | @samp{comp.programming.literate} will have the @samp{Death to everybody} | |
12728 | signature and the @samp{What me?} @code{Organization} header. | |
4009494e | 12729 | |
8a1cdce5 AC |
12730 | The first element in each style is called the @code{match}. If it's a |
12731 | string, then Gnus will try to regexp match it against the group name. | |
12732 | If it is the form @code{(header @var{match} @var{regexp})}, then Gnus | |
12733 | will look in the original article for a header whose name is | |
12734 | @var{match} and compare that @var{regexp}. @var{match} and | |
12735 | @var{regexp} are strings. (The original article is the one you are | |
12736 | replying or following up to. If you are not composing a reply or a | |
12737 | followup, then there is nothing to match against.) If the | |
12738 | @code{match} is a function symbol, that function will be called with | |
12739 | no arguments. If it's a variable symbol, then the variable will be | |
12740 | referenced. If it's a list, then that list will be @code{eval}ed. In | |
12741 | any case, if this returns a non-@code{nil} value, then the style is | |
12742 | said to @dfn{match}. | |
4009494e | 12743 | |
8a1cdce5 AC |
12744 | Each style may contain an arbitrary amount of @dfn{attributes}. Each |
12745 | attribute consists of a @code{(@var{name} @var{value})} pair. In | |
12746 | addition, you can also use the @code{(@var{name} :file @var{value})} | |
12747 | form or the @code{(@var{name} :value @var{value})} form. Where | |
12748 | @code{:file} signifies @var{value} represents a file name and its | |
12749 | contents should be used as the attribute value, @code{:value} signifies | |
12750 | @var{value} does not represent a file name explicitly. The attribute | |
12751 | name can be one of: | |
4009494e | 12752 | |
8a1cdce5 AC |
12753 | @itemize @bullet |
12754 | @item @code{signature} | |
12755 | @item @code{signature-file} | |
12756 | @item @code{x-face-file} | |
12757 | @item @code{address}, overriding @code{user-mail-address} | |
12758 | @item @code{name}, overriding @code{(user-full-name)} | |
12759 | @item @code{body} | |
12760 | @end itemize | |
4009494e | 12761 | |
8a1cdce5 AC |
12762 | Note that the @code{signature-file} attribute honors the variable |
12763 | @code{message-signature-directory}. | |
4009494e | 12764 | |
8a1cdce5 AC |
12765 | The attribute name can also be a string or a symbol. In that case, |
12766 | this will be used as a header name, and the value will be inserted in | |
12767 | the headers of the article; if the value is @code{nil}, the header | |
12768 | name will be removed. If the attribute name is @code{eval}, the form | |
12769 | is evaluated, and the result is thrown away. | |
4009494e | 12770 | |
8a1cdce5 AC |
12771 | The attribute value can be a string, a function with zero arguments |
12772 | (the return value will be used), a variable (its value will be used) | |
12773 | or a list (it will be @code{eval}ed and the return value will be | |
12774 | used). The functions and sexps are called/@code{eval}ed in the | |
12775 | message buffer that is being set up. The headers of the current | |
12776 | article are available through the @code{message-reply-headers} | |
12777 | variable, which is a vector of the following headers: number subject | |
12778 | from date id references chars lines xref extra. | |
4009494e | 12779 | |
8a1cdce5 AC |
12780 | In the case of a string value, if the @code{match} is a regular |
12781 | expression, a @samp{gnus-match-substitute-replacement} is proceed on | |
12782 | the value to replace the positional parameters @samp{\@var{n}} by the | |
0fd2c9a3 GM |
12783 | corresponding parenthetical matches (see @xref{Replacing Match,, |
12784 | Replacing the Text that Matched, elisp, The Emacs Lisp Reference Manual}.) | |
4009494e | 12785 | |
8a1cdce5 | 12786 | @vindex message-reply-headers |
4009494e | 12787 | |
8a1cdce5 AC |
12788 | If you wish to check whether the message you are about to compose is |
12789 | meant to be a news article or a mail message, you can check the values | |
12790 | of the @code{message-news-p} and @code{message-mail-p} functions. | |
4009494e | 12791 | |
8a1cdce5 AC |
12792 | @findex message-mail-p |
12793 | @findex message-news-p | |
4009494e | 12794 | |
8a1cdce5 | 12795 | So here's a new example: |
4009494e | 12796 | |
8a1cdce5 AC |
12797 | @lisp |
12798 | (setq gnus-posting-styles | |
12799 | '((".*" | |
12800 | (signature-file "~/.signature") | |
12801 | (name "User Name") | |
12802 | (x-face-file "~/.xface") | |
12803 | (x-url (getenv "WWW_HOME")) | |
12804 | (organization "People's Front Against MWM")) | |
12805 | ("^rec.humor" | |
12806 | (signature my-funny-signature-randomizer)) | |
12807 | ((equal (system-name) "gnarly") ;; @r{A form} | |
12808 | (signature my-quote-randomizer)) | |
12809 | (message-news-p ;; @r{A function symbol} | |
12810 | (signature my-news-signature)) | |
12811 | (window-system ;; @r{A value symbol} | |
12812 | ("X-Window-System" (format "%s" window-system))) | |
12813 | ;; @r{If I'm replying to Larsi, set the Organization header.} | |
12814 | ((header "from" "larsi.*org") | |
12815 | (Organization "Somewhere, Inc.")) | |
12816 | ((posting-from-work-p) ;; @r{A user defined function} | |
12817 | (signature-file "~/.work-signature") | |
12818 | (address "user@@bar.foo") | |
12819 | (body "You are fired.\n\nSincerely, your boss.") | |
89b163db | 12820 | ("X-Message-SMTP-Method" "smtp smtp.example.org 587") |
8a1cdce5 AC |
12821 | (organization "Important Work, Inc")) |
12822 | ("nnml:.*" | |
12823 | (From (with-current-buffer gnus-article-buffer | |
12824 | (message-fetch-field "to")))) | |
12825 | ("^nn.+:" | |
12826 | (signature-file "~/.mail-signature")))) | |
12827 | @end lisp | |
4009494e | 12828 | |
8a1cdce5 AC |
12829 | The @samp{nnml:.*} rule means that you use the @code{To} address as the |
12830 | @code{From} address in all your outgoing replies, which might be handy | |
12831 | if you fill many roles. | |
12832 | You may also use @code{message-alternative-emails} instead. | |
12833 | @xref{Message Headers, ,Message Headers, message, Message Manual}. | |
4009494e | 12834 | |
89b163db G |
12835 | Of particular interest in the ``work-mail'' style is the |
12836 | @samp{X-Message-SMTP-Method} header. It specifies how to send the | |
12837 | outgoing email. You may want to sent certain emails through certain | |
12838 | @acronym{SMTP} servers due to company policies, for instance. | |
12839 | @xref{Mail Variables, ,Message Variables, message, Message Manual}. | |
12840 | ||
12841 | ||
8a1cdce5 AC |
12842 | @node Drafts |
12843 | @section Drafts | |
12844 | @cindex drafts | |
4009494e | 12845 | |
8a1cdce5 AC |
12846 | If you are writing a message (mail or news) and suddenly remember that |
12847 | you have a steak in the oven (or some pesto in the food processor, you | |
12848 | craaazy vegetarians), you'll probably wish there was a method to save | |
12849 | the message you are writing so that you can continue editing it some | |
12850 | other day, and send it when you feel its finished. | |
4009494e | 12851 | |
8a1cdce5 AC |
12852 | Well, don't worry about it. Whenever you start composing a message of |
12853 | some sort using the Gnus mail and post commands, the buffer you get will | |
12854 | automatically associate to an article in a special @dfn{draft} group. | |
12855 | If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the | |
12856 | article will be saved there. (Auto-save files also go to the draft | |
12857 | group.) | |
4009494e | 12858 | |
8a1cdce5 AC |
12859 | @cindex nndraft |
12860 | @vindex nndraft-directory | |
12861 | The draft group is a special group (which is implemented as an | |
12862 | @code{nndraft} group, if you absolutely have to know) called | |
12863 | @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where | |
12864 | @code{nndraft} is to store its files. What makes this group special is | |
12865 | that you can't tick any articles in it or mark any articles as | |
12866 | read---all articles in the group are permanently unread. | |
4009494e | 12867 | |
8a1cdce5 AC |
12868 | If the group doesn't exist, it will be created and you'll be subscribed |
12869 | to it. The only way to make it disappear from the Group buffer is to | |
12870 | unsubscribe it. The special properties of the draft group comes from | |
12871 | a group property (@pxref{Group Parameters}), and if lost the group | |
12872 | behaves like any other group. This means the commands below will not | |
12873 | be available. To restore the special properties of the group, the | |
12874 | simplest way is to kill the group, using @kbd{C-k}, and restart | |
12875 | Gnus. The group is automatically created again with the | |
12876 | correct parameters. The content of the group is not lost. | |
4009494e | 12877 | |
8a1cdce5 AC |
12878 | @c @findex gnus-dissociate-buffer-from-draft |
12879 | @c @kindex C-c M-d (Mail) | |
12880 | @c @kindex C-c M-d (Post) | |
12881 | @c @findex gnus-associate-buffer-with-draft | |
12882 | @c @kindex C-c C-d (Mail) | |
12883 | @c @kindex C-c C-d (Post) | |
12884 | @c If you're writing some super-secret message that you later want to | |
12885 | @c encode with PGP before sending, you may wish to turn the auto-saving | |
12886 | @c (and association with the draft group) off. You never know who might be | |
12887 | @c interested in reading all your extremely valuable and terribly horrible | |
12888 | @c and interesting secrets. The @kbd{C-c M-d} | |
12889 | @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you. | |
12890 | @c If you change your mind and want to turn the auto-saving back on again, | |
12891 | @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that. | |
12892 | @c | |
12893 | @c @vindex gnus-use-draft | |
12894 | @c To leave association with the draft group off by default, set | |
12895 | @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default. | |
4009494e | 12896 | |
8a1cdce5 AC |
12897 | @findex gnus-draft-edit-message |
12898 | @kindex D e (Draft) | |
12899 | When you want to continue editing the article, you simply enter the | |
12900 | draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do | |
12901 | that. You will be placed in a buffer where you left off. | |
4009494e | 12902 | |
8a1cdce5 AC |
12903 | Rejected articles will also be put in this draft group (@pxref{Rejected |
12904 | Articles}). | |
4009494e | 12905 | |
8a1cdce5 AC |
12906 | @findex gnus-draft-send-all-messages |
12907 | @kindex D s (Draft) | |
12908 | @findex gnus-draft-send-message | |
12909 | @kindex D S (Draft) | |
12910 | If you have lots of rejected messages you want to post (or mail) without | |
12911 | doing further editing, you can use the @kbd{D s} command | |
12912 | (@code{gnus-draft-send-message}). This command understands the | |
12913 | process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S} | |
12914 | command (@code{gnus-draft-send-all-messages}) will ship off all messages | |
12915 | in the buffer. | |
4009494e | 12916 | |
8a1cdce5 AC |
12917 | @findex gnus-draft-toggle-sending |
12918 | @kindex D t (Draft) | |
12919 | If you have some messages that you wish not to send, you can use the | |
12920 | @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message | |
12921 | as unsendable. This is a toggling command. | |
4009494e | 12922 | |
8a1cdce5 AC |
12923 | Finally, if you want to delete a draft, use the normal @kbd{B DEL} |
12924 | command (@pxref{Mail Group Commands}). | |
4009494e | 12925 | |
4009494e | 12926 | |
8a1cdce5 AC |
12927 | @node Rejected Articles |
12928 | @section Rejected Articles | |
12929 | @cindex rejected articles | |
95838435 | 12930 | |
8a1cdce5 AC |
12931 | Sometimes a news server will reject an article. Perhaps the server |
12932 | doesn't like your face. Perhaps it just feels miserable. Perhaps | |
12933 | @emph{there be demons}. Perhaps you have included too much cited text. | |
12934 | Perhaps the disk is full. Perhaps the server is down. | |
4009494e | 12935 | |
8a1cdce5 AC |
12936 | These situations are, of course, totally beyond the control of Gnus. |
12937 | (Gnus, of course, loves the way you look, always feels great, has angels | |
12938 | fluttering around inside of it, doesn't care about how much cited text | |
12939 | you include, never runs full and never goes down.) So Gnus saves these | |
12940 | articles until some later time when the server feels better. | |
4009494e | 12941 | |
8a1cdce5 AC |
12942 | The rejected articles will automatically be put in a special draft group |
12943 | (@pxref{Drafts}). When the server comes back up again, you'd then | |
12944 | typically enter that group and send all the articles off. | |
4009494e | 12945 | |
8a1cdce5 AC |
12946 | @node Signing and encrypting |
12947 | @section Signing and encrypting | |
12948 | @cindex using gpg | |
12949 | @cindex using s/mime | |
12950 | @cindex using smime | |
4009494e | 12951 | |
8a1cdce5 AC |
12952 | Gnus can digitally sign and encrypt your messages, using vanilla |
12953 | @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For | |
12954 | decoding such messages, see the @code{mm-verify-option} and | |
12955 | @code{mm-decrypt-option} options (@pxref{Security}). | |
4009494e | 12956 | |
8a1cdce5 AC |
12957 | @vindex gnus-message-replysign |
12958 | @vindex gnus-message-replyencrypt | |
12959 | @vindex gnus-message-replysignencrypted | |
12960 | Often, you would like to sign replies to people who send you signed | |
12961 | messages. Even more often, you might want to encrypt messages which | |
12962 | are in reply to encrypted messages. Gnus offers | |
12963 | @code{gnus-message-replysign} to enable the former, and | |
12964 | @code{gnus-message-replyencrypt} for the latter. In addition, setting | |
12965 | @code{gnus-message-replysignencrypted} (on by default) will sign | |
12966 | automatically encrypted messages. | |
4009494e | 12967 | |
8a1cdce5 AC |
12968 | Instructing @acronym{MML} to perform security operations on a |
12969 | @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for | |
12970 | signing and the @kbd{C-c C-m c} key map for encryption, as follows. | |
4009494e | 12971 | |
8a1cdce5 | 12972 | @table @kbd |
4009494e | 12973 | |
8a1cdce5 AC |
12974 | @item C-c C-m s s |
12975 | @kindex C-c C-m s s (Message) | |
12976 | @findex mml-secure-message-sign-smime | |
71e691a5 | 12977 | |
8a1cdce5 | 12978 | Digitally sign current message using @acronym{S/MIME}. |
4009494e | 12979 | |
8a1cdce5 AC |
12980 | @item C-c C-m s o |
12981 | @kindex C-c C-m s o (Message) | |
12982 | @findex mml-secure-message-sign-pgp | |
4009494e | 12983 | |
8a1cdce5 | 12984 | Digitally sign current message using @acronym{PGP}. |
4009494e | 12985 | |
8a1cdce5 AC |
12986 | @item C-c C-m s p |
12987 | @kindex C-c C-m s p (Message) | |
12988 | @findex mml-secure-message-sign-pgp | |
4009494e | 12989 | |
8a1cdce5 | 12990 | Digitally sign current message using @acronym{PGP/MIME}. |
4009494e | 12991 | |
8a1cdce5 AC |
12992 | @item C-c C-m c s |
12993 | @kindex C-c C-m c s (Message) | |
12994 | @findex mml-secure-message-encrypt-smime | |
4009494e | 12995 | |
8a1cdce5 | 12996 | Digitally encrypt current message using @acronym{S/MIME}. |
4009494e | 12997 | |
8a1cdce5 AC |
12998 | @item C-c C-m c o |
12999 | @kindex C-c C-m c o (Message) | |
13000 | @findex mml-secure-message-encrypt-pgp | |
4009494e | 13001 | |
8a1cdce5 | 13002 | Digitally encrypt current message using @acronym{PGP}. |
4009494e | 13003 | |
8a1cdce5 AC |
13004 | @item C-c C-m c p |
13005 | @kindex C-c C-m c p (Message) | |
13006 | @findex mml-secure-message-encrypt-pgpmime | |
4009494e | 13007 | |
8a1cdce5 | 13008 | Digitally encrypt current message using @acronym{PGP/MIME}. |
4009494e | 13009 | |
8a1cdce5 AC |
13010 | @item C-c C-m C-n |
13011 | @kindex C-c C-m C-n (Message) | |
13012 | @findex mml-unsecure-message | |
13013 | Remove security related @acronym{MML} tags from message. | |
4009494e | 13014 | |
8a1cdce5 | 13015 | @end table |
4009494e | 13016 | |
8a1cdce5 | 13017 | @xref{Security, ,Security, message, Message Manual}, for more information. |
4009494e | 13018 | |
8a1cdce5 AC |
13019 | @node Select Methods |
13020 | @chapter Select Methods | |
13021 | @cindex foreign groups | |
13022 | @cindex select methods | |
4009494e | 13023 | |
8a1cdce5 AC |
13024 | A @dfn{foreign group} is a group not read by the usual (or |
13025 | default) means. It could be, for instance, a group from a different | |
13026 | @acronym{NNTP} server, it could be a virtual group, or it could be your own | |
13027 | personal mail group. | |
4009494e | 13028 | |
8a1cdce5 AC |
13029 | A foreign group (or any group, really) is specified by a @dfn{name} and |
13030 | a @dfn{select method}. To take the latter first, a select method is a | |
1df7defd | 13031 | list where the first element says what back end to use (e.g., @code{nntp}, |
8a1cdce5 AC |
13032 | @code{nnspool}, @code{nnml}) and the second element is the @dfn{server |
13033 | name}. There may be additional elements in the select method, where the | |
13034 | value may have special meaning for the back end in question. | |
4009494e | 13035 | |
8a1cdce5 AC |
13036 | One could say that a select method defines a @dfn{virtual server}---so |
13037 | we do just that (@pxref{Server Buffer}). | |
4009494e | 13038 | |
8a1cdce5 AC |
13039 | The @dfn{name} of the group is the name the back end will recognize the |
13040 | group as. | |
4009494e | 13041 | |
8a1cdce5 AC |
13042 | For instance, the group @samp{soc.motss} on the @acronym{NNTP} server |
13043 | @samp{some.where.edu} will have the name @samp{soc.motss} and select | |
13044 | method @code{(nntp "some.where.edu")}. Gnus will call this group | |
13045 | @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp} | |
13046 | back end just knows this group as @samp{soc.motss}. | |
4009494e | 13047 | |
8a1cdce5 | 13048 | The different methods all have their peculiarities, of course. |
4009494e | 13049 | |
8a1cdce5 AC |
13050 | @menu |
13051 | * Server Buffer:: Making and editing virtual servers. | |
13052 | * Getting News:: Reading USENET news with Gnus. | |
13053 | * Using IMAP:: Reading mail from @acronym{IMAP}. | |
13054 | * Getting Mail:: Reading your personal mail with Gnus. | |
13055 | * Browsing the Web:: Getting messages from a plethora of Web sources. | |
13056 | * Other Sources:: Reading directories, files. | |
13057 | * Combined Groups:: Combining groups into one group. | |
13058 | * Email Based Diary:: Using mails to manage diary events in Gnus. | |
13059 | * Gnus Unplugged:: Reading news and mail offline. | |
13060 | @end menu | |
4009494e | 13061 | |
239661c0 | 13062 | |
8a1cdce5 AC |
13063 | @node Server Buffer |
13064 | @section Server Buffer | |
13065 | ||
13066 | Traditionally, a @dfn{server} is a machine or a piece of software that | |
13067 | one connects to, and then requests information from. Gnus does not | |
13068 | connect directly to any real servers, but does all transactions through | |
13069 | one back end or other. But that's just putting one layer more between | |
13070 | the actual media and Gnus, so we might just as well say that each | |
13071 | back end represents a virtual server. | |
4009494e | 13072 | |
8a1cdce5 AC |
13073 | For instance, the @code{nntp} back end may be used to connect to several |
13074 | different actual @acronym{NNTP} servers, or, perhaps, to many different ports | |
13075 | on the same actual @acronym{NNTP} server. You tell Gnus which back end to | |
13076 | use, and what parameters to set by specifying a @dfn{select method}. | |
4009494e | 13077 | |
8a1cdce5 AC |
13078 | These select method specifications can sometimes become quite |
13079 | complicated---say, for instance, that you want to read from the | |
13080 | @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which | |
13081 | hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem. | |
13082 | Anyway, if you had to specify that for each group that used this | |
13083 | server, that would be too much work, so Gnus offers a way of naming | |
13084 | select methods, which is what you do in the server buffer. | |
4009494e | 13085 | |
8a1cdce5 AC |
13086 | To enter the server buffer, use the @kbd{^} |
13087 | (@code{gnus-group-enter-server-mode}) command in the group buffer. | |
4009494e GM |
13088 | |
13089 | @menu | |
8a1cdce5 AC |
13090 | * Server Buffer Format:: You can customize the look of this buffer. |
13091 | * Server Commands:: Commands to manipulate servers. | |
13092 | * Example Methods:: Examples server specifications. | |
13093 | * Creating a Virtual Server:: An example session. | |
13094 | * Server Variables:: Which variables to set. | |
13095 | * Servers and Methods:: You can use server names as select methods. | |
13096 | * Unavailable Servers:: Some servers you try to contact may be down. | |
4009494e GM |
13097 | @end menu |
13098 | ||
8a1cdce5 AC |
13099 | @vindex gnus-server-mode-hook |
13100 | @code{gnus-server-mode-hook} is run when creating the server buffer. | |
13101 | ||
13102 | ||
13103 | @node Server Buffer Format | |
13104 | @subsection Server Buffer Format | |
13105 | @cindex server buffer format | |
13106 | ||
13107 | @vindex gnus-server-line-format | |
13108 | You can change the look of the server buffer lines by changing the | |
13109 | @code{gnus-server-line-format} variable. This is a @code{format}-like | |
13110 | variable, with some simple extensions: | |
4009494e | 13111 | |
8a1cdce5 | 13112 | @table @samp |
4009494e | 13113 | |
8a1cdce5 AC |
13114 | @item h |
13115 | How the news is fetched---the back end name. | |
4009494e | 13116 | |
8a1cdce5 AC |
13117 | @item n |
13118 | The name of this server. | |
4009494e | 13119 | |
8a1cdce5 AC |
13120 | @item w |
13121 | Where the news is to be fetched from---the address. | |
4009494e | 13122 | |
8a1cdce5 AC |
13123 | @item s |
13124 | The opened/closed/denied status of the server. | |
4009494e | 13125 | |
8a1cdce5 AC |
13126 | @item a |
13127 | Whether this server is agentized. | |
13128 | @end table | |
4009494e | 13129 | |
8a1cdce5 AC |
13130 | @vindex gnus-server-mode-line-format |
13131 | The mode line can also be customized by using the | |
13132 | @code{gnus-server-mode-line-format} variable (@pxref{Mode Line | |
13133 | Formatting}). The following specs are understood: | |
4009494e | 13134 | |
8a1cdce5 AC |
13135 | @table @samp |
13136 | @item S | |
13137 | Server name. | |
4009494e | 13138 | |
8a1cdce5 AC |
13139 | @item M |
13140 | Server method. | |
4009494e GM |
13141 | @end table |
13142 | ||
8a1cdce5 | 13143 | Also @pxref{Formatting Variables}. |
4009494e | 13144 | |
4009494e | 13145 | |
8a1cdce5 AC |
13146 | @node Server Commands |
13147 | @subsection Server Commands | |
13148 | @cindex server commands | |
4009494e | 13149 | |
8a1cdce5 | 13150 | @table @kbd |
4009494e | 13151 | |
8a1cdce5 AC |
13152 | @item v |
13153 | @kindex v (Server) | |
13154 | @cindex keys, reserved for users (Server) | |
13155 | The key @kbd{v} is reserved for users. You can bind it to some | |
13156 | command or better use it as a prefix key. | |
4009494e | 13157 | |
8a1cdce5 AC |
13158 | @item a |
13159 | @kindex a (Server) | |
13160 | @findex gnus-server-add-server | |
13161 | Add a new server (@code{gnus-server-add-server}). | |
4009494e | 13162 | |
8a1cdce5 AC |
13163 | @item e |
13164 | @kindex e (Server) | |
13165 | @findex gnus-server-edit-server | |
13166 | Edit a server (@code{gnus-server-edit-server}). | |
4009494e | 13167 | |
8a1cdce5 AC |
13168 | @item S |
13169 | @kindex S (Server) | |
13170 | @findex gnus-server-show-server | |
13171 | Show the definition of a server (@code{gnus-server-show-server}). | |
4009494e | 13172 | |
8a1cdce5 AC |
13173 | @item SPACE |
13174 | @kindex SPACE (Server) | |
13175 | @findex gnus-server-read-server | |
13176 | Browse the current server (@code{gnus-server-read-server}). | |
4009494e | 13177 | |
8a1cdce5 AC |
13178 | @item q |
13179 | @kindex q (Server) | |
13180 | @findex gnus-server-exit | |
13181 | Return to the group buffer (@code{gnus-server-exit}). | |
4009494e | 13182 | |
8a1cdce5 AC |
13183 | @item k |
13184 | @kindex k (Server) | |
13185 | @findex gnus-server-kill-server | |
13186 | Kill the current server (@code{gnus-server-kill-server}). | |
4009494e | 13187 | |
8a1cdce5 AC |
13188 | @item y |
13189 | @kindex y (Server) | |
13190 | @findex gnus-server-yank-server | |
13191 | Yank the previously killed server (@code{gnus-server-yank-server}). | |
4009494e | 13192 | |
8a1cdce5 AC |
13193 | @item c |
13194 | @kindex c (Server) | |
13195 | @findex gnus-server-copy-server | |
13196 | Copy the current server (@code{gnus-server-copy-server}). | |
4009494e | 13197 | |
8a1cdce5 AC |
13198 | @item l |
13199 | @kindex l (Server) | |
13200 | @findex gnus-server-list-servers | |
13201 | List all servers (@code{gnus-server-list-servers}). | |
4009494e | 13202 | |
8a1cdce5 AC |
13203 | @item s |
13204 | @kindex s (Server) | |
13205 | @findex gnus-server-scan-server | |
13206 | Request that the server scan its sources for new articles | |
13207 | (@code{gnus-server-scan-server}). This is mainly sensible with mail | |
13208 | servers. | |
4009494e | 13209 | |
8a1cdce5 AC |
13210 | @item g |
13211 | @kindex g (Server) | |
13212 | @findex gnus-server-regenerate-server | |
13213 | Request that the server regenerate all its data structures | |
13214 | (@code{gnus-server-regenerate-server}). This can be useful if you have | |
13215 | a mail back end that has gotten out of sync. | |
4009494e | 13216 | |
8a1cdce5 AC |
13217 | @item z |
13218 | @kindex z (Server) | |
13219 | @findex gnus-server-compact-server | |
4009494e | 13220 | |
8a1cdce5 AC |
13221 | Compact all groups in the server under point |
13222 | (@code{gnus-server-compact-server}). Currently implemented only in | |
13223 | nnml (@pxref{Mail Spool}). This removes gaps between article numbers, | |
13224 | hence getting a correct total article count. | |
13225 | ||
13226 | @end table | |
13227 | ||
13228 | Some more commands for closing, disabling, and re-opening servers are | |
13229 | listed in @ref{Unavailable Servers}. | |
4009494e | 13230 | |
8a1cdce5 AC |
13231 | |
13232 | @node Example Methods | |
13233 | @subsection Example Methods | |
13234 | ||
13235 | Most select methods are pretty simple and self-explanatory: | |
4009494e GM |
13236 | |
13237 | @lisp | |
8a1cdce5 | 13238 | (nntp "news.funet.fi") |
4009494e GM |
13239 | @end lisp |
13240 | ||
8a1cdce5 | 13241 | Reading directly from the spool is even simpler: |
4009494e | 13242 | |
8a1cdce5 AC |
13243 | @lisp |
13244 | (nnspool "") | |
13245 | @end lisp | |
4009494e | 13246 | |
8a1cdce5 AC |
13247 | As you can see, the first element in a select method is the name of the |
13248 | back end, and the second is the @dfn{address}, or @dfn{name}, if you | |
13249 | will. | |
4009494e | 13250 | |
8a1cdce5 AC |
13251 | After these two elements, there may be an arbitrary number of |
13252 | @code{(@var{variable} @var{form})} pairs. | |
4009494e | 13253 | |
8a1cdce5 AC |
13254 | To go back to the first example---imagine that you want to read from |
13255 | port 15 on that machine. This is what the select method should | |
13256 | look like then: | |
4009494e | 13257 | |
8a1cdce5 AC |
13258 | @lisp |
13259 | (nntp "news.funet.fi" (nntp-port-number 15)) | |
13260 | @end lisp | |
4009494e | 13261 | |
8a1cdce5 AC |
13262 | You should read the documentation to each back end to find out what |
13263 | variables are relevant, but here's an @code{nnmh} example: | |
4009494e | 13264 | |
8a1cdce5 AC |
13265 | @code{nnmh} is a mail back end that reads a spool-like structure. Say |
13266 | you have two structures that you wish to access: One is your private | |
13267 | mail spool, and the other is a public one. Here's the possible spec for | |
13268 | your private mail: | |
4009494e | 13269 | |
4009494e | 13270 | @lisp |
8a1cdce5 | 13271 | (nnmh "private" (nnmh-directory "~/private/mail/")) |
4009494e GM |
13272 | @end lisp |
13273 | ||
8a1cdce5 AC |
13274 | (This server is then called @samp{private}, but you may have guessed |
13275 | that.) | |
13276 | ||
13277 | Here's the method for a public spool: | |
4009494e GM |
13278 | |
13279 | @lisp | |
8a1cdce5 AC |
13280 | (nnmh "public" |
13281 | (nnmh-directory "/usr/information/spool/") | |
13282 | (nnmh-get-new-mail nil)) | |
4009494e GM |
13283 | @end lisp |
13284 | ||
8a1cdce5 AC |
13285 | @cindex proxy |
13286 | @cindex firewall | |
4009494e | 13287 | |
8a1cdce5 AC |
13288 | If you are behind a firewall and only have access to the @acronym{NNTP} |
13289 | server from the firewall machine, you can instruct Gnus to @code{rlogin} | |
13290 | on the firewall machine and connect with | |
13291 | @uref{http://netcat.sourceforge.net/, netcat} from there to the | |
13292 | @acronym{NNTP} server. | |
13293 | Doing this can be rather fiddly, but your virtual server definition | |
13294 | should probably look something like this: | |
4009494e | 13295 | |
8a1cdce5 AC |
13296 | @lisp |
13297 | (nntp "firewall" | |
13298 | (nntp-open-connection-function nntp-open-via-rlogin-and-netcat) | |
13299 | (nntp-via-address "the.firewall.machine") | |
13300 | (nntp-address "the.real.nntp.host")) | |
13301 | @end lisp | |
4009494e | 13302 | |
8a1cdce5 AC |
13303 | If you want to use the wonderful @code{ssh} program to provide a |
13304 | compressed connection over the modem line, you could add the following | |
13305 | configuration to the example above: | |
4009494e | 13306 | |
8a1cdce5 AC |
13307 | @lisp |
13308 | (nntp-via-rlogin-command "ssh") | |
13309 | @end lisp | |
4009494e | 13310 | |
8a1cdce5 AC |
13311 | See also @code{nntp-via-rlogin-command-switches}. Here's an example for |
13312 | an indirect connection: | |
4009494e GM |
13313 | |
13314 | @lisp | |
8a1cdce5 AC |
13315 | (setq gnus-select-method |
13316 | '(nntp "indirect" | |
13317 | (nntp-address "news.server.example") | |
13318 | (nntp-via-user-name "intermediate_user_name") | |
13319 | (nntp-via-address "intermediate.host.example") | |
13320 | (nntp-via-rlogin-command "ssh") | |
13321 | (nntp-via-rlogin-command-switches ("-C")) | |
13322 | (nntp-open-connection-function nntp-open-via-rlogin-and-netcat))) | |
4009494e GM |
13323 | @end lisp |
13324 | ||
8a1cdce5 AC |
13325 | This means that you have to have set up @code{ssh-agent} correctly to |
13326 | provide automatic authorization, of course. | |
01c52d31 | 13327 | |
8a1cdce5 AC |
13328 | If you're behind a firewall, but have direct access to the outside world |
13329 | through a wrapper command like "runsocks", you could open a socksified | |
13330 | netcat connection to the news server as follows: | |
4009494e GM |
13331 | |
13332 | @lisp | |
8a1cdce5 AC |
13333 | (nntp "outside" |
13334 | (nntp-pre-command "runsocks") | |
13335 | (nntp-open-connection-function nntp-open-netcat-stream) | |
13336 | (nntp-address "the.news.server")) | |
4009494e GM |
13337 | @end lisp |
13338 | ||
4009494e | 13339 | |
8a1cdce5 AC |
13340 | @node Creating a Virtual Server |
13341 | @subsection Creating a Virtual Server | |
4009494e | 13342 | |
8a1cdce5 AC |
13343 | If you're saving lots of articles in the cache by using persistent |
13344 | articles, you may want to create a virtual server to read the cache. | |
4009494e | 13345 | |
8a1cdce5 AC |
13346 | First you need to add a new server. The @kbd{a} command does that. It |
13347 | would probably be best to use @code{nnml} to read the cache. You | |
13348 | could also use @code{nnspool} or @code{nnmh}, though. | |
4009494e | 13349 | |
8a1cdce5 | 13350 | Type @kbd{a nnml RET cache RET}. |
4009494e | 13351 | |
8a1cdce5 AC |
13352 | You should now have a brand new @code{nnml} virtual server called |
13353 | @samp{cache}. You now need to edit it to have the right definitions. | |
13354 | Type @kbd{e} to edit the server. You'll be entered into a buffer that | |
13355 | will contain the following: | |
4009494e | 13356 | |
4009494e | 13357 | @lisp |
8a1cdce5 | 13358 | (nnml "cache") |
4009494e GM |
13359 | @end lisp |
13360 | ||
8a1cdce5 | 13361 | Change that to: |
4009494e | 13362 | |
4009494e | 13363 | @lisp |
8a1cdce5 AC |
13364 | (nnml "cache" |
13365 | (nnml-directory "~/News/cache/") | |
13366 | (nnml-active-file "~/News/cache/active")) | |
4009494e GM |
13367 | @end lisp |
13368 | ||
8a1cdce5 AC |
13369 | Type @kbd{C-c C-c} to return to the server buffer. If you now press |
13370 | @kbd{RET} over this virtual server, you should be entered into a browse | |
13371 | buffer, and you should be able to enter any of the groups displayed. | |
4009494e | 13372 | |
8a1cdce5 AC |
13373 | |
13374 | @node Server Variables | |
13375 | @subsection Server Variables | |
13376 | @cindex server variables | |
13377 | @cindex server parameters | |
13378 | ||
13379 | One sticky point when defining variables (both on back ends and in Emacs | |
13380 | in general) is that some variables are typically initialized from other | |
13381 | variables when the definition of the variables is being loaded. If you | |
13382 | change the ``base'' variable after the variables have been loaded, you | |
13383 | won't change the ``derived'' variables. | |
13384 | ||
13385 | This typically affects directory and file variables. For instance, | |
13386 | @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml} | |
13387 | directory variables are initialized from that variable, so | |
13388 | @code{nnml-active-file} will be @file{~/Mail/active}. If you define a | |
13389 | new virtual @code{nnml} server, it will @emph{not} suffice to set just | |
13390 | @code{nnml-directory}---you have to explicitly set all the file | |
13391 | variables to be what you want them to be. For a complete list of | |
13392 | variables for each back end, see each back end's section later in this | |
13393 | manual, but here's an example @code{nnml} definition: | |
4009494e GM |
13394 | |
13395 | @lisp | |
8a1cdce5 AC |
13396 | (nnml "public" |
13397 | (nnml-directory "~/my-mail/") | |
13398 | (nnml-active-file "~/my-mail/active") | |
13399 | (nnml-newsgroups-file "~/my-mail/newsgroups")) | |
4009494e GM |
13400 | @end lisp |
13401 | ||
8a1cdce5 | 13402 | Server variables are often called @dfn{server parameters}. |
4009494e | 13403 | |
8a1cdce5 AC |
13404 | @node Servers and Methods |
13405 | @subsection Servers and Methods | |
4009494e | 13406 | |
8a1cdce5 | 13407 | Wherever you would normally use a select method |
1df7defd | 13408 | (e.g., @code{gnus-secondary-select-method}, in the group select method, |
8a1cdce5 AC |
13409 | when browsing a foreign server) you can use a virtual server name |
13410 | instead. This could potentially save lots of typing. And it's nice all | |
13411 | over. | |
13412 | ||
13413 | ||
13414 | @node Unavailable Servers | |
13415 | @subsection Unavailable Servers | |
13416 | ||
13417 | If a server seems to be unreachable, Gnus will mark that server as | |
13418 | @code{denied}. That means that any subsequent attempt to make contact | |
13419 | with that server will just be ignored. ``It can't be opened,'' Gnus | |
13420 | will tell you, without making the least effort to see whether that is | |
13421 | actually the case or not. | |
13422 | ||
13423 | That might seem quite naughty, but it does make sense most of the time. | |
13424 | Let's say you have 10 groups subscribed to on server | |
13425 | @samp{nephelococcygia.com}. This server is located somewhere quite far | |
13426 | away from you and the machine is quite slow, so it takes 1 minute just | |
13427 | to find out that it refuses connection to you today. If Gnus were to | |
13428 | attempt to do that 10 times, you'd be quite annoyed, so Gnus won't | |
13429 | attempt to do that. Once it has gotten a single ``connection refused'', | |
13430 | it will regard that server as ``down''. | |
13431 | ||
13432 | So, what happens if the machine was only feeling unwell temporarily? | |
13433 | How do you test to see whether the machine has come up again? | |
13434 | ||
13435 | You jump to the server buffer (@pxref{Server Buffer}) and poke it | |
13436 | with the following commands: | |
4009494e | 13437 | |
8a1cdce5 | 13438 | @table @kbd |
4009494e | 13439 | |
8a1cdce5 AC |
13440 | @item O |
13441 | @kindex O (Server) | |
13442 | @findex gnus-server-open-server | |
13443 | Try to establish connection to the server on the current line | |
13444 | (@code{gnus-server-open-server}). | |
4009494e | 13445 | |
8a1cdce5 AC |
13446 | @item C |
13447 | @kindex C (Server) | |
13448 | @findex gnus-server-close-server | |
13449 | Close the connection (if any) to the server | |
13450 | (@code{gnus-server-close-server}). | |
4009494e | 13451 | |
8a1cdce5 AC |
13452 | @item D |
13453 | @kindex D (Server) | |
13454 | @findex gnus-server-deny-server | |
13455 | Mark the current server as unreachable | |
13456 | (@code{gnus-server-deny-server}). | |
4009494e | 13457 | |
8a1cdce5 AC |
13458 | @item M-o |
13459 | @kindex M-o (Server) | |
13460 | @findex gnus-server-open-all-servers | |
13461 | Open the connections to all servers in the buffer | |
13462 | (@code{gnus-server-open-all-servers}). | |
4009494e | 13463 | |
8a1cdce5 AC |
13464 | @item M-c |
13465 | @kindex M-c (Server) | |
13466 | @findex gnus-server-close-all-servers | |
13467 | Close the connections to all servers in the buffer | |
13468 | (@code{gnus-server-close-all-servers}). | |
4009494e | 13469 | |
8a1cdce5 AC |
13470 | @item R |
13471 | @kindex R (Server) | |
13472 | @findex gnus-server-remove-denials | |
13473 | Remove all marks to whether Gnus was denied connection from any servers | |
13474 | (@code{gnus-server-remove-denials}). | |
4009494e | 13475 | |
8a1cdce5 AC |
13476 | @item c |
13477 | @kindex c (Server) | |
13478 | @findex gnus-server-copy-server | |
13479 | Copy a server and give it a new name | |
13480 | (@code{gnus-server-copy-server}). This can be useful if you have a | |
13481 | complex method definition, and want to use the same definition towards | |
13482 | a different (physical) server. | |
4009494e | 13483 | |
8a1cdce5 AC |
13484 | @item L |
13485 | @kindex L (Server) | |
13486 | @findex gnus-server-offline-server | |
13487 | Set server status to offline (@code{gnus-server-offline-server}). | |
4009494e | 13488 | |
8a1cdce5 | 13489 | @end table |
4009494e | 13490 | |
4009494e | 13491 | |
8a1cdce5 AC |
13492 | @node Getting News |
13493 | @section Getting News | |
13494 | @cindex reading news | |
13495 | @cindex news back ends | |
4009494e | 13496 | |
8a1cdce5 AC |
13497 | A newsreader is normally used for reading news. Gnus currently provides |
13498 | only two methods of getting news---it can read from an @acronym{NNTP} server, | |
13499 | or it can read from a local spool. | |
4009494e | 13500 | |
8a1cdce5 AC |
13501 | @menu |
13502 | * NNTP:: Reading news from an @acronym{NNTP} server. | |
13503 | * News Spool:: Reading news from the local spool. | |
13504 | @end menu | |
01c52d31 | 13505 | |
4009494e | 13506 | |
8a1cdce5 AC |
13507 | @node NNTP |
13508 | @subsection NNTP | |
13509 | @cindex nntp | |
389b76fa | 13510 | |
8a1cdce5 AC |
13511 | Subscribing to a foreign group from an @acronym{NNTP} server is rather easy. |
13512 | You just specify @code{nntp} as method and the address of the @acronym{NNTP} | |
13513 | server as the, uhm, address. | |
4009494e | 13514 | |
8a1cdce5 AC |
13515 | If the @acronym{NNTP} server is located at a non-standard port, setting the |
13516 | third element of the select method to this port number should allow you | |
13517 | to connect to the right port. You'll have to edit the group info for | |
13518 | that (@pxref{Foreign Groups}). | |
4009494e | 13519 | |
8a1cdce5 AC |
13520 | The name of the foreign group can be the same as a native group. In |
13521 | fact, you can subscribe to the same group from as many different servers | |
13522 | you feel like. There will be no name collisions. | |
4009494e | 13523 | |
8a1cdce5 AC |
13524 | The following variables can be used to create a virtual @code{nntp} |
13525 | server: | |
4009494e | 13526 | |
8a1cdce5 | 13527 | @table @code |
4009494e | 13528 | |
8a1cdce5 AC |
13529 | @item nntp-server-opened-hook |
13530 | @vindex nntp-server-opened-hook | |
13531 | @cindex @sc{mode reader} | |
13532 | @cindex authinfo | |
13533 | @cindex authentication | |
13534 | @cindex nntp authentication | |
13535 | @findex nntp-send-authinfo | |
13536 | @findex nntp-send-mode-reader | |
13537 | is run after a connection has been made. It can be used to send | |
13538 | commands to the @acronym{NNTP} server after it has been contacted. By | |
13539 | default it sends the command @code{MODE READER} to the server with the | |
13540 | @code{nntp-send-mode-reader} function. This function should always be | |
13541 | present in this hook. | |
4009494e | 13542 | |
8a1cdce5 AC |
13543 | @item nntp-authinfo-function |
13544 | @vindex nntp-authinfo-function | |
13545 | @findex nntp-send-authinfo | |
13546 | @vindex nntp-authinfo-file | |
13547 | This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP} | |
13548 | server. The default function is @code{nntp-send-authinfo}, which looks | |
13549 | through your @file{~/.authinfo} (or whatever you've set the | |
13550 | @code{nntp-authinfo-file} variable to) for applicable entries. If none | |
13551 | are found, it will prompt you for a login name and a password. The | |
13552 | format of the @file{~/.authinfo} file is (almost) the same as the | |
13553 | @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp} | |
13554 | manual page, but here are the salient facts: | |
4009494e | 13555 | |
8a1cdce5 AC |
13556 | @enumerate |
13557 | @item | |
13558 | The file contains one or more line, each of which define one server. | |
4009494e | 13559 | |
8a1cdce5 AC |
13560 | @item |
13561 | Each line may contain an arbitrary number of token/value pairs. | |
4009494e | 13562 | |
8a1cdce5 AC |
13563 | The valid tokens include @samp{machine}, @samp{login}, @samp{password}, |
13564 | @samp{default}. In addition Gnus introduces two new tokens, not present | |
13565 | in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and | |
13566 | @samp{force}. (This is the only way the @file{.authinfo} file format | |
13567 | deviates from the @file{.netrc} file format.) @samp{port} is used to | |
13568 | indicate what port on the server the credentials apply to and | |
13569 | @samp{force} is explained below. | |
4009494e | 13570 | |
8a1cdce5 | 13571 | @end enumerate |
4009494e | 13572 | |
8a1cdce5 | 13573 | Here's an example file: |
4009494e | 13574 | |
8a1cdce5 AC |
13575 | @example |
13576 | machine news.uio.no login larsi password geheimnis | |
13577 | machine nntp.ifi.uio.no login larsi force yes | |
13578 | @end example | |
4009494e | 13579 | |
8a1cdce5 AC |
13580 | The token/value pairs may appear in any order; @samp{machine} doesn't |
13581 | have to be first, for instance. | |
4009494e | 13582 | |
8a1cdce5 AC |
13583 | In this example, both login name and password have been supplied for the |
13584 | former server, while the latter has only the login name listed, and the | |
13585 | user will be prompted for the password. The latter also has the | |
13586 | @samp{force} tag, which means that the authinfo will be sent to the | |
13587 | @var{nntp} server upon connection; the default (i.e., when there is not | |
13588 | @samp{force} tag) is to not send authinfo to the @var{nntp} server | |
13589 | until the @var{nntp} server asks for it. | |
4009494e | 13590 | |
8a1cdce5 AC |
13591 | You can also add @samp{default} lines that will apply to all servers |
13592 | that don't have matching @samp{machine} lines. | |
4009494e | 13593 | |
8a1cdce5 AC |
13594 | @example |
13595 | default force yes | |
13596 | @end example | |
4009494e | 13597 | |
8a1cdce5 AC |
13598 | This will force sending @samp{AUTHINFO} commands to all servers not |
13599 | previously mentioned. | |
598451ed | 13600 | |
8a1cdce5 | 13601 | Remember to not leave the @file{~/.authinfo} file world-readable. |
4009494e | 13602 | |
8a1cdce5 AC |
13603 | @item nntp-server-action-alist |
13604 | @vindex nntp-server-action-alist | |
13605 | This is a list of regexps to match on server types and actions to be | |
13606 | taken when matches are made. For instance, if you want Gnus to beep | |
13607 | every time you connect to innd, you could say something like: | |
4009494e | 13608 | |
8a1cdce5 AC |
13609 | @lisp |
13610 | (setq nntp-server-action-alist | |
13611 | '(("innd" (ding)))) | |
13612 | @end lisp | |
4009494e | 13613 | |
8a1cdce5 | 13614 | You probably don't want to do that, though. |
4009494e | 13615 | |
8a1cdce5 | 13616 | The default value is |
4009494e | 13617 | |
8a1cdce5 AC |
13618 | @lisp |
13619 | '(("nntpd 1\\.5\\.11t" | |
13620 | (remove-hook 'nntp-server-opened-hook | |
13621 | 'nntp-send-mode-reader))) | |
13622 | @end lisp | |
4009494e | 13623 | |
8a1cdce5 AC |
13624 | This ensures that Gnus doesn't send the @code{MODE READER} command to |
13625 | nntpd 1.5.11t, since that command chokes that server, I've been told. | |
4009494e | 13626 | |
8a1cdce5 AC |
13627 | @item nntp-maximum-request |
13628 | @vindex nntp-maximum-request | |
13629 | If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end | |
13630 | will collect headers by sending a series of @code{head} commands. To | |
13631 | speed things up, the back end sends lots of these commands without | |
13632 | waiting for reply, and then reads all the replies. This is controlled | |
13633 | by the @code{nntp-maximum-request} variable, and is 400 by default. If | |
13634 | your network is buggy, you should set this to 1. | |
4009494e | 13635 | |
8a1cdce5 AC |
13636 | @item nntp-connection-timeout |
13637 | @vindex nntp-connection-timeout | |
13638 | If you have lots of foreign @code{nntp} groups that you connect to | |
13639 | regularly, you're sure to have problems with @acronym{NNTP} servers not | |
13640 | responding properly, or being too loaded to reply within reasonable | |
13641 | time. This is can lead to awkward problems, which can be helped | |
13642 | somewhat by setting @code{nntp-connection-timeout}. This is an integer | |
13643 | that says how many seconds the @code{nntp} back end should wait for a | |
13644 | connection before giving up. If it is @code{nil}, which is the default, | |
13645 | no timeouts are done. | |
4009494e | 13646 | |
8a1cdce5 AC |
13647 | @item nntp-nov-is-evil |
13648 | @vindex nntp-nov-is-evil | |
13649 | If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this | |
13650 | variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV} | |
13651 | can be used. | |
4009494e | 13652 | |
8a1cdce5 AC |
13653 | @item nntp-xover-commands |
13654 | @vindex nntp-xover-commands | |
13655 | @cindex @acronym{NOV} | |
13656 | @cindex XOVER | |
13657 | List of strings used as commands to fetch @acronym{NOV} lines from a | |
13658 | server. The default value of this variable is @code{("XOVER" | |
13659 | "XOVERVIEW")}. | |
4009494e | 13660 | |
8a1cdce5 AC |
13661 | @item nntp-nov-gap |
13662 | @vindex nntp-nov-gap | |
13663 | @code{nntp} normally sends just one big request for @acronym{NOV} lines to | |
13664 | the server. The server responds with one huge list of lines. However, | |
13665 | if you have read articles 2-5000 in the group, and only want to read | |
13666 | article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV} | |
13667 | lines that you will not need. This variable says how | |
13668 | big a gap between two consecutive articles is allowed to be before the | |
13669 | @code{XOVER} request is split into several request. Note that if your | |
13670 | network is fast, setting this variable to a really small number means | |
13671 | that fetching will probably be slower. If this variable is @code{nil}, | |
13672 | @code{nntp} will never split requests. The default is 5. | |
4009494e | 13673 | |
8a1cdce5 AC |
13674 | @item nntp-xref-number-is-evil |
13675 | @vindex nntp-xref-number-is-evil | |
13676 | When Gnus refers to an article having the @code{Message-ID} that a user | |
13677 | specifies or having the @code{Message-ID} of the parent article of the | |
13678 | current one (@pxref{Finding the Parent}), Gnus sends a @code{HEAD} | |
13679 | command to the @acronym{NNTP} server to know where it is, and the server | |
13680 | returns the data containing the pairs of a group and an article number | |
13681 | in the @code{Xref} header. Gnus normally uses the article number to | |
13682 | refer to the article if the data shows that that article is in the | |
13683 | current group, while it uses the @code{Message-ID} otherwise. However, | |
13684 | some news servers, e.g., ones running Diablo, run multiple engines | |
13685 | having the same articles but article numbers are not kept synchronized | |
13686 | between them. In that case, the article number that appears in the | |
13687 | @code{Xref} header varies by which engine is chosen, so you cannot refer | |
13688 | to the parent article that is in the current group, for instance. If | |
13689 | you connect to such a server, set this variable to a non-@code{nil} | |
13690 | value, and Gnus never uses article numbers. For example: | |
4009494e | 13691 | |
8a1cdce5 AC |
13692 | @lisp |
13693 | (setq gnus-select-method | |
13694 | '(nntp "newszilla" | |
13695 | (nntp-address "newszilla.example.com") | |
13696 | (nntp-xref-number-is-evil t) | |
13697 | @dots{})) | |
13698 | @end lisp | |
4009494e | 13699 | |
8a1cdce5 | 13700 | The default value of this server variable is @code{nil}. |
4009494e | 13701 | |
8a1cdce5 AC |
13702 | @item nntp-prepare-server-hook |
13703 | @vindex nntp-prepare-server-hook | |
13704 | A hook run before attempting to connect to an @acronym{NNTP} server. | |
4009494e | 13705 | |
8a1cdce5 AC |
13706 | @item nntp-record-commands |
13707 | @vindex nntp-record-commands | |
13708 | If non-@code{nil}, @code{nntp} will log all commands it sends to the | |
13709 | @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*} | |
13710 | buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection | |
13711 | that doesn't seem to work. | |
4009494e | 13712 | |
8a1cdce5 AC |
13713 | @item nntp-open-connection-function |
13714 | @vindex nntp-open-connection-function | |
13715 | It is possible to customize how the connection to the nntp server will | |
13716 | be opened. If you specify an @code{nntp-open-connection-function} | |
13717 | parameter, Gnus will use that function to establish the connection. | |
13718 | Seven pre-made functions are supplied. These functions can be grouped | |
13719 | in two categories: direct connection functions (four pre-made), and | |
13720 | indirect ones (three pre-made). | |
13721 | ||
13722 | @item nntp-never-echoes-commands | |
13723 | @vindex nntp-never-echoes-commands | |
13724 | Non-@code{nil} means the nntp server never echoes commands. It is | |
13725 | reported that some nntps server doesn't echo commands. So, you may want | |
13726 | to set this to non-@code{nil} in the method for such a server setting | |
13727 | @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for | |
13728 | example. The default value is @code{nil}. Note that the | |
13729 | @code{nntp-open-connection-functions-never-echo-commands} variable | |
13730 | overrides the @code{nil} value of this variable. | |
13731 | ||
13732 | @item nntp-open-connection-functions-never-echo-commands | |
13733 | @vindex nntp-open-connection-functions-never-echo-commands | |
13734 | List of functions that never echo commands. Add or set a function which | |
13735 | you set to @code{nntp-open-connection-function} to this list if it does | |
13736 | not echo commands. Note that a non-@code{nil} value of the | |
13737 | @code{nntp-never-echoes-commands} variable overrides this variable. The | |
13738 | default value is @code{(nntp-open-network-stream)}. | |
4009494e | 13739 | |
8a1cdce5 AC |
13740 | @item nntp-prepare-post-hook |
13741 | @vindex nntp-prepare-post-hook | |
13742 | A hook run just before posting an article. If there is no | |
13743 | @code{Message-ID} header in the article and the news server provides the | |
13744 | recommended ID, it will be added to the article before running this | |
13745 | hook. It is useful to make @code{Cancel-Lock} headers even if you | |
13746 | inhibit Gnus to add a @code{Message-ID} header, you could say: | |
4009494e | 13747 | |
8a1cdce5 AC |
13748 | @lisp |
13749 | (add-hook 'nntp-prepare-post-hook 'canlock-insert-header) | |
13750 | @end lisp | |
4009494e | 13751 | |
1df7defd | 13752 | Note that not all servers support the recommended ID@. This works for |
8a1cdce5 | 13753 | INN versions 2.3.0 and later, for instance. |
4009494e | 13754 | |
8a1cdce5 AC |
13755 | @item nntp-server-list-active-group |
13756 | If @code{nil}, then always use @samp{GROUP} instead of @samp{LIST | |
13757 | ACTIVE}. This is usually slower, but on misconfigured servers that | |
13758 | don't update their active files often, this can help. | |
4009494e | 13759 | |
4009494e GM |
13760 | |
13761 | @end table | |
13762 | ||
8a1cdce5 AC |
13763 | @menu |
13764 | * Direct Functions:: Connecting directly to the server. | |
13765 | * Indirect Functions:: Connecting indirectly to the server. | |
13766 | * Common Variables:: Understood by several connection functions. | |
8a1cdce5 | 13767 | @end menu |
4009494e | 13768 | |
4009494e | 13769 | |
8a1cdce5 AC |
13770 | @node Direct Functions |
13771 | @subsubsection Direct Functions | |
13772 | @cindex direct connection functions | |
4009494e | 13773 | |
8a1cdce5 AC |
13774 | These functions are called direct because they open a direct connection |
13775 | between your machine and the @acronym{NNTP} server. The behavior of these | |
13776 | functions is also affected by commonly understood variables | |
13777 | (@pxref{Common Variables}). | |
4009494e | 13778 | |
8a1cdce5 AC |
13779 | @table @code |
13780 | @findex nntp-open-network-stream | |
13781 | @item nntp-open-network-stream | |
13782 | This is the default, and simply connects to some port or other on the | |
13783 | remote system. If both Emacs and the server supports it, the | |
13784 | connection will be upgraded to an encrypted @acronym{STARTTLS} | |
13785 | connection automatically. | |
4009494e | 13786 | |
8a1cdce5 AC |
13787 | @item network-only |
13788 | The same as the above, but don't do automatic @acronym{STARTTLS} upgrades. | |
4009494e | 13789 | |
8a1cdce5 AC |
13790 | @findex nntp-open-tls-stream |
13791 | @item nntp-open-tls-stream | |
13792 | Opens a connection to a server over a @dfn{secure} channel. To use | |
321decc8 | 13793 | this you must have @uref{http://www.gnu.org/software/gnutls/, GnuTLS} |
8a1cdce5 | 13794 | installed. You then define a server as follows: |
4009494e | 13795 | |
8a1cdce5 AC |
13796 | @lisp |
13797 | ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}} | |
13798 | ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.} | |
13799 | ;; | |
13800 | (nntp "snews.bar.com" | |
13801 | (nntp-open-connection-function nntp-open-tls-stream) | |
13802 | (nntp-port-number 563) | |
13803 | (nntp-address "snews.bar.com")) | |
13804 | @end lisp | |
4009494e | 13805 | |
8a1cdce5 AC |
13806 | @findex nntp-open-ssl-stream |
13807 | @item nntp-open-ssl-stream | |
13808 | Opens a connection to a server over a @dfn{secure} channel. To use | |
13809 | this you must have @uref{http://www.openssl.org, OpenSSL} or | |
13810 | @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You | |
13811 | then define a server as follows: | |
4009494e | 13812 | |
8a1cdce5 AC |
13813 | @lisp |
13814 | ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}} | |
13815 | ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.} | |
13816 | ;; | |
13817 | (nntp "snews.bar.com" | |
13818 | (nntp-open-connection-function nntp-open-ssl-stream) | |
13819 | (nntp-port-number 563) | |
13820 | (nntp-address "snews.bar.com")) | |
13821 | @end lisp | |
4009494e | 13822 | |
8a1cdce5 AC |
13823 | @findex nntp-open-netcat-stream |
13824 | @item nntp-open-netcat-stream | |
13825 | Opens a connection to an @acronym{NNTP} server using the @code{netcat} | |
13826 | program. You might wonder why this function exists, since we have | |
13827 | the default @code{nntp-open-network-stream} which would do the job. (One | |
13828 | of) the reason(s) is that if you are behind a firewall but have direct | |
13829 | connections to the outside world thanks to a command wrapper like | |
13830 | @code{runsocks}, you can use it like this: | |
4009494e | 13831 | |
8a1cdce5 AC |
13832 | @lisp |
13833 | (nntp "socksified" | |
13834 | (nntp-pre-command "runsocks") | |
13835 | (nntp-open-connection-function nntp-open-netcat-stream) | |
13836 | (nntp-address "the.news.server")) | |
13837 | @end lisp | |
4009494e | 13838 | |
8a1cdce5 AC |
13839 | With the default method, you would need to wrap your whole Emacs |
13840 | session, which is not a good idea. | |
4009494e | 13841 | |
8a1cdce5 AC |
13842 | @findex nntp-open-telnet-stream |
13843 | @item nntp-open-telnet-stream | |
13844 | Like @code{nntp-open-netcat-stream}, but uses @code{telnet} rather than | |
13845 | @code{netcat}. @code{telnet} is a bit less robust because of things | |
13846 | like line-end-conversion, but sometimes netcat is simply | |
13847 | not available. The previous example would turn into: | |
4009494e | 13848 | |
8a1cdce5 AC |
13849 | @lisp |
13850 | (nntp "socksified" | |
13851 | (nntp-pre-command "runsocks") | |
13852 | (nntp-open-connection-function nntp-open-telnet-stream) | |
13853 | (nntp-address "the.news.server") | |
13854 | (nntp-end-of-line "\n")) | |
13855 | @end lisp | |
13856 | @end table | |
4009494e GM |
13857 | |
13858 | ||
8a1cdce5 AC |
13859 | @node Indirect Functions |
13860 | @subsubsection Indirect Functions | |
13861 | @cindex indirect connection functions | |
4009494e | 13862 | |
8a1cdce5 AC |
13863 | These functions are called indirect because they connect to an |
13864 | intermediate host before actually connecting to the @acronym{NNTP} server. | |
13865 | All of these functions and related variables are also said to belong to | |
13866 | the ``via'' family of connection: they're all prefixed with ``via'' to make | |
13867 | things cleaner. The behavior of these functions is also affected by | |
13868 | commonly understood variables (@pxref{Common Variables}). | |
4009494e | 13869 | |
8a1cdce5 AC |
13870 | @table @code |
13871 | @item nntp-open-via-rlogin-and-netcat | |
13872 | @findex nntp-open-via-rlogin-and-netcat | |
13873 | Does an @samp{rlogin} on a remote system, and then uses @code{netcat} to connect | |
13874 | to the real @acronym{NNTP} server from there. This is useful for instance if | |
13875 | you need to connect to a firewall machine first. | |
4009494e | 13876 | |
8a1cdce5 | 13877 | @code{nntp-open-via-rlogin-and-netcat}-specific variables: |
4009494e | 13878 | |
8a1cdce5 AC |
13879 | @table @code |
13880 | @item nntp-via-rlogin-command | |
13881 | @vindex nntp-via-rlogin-command | |
13882 | Command used to log in on the intermediate host. The default is | |
13883 | @samp{rsh}, but @samp{ssh} is a popular alternative. | |
4009494e | 13884 | |
8a1cdce5 AC |
13885 | @item nntp-via-rlogin-command-switches |
13886 | @vindex nntp-via-rlogin-command-switches | |
13887 | List of strings to be used as the switches to | |
13888 | @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use | |
13889 | @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to | |
13890 | @samp{("-C")} in order to compress all data connections. | |
13891 | @end table | |
4009494e | 13892 | |
8a1cdce5 AC |
13893 | @item nntp-open-via-rlogin-and-telnet |
13894 | @findex nntp-open-via-rlogin-and-telnet | |
13895 | Does essentially the same, but uses @code{telnet} instead of @samp{netcat} | |
13896 | to connect to the real @acronym{NNTP} server from the intermediate host. | |
13897 | @code{telnet} is a bit less robust because of things like | |
13898 | line-end-conversion, but sometimes @code{netcat} is simply not available. | |
4009494e | 13899 | |
8a1cdce5 | 13900 | @code{nntp-open-via-rlogin-and-telnet}-specific variables: |
4009494e | 13901 | |
8a1cdce5 AC |
13902 | @table @code |
13903 | @item nntp-telnet-command | |
13904 | @vindex nntp-telnet-command | |
13905 | Command used to connect to the real @acronym{NNTP} server from the | |
13906 | intermediate host. The default is @samp{telnet}. | |
4009494e | 13907 | |
8a1cdce5 AC |
13908 | @item nntp-telnet-switches |
13909 | @vindex nntp-telnet-switches | |
13910 | List of strings to be used as the switches to the | |
13911 | @code{nntp-telnet-command} command. The default is @code{("-8")}. | |
4009494e | 13912 | |
8a1cdce5 AC |
13913 | @item nntp-via-rlogin-command |
13914 | @vindex nntp-via-rlogin-command | |
13915 | Command used to log in on the intermediate host. The default is | |
13916 | @samp{rsh}, but @samp{ssh} is a popular alternative. | |
4009494e | 13917 | |
8a1cdce5 AC |
13918 | @item nntp-via-rlogin-command-switches |
13919 | @vindex nntp-via-rlogin-command-switches | |
13920 | List of strings to be used as the switches to | |
13921 | @code{nntp-via-rlogin-command}. If you use @samp{ssh}, you may need to set | |
13922 | this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if | |
13923 | the telnet command requires a pseudo-tty allocation on an intermediate | |
13924 | host. The default is @code{nil}. | |
13925 | @end table | |
4009494e | 13926 | |
8a1cdce5 AC |
13927 | Note that you may want to change the value for @code{nntp-end-of-line} |
13928 | to @samp{\n} (@pxref{Common Variables}). | |
4009494e | 13929 | |
8a1cdce5 AC |
13930 | @item nntp-open-via-telnet-and-telnet |
13931 | @findex nntp-open-via-telnet-and-telnet | |
13932 | Does essentially the same, but uses @samp{telnet} instead of | |
13933 | @samp{rlogin} to connect to the intermediate host. | |
4009494e | 13934 | |
8a1cdce5 | 13935 | @code{nntp-open-via-telnet-and-telnet}-specific variables: |
4009494e | 13936 | |
8a1cdce5 AC |
13937 | @table @code |
13938 | @item nntp-via-telnet-command | |
13939 | @vindex nntp-via-telnet-command | |
13940 | Command used to @code{telnet} the intermediate host. The default is | |
13941 | @samp{telnet}. | |
4009494e | 13942 | |
8a1cdce5 AC |
13943 | @item nntp-via-telnet-switches |
13944 | @vindex nntp-via-telnet-switches | |
13945 | List of strings to be used as the switches to the | |
13946 | @code{nntp-via-telnet-command} command. The default is @samp{("-8")}. | |
4009494e | 13947 | |
8a1cdce5 AC |
13948 | @item nntp-via-user-password |
13949 | @vindex nntp-via-user-password | |
13950 | Password to use when logging in on the intermediate host. | |
4009494e | 13951 | |
8a1cdce5 AC |
13952 | @item nntp-via-envuser |
13953 | @vindex nntp-via-envuser | |
13954 | If non-@code{nil}, the intermediate @code{telnet} session (client and | |
13955 | server both) will support the @code{ENVIRON} option and not prompt for | |
13956 | login name. This works for Solaris @code{telnet}, for instance. | |
59e75882 | 13957 | |
8a1cdce5 AC |
13958 | @item nntp-via-shell-prompt |
13959 | @vindex nntp-via-shell-prompt | |
13960 | Regexp matching the shell prompt on the intermediate host. The default | |
13961 | is @samp{bash\\|\$ *\r?$\\|> *\r?}. | |
4009494e | 13962 | |
8a1cdce5 | 13963 | @end table |
4009494e | 13964 | |
8a1cdce5 AC |
13965 | Note that you may want to change the value for @code{nntp-end-of-line} |
13966 | to @samp{\n} (@pxref{Common Variables}). | |
13967 | @end table | |
4009494e | 13968 | |
4009494e | 13969 | |
8a1cdce5 AC |
13970 | Here are some additional variables that are understood by all the above |
13971 | functions: | |
4009494e | 13972 | |
8a1cdce5 | 13973 | @table @code |
4009494e | 13974 | |
8a1cdce5 AC |
13975 | @item nntp-via-user-name |
13976 | @vindex nntp-via-user-name | |
13977 | User name to use when connecting to the intermediate host. | |
4009494e | 13978 | |
8a1cdce5 AC |
13979 | @item nntp-via-address |
13980 | @vindex nntp-via-address | |
13981 | Address of the intermediate host to connect to. | |
4009494e | 13982 | |
8a1cdce5 | 13983 | @end table |
01c52d31 | 13984 | |
01c52d31 | 13985 | |
8a1cdce5 AC |
13986 | @node Common Variables |
13987 | @subsubsection Common Variables | |
4009494e | 13988 | |
8a1cdce5 AC |
13989 | The following variables affect the behavior of all, or several of the |
13990 | pre-made connection functions. When not specified, all functions are | |
13991 | affected (the values of the following variables will be used as the | |
13992 | default if each virtual @code{nntp} server doesn't specify those server | |
13993 | variables individually). | |
516aa569 | 13994 | |
8a1cdce5 | 13995 | @table @code |
4009494e | 13996 | |
8a1cdce5 AC |
13997 | @item nntp-pre-command |
13998 | @vindex nntp-pre-command | |
13999 | A command wrapper to use when connecting through a non native | |
14000 | connection function (all except @code{nntp-open-network-stream}, | |
14001 | @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is | |
14002 | where you would put a @samp{SOCKS} wrapper for instance. | |
4009494e | 14003 | |
8a1cdce5 AC |
14004 | @item nntp-address |
14005 | @vindex nntp-address | |
14006 | The address of the @acronym{NNTP} server. | |
4009494e | 14007 | |
8a1cdce5 AC |
14008 | @item nntp-port-number |
14009 | @vindex nntp-port-number | |
14010 | Port number to connect to the @acronym{NNTP} server. The default is | |
14011 | @samp{nntp}. If you use @acronym{NNTP} over | |
14012 | @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather | |
14013 | than named ports (i.e, use @samp{563} instead of @samp{snews} or | |
14014 | @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may | |
14015 | not work with named ports. | |
4009494e | 14016 | |
8a1cdce5 AC |
14017 | @item nntp-end-of-line |
14018 | @vindex nntp-end-of-line | |
14019 | String to use as end-of-line marker when talking to the @acronym{NNTP} | |
14020 | server. This is @samp{\r\n} by default, but should be @samp{\n} when | |
14021 | using a non native telnet connection function. | |
4009494e | 14022 | |
8a1cdce5 AC |
14023 | @item nntp-netcat-command |
14024 | @vindex nntp-netcat-command | |
14025 | Command to use when connecting to the @acronym{NNTP} server through | |
14026 | @samp{netcat}. This is @emph{not} for an intermediate host. This is | |
14027 | just for the real @acronym{NNTP} server. The default is | |
14028 | @samp{nc}. | |
4009494e | 14029 | |
8a1cdce5 AC |
14030 | @item nntp-netcat-switches |
14031 | @vindex nntp-netcat-switches | |
14032 | A list of switches to pass to @code{nntp-netcat-command}. The default | |
14033 | is @samp{()}. | |
4009494e | 14034 | |
8a1cdce5 | 14035 | @end table |
4009494e | 14036 | |
8a1cdce5 AC |
14037 | @node News Spool |
14038 | @subsection News Spool | |
14039 | @cindex nnspool | |
14040 | @cindex news spool | |
4009494e | 14041 | |
8a1cdce5 AC |
14042 | Subscribing to a foreign group from the local spool is extremely easy, |
14043 | and might be useful, for instance, to speed up reading groups that | |
14044 | contain very big articles---@samp{alt.binaries.pictures.furniture}, for | |
14045 | instance. | |
4009494e | 14046 | |
8a1cdce5 AC |
14047 | Anyway, you just specify @code{nnspool} as the method and @code{""} (or |
14048 | anything else) as the address. | |
fbcbb58c | 14049 | |
8a1cdce5 AC |
14050 | If you have access to a local spool, you should probably use that as the |
14051 | native select method (@pxref{Finding the News}). It is normally faster | |
14052 | than using an @code{nntp} select method, but might not be. It depends. | |
14053 | You just have to try to find out what's best at your site. | |
4009494e | 14054 | |
8a1cdce5 | 14055 | @table @code |
fbcbb58c | 14056 | |
8a1cdce5 AC |
14057 | @item nnspool-inews-program |
14058 | @vindex nnspool-inews-program | |
14059 | Program used to post an article. | |
4009494e | 14060 | |
8a1cdce5 AC |
14061 | @item nnspool-inews-switches |
14062 | @vindex nnspool-inews-switches | |
14063 | Parameters given to the inews program when posting an article. | |
4009494e | 14064 | |
8a1cdce5 AC |
14065 | @item nnspool-spool-directory |
14066 | @vindex nnspool-spool-directory | |
14067 | Where @code{nnspool} looks for the articles. This is normally | |
14068 | @file{/usr/spool/news/}. | |
4009494e | 14069 | |
8a1cdce5 AC |
14070 | @item nnspool-nov-directory |
14071 | @vindex nnspool-nov-directory | |
14072 | Where @code{nnspool} will look for @acronym{NOV} files. This is normally@* | |
14073 | @file{/usr/spool/news/over.view/}. | |
4009494e | 14074 | |
8a1cdce5 AC |
14075 | @item nnspool-lib-dir |
14076 | @vindex nnspool-lib-dir | |
14077 | Where the news lib dir is (@file{/usr/lib/news/} by default). | |
4009494e | 14078 | |
8a1cdce5 AC |
14079 | @item nnspool-active-file |
14080 | @vindex nnspool-active-file | |
14081 | The name of the active file. | |
4009494e | 14082 | |
8a1cdce5 AC |
14083 | @item nnspool-newsgroups-file |
14084 | @vindex nnspool-newsgroups-file | |
14085 | The name of the group descriptions file. | |
4009494e | 14086 | |
8a1cdce5 AC |
14087 | @item nnspool-history-file |
14088 | @vindex nnspool-history-file | |
14089 | The name of the news history file. | |
4009494e | 14090 | |
8a1cdce5 AC |
14091 | @item nnspool-active-times-file |
14092 | @vindex nnspool-active-times-file | |
14093 | The name of the active date file. | |
4009494e | 14094 | |
8a1cdce5 AC |
14095 | @item nnspool-nov-is-evil |
14096 | @vindex nnspool-nov-is-evil | |
14097 | If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files | |
14098 | that it finds. | |
4009494e | 14099 | |
8a1cdce5 AC |
14100 | @item nnspool-sift-nov-with-sed |
14101 | @vindex nnspool-sift-nov-with-sed | |
14102 | @cindex sed | |
14103 | If non-@code{nil}, which is the default, use @code{sed} to get the | |
14104 | relevant portion from the overview file. If @code{nil}, | |
14105 | @code{nnspool} will load the entire file into a buffer and process it | |
14106 | there. | |
4009494e | 14107 | |
8a1cdce5 | 14108 | @end table |
4009494e GM |
14109 | |
14110 | ||
8a1cdce5 AC |
14111 | @node Using IMAP |
14112 | @section Using IMAP | |
14113 | @cindex imap | |
4009494e | 14114 | |
8a1cdce5 AC |
14115 | The most popular mail backend is probably @code{nnimap}, which |
14116 | provides access to @acronym{IMAP} servers. @acronym{IMAP} servers | |
14117 | store mail remotely, so the client doesn't store anything locally. | |
14118 | This means that it's a convenient choice when you're reading your mail | |
14119 | from different locations, or with different user agents. | |
4009494e | 14120 | |
8a1cdce5 AC |
14121 | @menu |
14122 | * Connecting to an IMAP Server:: Getting started with @acronym{IMAP}. | |
14123 | * Customizing the IMAP Connection:: Variables for @acronym{IMAP} connection. | |
14124 | * Client-Side IMAP Splitting:: Put mail in the correct mail box. | |
14125 | @end menu | |
4009494e | 14126 | |
4009494e | 14127 | |
8a1cdce5 AC |
14128 | @node Connecting to an IMAP Server |
14129 | @subsection Connecting to an IMAP Server | |
4009494e | 14130 | |
8a1cdce5 AC |
14131 | Connecting to an @acronym{IMAP} can be very easy. Type @kbd{B} in the |
14132 | group buffer, or (if your primary interest is reading email), say | |
14133 | something like: | |
4009494e | 14134 | |
8a1cdce5 AC |
14135 | @example |
14136 | (setq gnus-select-method | |
14137 | '(nnimap "imap.gmail.com")) | |
14138 | @end example | |
4009494e | 14139 | |
8a1cdce5 AC |
14140 | You'll be prompted for a user name and password. If you grow tired of |
14141 | that, then add the following to your @file{~/.authinfo} file: | |
4009494e | 14142 | |
8a1cdce5 AC |
14143 | @example |
14144 | machine imap.gmail.com login <username> password <password> port imap | |
14145 | @end example | |
4009494e | 14146 | |
8a1cdce5 | 14147 | That should basically be it for most users. |
4009494e | 14148 | |
4009494e | 14149 | |
8a1cdce5 AC |
14150 | @node Customizing the IMAP Connection |
14151 | @subsection Customizing the IMAP Connection | |
4009494e | 14152 | |
8a1cdce5 | 14153 | Here's an example method that's more complex: |
4009494e | 14154 | |
8a1cdce5 AC |
14155 | @example |
14156 | (nnimap "imap.gmail.com" | |
14157 | (nnimap-inbox "INBOX") | |
14158 | (nnimap-split-methods default) | |
14159 | (nnimap-expunge t) | |
14160 | (nnimap-stream ssl)) | |
14161 | @end example | |
4009494e | 14162 | |
8a1cdce5 AC |
14163 | @table @code |
14164 | @item nnimap-address | |
14165 | The address of the server, like @samp{imap.gmail.com}. | |
4009494e | 14166 | |
8a1cdce5 AC |
14167 | @item nnimap-server-port |
14168 | If the server uses a non-standard port, that can be specified here. A | |
14169 | typical port would be @code{"imap"} or @code{"imaps"}. | |
4009494e | 14170 | |
8a1cdce5 AC |
14171 | @item nnimap-stream |
14172 | How @code{nnimap} should connect to the server. Possible values are: | |
4009494e | 14173 | |
8a1cdce5 AC |
14174 | @table @code |
14175 | @item undecided | |
14176 | This is the default, and this first tries the @code{ssl} setting, and | |
14177 | then tries the @code{network} setting. | |
4009494e | 14178 | |
8a1cdce5 AC |
14179 | @item ssl |
14180 | This uses standard @acronym{TLS}/@acronym{SSL} connections. | |
4009494e | 14181 | |
8a1cdce5 AC |
14182 | @item network |
14183 | Non-encrypted and unsafe straight socket connection, but will upgrade | |
14184 | to encrypted @acronym{STARTTLS} if both Emacs and the server | |
14185 | supports it. | |
4009494e | 14186 | |
8a1cdce5 AC |
14187 | @item starttls |
14188 | Encrypted @acronym{STARTTLS} over the normal @acronym{IMAP} port. | |
8ccbef23 | 14189 | |
8a1cdce5 AC |
14190 | @item shell |
14191 | If you need to tunnel via other systems to connect to the server, you | |
14192 | can use this option, and customize @code{nnimap-shell-program} to be | |
14193 | what you need. | |
4009494e GM |
14194 | |
14195 | @end table | |
14196 | ||
8a1cdce5 AC |
14197 | @item nnimap-authenticator |
14198 | Some @acronym{IMAP} servers allow anonymous logins. In that case, | |
14199 | this should be set to @code{anonymous}. | |
4009494e | 14200 | |
8a1cdce5 AC |
14201 | @item nnimap-expunge |
14202 | If non-@code{nil}, expunge articles after deleting them. This is always done | |
14203 | if the server supports UID EXPUNGE, but it's not done by default on | |
14204 | servers that doesn't support that command. | |
4009494e | 14205 | |
8a1cdce5 | 14206 | @item nnimap-streaming |
3d2af193 LI |
14207 | Virtually all @acronym{IMAP} server support fast streaming of data. |
14208 | If you have problems connecting to the server, try setting this to | |
14209 | @code{nil}. | |
4009494e | 14210 | |
8a1cdce5 AC |
14211 | @item nnimap-fetch-partial-articles |
14212 | If non-@code{nil}, fetch partial articles from the server. If set to | |
14213 | a string, then it's interpreted as a regexp, and parts that have | |
14214 | matching types will be fetched. For instance, @samp{"text/"} will | |
14215 | fetch all textual parts, while leaving the rest on the server. | |
4009494e | 14216 | |
3d2af193 LI |
14217 | @item nnimap-record-commands |
14218 | If non-@code{nil}, record all @acronym{IMAP} commands in the | |
14219 | @samp{"*imap log*"} buffer. | |
14220 | ||
8a1cdce5 | 14221 | @end table |
4009494e | 14222 | |
4009494e | 14223 | |
8a1cdce5 AC |
14224 | @node Client-Side IMAP Splitting |
14225 | @subsection Client-Side IMAP Splitting | |
4009494e | 14226 | |
8a1cdce5 AC |
14227 | Many people prefer to do the sorting/splitting of mail into their mail |
14228 | boxes on the @acronym{IMAP} server. That way they don't have to | |
14229 | download the mail they're not all that interested in. | |
4009494e | 14230 | |
8a1cdce5 AC |
14231 | If you do want to do client-side mail splitting, then the following |
14232 | variables are relevant: | |
4009494e GM |
14233 | |
14234 | @table @code | |
8a1cdce5 AC |
14235 | @item nnimap-inbox |
14236 | This is the @acronym{IMAP} mail box that will be scanned for new mail. | |
4009494e | 14237 | |
8a1cdce5 AC |
14238 | @item nnimap-split-methods |
14239 | Uses the same syntax as @code{nnmail-split-methods} (@pxref{Splitting | |
14240 | Mail}), except the symbol @code{default}, which means that it should | |
14241 | use the value of the @code{nnmail-split-methods} variable. | |
4009494e | 14242 | |
8a1cdce5 AC |
14243 | @item nnimap-split-fancy |
14244 | Uses the same syntax as @code{nnmail-split-fancy}. | |
4009494e | 14245 | |
8a1cdce5 AC |
14246 | @item nnimap-unsplittable-articles |
14247 | List of flag symbols to ignore when doing splitting. That is, | |
14248 | articles that have these flags won't be considered when splitting. | |
14249 | The default is @samp{(%Deleted %Seen)}. | |
4009494e | 14250 | |
8a1cdce5 | 14251 | @end table |
4009494e | 14252 | |
fe72c8fa LI |
14253 | Here's a complete example @code{nnimap} backend with a client-side |
14254 | ``fancy'' splitting method: | |
14255 | ||
14256 | @example | |
14257 | (nnimap "imap.example.com" | |
14258 | (nnimap-inbox "INBOX") | |
14259 | (nnimap-split-methods | |
14260 | (| ("MailScanner-SpamCheck" "spam" "spam.detected") | |
14261 | (to "foo@@bar.com" "foo") | |
14262 | "undecided"))) | |
14263 | @end example | |
14264 | ||
4009494e | 14265 | |
8a1cdce5 AC |
14266 | @node Getting Mail |
14267 | @section Getting Mail | |
14268 | @cindex reading mail | |
14269 | @cindex mail | |
4009494e | 14270 | |
1df7defd | 14271 | Reading mail with a newsreader---isn't that just plain WeIrD@? But of |
8a1cdce5 | 14272 | course. |
4009494e | 14273 | |
8a1cdce5 AC |
14274 | @menu |
14275 | * Mail in a Newsreader:: Important introductory notes. | |
14276 | * Getting Started Reading Mail:: A simple cookbook example. | |
14277 | * Splitting Mail:: How to create mail groups. | |
14278 | * Mail Sources:: How to tell Gnus where to get mail from. | |
14279 | * Mail Back End Variables:: Variables for customizing mail handling. | |
14280 | * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail. | |
14281 | * Group Mail Splitting:: Use group customize to drive mail splitting. | |
14282 | * Incorporating Old Mail:: What about the old mail you have? | |
14283 | * Expiring Mail:: Getting rid of unwanted mail. | |
14284 | * Washing Mail:: Removing cruft from the mail you get. | |
14285 | * Duplicates:: Dealing with duplicated mail. | |
14286 | * Not Reading Mail:: Using mail back ends for reading other files. | |
14287 | * Choosing a Mail Back End:: Gnus can read a variety of mail formats. | |
14288 | @end menu | |
4009494e | 14289 | |
4009494e | 14290 | |
8a1cdce5 AC |
14291 | @node Mail in a Newsreader |
14292 | @subsection Mail in a Newsreader | |
4009494e | 14293 | |
8a1cdce5 AC |
14294 | If you are used to traditional mail readers, but have decided to switch |
14295 | to reading mail with Gnus, you may find yourself experiencing something | |
14296 | of a culture shock. | |
4009494e | 14297 | |
8a1cdce5 AC |
14298 | Gnus does not behave like traditional mail readers. If you want to make |
14299 | it behave that way, you can, but it's an uphill battle. | |
4009494e | 14300 | |
8a1cdce5 AC |
14301 | Gnus, by default, handles all its groups using the same approach. This |
14302 | approach is very newsreaderly---you enter a group, see the new/unread | |
14303 | messages, and when you read the messages, they get marked as read, and | |
14304 | you don't see them any more. (Unless you explicitly ask for them.) | |
4009494e | 14305 | |
8a1cdce5 | 14306 | In particular, you do not do anything explicitly to delete messages. |
4009494e | 14307 | |
8a1cdce5 AC |
14308 | Does this mean that all the messages that have been marked as read are |
14309 | deleted? How awful! | |
4009494e | 14310 | |
8a1cdce5 AC |
14311 | But, no, it means that old messages are @dfn{expired} according to some |
14312 | scheme or other. For news messages, the expire process is controlled by | |
14313 | the news administrator; for mail, the expire process is controlled by | |
14314 | you. The expire process for mail is covered in depth in @ref{Expiring | |
14315 | Mail}. | |
4009494e | 14316 | |
8a1cdce5 AC |
14317 | What many Gnus users find, after using it a while for both news and |
14318 | mail, is that the transport mechanism has very little to do with how | |
14319 | they want to treat a message. | |
4009494e | 14320 | |
8a1cdce5 AC |
14321 | Many people subscribe to several mailing lists. These are transported |
14322 | via @acronym{SMTP}, and are therefore mail. But we might go for weeks without | |
14323 | answering, or even reading these messages very carefully. We may not | |
14324 | need to save them because if we should need to read one again, they are | |
14325 | archived somewhere else. | |
4009494e | 14326 | |
8a1cdce5 AC |
14327 | Some people have local news groups which have only a handful of readers. |
14328 | These are transported via @acronym{NNTP}, and are therefore news. But we may need | |
14329 | to read and answer a large fraction of the messages very carefully in | |
14330 | order to do our work. And there may not be an archive, so we may need | |
14331 | to save the interesting messages the same way we would personal mail. | |
4009494e | 14332 | |
8a1cdce5 AC |
14333 | The important distinction turns out to be not the transport mechanism, |
14334 | but other factors such as how interested we are in the subject matter, | |
14335 | or how easy it is to retrieve the message if we need to read it again. | |
4009494e | 14336 | |
8a1cdce5 AC |
14337 | Gnus provides many options for sorting mail into ``groups'' which behave |
14338 | like newsgroups, and for treating each group (whether mail or news) | |
14339 | differently. | |
4009494e | 14340 | |
8a1cdce5 AC |
14341 | Some users never get comfortable using the Gnus (ahem) paradigm and wish |
14342 | that Gnus should grow up and be a male, er, mail reader. It is possible | |
14343 | to whip Gnus into a more mailreaderly being, but, as said before, it's | |
14344 | not easy. People who prefer proper mail readers should try @sc{vm} | |
14345 | instead, which is an excellent, and proper, mail reader. | |
4009494e | 14346 | |
8a1cdce5 AC |
14347 | I don't mean to scare anybody off, but I want to make it clear that you |
14348 | may be required to learn a new way of thinking about messages. After | |
14349 | you've been subjected to The Gnus Way, you will come to love it. I can | |
14350 | guarantee it. (At least the guy who sold me the Emacs Subliminal | |
14351 | Brain-Washing Functions that I've put into Gnus did guarantee it. You | |
14352 | Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way. | |
14353 | You Do.) | |
4009494e | 14354 | |
4009494e | 14355 | |
8a1cdce5 AC |
14356 | @node Getting Started Reading Mail |
14357 | @subsection Getting Started Reading Mail | |
14358 | ||
14359 | It's quite easy to use Gnus to read your new mail. You just plonk the | |
14360 | mail back end of your choice into @code{gnus-secondary-select-methods}, | |
14361 | and things will happen automatically. | |
14362 | ||
14363 | For instance, if you want to use @code{nnml} (which is a ``one file per | |
14364 | mail'' back end), you could put the following in your @file{~/.gnus.el} file: | |
14365 | ||
14366 | @lisp | |
14367 | (setq gnus-secondary-select-methods '((nnml ""))) | |
14368 | @end lisp | |
14369 | ||
14370 | Now, the next time you start Gnus, this back end will be queried for new | |
14371 | articles, and it will move all the messages in your spool file to its | |
14372 | directory, which is @file{~/Mail/} by default. The new group that will | |
14373 | be created (@samp{mail.misc}) will be subscribed, and you can read it | |
14374 | like any other group. | |
4009494e | 14375 | |
8a1cdce5 | 14376 | You will probably want to split the mail into several groups, though: |
4009494e GM |
14377 | |
14378 | @lisp | |
8a1cdce5 AC |
14379 | (setq nnmail-split-methods |
14380 | '(("junk" "^From:.*Lars Ingebrigtsen") | |
14381 | ("crazy" "^Subject:.*die\\|^Organization:.*flabby") | |
14382 | ("other" ""))) | |
4009494e GM |
14383 | @end lisp |
14384 | ||
8a1cdce5 AC |
14385 | This will result in three new @code{nnml} mail groups being created: |
14386 | @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the | |
14387 | mail that doesn't fit into the first two groups will be placed in the | |
14388 | last group. | |
4009494e | 14389 | |
8a1cdce5 AC |
14390 | This should be sufficient for reading mail with Gnus. You might want to |
14391 | give the other sections in this part of the manual a perusal, though. | |
14392 | Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}. | |
4009494e | 14393 | |
4009494e | 14394 | |
8a1cdce5 AC |
14395 | @node Splitting Mail |
14396 | @subsection Splitting Mail | |
14397 | @cindex splitting mail | |
14398 | @cindex mail splitting | |
14399 | @cindex mail filtering (splitting) | |
4009494e | 14400 | |
8a1cdce5 AC |
14401 | @vindex nnmail-split-methods |
14402 | The @code{nnmail-split-methods} variable says how the incoming mail is | |
14403 | to be split into groups. | |
4009494e | 14404 | |
8a1cdce5 AC |
14405 | @lisp |
14406 | (setq nnmail-split-methods | |
14407 | '(("mail.junk" "^From:.*Lars Ingebrigtsen") | |
14408 | ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby") | |
14409 | ("mail.other" ""))) | |
14410 | @end lisp | |
4009494e | 14411 | |
8a1cdce5 AC |
14412 | This variable is a list of lists, where the first element of each of |
14413 | these lists is the name of the mail group (they do not have to be called | |
14414 | something beginning with @samp{mail}, by the way), and the second | |
14415 | element is a regular expression used on the header of each mail to | |
14416 | determine if it belongs in this mail group. The first string may | |
14417 | contain @samp{\\1} forms, like the ones used by @code{replace-match} to | |
14418 | insert sub-expressions from the matched text. For instance: | |
4009494e GM |
14419 | |
14420 | @lisp | |
8a1cdce5 | 14421 | ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com") |
4009494e GM |
14422 | @end lisp |
14423 | ||
8a1cdce5 AC |
14424 | @noindent |
14425 | In that case, @code{nnmail-split-lowercase-expanded} controls whether | |
14426 | the inserted text should be made lowercase. @xref{Fancy Mail Splitting}. | |
4009494e | 14427 | |
8a1cdce5 AC |
14428 | The second element can also be a function. In that case, it will be |
14429 | called narrowed to the headers with the first element of the rule as the | |
14430 | argument. It should return a non-@code{nil} value if it thinks that the | |
14431 | mail belongs in that group. | |
6b958814 | 14432 | |
8a1cdce5 AC |
14433 | @cindex @samp{bogus} group |
14434 | The last of these groups should always be a general one, and the regular | |
14435 | expression should @emph{always} be @samp{""} so that it matches any mails | |
14436 | that haven't been matched by any of the other regexps. (These rules are | |
14437 | processed from the beginning of the alist toward the end. The first rule | |
14438 | to make a match will ``win'', unless you have crossposting enabled. In | |
14439 | that case, all matching rules will ``win''.) If no rule matched, the mail | |
14440 | will end up in the @samp{bogus} group. When new groups are created by | |
14441 | splitting mail, you may want to run @code{gnus-group-find-new-groups} to | |
14442 | see the new groups. This also applies to the @samp{bogus} group. | |
6b958814 | 14443 | |
8a1cdce5 AC |
14444 | If you like to tinker with this yourself, you can set this variable to a |
14445 | function of your choice. This function will be called without any | |
14446 | arguments in a buffer narrowed to the headers of an incoming mail | |
14447 | message. The function should return a list of group names that it | |
14448 | thinks should carry this mail message. | |
4009494e | 14449 | |
8a1cdce5 AC |
14450 | This variable can also be a fancy split method. For the syntax, |
14451 | see @ref{Fancy Mail Splitting}. | |
4009494e | 14452 | |
8a1cdce5 AC |
14453 | Note that the mail back ends are free to maul the poor, innocent, |
14454 | incoming headers all they want to. They all add @code{Lines} headers; | |
14455 | some add @code{X-Gnus-Group} headers; most rename the Unix mbox | |
14456 | @code{From<SPACE>} line to something else. | |
4009494e | 14457 | |
8a1cdce5 AC |
14458 | @vindex nnmail-crosspost |
14459 | The mail back ends all support cross-posting. If several regexps match, | |
14460 | the mail will be ``cross-posted'' to all those groups. | |
14461 | @code{nnmail-crosspost} says whether to use this mechanism or not. Note | |
14462 | that no articles are crossposted to the general (@samp{""}) group. | |
4009494e | 14463 | |
8a1cdce5 AC |
14464 | @vindex nnmail-crosspost-link-function |
14465 | @cindex crosspost | |
14466 | @cindex links | |
14467 | @code{nnmh} and @code{nnml} makes crossposts by creating hard links to | |
14468 | the crossposted articles. However, not all file systems support hard | |
14469 | links. If that's the case for you, set | |
14470 | @code{nnmail-crosspost-link-function} to @code{copy-file}. (This | |
14471 | variable is @code{add-name-to-file} by default.) | |
4009494e | 14472 | |
8a1cdce5 AC |
14473 | @kindex M-x nnmail-split-history |
14474 | @findex nnmail-split-history | |
14475 | If you wish to see where the previous mail split put the messages, you | |
14476 | can use the @kbd{M-x nnmail-split-history} command. If you wish to see | |
14477 | where re-spooling messages would put the messages, you can use | |
14478 | @code{gnus-summary-respool-trace} and related commands (@pxref{Mail | |
14479 | Group Commands}). | |
4009494e | 14480 | |
8a1cdce5 AC |
14481 | @vindex nnmail-split-header-length-limit |
14482 | Header lines longer than the value of | |
14483 | @code{nnmail-split-header-length-limit} are excluded from the split | |
14484 | function. | |
3b84b005 | 14485 | |
8a1cdce5 AC |
14486 | @vindex nnmail-mail-splitting-decodes |
14487 | @vindex nnmail-mail-splitting-charset | |
14488 | By default, splitting does not decode headers, so you can not match on | |
14489 | non-@acronym{ASCII} strings. But it is useful if you want to match | |
14490 | articles based on the raw header data. To enable it, set the | |
14491 | @code{nnmail-mail-splitting-decodes} variable to a non-@code{nil} value. | |
14492 | In addition, the value of the @code{nnmail-mail-splitting-charset} | |
14493 | variable is used for decoding non-@acronym{MIME} encoded string when | |
14494 | @code{nnmail-mail-splitting-decodes} is non-@code{nil}. The default | |
14495 | value is @code{nil} which means not to decode non-@acronym{MIME} encoded | |
14496 | string. A suitable value for you will be @code{undecided} or be the | |
14497 | charset used normally in mails you are interested in. | |
14498 | ||
14499 | @vindex nnmail-resplit-incoming | |
14500 | By default, splitting is performed on all incoming messages. If you | |
14501 | specify a @code{directory} entry for the variable @code{mail-sources} | |
14502 | (@pxref{Mail Source Specifiers}), however, then splitting does | |
14503 | @emph{not} happen by default. You can set the variable | |
14504 | @code{nnmail-resplit-incoming} to a non-@code{nil} value to make | |
14505 | splitting happen even in this case. (This variable has no effect on | |
14506 | other kinds of entries.) | |
14507 | ||
14508 | Gnus gives you all the opportunity you could possibly want for shooting | |
14509 | yourself in the foot. Let's say you create a group that will contain | |
14510 | all the mail you get from your boss. And then you accidentally | |
14511 | unsubscribe from the group. Gnus will still put all the mail from your | |
14512 | boss in the unsubscribed group, and so, when your boss mails you ``Have | |
14513 | that report ready by Monday or you're fired!'', you'll never see it and, | |
14514 | come Tuesday, you'll still believe that you're gainfully employed while | |
14515 | you really should be out collecting empty bottles to save up for next | |
14516 | month's rent money. | |
14517 | ||
14518 | ||
14519 | @node Mail Sources | |
14520 | @subsection Mail Sources | |
14521 | ||
14522 | Mail can be gotten from many different sources---the mail spool, from | |
14523 | a @acronym{POP} mail server, from a procmail directory, or from a | |
14524 | maildir, for instance. | |
14525 | ||
14526 | @menu | |
14527 | * Mail Source Specifiers:: How to specify what a mail source is. | |
14528 | * Mail Source Customization:: Some variables that influence things. | |
14529 | * Fetching Mail:: Using the mail source specifiers. | |
14530 | @end menu | |
4009494e | 14531 | |
4009494e | 14532 | |
8a1cdce5 AC |
14533 | @node Mail Source Specifiers |
14534 | @subsubsection Mail Source Specifiers | |
14535 | @cindex POP | |
14536 | @cindex mail server | |
14537 | @cindex procmail | |
14538 | @cindex mail spool | |
14539 | @cindex mail source | |
4009494e | 14540 | |
8a1cdce5 AC |
14541 | You tell Gnus how to fetch mail by setting @code{mail-sources} |
14542 | (@pxref{Fetching Mail}) to a @dfn{mail source specifier}. | |
4009494e | 14543 | |
8a1cdce5 | 14544 | Here's an example: |
4009494e GM |
14545 | |
14546 | @lisp | |
8a1cdce5 | 14547 | (pop :server "pop3.mailserver.com" :user "myname") |
4009494e GM |
14548 | @end lisp |
14549 | ||
8a1cdce5 AC |
14550 | As can be observed, a mail source specifier is a list where the first |
14551 | element is a @dfn{mail source type}, followed by an arbitrary number of | |
14552 | @dfn{keywords}. Keywords that are not explicitly specified are given | |
14553 | default values. | |
31fe2b00 | 14554 | |
8a1cdce5 AC |
14555 | The @code{mail-sources} is global for all mail groups. You can specify |
14556 | an additional mail source for a particular group by including the | |
14557 | @code{group} mail specifier in @code{mail-sources}, and setting a | |
14558 | @code{mail-source} group parameter (@pxref{Group Parameters}) specifying | |
14559 | a single mail source. When this is used, @code{mail-sources} is | |
14560 | typically just @code{(group)}; the @code{mail-source} parameter for a | |
14561 | group might look like this: | |
31fe2b00 SM |
14562 | |
14563 | @lisp | |
8a1cdce5 | 14564 | (mail-source . (file :path "home/user/spools/foo.spool")) |
31fe2b00 | 14565 | @end lisp |
4009494e | 14566 | |
8a1cdce5 AC |
14567 | This means that the group's (and only this group's) messages will be |
14568 | fetched from the spool file @samp{/user/spools/foo.spool}. | |
4009494e | 14569 | |
8a1cdce5 | 14570 | The following mail source types are available: |
4009494e GM |
14571 | |
14572 | @table @code | |
8a1cdce5 AC |
14573 | @item file |
14574 | Get mail from a single file; typically from the mail spool. | |
4009494e | 14575 | |
8a1cdce5 | 14576 | Keywords: |
4009494e GM |
14577 | |
14578 | @table @code | |
8a1cdce5 AC |
14579 | @item :path |
14580 | The file name. Defaults to the value of the @env{MAIL} | |
14581 | environment variable or the value of @code{rmail-spool-directory} | |
14582 | (usually something like @file{/usr/mail/spool/user-name}). | |
4009494e | 14583 | |
8a1cdce5 AC |
14584 | @item :prescript |
14585 | @itemx :postscript | |
14586 | Script run before/after fetching mail. | |
4009494e GM |
14587 | @end table |
14588 | ||
8a1cdce5 | 14589 | An example file mail source: |
01c52d31 | 14590 | |
8a1cdce5 AC |
14591 | @lisp |
14592 | (file :path "/usr/spool/mail/user-name") | |
14593 | @end lisp | |
01c52d31 | 14594 | |
8a1cdce5 | 14595 | Or using the default file name: |
01c52d31 | 14596 | |
8a1cdce5 AC |
14597 | @lisp |
14598 | (file) | |
14599 | @end lisp | |
31fe2b00 | 14600 | |
8a1cdce5 AC |
14601 | If the mail spool file is not located on the local machine, it's best |
14602 | to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail. | |
14603 | You can not use ange-ftp file names here---it has no way to lock the | |
14604 | mail spool while moving the mail. | |
4009494e | 14605 | |
8a1cdce5 | 14606 | If it's impossible to set up a proper server, you can use ssh instead. |
4009494e | 14607 | |
8a1cdce5 AC |
14608 | @lisp |
14609 | (setq mail-sources | |
14610 | '((file :prescript "ssh host bin/getmail >%t"))) | |
14611 | @end lisp | |
4009494e | 14612 | |
8a1cdce5 | 14613 | The @samp{getmail} script would look something like the following: |
4009494e | 14614 | |
8a1cdce5 AC |
14615 | @example |
14616 | #!/bin/sh | |
14617 | # getmail - move mail from spool to stdout | |
14618 | # flu@@iki.fi | |
4009494e | 14619 | |
8a1cdce5 AC |
14620 | MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail |
14621 | TMP=$HOME/Mail/tmp | |
14622 | rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP | |
14623 | @end example | |
4009494e | 14624 | |
8a1cdce5 AC |
14625 | Alter this script to fit the @samp{movemail} and temporary |
14626 | file you want to use. | |
4009494e | 14627 | |
4009494e | 14628 | |
8a1cdce5 AC |
14629 | @item directory |
14630 | @vindex nnmail-scan-directory-mail-source-once | |
14631 | Get mail from several files in a directory. This is typically used | |
14632 | when you have procmail split the incoming mail into several files. | |
14633 | That is, there is a one-to-one correspondence between files in that | |
14634 | directory and groups, so that mail from the file @file{foo.bar.spool} | |
14635 | will be put in the group @code{foo.bar}. (You can change the suffix | |
14636 | to be used instead of @code{.spool}.) Setting | |
14637 | @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces | |
14638 | Gnus to scan the mail source only once. This is particularly useful | |
14639 | if you want to scan mail groups at a specified level. | |
4009494e | 14640 | |
8a1cdce5 AC |
14641 | @vindex nnmail-resplit-incoming |
14642 | There is also the variable @code{nnmail-resplit-incoming}, if you set | |
14643 | that to a non-@code{nil} value, then the normal splitting process is | |
14644 | applied to all the files from the directory, @ref{Splitting Mail}. | |
4009494e | 14645 | |
8a1cdce5 | 14646 | Keywords: |
4009494e GM |
14647 | |
14648 | @table @code | |
8a1cdce5 AC |
14649 | @item :path |
14650 | The name of the directory where the files are. There is no default | |
14651 | value. | |
4009494e | 14652 | |
8a1cdce5 AC |
14653 | @item :suffix |
14654 | Only files ending with this suffix are used. The default is | |
14655 | @samp{.spool}. | |
4009494e | 14656 | |
8a1cdce5 AC |
14657 | @item :predicate |
14658 | Only files that have this predicate return non-@code{nil} are returned. | |
14659 | The default is @code{identity}. This is used as an additional | |
14660 | filter---only files that have the right suffix @emph{and} satisfy this | |
14661 | predicate are considered. | |
4009494e | 14662 | |
8a1cdce5 AC |
14663 | @item :prescript |
14664 | @itemx :postscript | |
14665 | Script run before/after fetching mail. | |
4009494e | 14666 | |
8a1cdce5 | 14667 | @end table |
4009494e | 14668 | |
8a1cdce5 | 14669 | An example directory mail source: |
4009494e | 14670 | |
8a1cdce5 AC |
14671 | @lisp |
14672 | (directory :path "/home/user-name/procmail-dir/" | |
14673 | :suffix ".prcml") | |
14674 | @end lisp | |
4009494e | 14675 | |
8a1cdce5 AC |
14676 | @item pop |
14677 | Get mail from a @acronym{POP} server. | |
4009494e | 14678 | |
8a1cdce5 | 14679 | Keywords: |
4009494e | 14680 | |
8a1cdce5 AC |
14681 | @table @code |
14682 | @item :server | |
14683 | The name of the @acronym{POP} server. The default is taken from the | |
14684 | @env{MAILHOST} environment variable. | |
4009494e | 14685 | |
8a1cdce5 | 14686 | @item :port |
1df7defd PE |
14687 | The port number of the @acronym{POP} server. This can be a number (e.g., |
14688 | @samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a | |
8a1cdce5 AC |
14689 | string, it should be a service name as listed in @file{/etc/services} on |
14690 | Unix systems. The default is @samp{"pop3"}. On some systems you might | |
14691 | need to specify it as @samp{"pop-3"} instead. | |
01c52d31 | 14692 | |
8a1cdce5 AC |
14693 | @item :user |
14694 | The user name to give to the @acronym{POP} server. The default is the login | |
14695 | name. | |
01c52d31 | 14696 | |
8a1cdce5 AC |
14697 | @item :password |
14698 | The password to give to the @acronym{POP} server. If not specified, | |
14699 | the user is prompted. | |
01c52d31 | 14700 | |
8a1cdce5 AC |
14701 | @item :program |
14702 | The program to use to fetch mail from the @acronym{POP} server. This | |
14703 | should be a @code{format}-like string. Here's an example: | |
01c52d31 | 14704 | |
8a1cdce5 AC |
14705 | @example |
14706 | fetchmail %u@@%s -P %p %t | |
14707 | @end example | |
01c52d31 | 14708 | |
8a1cdce5 | 14709 | The valid format specifier characters are: |
01c52d31 | 14710 | |
8a1cdce5 AC |
14711 | @table @samp |
14712 | @item t | |
14713 | The name of the file the mail is to be moved to. This must always be | |
14714 | included in this string. | |
01c52d31 | 14715 | |
8a1cdce5 AC |
14716 | @item s |
14717 | The name of the server. | |
01c52d31 | 14718 | |
8a1cdce5 AC |
14719 | @item P |
14720 | The port number of the server. | |
01c52d31 | 14721 | |
8a1cdce5 AC |
14722 | @item u |
14723 | The user name to use. | |
01c52d31 | 14724 | |
8a1cdce5 AC |
14725 | @item p |
14726 | The password to use. | |
14727 | @end table | |
4009494e | 14728 | |
8a1cdce5 AC |
14729 | The values used for these specs are taken from the values you give the |
14730 | corresponding keywords. | |
4009494e | 14731 | |
8a1cdce5 AC |
14732 | @item :prescript |
14733 | A script to be run before fetching the mail. The syntax is the same as | |
14734 | the @code{:program} keyword. This can also be a function to be run. | |
4009494e | 14735 | |
7c4bbb69 LI |
14736 | One popular way to use this is to set up an SSH tunnel to access the |
14737 | @acronym{POP} server. Here's an example: | |
14738 | ||
14739 | @lisp | |
14740 | (pop :server "127.0.0.1" | |
14741 | :port 1234 | |
14742 | :user "foo" | |
14743 | :password "secret" | |
14744 | :prescript | |
14745 | "nohup ssh -f -L 1234:pop.server:110 remote.host sleep 3600 &") | |
14746 | @end lisp | |
14747 | ||
8a1cdce5 AC |
14748 | @item :postscript |
14749 | A script to be run after fetching the mail. The syntax is the same as | |
14750 | the @code{:program} keyword. This can also be a function to be run. | |
4009494e | 14751 | |
8a1cdce5 AC |
14752 | @item :function |
14753 | The function to use to fetch mail from the @acronym{POP} server. The | |
14754 | function is called with one parameter---the name of the file where the | |
14755 | mail should be moved to. | |
4009494e | 14756 | |
8a1cdce5 AC |
14757 | @item :authentication |
14758 | This can be either the symbol @code{password} or the symbol @code{apop} | |
14759 | and says what authentication scheme to use. The default is | |
14760 | @code{password}. | |
4009494e | 14761 | |
8a1cdce5 | 14762 | @end table |
4009494e | 14763 | |
8a1cdce5 AC |
14764 | @vindex pop3-movemail |
14765 | @vindex pop3-leave-mail-on-server | |
14766 | If the @code{:program} and @code{:function} keywords aren't specified, | |
14767 | @code{pop3-movemail} will be used. If @code{pop3-leave-mail-on-server} | |
14768 | is non-@code{nil} the mail is to be left on the @acronym{POP} server | |
14769 | after fetching when using @code{pop3-movemail}. Note that POP servers | |
14770 | maintain no state information between sessions, so what the client | |
14771 | believes is there and what is actually there may not match up. If they | |
14772 | do not, then you may get duplicate mails or the whole thing can fall | |
14773 | apart and leave you with a corrupt mailbox. | |
4009494e | 14774 | |
8a1cdce5 AC |
14775 | Here are some examples for getting mail from a @acronym{POP} server. |
14776 | Fetch from the default @acronym{POP} server, using the default user | |
14777 | name, and default fetcher: | |
4009494e | 14778 | |
8a1cdce5 AC |
14779 | @lisp |
14780 | (pop) | |
14781 | @end lisp | |
4009494e | 14782 | |
8a1cdce5 | 14783 | Fetch from a named server with a named user and password: |
4009494e | 14784 | |
8a1cdce5 AC |
14785 | @lisp |
14786 | (pop :server "my.pop.server" | |
14787 | :user "user-name" :password "secret") | |
14788 | @end lisp | |
4009494e | 14789 | |
8a1cdce5 | 14790 | Use @samp{movemail} to move the mail: |
4009494e | 14791 | |
8a1cdce5 AC |
14792 | @lisp |
14793 | (pop :program "movemail po:%u %t %p") | |
14794 | @end lisp | |
4009494e | 14795 | |
8a1cdce5 AC |
14796 | @item maildir |
14797 | Get mail from a maildir. This is a type of mailbox that is supported by | |
14798 | at least qmail and postfix, where each file in a special directory | |
14799 | contains exactly one mail. | |
4009494e | 14800 | |
8a1cdce5 | 14801 | Keywords: |
4009494e | 14802 | |
8a1cdce5 AC |
14803 | @table @code |
14804 | @item :path | |
14805 | The name of the directory where the mails are stored. The default is | |
14806 | taken from the @env{MAILDIR} environment variable or | |
14807 | @file{~/Maildir/}. | |
14808 | @item :subdirs | |
14809 | The subdirectories of the Maildir. The default is | |
14810 | @samp{("new" "cur")}. | |
4009494e | 14811 | |
8a1cdce5 AC |
14812 | @c If you sometimes look at your mail through a pop3 daemon before fetching |
14813 | @c them with Gnus, you may also have to fetch your mails from the | |
14814 | @c @code{cur} directory inside the maildir, like in the first example | |
14815 | @c below. | |
4009494e | 14816 | |
8a1cdce5 AC |
14817 | You can also get mails from remote hosts (because maildirs don't suffer |
14818 | from locking problems). | |
4009494e | 14819 | |
8a1cdce5 | 14820 | @end table |
8ccbef23 | 14821 | |
8a1cdce5 | 14822 | Two example maildir mail sources: |
8ccbef23 | 14823 | |
8a1cdce5 AC |
14824 | @lisp |
14825 | (maildir :path "/home/user-name/Maildir/" | |
14826 | :subdirs ("cur" "new")) | |
14827 | @end lisp | |
8ccbef23 | 14828 | |
8a1cdce5 AC |
14829 | @lisp |
14830 | (maildir :path "/user@@remotehost.org:~/Maildir/" | |
14831 | :subdirs ("new")) | |
14832 | @end lisp | |
8ccbef23 | 14833 | |
8a1cdce5 AC |
14834 | @item imap |
14835 | Get mail from a @acronym{IMAP} server. If you don't want to use | |
1df7defd | 14836 | @acronym{IMAP} as intended, as a network mail reading protocol (i.e., |
8a1cdce5 AC |
14837 | with nnimap), for some reason or other, Gnus let you treat it similar |
14838 | to a @acronym{POP} server and fetches articles from a given | |
14839 | @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information. | |
8ccbef23 | 14840 | |
8a1cdce5 | 14841 | Keywords: |
8ccbef23 | 14842 | |
8a1cdce5 AC |
14843 | @table @code |
14844 | @item :server | |
14845 | The name of the @acronym{IMAP} server. The default is taken from the | |
14846 | @env{MAILHOST} environment variable. | |
8ccbef23 | 14847 | |
8a1cdce5 AC |
14848 | @item :port |
14849 | The port number of the @acronym{IMAP} server. The default is @samp{143}, or | |
14850 | @samp{993} for @acronym{TLS}/@acronym{SSL} connections. | |
8ccbef23 | 14851 | |
8a1cdce5 AC |
14852 | @item :user |
14853 | The user name to give to the @acronym{IMAP} server. The default is the login | |
14854 | name. | |
8ccbef23 | 14855 | |
8a1cdce5 AC |
14856 | @item :password |
14857 | The password to give to the @acronym{IMAP} server. If not specified, the user is | |
14858 | prompted. | |
8ccbef23 | 14859 | |
8a1cdce5 AC |
14860 | @item :stream |
14861 | What stream to use for connecting to the server, this is one of the | |
14862 | symbols in @code{imap-stream-alist}. Right now, this means | |
14863 | @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls}, | |
14864 | @samp{ssl}, @samp{shell} or the default @samp{network}. | |
8ccbef23 | 14865 | |
8a1cdce5 AC |
14866 | @item :authentication |
14867 | Which authenticator to use for authenticating to the server, this is | |
14868 | one of the symbols in @code{imap-authenticator-alist}. Right now, | |
14869 | this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5}, | |
14870 | @samp{cram-md5}, @samp{anonymous} or the default @samp{login}. | |
8ccbef23 | 14871 | |
8a1cdce5 AC |
14872 | @item :program |
14873 | When using the `shell' :stream, the contents of this variable is | |
14874 | mapped into the @code{imap-shell-program} variable. This should be a | |
14875 | @code{format}-like string (or list of strings). Here's an example: | |
8ccbef23 G |
14876 | |
14877 | @example | |
8a1cdce5 | 14878 | ssh %s imapd |
8ccbef23 G |
14879 | @end example |
14880 | ||
8a1cdce5 AC |
14881 | Make sure nothing is interfering with the output of the program, e.g., |
14882 | don't forget to redirect the error output to the void. The valid format | |
14883 | specifier characters are: | |
8ccbef23 | 14884 | |
8a1cdce5 AC |
14885 | @table @samp |
14886 | @item s | |
14887 | The name of the server. | |
8ccbef23 | 14888 | |
8a1cdce5 AC |
14889 | @item l |
14890 | User name from @code{imap-default-user}. | |
8ccbef23 | 14891 | |
8a1cdce5 AC |
14892 | @item p |
14893 | The port number of the server. | |
14894 | @end table | |
ed797193 | 14895 | |
8a1cdce5 AC |
14896 | The values used for these specs are taken from the values you give the |
14897 | corresponding keywords. | |
8ccbef23 | 14898 | |
8a1cdce5 AC |
14899 | @item :mailbox |
14900 | The name of the mailbox to get mail from. The default is @samp{INBOX} | |
14901 | which normally is the mailbox which receives incoming mail. | |
8ccbef23 | 14902 | |
8a1cdce5 AC |
14903 | @item :predicate |
14904 | The predicate used to find articles to fetch. The default, @samp{UNSEEN | |
14905 | UNDELETED}, is probably the best choice for most people, but if you | |
14906 | sometimes peek in your mailbox with a @acronym{IMAP} client and mark some | |
14907 | articles as read (or; SEEN) you might want to set this to @samp{1:*}. | |
14908 | Then all articles in the mailbox is fetched, no matter what. For a | |
14909 | complete list of predicates, see RFC 2060 section 6.4.4. | |
8ccbef23 | 14910 | |
8a1cdce5 AC |
14911 | @item :fetchflag |
14912 | How to flag fetched articles on the server, the default @samp{\Deleted} | |
14913 | will mark them as deleted, an alternative would be @samp{\Seen} which | |
14914 | would simply mark them as read. These are the two most likely choices, | |
14915 | but more flags are defined in RFC 2060 section 2.3.2. | |
8ccbef23 | 14916 | |
8a1cdce5 AC |
14917 | @item :dontexpunge |
14918 | If non-@code{nil}, don't remove all articles marked as deleted in the | |
14919 | mailbox after finishing the fetch. | |
8ccbef23 | 14920 | |
8a1cdce5 | 14921 | @end table |
8ccbef23 | 14922 | |
8a1cdce5 | 14923 | An example @acronym{IMAP} mail source: |
181cb5fb | 14924 | |
8a1cdce5 AC |
14925 | @lisp |
14926 | (imap :server "mail.mycorp.com" | |
14927 | :stream kerberos4 | |
14928 | :fetchflag "\\Seen") | |
14929 | @end lisp | |
8ccbef23 | 14930 | |
8a1cdce5 AC |
14931 | @item group |
14932 | Get the actual mail source from the @code{mail-source} group parameter, | |
14933 | @xref{Group Parameters}. | |
229b59da | 14934 | |
8ccbef23 G |
14935 | @end table |
14936 | ||
8a1cdce5 AC |
14937 | @table @dfn |
14938 | @item Common Keywords | |
14939 | Common keywords can be used in any type of mail source. | |
8ccbef23 | 14940 | |
8a1cdce5 | 14941 | Keywords: |
8ccbef23 G |
14942 | |
14943 | @table @code | |
8a1cdce5 AC |
14944 | @item :plugged |
14945 | If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you | |
14946 | use directory source to get mail, you can specify it as in this | |
14947 | example: | |
8ccbef23 | 14948 | |
8a1cdce5 AC |
14949 | @lisp |
14950 | (setq mail-sources | |
14951 | '((directory :path "/home/pavel/.Spool/" | |
14952 | :suffix "" | |
14953 | :plugged t))) | |
14954 | @end lisp | |
6b958814 | 14955 | |
8a1cdce5 AC |
14956 | Gnus will then fetch your mail even when you are unplugged. This is |
14957 | useful when you use local mail and news. | |
99e65b2d | 14958 | |
8a1cdce5 | 14959 | @end table |
8ccbef23 G |
14960 | @end table |
14961 | ||
8a1cdce5 | 14962 | @subsubsection Function Interface |
8ccbef23 | 14963 | |
8a1cdce5 AC |
14964 | Some of the above keywords specify a Lisp function to be executed. |
14965 | For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to | |
14966 | the value of the keyword while the function is executing. For example, | |
14967 | consider the following mail-source setting: | |
4009494e | 14968 | |
8a1cdce5 AC |
14969 | @lisp |
14970 | (setq mail-sources '((pop :user "jrl" | |
14971 | :server "pophost" :function fetchfunc))) | |
14972 | @end lisp | |
4009494e | 14973 | |
8a1cdce5 AC |
14974 | While the function @code{fetchfunc} is executing, the symbol @code{user} |
14975 | is bound to @code{"jrl"}, and the symbol @code{server} is bound to | |
14976 | @code{"pophost"}. The symbols @code{port}, @code{password}, | |
14977 | @code{program}, @code{prescript}, @code{postscript}, @code{function}, | |
14978 | and @code{authentication} are also bound (to their default values). | |
4009494e | 14979 | |
8a1cdce5 | 14980 | See above for a list of keywords for each type of mail source. |
4009494e | 14981 | |
4009494e | 14982 | |
8a1cdce5 AC |
14983 | @node Mail Source Customization |
14984 | @subsubsection Mail Source Customization | |
4009494e | 14985 | |
8a1cdce5 AC |
14986 | The following is a list of variables that influence how the mail is |
14987 | fetched. You would normally not need to set or change any of these | |
14988 | variables. | |
4009494e | 14989 | |
8a1cdce5 AC |
14990 | @table @code |
14991 | @item mail-source-crash-box | |
14992 | @vindex mail-source-crash-box | |
14993 | File where mail will be stored while processing it. The default is@* | |
14994 | @file{~/.emacs-mail-crash-box}. | |
4009494e | 14995 | |
8a1cdce5 AC |
14996 | @cindex Incoming* |
14997 | @item mail-source-delete-incoming | |
14998 | @vindex mail-source-delete-incoming | |
14999 | If non-@code{nil}, delete incoming files after handling them. If | |
15000 | @code{t}, delete the files immediately, if @code{nil}, never delete any | |
15001 | files. If a positive number, delete files older than number of days | |
15002 | (the deletion will only happen when receiving new mail). You may also | |
15003 | set @code{mail-source-delete-incoming} to @code{nil} and call | |
15004 | @code{mail-source-delete-old-incoming} from a hook or interactively. | |
15005 | @code{mail-source-delete-incoming} defaults to @code{10} in alpha Gnusae | |
15006 | and @code{2} in released Gnusae. @xref{Gnus Development}. | |
4009494e | 15007 | |
8a1cdce5 AC |
15008 | @item mail-source-delete-old-incoming-confirm |
15009 | @vindex mail-source-delete-old-incoming-confirm | |
15010 | If non-@code{nil}, ask for confirmation before deleting old incoming | |
15011 | files. This variable only applies when | |
15012 | @code{mail-source-delete-incoming} is a positive number. | |
4009494e | 15013 | |
8a1cdce5 AC |
15014 | @item mail-source-ignore-errors |
15015 | @vindex mail-source-ignore-errors | |
15016 | If non-@code{nil}, ignore errors when reading mail from a mail source. | |
15017 | ||
15018 | @item mail-source-directory | |
15019 | @vindex mail-source-directory | |
15020 | Directory where incoming mail source files (if any) will be stored. The | |
15021 | default is @file{~/Mail/}. At present, the only thing this is used for | |
15022 | is to say where the incoming files will be stored if the variable | |
15023 | @code{mail-source-delete-incoming} is @code{nil} or a number. | |
4009494e | 15024 | |
8a1cdce5 AC |
15025 | @item mail-source-incoming-file-prefix |
15026 | @vindex mail-source-incoming-file-prefix | |
15027 | Prefix for file name for storing incoming mail. The default is | |
15028 | @file{Incoming}, in which case files will end up with names like | |
15029 | @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only | |
15030 | relevant if @code{mail-source-delete-incoming} is @code{nil} or a | |
15031 | number. | |
4009494e | 15032 | |
8a1cdce5 AC |
15033 | @item mail-source-default-file-modes |
15034 | @vindex mail-source-default-file-modes | |
8d80ef01 | 15035 | All new mail files will get this file mode. The default is @code{#o600}. |
4009494e | 15036 | |
8a1cdce5 AC |
15037 | @item mail-source-movemail-program |
15038 | @vindex mail-source-movemail-program | |
15039 | If non-@code{nil}, name of program for fetching new mail. If | |
15040 | @code{nil}, @code{movemail} in @var{exec-directory}. | |
4009494e | 15041 | |
8a1cdce5 | 15042 | @end table |
4009494e | 15043 | |
4009494e | 15044 | |
8a1cdce5 AC |
15045 | @node Fetching Mail |
15046 | @subsubsection Fetching Mail | |
4009494e | 15047 | |
8a1cdce5 AC |
15048 | @vindex mail-sources |
15049 | The way to actually tell Gnus where to get new mail from is to set | |
15050 | @code{mail-sources} to a list of mail source specifiers | |
15051 | (@pxref{Mail Source Specifiers}). | |
4009494e | 15052 | |
8a1cdce5 AC |
15053 | If this variable is @code{nil}, the mail back ends will never attempt to |
15054 | fetch mail by themselves. | |
4009494e | 15055 | |
8a1cdce5 AC |
15056 | If you want to fetch mail both from your local spool as well as a |
15057 | @acronym{POP} mail server, you'd say something like: | |
4009494e | 15058 | |
8a1cdce5 AC |
15059 | @lisp |
15060 | (setq mail-sources | |
15061 | '((file) | |
15062 | (pop :server "pop3.mail.server" | |
15063 | :password "secret"))) | |
15064 | @end lisp | |
4009494e | 15065 | |
8a1cdce5 | 15066 | Or, if you don't want to use any of the keyword defaults: |
4009494e GM |
15067 | |
15068 | @lisp | |
8a1cdce5 AC |
15069 | (setq mail-sources |
15070 | '((file :path "/var/spool/mail/user-name") | |
15071 | (pop :server "pop3.mail.server" | |
15072 | :user "user-name" | |
15073 | :port "pop3" | |
15074 | :password "secret"))) | |
4009494e GM |
15075 | @end lisp |
15076 | ||
4009494e | 15077 | |
8a1cdce5 AC |
15078 | When you use a mail back end, Gnus will slurp all your mail from your |
15079 | inbox and plonk it down in your home directory. Gnus doesn't move any | |
15080 | mail if you're not using a mail back end---you have to do a lot of magic | |
15081 | invocations first. At the time when you have finished drawing the | |
15082 | pentagram, lightened the candles, and sacrificed the goat, you really | |
15083 | shouldn't be too surprised when Gnus moves your mail. | |
4009494e | 15084 | |
4009494e | 15085 | |
4009494e | 15086 | |
8a1cdce5 AC |
15087 | @node Mail Back End Variables |
15088 | @subsection Mail Back End Variables | |
4009494e | 15089 | |
8a1cdce5 AC |
15090 | These variables are (for the most part) pertinent to all the various |
15091 | mail back ends. | |
4009494e | 15092 | |
8a1cdce5 AC |
15093 | @table @code |
15094 | @vindex nnmail-read-incoming-hook | |
15095 | @item nnmail-read-incoming-hook | |
15096 | The mail back ends all call this hook after reading new mail. You can | |
15097 | use this hook to notify any mail watch programs, if you want to. | |
4009494e | 15098 | |
8a1cdce5 AC |
15099 | @vindex nnmail-split-hook |
15100 | @item nnmail-split-hook | |
15101 | @findex gnus-article-decode-encoded-words | |
15102 | @cindex RFC 1522 decoding | |
15103 | @cindex RFC 2047 decoding | |
15104 | Hook run in the buffer where the mail headers of each message is kept | |
15105 | just before the splitting based on these headers is done. The hook is | |
15106 | free to modify the buffer contents in any way it sees fit---the buffer | |
15107 | is discarded after the splitting has been done, and no changes performed | |
15108 | in the buffer will show up in any files. | |
15109 | @code{gnus-article-decode-encoded-words} is one likely function to add | |
15110 | to this hook. | |
15111 | ||
15112 | @vindex nnmail-pre-get-new-mail-hook | |
15113 | @vindex nnmail-post-get-new-mail-hook | |
15114 | @item nnmail-pre-get-new-mail-hook | |
15115 | @itemx nnmail-post-get-new-mail-hook | |
15116 | These are two useful hooks executed when treating new incoming | |
15117 | mail---@code{nnmail-pre-get-new-mail-hook} (is called just before | |
15118 | starting to handle the new mail) and | |
15119 | @code{nnmail-post-get-new-mail-hook} (is called when the mail handling | |
15120 | is done). Here's and example of using these two hooks to change the | |
15121 | default file modes the new mail files get: | |
4009494e GM |
15122 | |
15123 | @lisp | |
8a1cdce5 | 15124 | (add-hook 'nnmail-pre-get-new-mail-hook |
8d80ef01 | 15125 | (lambda () (set-default-file-modes #o700))) |
8a1cdce5 AC |
15126 | |
15127 | (add-hook 'nnmail-post-get-new-mail-hook | |
8d80ef01 | 15128 | (lambda () (set-default-file-modes #o775))) |
4009494e GM |
15129 | @end lisp |
15130 | ||
8a1cdce5 AC |
15131 | @item nnmail-use-long-file-names |
15132 | @vindex nnmail-use-long-file-names | |
15133 | If non-@code{nil}, the mail back ends will use long file and directory | |
15134 | names. Groups like @samp{mail.misc} will end up in directories | |
15135 | (assuming use of @code{nnml} back end) or files (assuming use of | |
15136 | @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil}, | |
15137 | the same group will end up in @file{mail/misc}. | |
4009494e | 15138 | |
8a1cdce5 AC |
15139 | @item nnmail-delete-file-function |
15140 | @vindex nnmail-delete-file-function | |
15141 | @findex delete-file | |
15142 | Function called to delete files. It is @code{delete-file} by default. | |
4009494e | 15143 | |
8a1cdce5 AC |
15144 | @item nnmail-cache-accepted-message-ids |
15145 | @vindex nnmail-cache-accepted-message-ids | |
15146 | If non-@code{nil}, put the @code{Message-ID}s of articles imported into | |
15147 | the back end (via @code{Gcc}, for instance) into the mail duplication | |
15148 | discovery cache. The default is @code{nil}. | |
4009494e | 15149 | |
8a1cdce5 AC |
15150 | @item nnmail-cache-ignore-groups |
15151 | @vindex nnmail-cache-ignore-groups | |
15152 | This can be a regular expression or a list of regular expressions. | |
15153 | Group names that match any of the regular expressions will never be | |
15154 | recorded in the @code{Message-ID} cache. | |
4009494e | 15155 | |
8a1cdce5 AC |
15156 | This can be useful, for example, when using Fancy Splitting |
15157 | (@pxref{Fancy Mail Splitting}) together with the function | |
15158 | @code{nnmail-split-fancy-with-parent}. | |
4009494e | 15159 | |
8a1cdce5 | 15160 | @end table |
4009494e | 15161 | |
a3f57c41 | 15162 | |
8a1cdce5 AC |
15163 | @node Fancy Mail Splitting |
15164 | @subsection Fancy Mail Splitting | |
15165 | @cindex mail splitting | |
15166 | @cindex fancy mail splitting | |
15167 | ||
15168 | @vindex nnmail-split-fancy | |
15169 | @findex nnmail-split-fancy | |
15170 | If the rather simple, standard method for specifying how to split mail | |
15171 | doesn't allow you to do what you want, you can set | |
15172 | @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can | |
15173 | play with the @code{nnmail-split-fancy} variable. | |
15174 | ||
15175 | Let's look at an example value of this variable first: | |
15176 | ||
15177 | @lisp | |
15178 | ;; @r{Messages from the mailer daemon are not crossposted to any of} | |
15179 | ;; @r{the ordinary groups. Warnings are put in a separate group} | |
15180 | ;; @r{from real errors.} | |
15181 | (| ("from" mail (| ("subject" "warn.*" "mail.warning") | |
15182 | "mail.misc")) | |
15183 | ;; @r{Non-error messages are crossposted to all relevant} | |
15184 | ;; @r{groups, but we don't crosspost between the group for the} | |
15185 | ;; @r{(ding) list and the group for other (ding) related mail.} | |
15186 | (& (| (any "ding@@ifi\\.uio\\.no" "ding.list") | |
15187 | ("subject" "ding" "ding.misc")) | |
15188 | ;; @r{Other mailing lists@dots{}} | |
15189 | (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list") | |
15190 | (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list") | |
15191 | ;; @r{Both lists below have the same suffix, so prevent} | |
15192 | ;; @r{cross-posting to mkpkg.list of messages posted only to} | |
15193 | ;; @r{the bugs- list, but allow cross-posting when the} | |
15194 | ;; @r{message was really cross-posted.} | |
15195 | (any "bugs-mypackage@@somewhere" "mypkg.bugs") | |
15196 | (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list") | |
15197 | ;; @r{People@dots{}} | |
15198 | (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen")) | |
15199 | ;; @r{Unmatched mail goes to the catch all group.} | |
15200 | "misc.misc") | |
15201 | @end lisp | |
15202 | ||
15203 | This variable has the format of a @dfn{split}. A split is a | |
15204 | (possibly) recursive structure where each split may contain other | |
15205 | splits. Here are the possible split syntaxes: | |
4009494e | 15206 | |
8a1cdce5 | 15207 | @table @code |
4009494e | 15208 | |
8a1cdce5 AC |
15209 | @item group |
15210 | If the split is a string, that will be taken as a group name. Normal | |
15211 | regexp match expansion will be done. See below for examples. | |
4009494e | 15212 | |
8a1cdce5 AC |
15213 | @c Don't fold this line. |
15214 | @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}]) | |
15215 | The split can be a list containing at least three elements. If the | |
15216 | first element @var{field} (a regexp matching a header) contains | |
15217 | @var{value} (also a regexp) then store the message as specified by | |
15218 | @var{split}. | |
4009494e | 15219 | |
8a1cdce5 AC |
15220 | If @var{restrict} (yet another regexp) matches some string after |
15221 | @var{field} and before the end of the matched @var{value}, the | |
15222 | @var{split} is ignored. If none of the @var{restrict} clauses match, | |
15223 | @var{split} is processed. | |
4009494e | 15224 | |
8a1cdce5 AC |
15225 | The last element @var{invert-partial} is optional. If it is |
15226 | non-@code{nil}, the match-partial-words behavior controlled by the | |
15227 | variable @code{nnmail-split-fancy-match-partial-words} (see below) is | |
15228 | be inverted. (New in Gnus 5.10.7) | |
4009494e | 15229 | |
8a1cdce5 AC |
15230 | @item (| @var{split} @dots{}) |
15231 | If the split is a list, and the first element is @code{|} (vertical | |
15232 | bar), then process each @var{split} until one of them matches. A | |
15233 | @var{split} is said to match if it will cause the mail message to be | |
15234 | stored in one or more groups. | |
4009494e | 15235 | |
8a1cdce5 AC |
15236 | @item (& @var{split} @dots{}) |
15237 | If the split is a list, and the first element is @code{&}, then | |
15238 | process all @var{split}s in the list. | |
4009494e | 15239 | |
8a1cdce5 AC |
15240 | @item junk |
15241 | If the split is the symbol @code{junk}, then don't save (i.e., delete) | |
15242 | this message. Use with extreme caution. | |
4009494e | 15243 | |
8a1cdce5 AC |
15244 | @item (: @var{function} @var{arg1} @var{arg2} @dots{}) |
15245 | If the split is a list, and the first element is @samp{:}, then the | |
15246 | second element will be called as a function with @var{args} given as | |
15247 | arguments. The function should return a @var{split}. | |
4009494e | 15248 | |
8a1cdce5 AC |
15249 | @cindex body split |
15250 | For instance, the following function could be used to split based on the | |
15251 | body of the messages: | |
4009494e | 15252 | |
8a1cdce5 AC |
15253 | @lisp |
15254 | (defun split-on-body () | |
15255 | (save-excursion | |
15256 | (save-restriction | |
15257 | (widen) | |
15258 | (goto-char (point-min)) | |
15259 | (when (re-search-forward "Some.*string" nil t) | |
15260 | "string.group")))) | |
15261 | @end lisp | |
4009494e | 15262 | |
8a1cdce5 AC |
15263 | The buffer is narrowed to the header of the message in question when |
15264 | @var{function} is run. That's why @code{(widen)} needs to be called | |
15265 | after @code{save-excursion} and @code{save-restriction} in the example | |
15266 | above. Also note that with the nnimap backend, message bodies will | |
15267 | not be downloaded by default. You need to set | |
15268 | @code{nnimap-split-download-body} to @code{t} to do that | |
15269 | (@pxref{Client-Side IMAP Splitting}). | |
4009494e | 15270 | |
8a1cdce5 AC |
15271 | @item (! @var{func} @var{split}) |
15272 | If the split is a list, and the first element is @code{!}, then | |
15273 | @var{split} will be processed, and @var{func} will be called as a | |
15274 | function with the result of @var{split} as argument. @var{func} | |
15275 | should return a split. | |
4009494e | 15276 | |
8a1cdce5 AC |
15277 | @item nil |
15278 | If the split is @code{nil}, it is ignored. | |
4009494e | 15279 | |
8a1cdce5 | 15280 | @end table |
4009494e | 15281 | |
8a1cdce5 | 15282 | In these splits, @var{field} must match a complete field name. |
4009494e | 15283 | |
8a1cdce5 AC |
15284 | Normally, @var{value} in these splits must match a complete @emph{word} |
15285 | according to the fundamental mode syntax table. In other words, all | |
15286 | @var{value}'s will be implicitly surrounded by @code{\<...\>} markers, | |
15287 | which are word delimiters. Therefore, if you use the following split, | |
15288 | for example, | |
4009494e | 15289 | |
8a1cdce5 AC |
15290 | @example |
15291 | (any "joe" "joemail") | |
15292 | @end example | |
a1da1e37 | 15293 | |
8a1cdce5 AC |
15294 | @noindent |
15295 | messages sent from @samp{joedavis@@foo.org} will normally not be filed | |
15296 | in @samp{joemail}. If you want to alter this behavior, you can use any | |
15297 | of the following three ways: | |
a1da1e37 | 15298 | |
8a1cdce5 AC |
15299 | @enumerate |
15300 | @item | |
15301 | @vindex nnmail-split-fancy-match-partial-words | |
15302 | You can set the @code{nnmail-split-fancy-match-partial-words} variable | |
15303 | to non-@code{nil} in order to ignore word boundaries and instead the | |
15304 | match becomes more like a grep. This variable controls whether partial | |
15305 | words are matched during fancy splitting. The default value is | |
15306 | @code{nil}. | |
a1da1e37 | 15307 | |
8a1cdce5 | 15308 | Note that it influences all @var{value}'s in your split rules. |
4009494e | 15309 | |
8a1cdce5 AC |
15310 | @item |
15311 | @var{value} beginning with @code{.*} ignores word boundaries in front of | |
15312 | a word. Similarly, if @var{value} ends with @code{.*}, word boundaries | |
15313 | in the rear of a word will be ignored. For example, the @var{value} | |
15314 | @code{"@@example\\.com"} does not match @samp{foo@@example.com} but | |
15315 | @code{".*@@example\\.com"} does. | |
4009494e | 15316 | |
8a1cdce5 AC |
15317 | @item |
15318 | You can set the @var{invert-partial} flag in your split rules of the | |
15319 | @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this | |
15320 | section. If the flag is set, word boundaries on both sides of a word | |
15321 | are ignored even if @code{nnmail-split-fancy-match-partial-words} is | |
15322 | @code{nil}. Contrarily, if the flag is set, word boundaries are not | |
15323 | ignored even if @code{nnmail-split-fancy-match-partial-words} is | |
15324 | non-@code{nil}. (New in Gnus 5.10.7) | |
15325 | @end enumerate | |
4009494e | 15326 | |
8a1cdce5 AC |
15327 | @vindex nnmail-split-abbrev-alist |
15328 | @var{field} and @var{value} can also be Lisp symbols, in that case | |
15329 | they are expanded as specified by the variable | |
15330 | @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, | |
15331 | where the @sc{car} of a cell contains the key, and the @sc{cdr} | |
15332 | contains the associated value. Predefined entries in | |
15333 | @code{nnmail-split-abbrev-alist} include: | |
4009494e | 15334 | |
8a1cdce5 AC |
15335 | @table @code |
15336 | @item from | |
15337 | Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields. | |
15338 | @item to | |
15339 | Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To}, | |
15340 | @samp{Resent-To} and @samp{Resent-Cc} fields. | |
15341 | @item any | |
15342 | Is the union of the @code{from} and @code{to} entries. | |
4009494e GM |
15343 | @end table |
15344 | ||
8a1cdce5 AC |
15345 | @vindex nnmail-split-fancy-syntax-table |
15346 | @code{nnmail-split-fancy-syntax-table} is the syntax table in effect | |
15347 | when all this splitting is performed. | |
4009494e | 15348 | |
8a1cdce5 AC |
15349 | If you want to have Gnus create groups dynamically based on some |
15350 | information in the headers (i.e., do @code{replace-match}-like | |
15351 | substitutions in the group names), you can say things like: | |
4009494e | 15352 | |
8a1cdce5 AC |
15353 | @example |
15354 | (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1") | |
15355 | @end example | |
4009494e | 15356 | |
8a1cdce5 AC |
15357 | In this example, messages sent to @samp{debian-foo@@lists.debian.org} |
15358 | will be filed in @samp{mail.debian.foo}. | |
4009494e | 15359 | |
8a1cdce5 AC |
15360 | If the string contains the element @samp{\&}, then the previously |
15361 | matched string will be substituted. Similarly, the elements @samp{\\1} | |
15362 | up to @samp{\\9} will be substituted with the text matched by the | |
15363 | groupings 1 through 9. | |
4009494e | 15364 | |
8a1cdce5 AC |
15365 | @vindex nnmail-split-lowercase-expanded |
15366 | Where @code{nnmail-split-lowercase-expanded} controls whether the | |
15367 | lowercase of the matched string should be used for the substitution. | |
15368 | Setting it as non-@code{nil} is useful to avoid the creation of multiple | |
15369 | groups when users send to an address using different case | |
1df7defd | 15370 | (i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value |
8a1cdce5 AC |
15371 | is @code{t}. |
15372 | ||
15373 | @findex nnmail-split-fancy-with-parent | |
15374 | @code{nnmail-split-fancy-with-parent} is a function which allows you to | |
15375 | split followups into the same groups their parents are in. Sometimes | |
15376 | you can't make splitting rules for all your mail. For example, your | |
15377 | boss might send you personal mail regarding different projects you are | |
15378 | working on, and as you can't tell your boss to put a distinguishing | |
15379 | string into the subject line, you have to resort to manually moving the | |
15380 | messages into the right group. With this function, you only have to do | |
15381 | it once per thread. | |
4009494e | 15382 | |
8a1cdce5 AC |
15383 | To use this feature, you have to set @code{nnmail-treat-duplicates} |
15384 | and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil} | |
15385 | value. And then you can include @code{nnmail-split-fancy-with-parent} | |
15386 | using the colon feature, like so: | |
4009494e | 15387 | @lisp |
8a1cdce5 AC |
15388 | (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}} |
15389 | nnmail-cache-accepted-message-ids t | |
15390 | nnmail-split-fancy | |
15391 | '(| (: nnmail-split-fancy-with-parent) | |
15392 | ;; @r{other splits go here} | |
15393 | )) | |
4009494e GM |
15394 | @end lisp |
15395 | ||
8a1cdce5 AC |
15396 | This feature works as follows: when @code{nnmail-treat-duplicates} is |
15397 | non-@code{nil}, Gnus records the message id of every message it sees | |
15398 | in the file specified by the variable | |
15399 | @code{nnmail-message-id-cache-file}, together with the group it is in | |
15400 | (the group is omitted for non-mail messages). When mail splitting is | |
15401 | invoked, the function @code{nnmail-split-fancy-with-parent} then looks | |
15402 | at the References (and In-Reply-To) header of each message to split | |
15403 | and searches the file specified by @code{nnmail-message-id-cache-file} | |
15404 | for the message ids. When it has found a parent, it returns the | |
15405 | corresponding group name unless the group name matches the regexp | |
15406 | @code{nnmail-split-fancy-with-parent-ignore-groups}. It is | |
15407 | recommended that you set @code{nnmail-message-id-cache-length} to a | |
15408 | somewhat higher number than the default so that the message ids are | |
15409 | still in the cache. (A value of 5000 appears to create a file some | |
15410 | 300 kBytes in size.) | |
15411 | @vindex nnmail-cache-accepted-message-ids | |
15412 | When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus | |
15413 | also records the message ids of moved articles, so that the followup | |
15414 | messages goes into the new group. | |
4009494e | 15415 | |
8a1cdce5 AC |
15416 | Also see the variable @code{nnmail-cache-ignore-groups} if you don't |
15417 | want certain groups to be recorded in the cache. For example, if all | |
15418 | outgoing messages are written to an ``outgoing'' group, you could set | |
15419 | @code{nnmail-cache-ignore-groups} to match that group name. | |
15420 | Otherwise, answers to all your messages would end up in the | |
15421 | ``outgoing'' group. | |
4009494e GM |
15422 | |
15423 | ||
8a1cdce5 AC |
15424 | @node Group Mail Splitting |
15425 | @subsection Group Mail Splitting | |
15426 | @cindex mail splitting | |
15427 | @cindex group mail splitting | |
4009494e | 15428 | |
8a1cdce5 AC |
15429 | @findex gnus-group-split |
15430 | If you subscribe to dozens of mailing lists but you don't want to | |
15431 | maintain mail splitting rules manually, group mail splitting is for you. | |
15432 | You just have to set @code{to-list} and/or @code{to-address} in group | |
15433 | parameters or group customization and set @code{nnmail-split-methods} to | |
15434 | @code{gnus-group-split}. This splitting function will scan all groups | |
15435 | for those parameters and split mail accordingly, i.e., messages posted | |
15436 | from or to the addresses specified in the parameters @code{to-list} or | |
15437 | @code{to-address} of a mail group will be stored in that group. | |
4009494e | 15438 | |
8a1cdce5 AC |
15439 | Sometimes, mailing lists have multiple addresses, and you may want mail |
15440 | splitting to recognize them all: just set the @code{extra-aliases} group | |
15441 | parameter to the list of additional addresses and it's done. If you'd | |
15442 | rather use a regular expression, set @code{split-regexp}. | |
4009494e | 15443 | |
8a1cdce5 AC |
15444 | All these parameters in a group will be used to create an |
15445 | @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any}, | |
15446 | the @var{value} is a single regular expression that matches | |
15447 | @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all | |
15448 | matches of @code{split-regexp}, and the @var{split} is the name of the | |
15449 | group. @var{restrict}s are also supported: just set the | |
15450 | @code{split-exclude} parameter to a list of regular expressions. | |
4009494e | 15451 | |
8a1cdce5 AC |
15452 | If you can't get the right split to be generated using all these |
15453 | parameters, or you just need something fancier, you can set the | |
15454 | parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In | |
15455 | this case, all other aforementioned parameters will be ignored by | |
15456 | @code{gnus-group-split}. In particular, @code{split-spec} may be set to | |
15457 | @code{nil}, in which case the group will be ignored by | |
15458 | @code{gnus-group-split}. | |
4009494e | 15459 | |
8a1cdce5 AC |
15460 | @vindex gnus-group-split-default-catch-all-group |
15461 | @code{gnus-group-split} will do cross-posting on all groups that match, | |
15462 | by defining a single @code{&} fancy split containing one split for each | |
15463 | group. If a message doesn't match any split, it will be stored in the | |
15464 | group named in @code{gnus-group-split-default-catch-all-group}, unless | |
15465 | some group has @code{split-spec} set to @code{catch-all}, in which case | |
15466 | that group is used as the catch-all group. Even though this variable is | |
15467 | often used just to name a group, it may also be set to an arbitrarily | |
15468 | complex fancy split (after all, a group name is a fancy split), and this | |
15469 | may be useful to split mail that doesn't go to any mailing list to | |
15470 | personal mail folders. Note that this fancy split is added as the last | |
15471 | element of a @code{|} split list that also contains a @code{&} split | |
15472 | with the rules extracted from group parameters. | |
4009494e | 15473 | |
8a1cdce5 AC |
15474 | It's time for an example. Assume the following group parameters have |
15475 | been defined: | |
4009494e | 15476 | |
8a1cdce5 AC |
15477 | @example |
15478 | nnml:mail.bar: | |
15479 | ((to-address . "bar@@femail.com") | |
15480 | (split-regexp . ".*@@femail\\.com")) | |
15481 | nnml:mail.foo: | |
15482 | ((to-list . "foo@@nowhere.gov") | |
15483 | (extra-aliases "foo@@localhost" "foo-redist@@home") | |
15484 | (split-exclude "bugs-foo" "rambling-foo") | |
15485 | (admin-address . "foo-request@@nowhere.gov")) | |
15486 | nnml:mail.others: | |
15487 | ((split-spec . catch-all)) | |
15488 | @end example | |
4009494e | 15489 | |
8a1cdce5 AC |
15490 | Setting @code{nnmail-split-methods} to @code{gnus-group-split} will |
15491 | behave as if @code{nnmail-split-fancy} had been selected and variable | |
15492 | @code{nnmail-split-fancy} had been set as follows: | |
4009494e GM |
15493 | |
15494 | @lisp | |
8a1cdce5 AC |
15495 | (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar") |
15496 | (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)" | |
15497 | - "bugs-foo" - "rambling-foo" "mail.foo")) | |
15498 | "mail.others") | |
4009494e GM |
15499 | @end lisp |
15500 | ||
8a1cdce5 AC |
15501 | @findex gnus-group-split-fancy |
15502 | If you'd rather not use group splitting for all your mail groups, you | |
15503 | may use it for only some of them, by using @code{nnmail-split-fancy} | |
15504 | splits like this: | |
4009494e | 15505 | |
8a1cdce5 AC |
15506 | @lisp |
15507 | (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all}) | |
15508 | @end lisp | |
4009494e | 15509 | |
8a1cdce5 AC |
15510 | @var{groups} may be a regular expression or a list of group names whose |
15511 | parameters will be scanned to generate the output split. | |
15512 | @var{no-crosspost} can be used to disable cross-posting; in this case, a | |
15513 | single @code{|} split will be output. @var{catch-all} is the fall back | |
15514 | fancy split, used like @code{gnus-group-split-default-catch-all-group}. | |
15515 | If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the | |
15516 | empty string in any selected group, no catch-all split will be issued. | |
15517 | Otherwise, if some group has @code{split-spec} set to @code{catch-all}, | |
15518 | this group will override the value of the @var{catch-all} argument. | |
4009494e | 15519 | |
8a1cdce5 AC |
15520 | @findex gnus-group-split-setup |
15521 | Unfortunately, scanning all groups and their parameters can be quite | |
15522 | slow, especially considering that it has to be done for every message. | |
15523 | But don't despair! The function @code{gnus-group-split-setup} can be | |
15524 | used to enable @code{gnus-group-split} in a much more efficient way. It | |
15525 | sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets | |
15526 | @code{nnmail-split-fancy} to the split produced by | |
15527 | @code{gnus-group-split-fancy}. Thus, the group parameters are only | |
15528 | scanned once, no matter how many messages are split. | |
4009494e | 15529 | |
8a1cdce5 AC |
15530 | @findex gnus-group-split-update |
15531 | However, if you change group parameters, you'd have to update | |
15532 | @code{nnmail-split-fancy} manually. You can do it by running | |
15533 | @code{gnus-group-split-update}. If you'd rather have it updated | |
15534 | automatically, just tell @code{gnus-group-split-setup} to do it for | |
15535 | you. For example, add to your @file{~/.gnus.el}: | |
4009494e | 15536 | |
8a1cdce5 AC |
15537 | @lisp |
15538 | (gnus-group-split-setup @var{auto-update} @var{catch-all}) | |
15539 | @end lisp | |
4009494e | 15540 | |
8a1cdce5 AC |
15541 | If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update} |
15542 | will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever | |
15543 | have to worry about updating @code{nnmail-split-fancy} again. If you | |
15544 | don't omit @var{catch-all} (it's optional, equivalent to @code{nil}), | |
15545 | @code{gnus-group-split-default-catch-all-group} will be set to its | |
15546 | value. | |
4009494e | 15547 | |
8a1cdce5 AC |
15548 | @vindex gnus-group-split-updated-hook |
15549 | Because you may want to change @code{nnmail-split-fancy} after it is set | |
15550 | by @code{gnus-group-split-update}, this function will run | |
15551 | @code{gnus-group-split-updated-hook} just before finishing. | |
4009494e | 15552 | |
8a1cdce5 AC |
15553 | @node Incorporating Old Mail |
15554 | @subsection Incorporating Old Mail | |
15555 | @cindex incorporating old mail | |
15556 | @cindex import old mail | |
4009494e | 15557 | |
8a1cdce5 AC |
15558 | Most people have lots of old mail stored in various file formats. If |
15559 | you have set up Gnus to read mail using one of the spiffy Gnus mail | |
15560 | back ends, you'll probably wish to have that old mail incorporated into | |
15561 | your mail groups. | |
4009494e | 15562 | |
8a1cdce5 | 15563 | Doing so can be quite easy. |
4009494e | 15564 | |
8a1cdce5 AC |
15565 | To take an example: You're reading mail using @code{nnml} |
15566 | (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a | |
15567 | satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox | |
15568 | file filled with important, but old, mail. You want to move it into | |
15569 | your @code{nnml} groups. | |
4009494e | 15570 | |
8a1cdce5 | 15571 | Here's how: |
4009494e | 15572 | |
8a1cdce5 AC |
15573 | @enumerate |
15574 | @item | |
15575 | Go to the group buffer. | |
4009494e | 15576 | |
8a1cdce5 AC |
15577 | @item |
15578 | Type @kbd{G f} and give the file name to the mbox file when prompted to create an | |
15579 | @code{nndoc} group from the mbox file (@pxref{Foreign Groups}). | |
4009494e | 15580 | |
8a1cdce5 AC |
15581 | @item |
15582 | Type @kbd{SPACE} to enter the newly created group. | |
4009494e | 15583 | |
8a1cdce5 AC |
15584 | @item |
15585 | Type @kbd{M P b} to process-mark all articles in this group's buffer | |
15586 | (@pxref{Setting Process Marks}). | |
4009494e | 15587 | |
8a1cdce5 AC |
15588 | @item |
15589 | Type @kbd{B r} to respool all the process-marked articles, and answer | |
15590 | @samp{nnml} when prompted (@pxref{Mail Group Commands}). | |
15591 | @end enumerate | |
4009494e | 15592 | |
8a1cdce5 AC |
15593 | All the mail messages in the mbox file will now also be spread out over |
15594 | all your @code{nnml} groups. Try entering them and check whether things | |
15595 | have gone without a glitch. If things look ok, you may consider | |
15596 | deleting the mbox file, but I wouldn't do that unless I was absolutely | |
15597 | sure that all the mail has ended up where it should be. | |
4009494e | 15598 | |
8a1cdce5 AC |
15599 | Respooling is also a handy thing to do if you're switching from one mail |
15600 | back end to another. Just respool all the mail in the old mail groups | |
15601 | using the new mail back end. | |
4009494e | 15602 | |
4009494e | 15603 | |
8a1cdce5 AC |
15604 | @node Expiring Mail |
15605 | @subsection Expiring Mail | |
15606 | @cindex article expiry | |
15607 | @cindex expiring mail | |
4009494e | 15608 | |
8a1cdce5 AC |
15609 | Traditional mail readers have a tendency to remove mail articles when |
15610 | you mark them as read, in some way. Gnus takes a fundamentally | |
15611 | different approach to mail reading. | |
4009494e | 15612 | |
8a1cdce5 AC |
15613 | Gnus basically considers mail just to be news that has been received in |
15614 | a rather peculiar manner. It does not think that it has the power to | |
15615 | actually change the mail, or delete any mail messages. If you enter a | |
15616 | mail group, and mark articles as ``read'', or kill them in some other | |
15617 | fashion, the mail articles will still exist on the system. I repeat: | |
15618 | Gnus will not delete your old, read mail. Unless you ask it to, of | |
15619 | course. | |
4009494e | 15620 | |
8a1cdce5 AC |
15621 | To make Gnus get rid of your unwanted mail, you have to mark the |
15622 | articles as @dfn{expirable}. (With the default key bindings, this means | |
15623 | that you have to type @kbd{E}.) This does not mean that the articles | |
15624 | will disappear right away, however. In general, a mail article will be | |
15625 | deleted from your system if, 1) it is marked as expirable, AND 2) it is | |
15626 | more than one week old. If you do not mark an article as expirable, it | |
15627 | will remain on your system until hell freezes over. This bears | |
15628 | repeating one more time, with some spurious capitalizations: IF you do | |
15629 | NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES. | |
4009494e | 15630 | |
d30dd079 | 15631 | @vindex gnus-auto-expirable-marks |
8a1cdce5 AC |
15632 | You do not have to mark articles as expirable by hand. Gnus provides |
15633 | two features, called ``auto-expire'' and ``total-expire'', that can help you | |
15634 | with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E} | |
15635 | for you when you select an article. And ``total-expire'' means that Gnus | |
15636 | considers all articles as expirable that are read. So, in addition to | |
15637 | the articles marked @samp{E}, also the articles marked @samp{r}, | |
d30dd079 G |
15638 | @samp{R}, @samp{O}, @samp{K}, @samp{Y} (and so on) are considered |
15639 | expirable. @code{gnus-auto-expirable-marks} has the full list of | |
15640 | these marks. | |
4009494e | 15641 | |
8a1cdce5 AC |
15642 | When should either auto-expire or total-expire be used? Most people |
15643 | who are subscribed to mailing lists split each list into its own group | |
15644 | and then turn on auto-expire or total-expire for those groups. | |
15645 | (@xref{Splitting Mail}, for more information on splitting each list | |
15646 | into its own group.) | |
4009494e | 15647 | |
8a1cdce5 AC |
15648 | Which one is better, auto-expire or total-expire? It's not easy to |
15649 | answer. Generally speaking, auto-expire is probably faster. Another | |
15650 | advantage of auto-expire is that you get more marks to work with: for | |
15651 | the articles that are supposed to stick around, you can still choose | |
15652 | between tick and dormant and read marks. But with total-expire, you | |
15653 | only have dormant and ticked to choose from. The advantage of | |
15654 | total-expire is that it works well with adaptive scoring (@pxref{Adaptive | |
15655 | Scoring}). Auto-expire works with normal scoring but not with adaptive | |
15656 | scoring. | |
4009494e | 15657 | |
8a1cdce5 AC |
15658 | @vindex gnus-auto-expirable-newsgroups |
15659 | Groups that match the regular expression | |
15660 | @code{gnus-auto-expirable-newsgroups} will have all articles that you | |
15661 | read marked as expirable automatically. All articles marked as | |
15662 | expirable have an @samp{E} in the first column in the summary buffer. | |
4009494e | 15663 | |
8a1cdce5 AC |
15664 | By default, if you have auto expiry switched on, Gnus will mark all the |
15665 | articles you read as expirable, no matter if they were read or unread | |
15666 | before. To avoid having articles marked as read marked as expirable | |
15667 | automatically, you can put something like the following in your | |
15668 | @file{~/.gnus.el} file: | |
4009494e | 15669 | |
8a1cdce5 | 15670 | @vindex gnus-mark-article-hook |
4009494e | 15671 | @lisp |
8a1cdce5 AC |
15672 | (remove-hook 'gnus-mark-article-hook |
15673 | 'gnus-summary-mark-read-and-unread-as-read) | |
15674 | (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read) | |
4009494e GM |
15675 | @end lisp |
15676 | ||
8a1cdce5 AC |
15677 | Note that making a group auto-expirable doesn't mean that all read |
15678 | articles are expired---only the articles marked as expirable | |
15679 | will be expired. Also note that using the @kbd{d} command won't make | |
15680 | articles expirable---only semi-automatic marking of articles as read will | |
15681 | mark the articles as expirable in auto-expirable groups. | |
15682 | ||
15683 | Let's say you subscribe to a couple of mailing lists, and you want the | |
15684 | articles you have read to disappear after a while: | |
15685 | ||
4009494e | 15686 | @lisp |
8a1cdce5 AC |
15687 | (setq gnus-auto-expirable-newsgroups |
15688 | "mail.nonsense-list\\|mail.nice-list") | |
4009494e GM |
15689 | @end lisp |
15690 | ||
8a1cdce5 AC |
15691 | Another way to have auto-expiry happen is to have the element |
15692 | @code{auto-expire} in the group parameters of the group. | |
4009494e | 15693 | |
8a1cdce5 AC |
15694 | If you use adaptive scoring (@pxref{Adaptive Scoring}) and |
15695 | auto-expiring, you'll have problems. Auto-expiring and adaptive scoring | |
15696 | don't really mix very well. | |
4009494e | 15697 | |
8a1cdce5 AC |
15698 | @vindex nnmail-expiry-wait |
15699 | The @code{nnmail-expiry-wait} variable supplies the default time an | |
15700 | expirable article has to live. Gnus starts counting days from when the | |
15701 | message @emph{arrived}, not from when it was sent. The default is seven | |
15702 | days. | |
4009494e | 15703 | |
8a1cdce5 AC |
15704 | Gnus also supplies a function that lets you fine-tune how long articles |
15705 | are to live, based on what group they are in. Let's say you want to | |
15706 | have one month expiry period in the @samp{mail.private} group, a one day | |
15707 | expiry period in the @samp{mail.junk} group, and a six day expiry period | |
15708 | everywhere else: | |
4009494e | 15709 | |
8a1cdce5 AC |
15710 | @vindex nnmail-expiry-wait-function |
15711 | @lisp | |
15712 | (setq nnmail-expiry-wait-function | |
15713 | (lambda (group) | |
15714 | (cond ((string= group "mail.private") | |
15715 | 31) | |
15716 | ((string= group "mail.junk") | |
15717 | 1) | |
15718 | ((string= group "important") | |
15719 | 'never) | |
15720 | (t | |
15721 | 6)))) | |
15722 | @end lisp | |
4009494e | 15723 | |
8a1cdce5 AC |
15724 | The group names this function is fed are ``unadorned'' group |
15725 | names---no @samp{nnml:} prefixes and the like. | |
4009494e | 15726 | |
8a1cdce5 AC |
15727 | The @code{nnmail-expiry-wait} variable and |
15728 | @code{nnmail-expiry-wait-function} function can either be a number (not | |
15729 | necessarily an integer) or one of the symbols @code{immediate} or | |
15730 | @code{never}. | |
4009494e | 15731 | |
8a1cdce5 AC |
15732 | You can also use the @code{expiry-wait} group parameter to selectively |
15733 | change the expiry period (@pxref{Group Parameters}). | |
4009494e | 15734 | |
8a1cdce5 AC |
15735 | @vindex nnmail-expiry-target |
15736 | The normal action taken when expiring articles is to delete them. | |
15737 | However, in some circumstances it might make more sense to move them | |
15738 | to other groups instead of deleting them. The variable | |
15739 | @code{nnmail-expiry-target} (and the @code{expiry-target} group | |
15740 | parameter) controls this. The variable supplies a default value for | |
15741 | all groups, which can be overridden for specific groups by the group | |
15742 | parameter. default value is @code{delete}, but this can also be a | |
15743 | string (which should be the name of the group the message should be | |
15744 | moved to), or a function (which will be called in a buffer narrowed to | |
15745 | the message in question, and with the name of the group being moved | |
15746 | from as its parameter) which should return a target---either a group | |
15747 | name or @code{delete}. | |
15748 | ||
15749 | Here's an example for specifying a group name: | |
15750 | @lisp | |
15751 | (setq nnmail-expiry-target "nnml:expired") | |
15752 | @end lisp | |
15753 | ||
15754 | @findex nnmail-fancy-expiry-target | |
15755 | @vindex nnmail-fancy-expiry-targets | |
15756 | Gnus provides a function @code{nnmail-fancy-expiry-target} which will | |
15757 | expire mail to groups according to the variable | |
15758 | @code{nnmail-fancy-expiry-targets}. Here's an example: | |
4009494e | 15759 | |
8a1cdce5 AC |
15760 | @lisp |
15761 | (setq nnmail-expiry-target 'nnmail-fancy-expiry-target | |
15762 | nnmail-fancy-expiry-targets | |
15763 | '((to-from "boss" "nnfolder:Work") | |
15764 | ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b") | |
15765 | ("from" ".*" "nnfolder:Archive-%Y"))) | |
15766 | @end lisp | |
4009494e | 15767 | |
8a1cdce5 AC |
15768 | With this setup, any mail that has @code{IMPORTANT} in its Subject |
15769 | header and was sent in the year @code{YYYY} and month @code{MMM}, will | |
15770 | get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its | |
15771 | From or To header contains the string @code{boss}, it will get expired | |
15772 | to @code{nnfolder:Work}. All other mail will get expired to | |
15773 | @code{nnfolder:Archive-YYYY}. | |
4009494e | 15774 | |
8a1cdce5 AC |
15775 | @vindex nnmail-keep-last-article |
15776 | If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never | |
15777 | expire the final article in a mail newsgroup. This is to make life | |
15778 | easier for procmail users. | |
4009494e | 15779 | |
8a1cdce5 AC |
15780 | @vindex gnus-total-expirable-newsgroups |
15781 | By the way: That line up there, about Gnus never expiring non-expirable | |
15782 | articles, is a lie. If you put @code{total-expire} in the group | |
15783 | parameters, articles will not be marked as expirable, but all read | |
15784 | articles will be put through the expiry process. Use with extreme | |
15785 | caution. Even more dangerous is the | |
15786 | @code{gnus-total-expirable-newsgroups} variable. All groups that match | |
15787 | this regexp will have all read articles put through the expiry process, | |
15788 | which means that @emph{all} old mail articles in the groups in question | |
15789 | will be deleted after a while. Use with extreme caution, and don't come | |
15790 | crying to me when you discover that the regexp you used matched the | |
15791 | wrong group and all your important mail has disappeared. Be a | |
15792 | @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable | |
15793 | with! So there! | |
4009494e | 15794 | |
8a1cdce5 | 15795 | Most people make most of their mail groups total-expirable, though. |
4009494e | 15796 | |
8a1cdce5 AC |
15797 | @vindex gnus-inhibit-user-auto-expire |
15798 | If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking | |
15799 | commands will not mark an article as expirable, even if the group has | |
15800 | auto-expire turned on. | |
4009494e | 15801 | |
8a1cdce5 AC |
15802 | @vindex gnus-mark-copied-or-moved-articles-as-expirable |
15803 | The expirable marks of articles will be removed when copying or moving | |
15804 | them to a group in which auto-expire is not turned on. This is for | |
15805 | preventing articles from being expired unintentionally. On the other | |
15806 | hand, to a group that has turned auto-expire on, the expirable marks of | |
15807 | articles that are copied or moved will not be changed by default. I.e., | |
15808 | when copying or moving to such a group, articles that were expirable | |
15809 | will be left expirable and ones that were not expirable will not be | |
15810 | marked as expirable. So, even though in auto-expire groups, some | |
15811 | articles will never get expired (unless you read them again). If you | |
15812 | don't side with that behavior that unexpirable articles may be mixed | |
15813 | into auto-expire groups, you can set | |
15814 | @code{gnus-mark-copied-or-moved-articles-as-expirable} to a | |
15815 | non-@code{nil} value. In that case, articles that have been read will | |
15816 | be marked as expirable automatically when being copied or moved to a | |
15817 | group that has auto-expire turned on. The default value is @code{nil}. | |
4009494e | 15818 | |
4009494e | 15819 | |
8a1cdce5 AC |
15820 | @node Washing Mail |
15821 | @subsection Washing Mail | |
15822 | @cindex mail washing | |
15823 | @cindex list server brain damage | |
15824 | @cindex incoming mail treatment | |
4009494e | 15825 | |
8a1cdce5 AC |
15826 | Mailers and list servers are notorious for doing all sorts of really, |
15827 | really stupid things with mail. ``Hey, RFC 822 doesn't explicitly | |
15828 | prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the | |
15829 | end of all lines passing through our server, so let's do that!!!!1!'' | |
15830 | Yes, but RFC 822 wasn't designed to be read by morons. Things that were | |
15831 | considered to be self-evident were not discussed. So. Here we are. | |
4009494e | 15832 | |
8a1cdce5 AC |
15833 | Case in point: The German version of Microsoft Exchange adds @samp{AW: |
15834 | } to the subjects of replies instead of @samp{Re: }. I could pretend to | |
15835 | be shocked and dismayed by this, but I haven't got the energy. It is to | |
15836 | laugh. | |
4009494e | 15837 | |
8a1cdce5 AC |
15838 | Gnus provides a plethora of functions for washing articles while |
15839 | displaying them, but it might be nicer to do the filtering before | |
15840 | storing the mail to disk. For that purpose, we have three hooks and | |
15841 | various functions that can be put in these hooks. | |
4009494e | 15842 | |
8a1cdce5 AC |
15843 | @table @code |
15844 | @item nnmail-prepare-incoming-hook | |
15845 | @vindex nnmail-prepare-incoming-hook | |
15846 | This hook is called before doing anything with the mail and is meant for | |
15847 | grand, sweeping gestures. It is called in a buffer that contains all | |
15848 | the new, incoming mail. Functions to be used include: | |
4009494e | 15849 | |
8a1cdce5 AC |
15850 | @table @code |
15851 | @item nnheader-ms-strip-cr | |
15852 | @findex nnheader-ms-strip-cr | |
15853 | Remove trailing carriage returns from each line. This is default on | |
15854 | Emacs running on MS machines. | |
a1da1e37 | 15855 | |
4009494e GM |
15856 | @end table |
15857 | ||
8a1cdce5 AC |
15858 | @item nnmail-prepare-incoming-header-hook |
15859 | @vindex nnmail-prepare-incoming-header-hook | |
15860 | This hook is called narrowed to each header. It can be used when | |
15861 | cleaning up the headers. Functions that can be used include: | |
4009494e GM |
15862 | |
15863 | @table @code | |
8a1cdce5 AC |
15864 | @item nnmail-remove-leading-whitespace |
15865 | @findex nnmail-remove-leading-whitespace | |
15866 | Clear leading white space that ``helpful'' listservs have added to the | |
15867 | headers to make them look nice. Aaah. | |
4009494e | 15868 | |
8a1cdce5 AC |
15869 | (Note that this function works on both the header on the body of all |
15870 | messages, so it is a potentially dangerous function to use (if a body | |
15871 | of a message contains something that looks like a header line). So | |
15872 | rather than fix the bug, it is of course the right solution to make it | |
15873 | into a feature by documenting it.) | |
4009494e | 15874 | |
8a1cdce5 AC |
15875 | @item nnmail-remove-list-identifiers |
15876 | @findex nnmail-remove-list-identifiers | |
15877 | Some list servers add an identifier---for example, @samp{(idm)}---to the | |
15878 | beginning of all @code{Subject} headers. I'm sure that's nice for | |
15879 | people who use stone age mail readers. This function will remove | |
15880 | strings that match the @code{nnmail-list-identifiers} regexp, which can | |
15881 | also be a list of regexp. @code{nnmail-list-identifiers} may not contain | |
15882 | @code{\\(..\\)}. | |
4009494e | 15883 | |
8a1cdce5 AC |
15884 | For instance, if you want to remove the @samp{(idm)} and the |
15885 | @samp{nagnagnag} identifiers: | |
4009494e GM |
15886 | |
15887 | @lisp | |
8a1cdce5 AC |
15888 | (setq nnmail-list-identifiers |
15889 | '("(idm)" "nagnagnag")) | |
4009494e GM |
15890 | @end lisp |
15891 | ||
8a1cdce5 AC |
15892 | This can also be done non-destructively with |
15893 | @code{gnus-list-identifiers}, @xref{Article Hiding}. | |
4009494e | 15894 | |
8a1cdce5 AC |
15895 | @item nnmail-remove-tabs |
15896 | @findex nnmail-remove-tabs | |
15897 | Translate all @samp{TAB} characters into @samp{SPACE} characters. | |
4009494e | 15898 | |
8a1cdce5 AC |
15899 | @item nnmail-ignore-broken-references |
15900 | @findex nnmail-ignore-broken-references | |
15901 | @c @findex nnmail-fix-eudora-headers | |
15902 | @cindex Eudora | |
15903 | @cindex Pegasus | |
1df7defd | 15904 | Some mail user agents (e.g., Eudora and Pegasus) produce broken |
8a1cdce5 AC |
15905 | @code{References} headers, but correct @code{In-Reply-To} headers. This |
15906 | function will get rid of the @code{References} header if the headers | |
15907 | contain a line matching the regular expression | |
15908 | @code{nnmail-broken-references-mailers}. | |
4009494e | 15909 | |
8a1cdce5 | 15910 | @end table |
4009494e | 15911 | |
8a1cdce5 AC |
15912 | @item nnmail-prepare-incoming-message-hook |
15913 | @vindex nnmail-prepare-incoming-message-hook | |
15914 | This hook is called narrowed to each message. Functions to be used | |
15915 | include: | |
4009494e GM |
15916 | |
15917 | @table @code | |
8a1cdce5 AC |
15918 | @item article-de-quoted-unreadable |
15919 | @findex article-de-quoted-unreadable | |
15920 | Decode Quoted Readable encoding. | |
4009494e | 15921 | |
8a1cdce5 AC |
15922 | @end table |
15923 | @end table | |
4009494e | 15924 | |
4009494e | 15925 | |
8a1cdce5 AC |
15926 | @node Duplicates |
15927 | @subsection Duplicates | |
15928 | ||
15929 | @vindex nnmail-treat-duplicates | |
15930 | @vindex nnmail-message-id-cache-length | |
15931 | @vindex nnmail-message-id-cache-file | |
15932 | @cindex duplicate mails | |
15933 | If you are a member of a couple of mailing lists, you will sometimes | |
15934 | receive two copies of the same mail. This can be quite annoying, so | |
15935 | @code{nnmail} checks for and treats any duplicates it might find. To do | |
15936 | this, it keeps a cache of old @code{Message-ID}s--- | |
15937 | @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by | |
15938 | default. The approximate maximum number of @code{Message-ID}s stored | |
15939 | there is controlled by the @code{nnmail-message-id-cache-length} | |
15940 | variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be | |
15941 | stored.) If all this sounds scary to you, you can set | |
15942 | @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by | |
15943 | default), and @code{nnmail} won't delete duplicate mails. Instead it | |
15944 | will insert a warning into the head of the mail saying that it thinks | |
15945 | that this is a duplicate of a different message. | |
15946 | ||
15947 | This variable can also be a function. If that's the case, the function | |
15948 | will be called from a buffer narrowed to the message in question with | |
15949 | the @code{Message-ID} as a parameter. The function must return either | |
15950 | @code{nil}, @code{warn}, or @code{delete}. | |
4009494e | 15951 | |
8a1cdce5 AC |
15952 | You can turn this feature off completely by setting the variable to |
15953 | @code{nil}. | |
4009494e | 15954 | |
8a1cdce5 AC |
15955 | If you want all the duplicate mails to be put into a special |
15956 | @dfn{duplicates} group, you could do that using the normal mail split | |
15957 | methods: | |
4009494e | 15958 | |
8a1cdce5 AC |
15959 | @lisp |
15960 | (setq nnmail-split-fancy | |
15961 | '(| ;; @r{Messages duplicates go to a separate group.} | |
15962 | ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate") | |
15963 | ;; @r{Message from daemons, postmaster, and the like to another.} | |
15964 | (any mail "mail.misc") | |
15965 | ;; @r{Other rules.} | |
15966 | [...] )) | |
15967 | @end lisp | |
15968 | @noindent | |
15969 | Or something like: | |
15970 | @lisp | |
15971 | (setq nnmail-split-methods | |
15972 | '(("duplicates" "^Gnus-Warning:.*duplicate") | |
15973 | ;; @r{Other rules.} | |
15974 | [...])) | |
15975 | @end lisp | |
4009494e | 15976 | |
8a1cdce5 AC |
15977 | Here's a neat feature: If you know that the recipient reads her mail |
15978 | with Gnus, and that she has @code{nnmail-treat-duplicates} set to | |
15979 | @code{delete}, you can send her as many insults as you like, just by | |
15980 | using a @code{Message-ID} of a mail that you know that she's already | |
15981 | received. Think of all the fun! She'll never see any of it! Whee! | |
4009494e | 15982 | |
4009494e | 15983 | |
8a1cdce5 AC |
15984 | @node Not Reading Mail |
15985 | @subsection Not Reading Mail | |
4009494e | 15986 | |
8a1cdce5 AC |
15987 | If you start using any of the mail back ends, they have the annoying |
15988 | habit of assuming that you want to read mail with them. This might not | |
15989 | be unreasonable, but it might not be what you want. | |
4009494e | 15990 | |
8a1cdce5 AC |
15991 | If you set @code{mail-sources} and @code{nnmail-spool-file} to |
15992 | @code{nil}, none of the back ends will ever attempt to read incoming | |
15993 | mail, which should help. | |
4009494e | 15994 | |
8a1cdce5 AC |
15995 | @vindex nnbabyl-get-new-mail |
15996 | @vindex nnmbox-get-new-mail | |
15997 | @vindex nnml-get-new-mail | |
15998 | @vindex nnmh-get-new-mail | |
15999 | @vindex nnfolder-get-new-mail | |
16000 | This might be too much, if, for instance, you are reading mail quite | |
16001 | happily with @code{nnml} and just want to peek at some old (pre-Emacs | |
16002 | 23) Rmail file you have stashed away with @code{nnbabyl}. All back ends have | |
16003 | variables called back-end-@code{get-new-mail}. If you want to disable | |
16004 | the @code{nnbabyl} mail reading, you edit the virtual server for the | |
16005 | group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}. | |
4009494e | 16006 | |
8a1cdce5 AC |
16007 | All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook} |
16008 | narrowed to the article to be saved before saving it when reading | |
16009 | incoming mail. | |
4009494e | 16010 | |
4009494e | 16011 | |
8a1cdce5 AC |
16012 | @node Choosing a Mail Back End |
16013 | @subsection Choosing a Mail Back End | |
4009494e | 16014 | |
8a1cdce5 AC |
16015 | Gnus will read the mail spool when you activate a mail group. The mail |
16016 | file is first copied to your home directory. What happens after that | |
16017 | depends on what format you want to store your mail in. | |
4009494e | 16018 | |
8a1cdce5 AC |
16019 | There are six different mail back ends in the standard Gnus, and more |
16020 | back ends are available separately. The mail back end most people use | |
16021 | (because it is possibly the fastest) is @code{nnml} (@pxref{Mail | |
16022 | Spool}). | |
4009494e | 16023 | |
8a1cdce5 AC |
16024 | @menu |
16025 | * Unix Mail Box:: Using the (quite) standard Un*x mbox. | |
16026 | * Babyl:: Babyl was used by older versions of Rmail. | |
16027 | * Mail Spool:: Store your mail in a private spool? | |
16028 | * MH Spool:: An mhspool-like back end. | |
16029 | * Maildir:: Another one-file-per-message format. | |
16030 | * Mail Folders:: Having one file for each group. | |
16031 | * Comparing Mail Back Ends:: An in-depth looks at pros and cons. | |
16032 | @end menu | |
4009494e GM |
16033 | |
16034 | ||
16035 | ||
8a1cdce5 AC |
16036 | @node Unix Mail Box |
16037 | @subsubsection Unix Mail Box | |
16038 | @cindex nnmbox | |
16039 | @cindex unix mail box | |
4009494e | 16040 | |
8a1cdce5 AC |
16041 | @vindex nnmbox-active-file |
16042 | @vindex nnmbox-mbox-file | |
16043 | The @dfn{nnmbox} back end will use the standard Un*x mbox file to store | |
16044 | mail. @code{nnmbox} will add extra headers to each mail article to say | |
16045 | which group it belongs in. | |
4009494e | 16046 | |
8a1cdce5 | 16047 | Virtual server settings: |
4009494e | 16048 | |
8a1cdce5 AC |
16049 | @table @code |
16050 | @item nnmbox-mbox-file | |
16051 | @vindex nnmbox-mbox-file | |
16052 | The name of the mail box in the user's home directory. Default is | |
16053 | @file{~/mbox}. | |
4009494e | 16054 | |
8a1cdce5 AC |
16055 | @item nnmbox-active-file |
16056 | @vindex nnmbox-active-file | |
16057 | The name of the active file for the mail box. Default is | |
16058 | @file{~/.mbox-active}. | |
4009494e | 16059 | |
8a1cdce5 AC |
16060 | @item nnmbox-get-new-mail |
16061 | @vindex nnmbox-get-new-mail | |
16062 | If non-@code{nil}, @code{nnmbox} will read incoming mail and split it | |
16063 | into groups. Default is @code{t}. | |
16064 | @end table | |
4009494e | 16065 | |
4009494e | 16066 | |
8a1cdce5 AC |
16067 | @node Babyl |
16068 | @subsubsection Babyl | |
16069 | @cindex nnbabyl | |
4009494e | 16070 | |
8a1cdce5 AC |
16071 | @vindex nnbabyl-active-file |
16072 | @vindex nnbabyl-mbox-file | |
16073 | The @dfn{nnbabyl} back end will use a Babyl mail box to store mail. | |
16074 | @code{nnbabyl} will add extra headers to each mail article to say which | |
16075 | group it belongs in. | |
4009494e | 16076 | |
8a1cdce5 | 16077 | Virtual server settings: |
4009494e | 16078 | |
8a1cdce5 AC |
16079 | @table @code |
16080 | @item nnbabyl-mbox-file | |
16081 | @vindex nnbabyl-mbox-file | |
16082 | The name of the Babyl file. The default is @file{~/RMAIL} | |
4009494e | 16083 | |
8a1cdce5 AC |
16084 | @item nnbabyl-active-file |
16085 | @vindex nnbabyl-active-file | |
16086 | The name of the active file for the Babyl file. The default is | |
16087 | @file{~/.rmail-active} | |
4009494e | 16088 | |
8a1cdce5 AC |
16089 | @item nnbabyl-get-new-mail |
16090 | @vindex nnbabyl-get-new-mail | |
16091 | If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is | |
16092 | @code{t} | |
4009494e GM |
16093 | @end table |
16094 | ||
16095 | ||
8a1cdce5 AC |
16096 | @node Mail Spool |
16097 | @subsubsection Mail Spool | |
16098 | @cindex nnml | |
16099 | @cindex mail @acronym{NOV} spool | |
16100 | ||
16101 | The @dfn{nnml} spool mail format isn't compatible with any other known | |
16102 | format. It should be used with some caution. | |
16103 | ||
16104 | @vindex nnml-directory | |
16105 | If you use this back end, Gnus will split all incoming mail into files, | |
16106 | one file for each mail, and put the articles into the corresponding | |
16107 | directories under the directory specified by the @code{nnml-directory} | |
16108 | variable. The default value is @file{~/Mail/}. | |
16109 | ||
16110 | You do not have to create any directories beforehand; Gnus will take | |
16111 | care of all that. | |
16112 | ||
16113 | If you have a strict limit as to how many files you are allowed to store | |
16114 | in your account, you should not use this back end. As each mail gets its | |
16115 | own file, you might very well occupy thousands of inodes within a few | |
16116 | weeks. If this is no problem for you, and it isn't a problem for you | |
16117 | having your friendly systems administrator walking around, madly, | |
16118 | shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should | |
16119 | know that this is probably the fastest format to use. You do not have | |
16120 | to trudge through a big mbox file just to read your new mail. | |
4009494e | 16121 | |
8a1cdce5 AC |
16122 | @code{nnml} is probably the slowest back end when it comes to article |
16123 | splitting. It has to create lots of files, and it also generates | |
16124 | @acronym{NOV} databases for the incoming mails. This makes it possibly the | |
16125 | fastest back end when it comes to reading mail. | |
4009494e | 16126 | |
8a1cdce5 | 16127 | Virtual server settings: |
4009494e GM |
16128 | |
16129 | @table @code | |
8a1cdce5 AC |
16130 | @item nnml-directory |
16131 | @vindex nnml-directory | |
16132 | All @code{nnml} directories will be placed under this directory. The | |
16133 | default is the value of @code{message-directory} (whose default value | |
16134 | is @file{~/Mail}). | |
4009494e | 16135 | |
8a1cdce5 AC |
16136 | @item nnml-active-file |
16137 | @vindex nnml-active-file | |
16138 | The active file for the @code{nnml} server. The default is | |
16139 | @file{~/Mail/active}. | |
4009494e | 16140 | |
8a1cdce5 AC |
16141 | @item nnml-newsgroups-file |
16142 | @vindex nnml-newsgroups-file | |
16143 | The @code{nnml} group descriptions file. @xref{Newsgroups File | |
16144 | Format}. The default is @file{~/Mail/newsgroups}. | |
4009494e | 16145 | |
8a1cdce5 AC |
16146 | @item nnml-get-new-mail |
16147 | @vindex nnml-get-new-mail | |
16148 | If non-@code{nil}, @code{nnml} will read incoming mail. The default is | |
16149 | @code{t}. | |
4009494e | 16150 | |
8a1cdce5 AC |
16151 | @item nnml-nov-is-evil |
16152 | @vindex nnml-nov-is-evil | |
16153 | If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The | |
16154 | default is @code{nil}. | |
4009494e | 16155 | |
8a1cdce5 AC |
16156 | @item nnml-nov-file-name |
16157 | @vindex nnml-nov-file-name | |
16158 | The name of the @acronym{NOV} files. The default is @file{.overview}. | |
4009494e | 16159 | |
8a1cdce5 AC |
16160 | @item nnml-prepare-save-mail-hook |
16161 | @vindex nnml-prepare-save-mail-hook | |
16162 | Hook run narrowed to an article before saving. | |
4009494e | 16163 | |
8a1cdce5 AC |
16164 | @item nnml-use-compressed-files |
16165 | @vindex nnml-use-compressed-files | |
16166 | If non-@code{nil}, @code{nnml} will allow using compressed message | |
16167 | files. This requires @code{auto-compression-mode} to be enabled | |
16168 | (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}). | |
16169 | If the value of @code{nnml-use-compressed-files} is a string, it is used | |
16170 | as the file extension specifying the compression program. You can set it | |
16171 | to @samp{.bz2} if your Emacs supports it. A value of @code{t} is | |
16172 | equivalent to @samp{.gz}. | |
4009494e | 16173 | |
8a1cdce5 AC |
16174 | @item nnml-compressed-files-size-threshold |
16175 | @vindex nnml-compressed-files-size-threshold | |
16176 | Default size threshold for compressed message files. Message files with | |
16177 | bodies larger than that many characters will be automatically compressed | |
16178 | if @code{nnml-use-compressed-files} is non-@code{nil}. | |
4009494e | 16179 | |
8a1cdce5 | 16180 | @end table |
4009494e | 16181 | |
8a1cdce5 AC |
16182 | @findex nnml-generate-nov-databases |
16183 | If your @code{nnml} groups and @acronym{NOV} files get totally out of | |
16184 | whack, you can do a complete update by typing @kbd{M-x | |
16185 | nnml-generate-nov-databases}. This command will trawl through the | |
16186 | entire @code{nnml} hierarchy, looking at each and every article, so it | |
16187 | might take a while to complete. A better interface to this | |
16188 | functionality can be found in the server buffer (@pxref{Server | |
16189 | Commands}). | |
4009494e | 16190 | |
4009494e | 16191 | |
8a1cdce5 AC |
16192 | @node MH Spool |
16193 | @subsubsection MH Spool | |
16194 | @cindex nnmh | |
16195 | @cindex mh-e mail spool | |
4009494e | 16196 | |
8a1cdce5 AC |
16197 | @code{nnmh} is just like @code{nnml}, except that is doesn't generate |
16198 | @acronym{NOV} databases and it doesn't keep an active file or marks | |
16199 | file. This makes @code{nnmh} a @emph{much} slower back end than | |
16200 | @code{nnml}, but it also makes it easier to write procmail scripts | |
16201 | for. | |
4009494e | 16202 | |
8a1cdce5 | 16203 | Virtual server settings: |
4009494e | 16204 | |
8a1cdce5 AC |
16205 | @table @code |
16206 | @item nnmh-directory | |
16207 | @vindex nnmh-directory | |
16208 | All @code{nnmh} directories will be located under this directory. The | |
16209 | default is the value of @code{message-directory} (whose default is | |
16210 | @file{~/Mail}) | |
4009494e | 16211 | |
8a1cdce5 AC |
16212 | @item nnmh-get-new-mail |
16213 | @vindex nnmh-get-new-mail | |
16214 | If non-@code{nil}, @code{nnmh} will read incoming mail. The default is | |
16215 | @code{t}. | |
4009494e | 16216 | |
8a1cdce5 AC |
16217 | @item nnmh-be-safe |
16218 | @vindex nnmh-be-safe | |
16219 | If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make | |
16220 | sure that the articles in the folder are actually what Gnus thinks | |
16221 | they are. It will check date stamps and stat everything in sight, so | |
16222 | setting this to @code{t} will mean a serious slow-down. If you never | |
16223 | use anything but Gnus to read the @code{nnmh} articles, you do not | |
16224 | have to set this variable to @code{t}. The default is @code{nil}. | |
16225 | @end table | |
4009494e | 16226 | |
4009494e | 16227 | |
8a1cdce5 AC |
16228 | @node Maildir |
16229 | @subsubsection Maildir | |
16230 | @cindex nnmaildir | |
16231 | @cindex maildir | |
4009494e | 16232 | |
8a1cdce5 AC |
16233 | @code{nnmaildir} stores mail in the maildir format, with each maildir |
16234 | corresponding to a group in Gnus. This format is documented here: | |
16235 | @uref{http://cr.yp.to/proto/maildir.html} and here: | |
16236 | @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir} | |
16237 | also stores extra information in the @file{.nnmaildir/} directory | |
16238 | within a maildir. | |
16239 | ||
16240 | Maildir format was designed to allow concurrent deliveries and | |
16241 | reading, without needing locks. With other back ends, you would have | |
16242 | your mail delivered to a spool of some kind, and then you would | |
16243 | configure Gnus to split mail from that spool into your groups. You | |
16244 | can still do that with @code{nnmaildir}, but the more common | |
16245 | configuration is to have your mail delivered directly to the maildirs | |
16246 | that appear as group in Gnus. | |
4009494e | 16247 | |
8a1cdce5 AC |
16248 | @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will |
16249 | never corrupt its data in memory, and @code{SIGKILL} will never | |
16250 | corrupt its data in the filesystem. | |
4009494e | 16251 | |
8a1cdce5 AC |
16252 | @code{nnmaildir} stores article marks and @acronym{NOV} data in each |
16253 | maildir. So you can copy a whole maildir from one Gnus setup to | |
16254 | another, and you will keep your marks. | |
4009494e | 16255 | |
8a1cdce5 | 16256 | Virtual server settings: |
4009494e | 16257 | |
8a1cdce5 AC |
16258 | @table @code |
16259 | @item directory | |
16260 | For each of your @code{nnmaildir} servers (it's very unlikely that | |
16261 | you'd need more than one), you need to create a directory and populate | |
16262 | it with maildirs or symlinks to maildirs (and nothing else; do not | |
16263 | choose a directory already used for other purposes). Each maildir | |
16264 | will be represented in Gnus as a newsgroup on that server; the | |
16265 | filename of the symlink will be the name of the group. Any filenames | |
16266 | in the directory starting with @samp{.} are ignored. The directory is | |
16267 | scanned when you first start Gnus, and each time you type @kbd{g} in | |
16268 | the group buffer; if any maildirs have been removed or added, | |
16269 | @code{nnmaildir} notices at these times. | |
4009494e | 16270 | |
8a1cdce5 AC |
16271 | The value of the @code{directory} parameter should be a Lisp form |
16272 | which is processed by @code{eval} and @code{expand-file-name} to get | |
16273 | the path of the directory for this server. The form is @code{eval}ed | |
16274 | only when the server is opened; the resulting string is used until the | |
16275 | server is closed. (If you don't know about forms and @code{eval}, | |
16276 | don't worry---a simple string will work.) This parameter is not | |
16277 | optional; you must specify it. I don't recommend using | |
16278 | @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus | |
16279 | use that directory by default for various things, and may get confused | |
16280 | if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical | |
16281 | value. | |
4009494e | 16282 | |
8a1cdce5 AC |
16283 | @item target-prefix |
16284 | This should be a Lisp form which is processed by @code{eval} and | |
16285 | @code{expand-file-name}. The form is @code{eval}ed only when the | |
16286 | server is opened; the resulting string is used until the server is | |
16287 | closed. | |
4009494e | 16288 | |
8a1cdce5 AC |
16289 | When you create a group on an @code{nnmaildir} server, the maildir is |
16290 | created with @code{target-prefix} prepended to its name, and a symlink | |
16291 | pointing to that maildir is created, named with the plain group name. | |
16292 | So if @code{directory} is @code{"~/.nnmaildir"} and | |
16293 | @code{target-prefix} is @code{"../maildirs/"}, then when you create | |
16294 | the group @code{foo}, @code{nnmaildir} will create | |
16295 | @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create | |
16296 | @file{~/.nnmaildir/foo} as a symlink pointing to | |
16297 | @file{../maildirs/foo}. | |
4009494e | 16298 | |
8a1cdce5 AC |
16299 | You can set @code{target-prefix} to a string without any slashes to |
16300 | create both maildirs and symlinks in the same @code{directory}; in | |
16301 | this case, any maildirs found in @code{directory} whose names start | |
16302 | with @code{target-prefix} will not be listed as groups (but the | |
16303 | symlinks pointing to them will be). | |
4009494e | 16304 | |
8a1cdce5 AC |
16305 | As a special case, if @code{target-prefix} is @code{""} (the default), |
16306 | then when you create a group, the maildir will be created in | |
16307 | @code{directory} without a corresponding symlink. Beware that you | |
16308 | cannot use @code{gnus-group-delete-group} on such groups without the | |
16309 | @code{force} argument. | |
4009494e | 16310 | |
8a1cdce5 AC |
16311 | @item directory-files |
16312 | This should be a function with the same interface as | |
16313 | @code{directory-files} (such as @code{directory-files} itself). It is | |
16314 | used to scan the server's @code{directory} for maildirs. This | |
16315 | parameter is optional; the default is | |
16316 | @code{nnheader-directory-files-safe} if | |
16317 | @code{nnheader-directory-files-is-safe} is @code{nil}, and | |
16318 | @code{directory-files} otherwise. | |
16319 | (@code{nnheader-directory-files-is-safe} is checked only once when the | |
16320 | server is opened; if you want to check it each time the directory is | |
16321 | scanned, you'll have to provide your own function that does that.) | |
4009494e | 16322 | |
8a1cdce5 AC |
16323 | @item get-new-mail |
16324 | If non-@code{nil}, then after scanning for new mail in the group | |
16325 | maildirs themselves as usual, this server will also incorporate mail | |
16326 | the conventional Gnus way, from @code{mail-sources} according to | |
16327 | @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default | |
16328 | value is @code{nil}. | |
4009494e | 16329 | |
8a1cdce5 AC |
16330 | Do @emph{not} use the same maildir both in @code{mail-sources} and as |
16331 | an @code{nnmaildir} group. The results might happen to be useful, but | |
16332 | that would be by chance, not by design, and the results might be | |
16333 | different in the future. If your split rules create new groups, | |
16334 | remember to supply a @code{create-directory} server parameter. | |
16335 | @end table | |
4009494e | 16336 | |
8a1cdce5 | 16337 | @subsubsection Group parameters |
4009494e | 16338 | |
8a1cdce5 AC |
16339 | @code{nnmaildir} uses several group parameters. It's safe to ignore |
16340 | all this; the default behavior for @code{nnmaildir} is the same as the | |
16341 | default behavior for other mail back ends: articles are deleted after | |
16342 | one week, etc. Except for the expiry parameters, all this | |
16343 | functionality is unique to @code{nnmaildir}, so you can ignore it if | |
16344 | you're just trying to duplicate the behavior you already have with | |
16345 | another back end. | |
4009494e | 16346 | |
8a1cdce5 AC |
16347 | If the value of any of these parameters is a vector, the first element |
16348 | is evaluated as a Lisp form and the result is used, rather than the | |
16349 | original value. If the value is not a vector, the value itself is | |
16350 | evaluated as a Lisp form. (This is why these parameters use names | |
16351 | different from those of other, similar parameters supported by other | |
16352 | back ends: they have different, though similar, meanings.) (For | |
16353 | numbers, strings, @code{nil}, and @code{t}, you can ignore the | |
16354 | @code{eval} business again; for other values, remember to use an extra | |
16355 | quote and wrap the value in a vector when appropriate.) | |
4009494e | 16356 | |
8a1cdce5 AC |
16357 | @table @code |
16358 | @item expire-age | |
16359 | An integer specifying the minimum age, in seconds, of an article | |
16360 | before it will be expired, or the symbol @code{never} to specify that | |
16361 | articles should never be expired. If this parameter is not set, | |
16362 | @code{nnmaildir} falls back to the usual | |
16363 | @code{nnmail-expiry-wait}(@code{-function}) variables (the | |
16364 | @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait} | |
16365 | and makes @code{nnmail-expiry-wait-function} ineffective). If you | |
16366 | wanted a value of 3 days, you could use something like @code{[(* 3 24 | |
16367 | 60 60)]}; @code{nnmaildir} will evaluate the form and use the result. | |
16368 | An article's age is measured starting from the article file's | |
16369 | modification time. Normally, this is the same as the article's | |
16370 | delivery time, but editing an article makes it younger. Moving an | |
16371 | article (other than via expiry) may also make an article younger. | |
4009494e | 16372 | |
8a1cdce5 AC |
16373 | @item expire-group |
16374 | If this is set to a string such as a full Gnus group name, like | |
16375 | @example | |
16376 | "backend+server.address.string:group.name" | |
16377 | @end example | |
16378 | and if it is not the name of the same group that the parameter belongs | |
16379 | to, then articles will be moved to the specified group during expiry | |
16380 | before being deleted. @emph{If this is set to an @code{nnmaildir} | |
16381 | group, the article will be just as old in the destination group as it | |
16382 | was in the source group.} So be careful with @code{expire-age} in the | |
16383 | destination group. If this is set to the name of the same group that | |
16384 | the parameter belongs to, then the article is not expired at all. If | |
16385 | you use the vector form, the first element is evaluated once for each | |
16386 | article. So that form can refer to | |
16387 | @code{nnmaildir-article-file-name}, etc., to decide where to put the | |
16388 | article. @emph{Even if this parameter is not set, @code{nnmaildir} | |
16389 | does not fall back to the @code{expiry-target} group parameter or the | |
16390 | @code{nnmail-expiry-target} variable.} | |
4009494e | 16391 | |
8a1cdce5 AC |
16392 | @item read-only |
16393 | If this is set to @code{t}, @code{nnmaildir} will treat the articles | |
16394 | in this maildir as read-only. This means: articles are not renamed | |
16395 | from @file{new/} into @file{cur/}; articles are only found in | |
16396 | @file{new/}, not @file{cur/}; articles are never deleted; articles | |
16397 | cannot be edited. @file{new/} is expected to be a symlink to the | |
16398 | @file{new/} directory of another maildir---e.g., a system-wide mailbox | |
16399 | containing a mailing list of common interest. Everything in the | |
16400 | maildir outside @file{new/} is @emph{not} treated as read-only, so for | |
16401 | a shared mailbox, you do still need to set up your own maildir (or | |
16402 | have write permission to the shared mailbox); your maildir just won't | |
16403 | contain extra copies of the articles. | |
4009494e | 16404 | |
8a1cdce5 AC |
16405 | @item directory-files |
16406 | A function with the same interface as @code{directory-files}. It is | |
16407 | used to scan the directories in the maildir corresponding to this | |
16408 | group to find articles. The default is the function specified by the | |
16409 | server's @code{directory-files} parameter. | |
4009494e | 16410 | |
8a1cdce5 AC |
16411 | @item distrust-Lines: |
16412 | If non-@code{nil}, @code{nnmaildir} will always count the lines of an | |
16413 | article, rather than use the @code{Lines:} header field. If | |
16414 | @code{nil}, the header field will be used if present. | |
4009494e | 16415 | |
8a1cdce5 AC |
16416 | @item always-marks |
16417 | A list of mark symbols, such as @code{['(read expire)]}. Whenever | |
16418 | Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will | |
16419 | say that all articles have these marks, regardless of whether the | |
16420 | marks stored in the filesystem say so. This is a proof-of-concept | |
16421 | feature that will probably be removed eventually; it ought to be done | |
16422 | in Gnus proper, or abandoned if it's not worthwhile. | |
4009494e | 16423 | |
8a1cdce5 AC |
16424 | @item never-marks |
16425 | A list of mark symbols, such as @code{['(tick expire)]}. Whenever | |
16426 | Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will | |
16427 | say that no articles have these marks, regardless of whether the marks | |
16428 | stored in the filesystem say so. @code{never-marks} overrides | |
16429 | @code{always-marks}. This is a proof-of-concept feature that will | |
16430 | probably be removed eventually; it ought to be done in Gnus proper, or | |
16431 | abandoned if it's not worthwhile. | |
4009494e | 16432 | |
8a1cdce5 AC |
16433 | @item nov-cache-size |
16434 | An integer specifying the size of the @acronym{NOV} memory cache. To | |
16435 | speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory | |
16436 | for a limited number of articles in each group. (This is probably not | |
16437 | worthwhile, and will probably be removed in the future.) This | |
16438 | parameter's value is noticed only the first time a group is seen after | |
16439 | the server is opened---i.e., when you first start Gnus, typically. | |
16440 | The @acronym{NOV} cache is never resized until the server is closed | |
16441 | and reopened. The default is an estimate of the number of articles | |
16442 | that would be displayed in the summary buffer: a count of articles | |
16443 | that are either marked with @code{tick} or not marked with | |
16444 | @code{read}, plus a little extra. | |
16445 | @end table | |
4009494e | 16446 | |
8a1cdce5 AC |
16447 | @subsubsection Article identification |
16448 | Articles are stored in the @file{cur/} subdirectory of each maildir. | |
16449 | Each article file is named like @code{uniq:info}, where @code{uniq} | |
16450 | contains no colons. @code{nnmaildir} ignores, but preserves, the | |
16451 | @code{:info} part. (Other maildir readers typically use this part of | |
16452 | the filename to store marks.) The @code{uniq} part uniquely | |
16453 | identifies the article, and is used in various places in the | |
16454 | @file{.nnmaildir/} subdirectory of the maildir to store information | |
16455 | about the corresponding article. The full pathname of an article is | |
16456 | available in the variable @code{nnmaildir-article-file-name} after you | |
16457 | request the article in the summary buffer. | |
4009494e | 16458 | |
8a1cdce5 AC |
16459 | @subsubsection NOV data |
16460 | An article identified by @code{uniq} has its @acronym{NOV} data (used | |
16461 | to generate lines in the summary buffer) stored in | |
16462 | @code{.nnmaildir/nov/uniq}. There is no | |
16463 | @code{nnmaildir-generate-nov-databases} function. (There isn't much | |
16464 | need for it---an article's @acronym{NOV} data is updated automatically | |
16465 | when the article or @code{nnmail-extra-headers} has changed.) You can | |
16466 | force @code{nnmaildir} to regenerate the @acronym{NOV} data for a | |
16467 | single article simply by deleting the corresponding @acronym{NOV} | |
16468 | file, but @emph{beware}: this will also cause @code{nnmaildir} to | |
16469 | assign a new article number for this article, which may cause trouble | |
16470 | with @code{seen} marks, the Agent, and the cache. | |
4009494e | 16471 | |
8a1cdce5 AC |
16472 | @subsubsection Article marks |
16473 | An article identified by @code{uniq} is considered to have the mark | |
16474 | @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists. | |
16475 | When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir} | |
16476 | looks for such files and reports the set of marks it finds. When Gnus | |
16477 | asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir} | |
16478 | creates and deletes the corresponding files as needed. (Actually, | |
16479 | rather than create a new file for each mark, it just creates hard | |
16480 | links to @file{.nnmaildir/markfile}, to save inodes.) | |
4009494e | 16481 | |
8a1cdce5 AC |
16482 | You can invent new marks by creating a new directory in |
16483 | @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from | |
16484 | your server, untar it later, and keep your marks. You can add and | |
16485 | remove marks yourself by creating and deleting mark files. If you do | |
16486 | this while Gnus is running and your @code{nnmaildir} server is open, | |
16487 | it's best to exit all summary buffers for @code{nnmaildir} groups and | |
16488 | type @kbd{s} in the group buffer first, and to type @kbd{g} or | |
16489 | @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not | |
16490 | pick up the changes, and might undo them. | |
4009494e | 16491 | |
4009494e | 16492 | |
8a1cdce5 AC |
16493 | @node Mail Folders |
16494 | @subsubsection Mail Folders | |
16495 | @cindex nnfolder | |
16496 | @cindex mbox folders | |
16497 | @cindex mail folders | |
4009494e | 16498 | |
8a1cdce5 AC |
16499 | @code{nnfolder} is a back end for storing each mail group in a |
16500 | separate file. Each file is in the standard Un*x mbox format. | |
16501 | @code{nnfolder} will add extra headers to keep track of article | |
16502 | numbers and arrival dates. | |
4009494e | 16503 | |
8a1cdce5 | 16504 | Virtual server settings: |
4009494e | 16505 | |
8a1cdce5 AC |
16506 | @table @code |
16507 | @item nnfolder-directory | |
16508 | @vindex nnfolder-directory | |
16509 | All the @code{nnfolder} mail boxes will be stored under this | |
16510 | directory. The default is the value of @code{message-directory} | |
16511 | (whose default is @file{~/Mail}) | |
4009494e | 16512 | |
8a1cdce5 AC |
16513 | @item nnfolder-active-file |
16514 | @vindex nnfolder-active-file | |
16515 | The name of the active file. The default is @file{~/Mail/active}. | |
4009494e | 16516 | |
8a1cdce5 AC |
16517 | @item nnfolder-newsgroups-file |
16518 | @vindex nnfolder-newsgroups-file | |
16519 | The name of the group descriptions file. @xref{Newsgroups File | |
16520 | Format}. The default is @file{~/Mail/newsgroups} | |
4009494e | 16521 | |
8a1cdce5 AC |
16522 | @item nnfolder-get-new-mail |
16523 | @vindex nnfolder-get-new-mail | |
16524 | If non-@code{nil}, @code{nnfolder} will read incoming mail. The | |
16525 | default is @code{t} | |
4009494e | 16526 | |
8a1cdce5 AC |
16527 | @item nnfolder-save-buffer-hook |
16528 | @vindex nnfolder-save-buffer-hook | |
16529 | @cindex backup files | |
16530 | Hook run before saving the folders. Note that Emacs does the normal | |
16531 | backup renaming of files even with the @code{nnfolder} buffers. If | |
16532 | you wish to switch this off, you could say something like the | |
16533 | following in your @file{.emacs} file: | |
4009494e | 16534 | |
8a1cdce5 AC |
16535 | @lisp |
16536 | (defun turn-off-backup () | |
16537 | (set (make-local-variable 'backup-inhibited) t)) | |
4009494e | 16538 | |
8a1cdce5 AC |
16539 | (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup) |
16540 | @end lisp | |
4009494e | 16541 | |
8a1cdce5 AC |
16542 | @item nnfolder-delete-mail-hook |
16543 | @vindex nnfolder-delete-mail-hook | |
16544 | Hook run in a buffer narrowed to the message that is to be deleted. | |
16545 | This function can be used to copy the message to somewhere else, or to | |
16546 | extract some information from it before removing it. | |
4009494e | 16547 | |
8a1cdce5 AC |
16548 | @item nnfolder-nov-is-evil |
16549 | @vindex nnfolder-nov-is-evil | |
16550 | If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The | |
16551 | default is @code{nil}. | |
4009494e | 16552 | |
8a1cdce5 AC |
16553 | @item nnfolder-nov-file-suffix |
16554 | @vindex nnfolder-nov-file-suffix | |
16555 | The extension for @acronym{NOV} files. The default is @file{.nov}. | |
4009494e | 16556 | |
8a1cdce5 AC |
16557 | @item nnfolder-nov-directory |
16558 | @vindex nnfolder-nov-directory | |
16559 | The directory where the @acronym{NOV} files should be stored. If | |
16560 | @code{nil}, @code{nnfolder-directory} is used. | |
4009494e | 16561 | |
8a1cdce5 | 16562 | @end table |
4009494e | 16563 | |
4009494e | 16564 | |
8a1cdce5 AC |
16565 | @findex nnfolder-generate-active-file |
16566 | @kindex M-x nnfolder-generate-active-file | |
16567 | If you have lots of @code{nnfolder}-like files you'd like to read with | |
16568 | @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file} | |
16569 | command to make @code{nnfolder} aware of all likely files in | |
16570 | @code{nnfolder-directory}. This only works if you use long file names, | |
16571 | though. | |
4009494e | 16572 | |
8a1cdce5 AC |
16573 | @node Comparing Mail Back Ends |
16574 | @subsubsection Comparing Mail Back Ends | |
4009494e | 16575 | |
8a1cdce5 AC |
16576 | First, just for terminology, the @dfn{back end} is the common word for a |
16577 | low-level access method---a transport, if you will, by which something | |
16578 | is acquired. The sense is that one's mail has to come from somewhere, | |
16579 | and so selection of a suitable back end is required in order to get that | |
16580 | mail within spitting distance of Gnus. | |
4009494e | 16581 | |
8a1cdce5 AC |
16582 | The same concept exists for Usenet itself: Though access to articles is |
16583 | typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone | |
16584 | in the world got at Usenet by running a reader on the machine where the | |
16585 | articles lay (the machine which today we call an @acronym{NNTP} server), and | |
16586 | access was by the reader stepping into the articles' directory spool | |
16587 | area directly. One can still select between either the @code{nntp} or | |
16588 | @code{nnspool} back ends, to select between these methods, if one happens | |
16589 | actually to live on the server (or can see its spool directly, anyway, | |
16590 | via NFS). | |
4009494e | 16591 | |
8a1cdce5 AC |
16592 | The goal in selecting a mail back end is to pick one which |
16593 | simultaneously represents a suitable way of dealing with the original | |
16594 | format plus leaving mail in a form that is convenient to use in the | |
16595 | future. Here are some high and low points on each: | |
4009494e | 16596 | |
8a1cdce5 AC |
16597 | @table @code |
16598 | @item nnmbox | |
4009494e | 16599 | |
8a1cdce5 AC |
16600 | UNIX systems have historically had a single, very common, and well- |
16601 | defined format. All messages arrive in a single @dfn{spool file}, and | |
16602 | they are delineated by a line whose regular expression matches | |
16603 | @samp{^From_}. (My notational use of @samp{_} is to indicate a space, | |
16604 | to make it clear in this instance that this is not the RFC-specified | |
16605 | @samp{From:} header.) Because Emacs and therefore Gnus emanate | |
16606 | historically from the Unix environment, it is simplest if one does not | |
16607 | mess a great deal with the original mailbox format, so if one chooses | |
16608 | this back end, Gnus' primary activity in getting mail from the real spool | |
16609 | area to Gnus' preferred directory is simply to copy it, with no | |
16610 | (appreciable) format change in the process. It is the ``dumbest'' way | |
16611 | to move mail into availability in the Gnus environment. This makes it | |
16612 | fast to move into place, but slow to parse, when Gnus has to look at | |
16613 | what's where. | |
4009494e | 16614 | |
8a1cdce5 | 16615 | @item nnbabyl |
4009494e | 16616 | |
8a1cdce5 AC |
16617 | Once upon a time, there was the DEC-10 and DEC-20, running operating |
16618 | systems called TOPS and related things, and the usual (only?) mail | |
16619 | reading environment was a thing called Babyl. I don't know what format | |
16620 | was used for mail landing on the system, but Babyl had its own internal | |
16621 | format to which mail was converted, primarily involving creating a | |
16622 | spool-file-like entity with a scheme for inserting Babyl-specific | |
16623 | headers and status bits above the top of each message in the file. | |
44e97401 | 16624 | Rmail was Emacs's first mail reader, it was written by Richard Stallman, |
8a1cdce5 AC |
16625 | and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail |
16626 | to understand the mail files folks already had in existence. Gnus (and | |
16627 | VM, for that matter) continue to support this format because it's | |
16628 | perceived as having some good qualities in those mailer-specific | |
16629 | headers/status bits stuff. Rmail itself still exists as well, of | |
16630 | course, and is still maintained within Emacs. Since Emacs 23, it | |
16631 | uses standard mbox format rather than Babyl. | |
4009494e | 16632 | |
8a1cdce5 AC |
16633 | Both of the above forms leave your mail in a single file on your |
16634 | file system, and they must parse that entire file each time you take a | |
16635 | look at your mail. | |
4009494e | 16636 | |
8a1cdce5 | 16637 | @item nnml |
4009494e | 16638 | |
8a1cdce5 AC |
16639 | @code{nnml} is the back end which smells the most as though you were |
16640 | actually operating with an @code{nnspool}-accessed Usenet system. (In | |
16641 | fact, I believe @code{nnml} actually derived from @code{nnspool} code, | |
16642 | lo these years ago.) One's mail is taken from the original spool file, | |
16643 | and is then cut up into individual message files, 1:1. It maintains a | |
16644 | Usenet-style active file (analogous to what one finds in an INN- or | |
16645 | CNews-based news system in (for instance) @file{/var/lib/news/active}, | |
16646 | or what is returned via the @samp{NNTP LIST} verb) and also creates | |
16647 | @dfn{overview} files for efficient group entry, as has been defined for | |
16648 | @acronym{NNTP} servers for some years now. It is slower in mail-splitting, | |
16649 | due to the creation of lots of files, updates to the @code{nnml} active | |
16650 | file, and additions to overview files on a per-message basis, but it is | |
16651 | extremely fast on access because of what amounts to the indexing support | |
16652 | provided by the active file and overviews. | |
4009494e | 16653 | |
8a1cdce5 AC |
16654 | @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the |
16655 | resource which defines available places in the file system to put new | |
16656 | files. Sysadmins take a dim view of heavy inode occupation within | |
16657 | tight, shared file systems. But if you live on a personal machine where | |
16658 | the file system is your own and space is not at a premium, @code{nnml} | |
16659 | wins big. | |
4009494e | 16660 | |
8a1cdce5 AC |
16661 | It is also problematic using this back end if you are living in a |
16662 | FAT16-based Windows world, since much space will be wasted on all these | |
16663 | tiny files. | |
4009494e | 16664 | |
8a1cdce5 | 16665 | @item nnmh |
4009494e | 16666 | |
8a1cdce5 AC |
16667 | The Rand MH mail-reading system has been around UNIX systems for a very |
16668 | long time; it operates by splitting one's spool file of messages into | |
16669 | individual files, but with little or no indexing support---@code{nnmh} | |
16670 | is considered to be semantically equivalent to ``@code{nnml} without | |
16671 | active file or overviews''. This is arguably the worst choice, because | |
16672 | one gets the slowness of individual file creation married to the | |
16673 | slowness of access parsing when learning what's new in one's groups. | |
4009494e | 16674 | |
8a1cdce5 | 16675 | @item nnfolder |
4009494e | 16676 | |
8a1cdce5 AC |
16677 | Basically the effect of @code{nnfolder} is @code{nnmbox} (the first |
16678 | method described above) on a per-group basis. That is, @code{nnmbox} | |
16679 | itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a | |
16680 | little bit of optimization to this so that each of one's mail groups has | |
16681 | a Unix mail box file. It's faster than @code{nnmbox} because each group | |
16682 | can be parsed separately, and still provides the simple Unix mail box | |
16683 | format requiring minimal effort in moving the mail around. In addition, | |
16684 | it maintains an ``active'' file making it much faster for Gnus to figure | |
16685 | out how many messages there are in each separate group. | |
4009494e | 16686 | |
8a1cdce5 AC |
16687 | If you have groups that are expected to have a massive amount of |
16688 | messages, @code{nnfolder} is not the best choice, but if you receive | |
16689 | only a moderate amount of mail, @code{nnfolder} is probably the most | |
16690 | friendly mail back end all over. | |
16691 | ||
16692 | @item nnmaildir | |
4009494e | 16693 | |
8a1cdce5 AC |
16694 | For configuring expiry and other things, @code{nnmaildir} uses |
16695 | incompatible group parameters, slightly different from those of other | |
16696 | mail back ends. | |
4009494e | 16697 | |
8a1cdce5 AC |
16698 | @code{nnmaildir} is largely similar to @code{nnml}, with some notable |
16699 | differences. Each message is stored in a separate file, but the | |
16700 | filename is unrelated to the article number in Gnus. @code{nnmaildir} | |
16701 | also stores the equivalent of @code{nnml}'s overview files in one file | |
16702 | per article, so it uses about twice as many inodes as @code{nnml}. | |
16703 | (Use @code{df -i} to see how plentiful your inode supply is.) If this | |
16704 | slows you down or takes up very much space, a non-block-structured | |
16705 | file system. | |
4009494e | 16706 | |
8a1cdce5 AC |
16707 | Since maildirs don't require locking for delivery, the maildirs you use |
16708 | as groups can also be the maildirs your mail is directly delivered to. | |
16709 | This means you can skip Gnus' mail splitting if your mail is already | |
16710 | organized into different mailboxes during delivery. A @code{directory} | |
16711 | entry in @code{mail-sources} would have a similar effect, but would | |
16712 | require one set of mailboxes for spooling deliveries (in mbox format, | |
16713 | thus damaging message bodies), and another set to be used as groups (in | |
16714 | whatever format you like). A maildir has a built-in spool, in the | |
16715 | @code{new/} subdirectory. Beware that currently, mail moved from | |
16716 | @code{new/} to @code{cur/} instead of via mail splitting will not | |
16717 | undergo treatment such as duplicate checking. | |
4009494e | 16718 | |
8a1cdce5 AC |
16719 | @code{nnmaildir} stores article marks for a given group in the |
16720 | corresponding maildir, in a way designed so that it's easy to manipulate | |
16721 | them from outside Gnus. You can tar up a maildir, unpack it somewhere | |
89b163db | 16722 | else, and still have your marks. |
4009494e | 16723 | |
8a1cdce5 AC |
16724 | @code{nnmaildir} uses a significant amount of memory to speed things up. |
16725 | (It keeps in memory some of the things that @code{nnml} stores in files | |
16726 | and that @code{nnmh} repeatedly parses out of message files.) If this | |
16727 | is a problem for you, you can set the @code{nov-cache-size} group | |
16728 | parameter to something small (0 would probably not work, but 1 probably | |
16729 | would) to make it use less memory. This caching will probably be | |
16730 | removed in the future. | |
4009494e | 16731 | |
8a1cdce5 AC |
16732 | Startup is likely to be slower with @code{nnmaildir} than with other |
16733 | back ends. Everything else is likely to be faster, depending in part | |
16734 | on your file system. | |
4009494e | 16735 | |
8a1cdce5 AC |
16736 | @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo} |
16737 | to write an @code{nnmaildir}-derived back end. | |
4009494e | 16738 | |
8a1cdce5 | 16739 | @end table |
b0b63450 | 16740 | |
4009494e | 16741 | |
8a1cdce5 AC |
16742 | @node Browsing the Web |
16743 | @section Browsing the Web | |
16744 | @cindex web | |
16745 | @cindex browsing the web | |
16746 | @cindex www | |
16747 | @cindex http | |
4009494e | 16748 | |
8a1cdce5 AC |
16749 | Web-based discussion forums are getting more and more popular. On many |
16750 | subjects, the web-based forums have become the most important forums, | |
16751 | eclipsing the importance of mailing lists and news groups. The reason | |
16752 | is easy to understand---they are friendly to new users; you just point | |
16753 | and click, and there's the discussion. With mailing lists, you have to | |
16754 | go through a cumbersome subscription procedure, and most people don't | |
16755 | even know what a news group is. | |
4009494e | 16756 | |
8a1cdce5 AC |
16757 | The problem with this scenario is that web browsers are not very good at |
16758 | being newsreaders. They do not keep track of what articles you've read; | |
16759 | they do not allow you to score on subjects you're interested in; they do | |
16760 | not allow off-line browsing; they require you to click around and drive | |
16761 | you mad in the end. | |
4009494e | 16762 | |
8a1cdce5 AC |
16763 | So---if web browsers suck at reading discussion forums, why not use Gnus |
16764 | to do it instead? | |
4009494e | 16765 | |
8a1cdce5 AC |
16766 | Gnus has been getting a bit of a collection of back ends for providing |
16767 | interfaces to these sources. | |
4009494e | 16768 | |
8a1cdce5 AC |
16769 | @menu |
16770 | * Archiving Mail:: | |
16771 | * Web Searches:: Creating groups from articles that match a string. | |
16772 | * RSS:: Reading RDF site summary. | |
16773 | * Customizing W3:: Doing stuff to Emacs/W3 from Gnus. | |
16774 | @end menu | |
4009494e | 16775 | |
8a1cdce5 AC |
16776 | All the web sources require Emacs/W3 and the url library or those |
16777 | alternatives to work. | |
4009494e | 16778 | |
8a1cdce5 AC |
16779 | The main caveat with all these web sources is that they probably won't |
16780 | work for a very long time. Gleaning information from the @acronym{HTML} data | |
16781 | is guesswork at best, and when the layout is altered, the Gnus back end | |
16782 | will fail. If you have reasonably new versions of these back ends, | |
16783 | though, you should be ok. | |
4009494e | 16784 | |
8a1cdce5 AC |
16785 | One thing all these Web methods have in common is that the Web sources |
16786 | are often down, unavailable or just plain too slow to be fun. In those | |
16787 | cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus | |
16788 | Unplugged}) handle downloading articles, and then you can read them at | |
16789 | leisure from your local disk. No more World Wide Wait for you. | |
4009494e | 16790 | |
8a1cdce5 AC |
16791 | @node Archiving Mail |
16792 | @subsection Archiving Mail | |
16793 | @cindex archiving mail | |
16794 | @cindex backup of mail | |
4009494e | 16795 | |
8a1cdce5 AC |
16796 | Some of the back ends, notably @code{nnml}, @code{nnfolder}, and |
16797 | @code{nnmaildir}, now actually store the article marks with each group. | |
16798 | For these servers, archiving and restoring a group while preserving | |
16799 | marks is fairly simple. | |
4009494e | 16800 | |
8a1cdce5 AC |
16801 | (Preserving the group level and group parameters as well still |
16802 | requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity | |
16803 | though.) | |
4009494e | 16804 | |
8a1cdce5 AC |
16805 | To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir} |
16806 | server, take a recursive copy of the server directory. There is no need | |
16807 | to shut down Gnus, so archiving may be invoked by @code{cron} or | |
16808 | similar. You restore the data by restoring the directory tree, and | |
16809 | adding a server definition pointing to that directory in Gnus. The | |
16810 | @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things | |
16811 | might interfere with overwriting data, so you may want to shut down Gnus | |
16812 | before you restore the data. | |
4009494e | 16813 | |
8a1cdce5 AC |
16814 | @node Web Searches |
16815 | @subsection Web Searches | |
16816 | @cindex nnweb | |
16817 | @cindex Google | |
16818 | @cindex dejanews | |
16819 | @cindex gmane | |
16820 | @cindex Usenet searches | |
16821 | @cindex searching the Usenet | |
4009494e | 16822 | |
8a1cdce5 AC |
16823 | It's, like, too neat to search the Usenet for articles that match a |
16824 | string, but it, like, totally @emph{sucks}, like, totally, to use one of | |
16825 | those, like, Web browsers, and you, like, have to, rilly, like, look at | |
16826 | the commercials, so, like, with Gnus you can do @emph{rad}, rilly, | |
16827 | searches without having to use a browser. | |
4009494e | 16828 | |
8a1cdce5 AC |
16829 | The @code{nnweb} back end allows an easy interface to the mighty search |
16830 | engine. You create an @code{nnweb} group, enter a search pattern, and | |
16831 | then enter the group and read the articles like you would any normal | |
16832 | group. The @kbd{G w} command in the group buffer (@pxref{Foreign | |
16833 | Groups}) will do this in an easy-to-use fashion. | |
4009494e | 16834 | |
8a1cdce5 AC |
16835 | @code{nnweb} groups don't really lend themselves to being solid |
16836 | groups---they have a very fleeting idea of article numbers. In fact, | |
16837 | each time you enter an @code{nnweb} group (not even changing the search | |
16838 | pattern), you are likely to get the articles ordered in a different | |
16839 | manner. Not even using duplicate suppression (@pxref{Duplicate | |
16840 | Suppression}) will help, since @code{nnweb} doesn't even know the | |
16841 | @code{Message-ID} of the articles before reading them using some search | |
16842 | engines (Google, for instance). The only possible way to keep track | |
16843 | of which articles you've read is by scoring on the @code{Date} | |
16844 | header---mark all articles posted before the last date you read the | |
16845 | group as read. | |
4009494e | 16846 | |
8a1cdce5 AC |
16847 | If the search engine changes its output substantially, @code{nnweb} |
16848 | won't be able to parse it and will fail. One could hardly fault the Web | |
16849 | providers if they were to do this---their @emph{raison d'@^etre} is to | |
16850 | make money off of advertisements, not to provide services to the | |
16851 | community. Since @code{nnweb} washes the ads off all the articles, one | |
16852 | might think that the providers might be somewhat miffed. We'll see. | |
4009494e | 16853 | |
8a1cdce5 AC |
16854 | You must have the @code{url} and @code{W3} package or those alternatives |
16855 | (try @code{customize-group} on the @samp{mm-url} variable group) | |
16856 | installed to be able to use @code{nnweb}. | |
4009494e | 16857 | |
8a1cdce5 | 16858 | Virtual server variables: |
4009494e | 16859 | |
8a1cdce5 AC |
16860 | @table @code |
16861 | @item nnweb-type | |
16862 | @vindex nnweb-type | |
16863 | What search engine type is being used. The currently supported types | |
16864 | are @code{google}, @code{dejanews}, and @code{gmane}. Note that | |
16865 | @code{dejanews} is an alias to @code{google}. | |
4009494e | 16866 | |
8a1cdce5 AC |
16867 | @item nnweb-search |
16868 | @vindex nnweb-search | |
16869 | The search string to feed to the search engine. | |
4009494e | 16870 | |
8a1cdce5 AC |
16871 | @item nnweb-max-hits |
16872 | @vindex nnweb-max-hits | |
16873 | Advisory maximum number of hits per search to display. The default is | |
16874 | 999. | |
4009494e | 16875 | |
8a1cdce5 AC |
16876 | @item nnweb-type-definition |
16877 | @vindex nnweb-type-definition | |
16878 | Type-to-definition alist. This alist says what @code{nnweb} should do | |
16879 | with the various search engine types. The following elements must be | |
16880 | present: | |
4009494e | 16881 | |
8a1cdce5 AC |
16882 | @table @code |
16883 | @item article | |
16884 | Function to decode the article and provide something that Gnus | |
16885 | understands. | |
4009494e | 16886 | |
8a1cdce5 AC |
16887 | @item map |
16888 | Function to create an article number to message header and URL alist. | |
4009494e | 16889 | |
8a1cdce5 AC |
16890 | @item search |
16891 | Function to send the search string to the search engine. | |
4009494e | 16892 | |
8a1cdce5 AC |
16893 | @item address |
16894 | The address the aforementioned function should send the search string | |
16895 | to. | |
4009494e | 16896 | |
8a1cdce5 AC |
16897 | @item id |
16898 | Format string URL to fetch an article by @code{Message-ID}. | |
16899 | @end table | |
4009494e | 16900 | |
8a1cdce5 | 16901 | @end table |
4009494e | 16902 | |
4009494e | 16903 | |
8a1cdce5 AC |
16904 | @node RSS |
16905 | @subsection RSS | |
16906 | @cindex nnrss | |
16907 | @cindex RSS | |
4009494e | 16908 | |
8a1cdce5 AC |
16909 | Some web sites have an RDF Site Summary (@acronym{RSS}). |
16910 | @acronym{RSS} is a format for summarizing headlines from news related | |
16911 | sites (such as BBC or CNN). But basically anything list-like can be | |
16912 | presented as an @acronym{RSS} feed: weblogs, changelogs or recent | |
1df7defd | 16913 | changes to a wiki (e.g., @url{http://cliki.net/recent-changes.rdf}). |
4009494e | 16914 | |
8a1cdce5 AC |
16915 | @acronym{RSS} has a quite regular and nice interface, and it's |
16916 | possible to get the information Gnus needs to keep groups updated. | |
4009494e | 16917 | |
8a1cdce5 AC |
16918 | Note: you had better use Emacs which supports the @code{utf-8} coding |
16919 | system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII} | |
16920 | text by default. It is also used by default for non-@acronym{ASCII} | |
16921 | group names. | |
4009494e | 16922 | |
8a1cdce5 AC |
16923 | @kindex G R (Group) |
16924 | Use @kbd{G R} from the group buffer to subscribe to a feed---you will be | |
16925 | prompted for the location, the title and the description of the feed. | |
16926 | The title, which allows any characters, will be used for the group name | |
16927 | and the name of the group data file. The description can be omitted. | |
4009494e | 16928 | |
8a1cdce5 AC |
16929 | An easy way to get started with @code{nnrss} is to say something like |
16930 | the following in the group buffer: @kbd{B nnrss RET RET y}, then | |
16931 | subscribe to groups. | |
4009494e | 16932 | |
8a1cdce5 AC |
16933 | The @code{nnrss} back end saves the group data file in |
16934 | @code{nnrss-directory} (see below) for each @code{nnrss} group. File | |
16935 | names containing non-@acronym{ASCII} characters will be encoded by the | |
16936 | coding system specified with the @code{nnmail-pathname-coding-system} | |
16937 | variable or other. Also @xref{Non-ASCII Group Names}, for more | |
16938 | information. | |
4009494e | 16939 | |
8a1cdce5 AC |
16940 | The @code{nnrss} back end generates @samp{multipart/alternative} |
16941 | @acronym{MIME} articles in which each contains a @samp{text/plain} part | |
16942 | and a @samp{text/html} part. | |
4009494e | 16943 | |
8a1cdce5 AC |
16944 | @cindex OPML |
16945 | You can also use the following commands to import and export your | |
16946 | subscriptions from a file in @acronym{OPML} format (Outline Processor | |
16947 | Markup Language). | |
8ccbef23 | 16948 | |
8a1cdce5 AC |
16949 | @defun nnrss-opml-import file |
16950 | Prompt for an @acronym{OPML} file, and subscribe to each feed in the | |
16951 | file. | |
16952 | @end defun | |
4009494e | 16953 | |
8a1cdce5 AC |
16954 | @defun nnrss-opml-export |
16955 | Write your current @acronym{RSS} subscriptions to a buffer in | |
16956 | @acronym{OPML} format. | |
16957 | @end defun | |
4009494e | 16958 | |
8a1cdce5 | 16959 | The following @code{nnrss} variables can be altered: |
4009494e GM |
16960 | |
16961 | @table @code | |
8a1cdce5 AC |
16962 | @item nnrss-directory |
16963 | @vindex nnrss-directory | |
16964 | The directory where @code{nnrss} stores its files. The default is | |
16965 | @file{~/News/rss/}. | |
4009494e | 16966 | |
8a1cdce5 AC |
16967 | @item nnrss-file-coding-system |
16968 | @vindex nnrss-file-coding-system | |
16969 | The coding system used when reading and writing the @code{nnrss} groups | |
16970 | data files. The default is the value of | |
16971 | @code{mm-universal-coding-system} (which defaults to @code{emacs-mule} | |
16972 | in Emacs or @code{escape-quoted} in XEmacs). | |
4009494e | 16973 | |
8a1cdce5 AC |
16974 | @item nnrss-ignore-article-fields |
16975 | @vindex nnrss-ignore-article-fields | |
16976 | Some feeds update constantly article fields during their publications, | |
1df7defd | 16977 | e.g., to indicate the number of comments. However, if there is |
8a1cdce5 AC |
16978 | a difference between the local article and the distant one, the latter |
16979 | is considered to be new. To avoid this and discard some fields, set this | |
16980 | variable to the list of fields to be ignored. The default is | |
16981 | @code{'(slash:comments)}. | |
4009494e | 16982 | |
8a1cdce5 AC |
16983 | @item nnrss-use-local |
16984 | @vindex nnrss-use-local | |
16985 | @findex nnrss-generate-download-script | |
16986 | If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read | |
16987 | the feeds from local files in @code{nnrss-directory}. You can use | |
16988 | the command @code{nnrss-generate-download-script} to generate a | |
16989 | download script using @command{wget}. | |
16990 | @end table | |
4009494e | 16991 | |
8a1cdce5 AC |
16992 | The following code may be helpful, if you want to show the description in |
16993 | the summary buffer. | |
4009494e | 16994 | |
8a1cdce5 AC |
16995 | @lisp |
16996 | (add-to-list 'nnmail-extra-headers nnrss-description-field) | |
16997 | (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n") | |
4009494e | 16998 | |
8a1cdce5 AC |
16999 | (defun gnus-user-format-function-X (header) |
17000 | (let ((descr | |
17001 | (assq nnrss-description-field (mail-header-extra header)))) | |
17002 | (if descr (concat "\n\t" (cdr descr)) ""))) | |
17003 | @end lisp | |
4009494e | 17004 | |
8a1cdce5 AC |
17005 | The following code may be useful to open an nnrss url directly from the |
17006 | summary buffer. | |
4009494e | 17007 | |
8a1cdce5 AC |
17008 | @lisp |
17009 | (require 'browse-url) | |
4009494e | 17010 | |
8a1cdce5 AC |
17011 | (defun browse-nnrss-url (arg) |
17012 | (interactive "p") | |
17013 | (let ((url (assq nnrss-url-field | |
17014 | (mail-header-extra | |
17015 | (gnus-data-header | |
17016 | (assq (gnus-summary-article-number) | |
17017 | gnus-newsgroup-data)))))) | |
17018 | (if url | |
17019 | (progn | |
17020 | (browse-url (cdr url)) | |
17021 | (gnus-summary-mark-as-read-forward 1)) | |
17022 | (gnus-summary-scroll-up arg)))) | |
4009494e | 17023 | |
8a1cdce5 AC |
17024 | (eval-after-load "gnus" |
17025 | #'(define-key gnus-summary-mode-map | |
17026 | (kbd "<RET>") 'browse-nnrss-url)) | |
17027 | (add-to-list 'nnmail-extra-headers nnrss-url-field) | |
17028 | @end lisp | |
4009494e | 17029 | |
8a1cdce5 AC |
17030 | Even if you have added @samp{text/html} to the |
17031 | @code{mm-discouraged-alternatives} variable (@pxref{Display | |
17032 | Customization, ,Display Customization, emacs-mime, The Emacs MIME | |
17033 | Manual}) since you don't want to see @acronym{HTML} parts, it might be | |
17034 | more useful especially in @code{nnrss} groups to display | |
17035 | @samp{text/html} parts. Here's an example of setting | |
17036 | @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group | |
17037 | Parameters}) in order to display @samp{text/html} parts only in | |
17038 | @code{nnrss} groups: | |
4009494e | 17039 | |
8a1cdce5 AC |
17040 | @lisp |
17041 | ;; @r{Set the default value of @code{mm-discouraged-alternatives}.} | |
17042 | (eval-after-load "gnus-sum" | |
17043 | '(add-to-list | |
17044 | 'gnus-newsgroup-variables | |
17045 | '(mm-discouraged-alternatives | |
17046 | . '("text/html" "image/.*")))) | |
4009494e | 17047 | |
8a1cdce5 AC |
17048 | ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.} |
17049 | (add-to-list | |
17050 | 'gnus-parameters | |
17051 | '("\\`nnrss:" (mm-discouraged-alternatives nil))) | |
17052 | @end lisp | |
4009494e | 17053 | |
4009494e | 17054 | |
8a1cdce5 AC |
17055 | @node Customizing W3 |
17056 | @subsection Customizing W3 | |
17057 | @cindex W3 | |
17058 | @cindex html | |
17059 | @cindex url | |
17060 | @cindex Netscape | |
4009494e | 17061 | |
8a1cdce5 AC |
17062 | Gnus uses the url library to fetch web pages and Emacs/W3 (or those |
17063 | alternatives) to display web pages. Emacs/W3 is documented in its own | |
17064 | manual, but there are some things that may be more relevant for Gnus | |
17065 | users. | |
4009494e | 17066 | |
8a1cdce5 AC |
17067 | For instance, a common question is how to make Emacs/W3 follow links |
17068 | using the @code{browse-url} functions (which will call some external web | |
17069 | browser like Netscape). Here's one way: | |
4009494e | 17070 | |
8a1cdce5 AC |
17071 | @lisp |
17072 | (eval-after-load "w3" | |
17073 | '(progn | |
17074 | (fset 'w3-fetch-orig (symbol-function 'w3-fetch)) | |
17075 | (defun w3-fetch (&optional url target) | |
17076 | (interactive (list (w3-read-url-with-default))) | |
17077 | (if (eq major-mode 'gnus-article-mode) | |
17078 | (browse-url url) | |
17079 | (w3-fetch-orig url target))))) | |
17080 | @end lisp | |
4009494e | 17081 | |
8a1cdce5 AC |
17082 | Put that in your @file{.emacs} file, and hitting links in W3-rendered |
17083 | @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to | |
17084 | follow the link. | |
4009494e | 17085 | |
4009494e | 17086 | |
8a1cdce5 AC |
17087 | @node Other Sources |
17088 | @section Other Sources | |
4009494e | 17089 | |
8a1cdce5 AC |
17090 | Gnus can do more than just read news or mail. The methods described |
17091 | below allow Gnus to view directories and files as if they were | |
17092 | newsgroups. | |
4009494e | 17093 | |
8a1cdce5 AC |
17094 | @menu |
17095 | * Directory Groups:: You can read a directory as if it was a newsgroup. | |
17096 | * Anything Groups:: Dired? Who needs dired? | |
17097 | * Document Groups:: Single files can be the basis of a group. | |
17098 | * Mail-To-News Gateways:: Posting articles via mail-to-news gateways. | |
c5ecc769 | 17099 | * The Empty Backend:: The backend that never has any news. |
8a1cdce5 | 17100 | @end menu |
4009494e | 17101 | |
4009494e | 17102 | |
8a1cdce5 AC |
17103 | @node Directory Groups |
17104 | @subsection Directory Groups | |
17105 | @cindex nndir | |
17106 | @cindex directory groups | |
4009494e | 17107 | |
8a1cdce5 AC |
17108 | If you have a directory that has lots of articles in separate files in |
17109 | it, you might treat it as a newsgroup. The files have to have numerical | |
17110 | names, of course. | |
4009494e | 17111 | |
8a1cdce5 AC |
17112 | This might be an opportune moment to mention @code{ange-ftp} (and its |
17113 | successor @code{efs}), that most wonderful of all wonderful Emacs | |
17114 | packages. When I wrote @code{nndir}, I didn't think much about it---a | |
17115 | back end to read directories. Big deal. | |
4009494e | 17116 | |
8a1cdce5 AC |
17117 | @code{ange-ftp} changes that picture dramatically. For instance, if you |
17118 | enter the @code{ange-ftp} file name | |
17119 | @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name, | |
17120 | @code{ange-ftp} or @code{efs} will actually allow you to read this | |
17121 | directory over at @samp{sina} as a newsgroup. Distributed news ahoy! | |
01c52d31 | 17122 | |
8a1cdce5 | 17123 | @code{nndir} will use @acronym{NOV} files if they are present. |
4009494e | 17124 | |
8a1cdce5 AC |
17125 | @code{nndir} is a ``read-only'' back end---you can't delete or expire |
17126 | articles with this method. You can use @code{nnmh} or @code{nnml} for | |
17127 | whatever you use @code{nndir} for, so you could switch to any of those | |
17128 | methods if you feel the need to have a non-read-only @code{nndir}. | |
4009494e | 17129 | |
4009494e | 17130 | |
8a1cdce5 AC |
17131 | @node Anything Groups |
17132 | @subsection Anything Groups | |
17133 | @cindex nneething | |
4009494e | 17134 | |
8a1cdce5 AC |
17135 | From the @code{nndir} back end (which reads a single spool-like |
17136 | directory), it's just a hop and a skip to @code{nneething}, which | |
17137 | pretends that any arbitrary directory is a newsgroup. Strange, but | |
17138 | true. | |
4009494e | 17139 | |
8a1cdce5 AC |
17140 | When @code{nneething} is presented with a directory, it will scan this |
17141 | directory and assign article numbers to each file. When you enter such | |
17142 | a group, @code{nneething} must create ``headers'' that Gnus can use. | |
17143 | After all, Gnus is a newsreader, in case you're forgetting. | |
17144 | @code{nneething} does this in a two-step process. First, it snoops each | |
17145 | file in question. If the file looks like an article (i.e., the first | |
17146 | few lines look like headers), it will use this as the head. If this is | |
1df7defd | 17147 | just some arbitrary file without a head (e.g., a C source file), |
8a1cdce5 AC |
17148 | @code{nneething} will cobble up a header out of thin air. It will use |
17149 | file ownership, name and date and do whatever it can with these | |
17150 | elements. | |
4009494e | 17151 | |
8a1cdce5 AC |
17152 | All this should happen automatically for you, and you will be presented |
17153 | with something that looks very much like a newsgroup. Totally like a | |
17154 | newsgroup, to be precise. If you select an article, it will be displayed | |
17155 | in the article buffer, just as usual. | |
4009494e | 17156 | |
8a1cdce5 AC |
17157 | If you select a line that represents a directory, Gnus will pop you into |
17158 | a new summary buffer for this @code{nneething} group. And so on. You can | |
17159 | traverse the entire disk this way, if you feel like, but remember that | |
17160 | Gnus is not dired, really, and does not intend to be, either. | |
4009494e | 17161 | |
8a1cdce5 AC |
17162 | There are two overall modes to this action---ephemeral or solid. When |
17163 | doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus | |
17164 | will not store information on what files you have read, and what files | |
17165 | are new, and so on. If you create a solid @code{nneething} group the | |
17166 | normal way with @kbd{G m}, Gnus will store a mapping table between | |
17167 | article numbers and file names, and you can treat this group like any | |
17168 | other groups. When you activate a solid @code{nneething} group, you will | |
17169 | be told how many unread articles it contains, etc., etc. | |
4009494e | 17170 | |
8a1cdce5 | 17171 | Some variables: |
4009494e | 17172 | |
8a1cdce5 AC |
17173 | @table @code |
17174 | @item nneething-map-file-directory | |
17175 | @vindex nneething-map-file-directory | |
17176 | All the mapping files for solid @code{nneething} groups will be stored | |
17177 | in this directory, which defaults to @file{~/.nneething/}. | |
4009494e | 17178 | |
8a1cdce5 AC |
17179 | @item nneething-exclude-files |
17180 | @vindex nneething-exclude-files | |
17181 | All files that match this regexp will be ignored. Nice to use to exclude | |
17182 | auto-save files and the like, which is what it does by default. | |
4009494e | 17183 | |
8a1cdce5 AC |
17184 | @item nneething-include-files |
17185 | @vindex nneething-include-files | |
17186 | Regexp saying what files to include in the group. If this variable is | |
17187 | non-@code{nil}, only files matching this regexp will be included. | |
4009494e | 17188 | |
8a1cdce5 AC |
17189 | @item nneething-map-file |
17190 | @vindex nneething-map-file | |
17191 | Name of the map files. | |
17192 | @end table | |
4009494e | 17193 | |
4009494e | 17194 | |
8a1cdce5 AC |
17195 | @node Document Groups |
17196 | @subsection Document Groups | |
17197 | @cindex nndoc | |
17198 | @cindex documentation group | |
17199 | @cindex help group | |
4009494e | 17200 | |
8a1cdce5 AC |
17201 | @code{nndoc} is a cute little thing that will let you read a single file |
17202 | as a newsgroup. Several files types are supported: | |
4009494e GM |
17203 | |
17204 | @table @code | |
8a1cdce5 AC |
17205 | @cindex Babyl |
17206 | @item babyl | |
17207 | The Babyl format. | |
4009494e | 17208 | |
8a1cdce5 AC |
17209 | @cindex mbox |
17210 | @cindex Unix mbox | |
17211 | @item mbox | |
17212 | The standard Unix mbox file. | |
4009494e | 17213 | |
8a1cdce5 AC |
17214 | @cindex MMDF mail box |
17215 | @item mmdf | |
17216 | The MMDF mail box format. | |
4009494e | 17217 | |
8a1cdce5 AC |
17218 | @item news |
17219 | Several news articles appended into a file. | |
4009494e | 17220 | |
8a1cdce5 AC |
17221 | @cindex rnews batch files |
17222 | @item rnews | |
17223 | The rnews batch transport format. | |
4009494e | 17224 | |
8a1cdce5 AC |
17225 | @item nsmail |
17226 | Netscape mail boxes. | |
4009494e | 17227 | |
8a1cdce5 AC |
17228 | @item mime-parts |
17229 | @acronym{MIME} multipart messages. | |
4009494e | 17230 | |
8a1cdce5 AC |
17231 | @item standard-digest |
17232 | The standard (RFC 1153) digest format. | |
4009494e | 17233 | |
8a1cdce5 AC |
17234 | @item mime-digest |
17235 | A @acronym{MIME} digest of messages. | |
4009494e | 17236 | |
8a1cdce5 AC |
17237 | @item lanl-gov-announce |
17238 | Announcement messages from LANL Gov Announce. | |
4009494e | 17239 | |
8a1cdce5 AC |
17240 | @cindex git commit messages |
17241 | @item git | |
17242 | @code{git} commit messages. | |
4009494e | 17243 | |
8a1cdce5 AC |
17244 | @cindex forwarded messages |
17245 | @item rfc822-forward | |
17246 | A message forwarded according to RFC822. | |
4009494e | 17247 | |
8a1cdce5 AC |
17248 | @item outlook |
17249 | The Outlook mail box. | |
4009494e | 17250 | |
8a1cdce5 AC |
17251 | @item oe-dbx |
17252 | The Outlook Express dbx mail box. | |
4009494e | 17253 | |
8a1cdce5 AC |
17254 | @item exim-bounce |
17255 | A bounce message from the Exim MTA. | |
4009494e | 17256 | |
8a1cdce5 AC |
17257 | @item forward |
17258 | A message forwarded according to informal rules. | |
4009494e | 17259 | |
8a1cdce5 AC |
17260 | @item rfc934 |
17261 | An RFC934-forwarded message. | |
4009494e | 17262 | |
8a1cdce5 AC |
17263 | @item mailman |
17264 | A mailman digest. | |
4009494e | 17265 | |
8a1cdce5 AC |
17266 | @item clari-briefs |
17267 | A digest of Clarinet brief news items. | |
4009494e | 17268 | |
8a1cdce5 AC |
17269 | @item slack-digest |
17270 | Non-standard digest format---matches most things, but does it badly. | |
17271 | ||
17272 | @item mail-in-mail | |
17273 | The last resort. | |
4009494e GM |
17274 | @end table |
17275 | ||
8a1cdce5 AC |
17276 | You can also use the special ``file type'' @code{guess}, which means |
17277 | that @code{nndoc} will try to guess what file type it is looking at. | |
17278 | @code{digest} means that @code{nndoc} should guess what digest type the | |
17279 | file is. | |
4009494e | 17280 | |
8a1cdce5 AC |
17281 | @code{nndoc} will not try to change the file or insert any extra headers into |
17282 | it---it will simply, like, let you use the file as the basis for a | |
17283 | group. And that's it. | |
4009494e | 17284 | |
8a1cdce5 AC |
17285 | If you have some old archived articles that you want to insert into your |
17286 | new & spiffy Gnus mail back end, @code{nndoc} can probably help you with | |
17287 | that. Say you have an old @file{RMAIL} file with mail that you now want | |
17288 | to split into your new @code{nnml} groups. You look at that file using | |
17289 | @code{nndoc} (using the @kbd{G f} command in the group buffer | |
17290 | (@pxref{Foreign Groups})), set the process mark on all the articles in | |
17291 | the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r}) | |
17292 | using @code{nnml}. If all goes well, all the mail in the @file{RMAIL} | |
17293 | file is now also stored in lots of @code{nnml} directories, and you can | |
17294 | delete that pesky @file{RMAIL} file. If you have the guts! | |
4009494e | 17295 | |
8a1cdce5 | 17296 | Virtual server variables: |
4009494e | 17297 | |
8a1cdce5 AC |
17298 | @table @code |
17299 | @item nndoc-article-type | |
17300 | @vindex nndoc-article-type | |
17301 | This should be one of @code{mbox}, @code{babyl}, @code{digest}, | |
17302 | @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934}, | |
17303 | @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest}, | |
17304 | @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook}, | |
17305 | @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}. | |
4009494e | 17306 | |
8a1cdce5 AC |
17307 | @item nndoc-post-type |
17308 | @vindex nndoc-post-type | |
17309 | This variable says whether Gnus is to consider the group a news group or | |
17310 | a mail group. There are two valid values: @code{mail} (the default) | |
17311 | and @code{news}. | |
17312 | @end table | |
4009494e | 17313 | |
8a1cdce5 AC |
17314 | @menu |
17315 | * Document Server Internals:: How to add your own document types. | |
17316 | @end menu | |
4009494e | 17317 | |
4009494e | 17318 | |
8a1cdce5 AC |
17319 | @node Document Server Internals |
17320 | @subsubsection Document Server Internals | |
4009494e | 17321 | |
8a1cdce5 AC |
17322 | Adding new document types to be recognized by @code{nndoc} isn't |
17323 | difficult. You just have to whip up a definition of what the document | |
17324 | looks like, write a predicate function to recognize that document type, | |
17325 | and then hook into @code{nndoc}. | |
4009494e | 17326 | |
8a1cdce5 | 17327 | First, here's an example document type definition: |
4009494e | 17328 | |
8a1cdce5 AC |
17329 | @example |
17330 | (mmdf | |
17331 | (article-begin . "^\^A\^A\^A\^A\n") | |
17332 | (body-end . "^\^A\^A\^A\^A\n")) | |
17333 | @end example | |
4009494e | 17334 | |
8a1cdce5 AC |
17335 | The definition is simply a unique @dfn{name} followed by a series of |
17336 | regexp pseudo-variable settings. Below are the possible | |
17337 | variables---don't be daunted by the number of variables; most document | |
17338 | types can be defined with very few settings: | |
4009494e | 17339 | |
8a1cdce5 AC |
17340 | @table @code |
17341 | @item first-article | |
17342 | If present, @code{nndoc} will skip past all text until it finds | |
17343 | something that match this regexp. All text before this will be | |
17344 | totally ignored. | |
4009494e | 17345 | |
8a1cdce5 AC |
17346 | @item article-begin |
17347 | This setting has to be present in all document type definitions. It | |
17348 | says what the beginning of each article looks like. To do more | |
17349 | complicated things that cannot be dealt with a simple regexp, you can | |
17350 | use @code{article-begin-function} instead of this. | |
4009494e | 17351 | |
8a1cdce5 AC |
17352 | @item article-begin-function |
17353 | If present, this should be a function that moves point to the beginning | |
17354 | of each article. This setting overrides @code{article-begin}. | |
4009494e | 17355 | |
8a1cdce5 AC |
17356 | @item head-begin |
17357 | If present, this should be a regexp that matches the head of the | |
17358 | article. To do more complicated things that cannot be dealt with a | |
17359 | simple regexp, you can use @code{head-begin-function} instead of this. | |
4009494e | 17360 | |
8a1cdce5 AC |
17361 | @item head-begin-function |
17362 | If present, this should be a function that moves point to the head of | |
17363 | the article. This setting overrides @code{head-begin}. | |
4009494e | 17364 | |
8a1cdce5 AC |
17365 | @item head-end |
17366 | This should match the end of the head of the article. It defaults to | |
17367 | @samp{^$}---the empty line. | |
4009494e | 17368 | |
8a1cdce5 AC |
17369 | @item body-begin |
17370 | This should match the beginning of the body of the article. It defaults | |
17371 | to @samp{^\n}. To do more complicated things that cannot be dealt with | |
17372 | a simple regexp, you can use @code{body-begin-function} instead of this. | |
4009494e | 17373 | |
8a1cdce5 AC |
17374 | @item body-begin-function |
17375 | If present, this function should move point to the beginning of the body | |
17376 | of the article. This setting overrides @code{body-begin}. | |
4009494e | 17377 | |
8a1cdce5 AC |
17378 | @item body-end |
17379 | If present, this should match the end of the body of the article. To do | |
17380 | more complicated things that cannot be dealt with a simple regexp, you | |
17381 | can use @code{body-end-function} instead of this. | |
4009494e | 17382 | |
8a1cdce5 AC |
17383 | @item body-end-function |
17384 | If present, this function should move point to the end of the body of | |
17385 | the article. This setting overrides @code{body-end}. | |
17386 | ||
17387 | @item file-begin | |
17388 | If present, this should match the beginning of the file. All text | |
17389 | before this regexp will be totally ignored. | |
17390 | ||
17391 | @item file-end | |
17392 | If present, this should match the end of the file. All text after this | |
17393 | regexp will be totally ignored. | |
4009494e GM |
17394 | |
17395 | @end table | |
17396 | ||
8a1cdce5 AC |
17397 | So, using these variables @code{nndoc} is able to dissect a document |
17398 | file into a series of articles, each with a head and a body. However, a | |
17399 | few more variables are needed since not all document types are all that | |
17400 | news-like---variables needed to transform the head or the body into | |
17401 | something that's palatable for Gnus: | |
4009494e | 17402 | |
8a1cdce5 AC |
17403 | @table @code |
17404 | @item prepare-body-function | |
17405 | If present, this function will be called when requesting an article. It | |
17406 | will be called with point at the start of the body, and is useful if the | |
17407 | document has encoded some parts of its contents. | |
4009494e | 17408 | |
8a1cdce5 AC |
17409 | @item article-transform-function |
17410 | If present, this function is called when requesting an article. It's | |
17411 | meant to be used for more wide-ranging transformation of both head and | |
17412 | body of the article. | |
4009494e | 17413 | |
8a1cdce5 AC |
17414 | @item generate-head-function |
17415 | If present, this function is called to generate a head that Gnus can | |
17416 | understand. It is called with the article number as a parameter, and is | |
17417 | expected to generate a nice head for the article in question. It is | |
17418 | called when requesting the headers of all articles. | |
4009494e | 17419 | |
8a1cdce5 AC |
17420 | @item generate-article-function |
17421 | If present, this function is called to generate an entire article that | |
17422 | Gnus can understand. It is called with the article number as a | |
17423 | parameter when requesting all articles. | |
4009494e | 17424 | |
8a1cdce5 AC |
17425 | @item dissection-function |
17426 | If present, this function is called to dissect a document by itself, | |
17427 | overriding @code{first-article}, @code{article-begin}, | |
17428 | @code{article-begin-function}, @code{head-begin}, | |
17429 | @code{head-begin-function}, @code{head-end}, @code{body-begin}, | |
17430 | @code{body-begin-function}, @code{body-end}, @code{body-end-function}, | |
17431 | @code{file-begin}, and @code{file-end}. | |
4009494e | 17432 | |
8a1cdce5 | 17433 | @end table |
4009494e | 17434 | |
8a1cdce5 AC |
17435 | Let's look at the most complicated example I can come up with---standard |
17436 | digests: | |
4009494e | 17437 | |
8a1cdce5 AC |
17438 | @example |
17439 | (standard-digest | |
17440 | (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+")) | |
17441 | (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+")) | |
17442 | (prepare-body-function . nndoc-unquote-dashes) | |
17443 | (body-end-function . nndoc-digest-body-end) | |
17444 | (head-end . "^ ?$") | |
17445 | (body-begin . "^ ?\n") | |
17446 | (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$") | |
17447 | (subtype digest guess)) | |
17448 | @end example | |
4009494e | 17449 | |
8a1cdce5 AC |
17450 | We see that all text before a 70-width line of dashes is ignored; all |
17451 | text after a line that starts with that @samp{^End of} is also ignored; | |
17452 | each article begins with a 30-width line of dashes; the line separating | |
17453 | the head from the body may contain a single space; and that the body is | |
17454 | run through @code{nndoc-unquote-dashes} before being delivered. | |
4009494e | 17455 | |
8a1cdce5 AC |
17456 | To hook your own document definition into @code{nndoc}, use the |
17457 | @code{nndoc-add-type} function. It takes two parameters---the first | |
17458 | is the definition itself and the second (optional) parameter says | |
17459 | where in the document type definition alist to put this definition. | |
17460 | The alist is traversed sequentially, and | |
17461 | @code{nndoc-@var{type}-type-p} is called for a given type @var{type}. | |
17462 | So @code{nndoc-mmdf-type-p} is called to see whether a document is of | |
17463 | @code{mmdf} type, and so on. These type predicates should return | |
17464 | @code{nil} if the document is not of the correct type; @code{t} if it | |
17465 | is of the correct type; and a number if the document might be of the | |
17466 | correct type. A high number means high probability; a low number | |
17467 | means low probability with @samp{0} being the lowest valid number. | |
4009494e | 17468 | |
4009494e | 17469 | |
8a1cdce5 AC |
17470 | @node Mail-To-News Gateways |
17471 | @subsection Mail-To-News Gateways | |
17472 | @cindex mail-to-news gateways | |
17473 | @cindex gateways | |
4009494e | 17474 | |
8a1cdce5 AC |
17475 | If your local @code{nntp} server doesn't allow posting, for some reason |
17476 | or other, you can post using one of the numerous mail-to-news gateways. | |
17477 | The @code{nngateway} back end provides the interface. | |
4009494e | 17478 | |
8a1cdce5 AC |
17479 | Note that you can't read anything from this back end---it can only be |
17480 | used to post with. | |
4009494e | 17481 | |
8a1cdce5 | 17482 | Server variables: |
4009494e | 17483 | |
8a1cdce5 AC |
17484 | @table @code |
17485 | @item nngateway-address | |
17486 | @vindex nngateway-address | |
17487 | This is the address of the mail-to-news gateway. | |
4009494e | 17488 | |
8a1cdce5 AC |
17489 | @item nngateway-header-transformation |
17490 | @vindex nngateway-header-transformation | |
17491 | News headers often have to be transformed in some odd way or other | |
17492 | for the mail-to-news gateway to accept it. This variable says what | |
17493 | transformation should be called, and defaults to | |
17494 | @code{nngateway-simple-header-transformation}. The function is called | |
17495 | narrowed to the headers to be transformed and with one parameter---the | |
17496 | gateway address. | |
4009494e | 17497 | |
8a1cdce5 AC |
17498 | This default function just inserts a new @code{To} header based on the |
17499 | @code{Newsgroups} header and the gateway address. | |
17500 | For instance, an article with this @code{Newsgroups} header: | |
4009494e | 17501 | |
8a1cdce5 AC |
17502 | @example |
17503 | Newsgroups: alt.religion.emacs | |
17504 | @end example | |
4009494e | 17505 | |
8a1cdce5 | 17506 | will get this @code{To} header inserted: |
4009494e | 17507 | |
8a1cdce5 AC |
17508 | @example |
17509 | To: alt-religion-emacs@@GATEWAY | |
17510 | @end example | |
4009494e | 17511 | |
8a1cdce5 | 17512 | The following pre-defined functions exist: |
4009494e | 17513 | |
8a1cdce5 AC |
17514 | @findex nngateway-simple-header-transformation |
17515 | @table @code | |
4009494e | 17516 | |
8a1cdce5 AC |
17517 | @item nngateway-simple-header-transformation |
17518 | Creates a @code{To} header that looks like | |
17519 | @var{newsgroup}@@@code{nngateway-address}. | |
4009494e | 17520 | |
8a1cdce5 | 17521 | @findex nngateway-mail2news-header-transformation |
4009494e | 17522 | |
8a1cdce5 AC |
17523 | @item nngateway-mail2news-header-transformation |
17524 | Creates a @code{To} header that looks like | |
17525 | @code{nngateway-address}. | |
17526 | @end table | |
4009494e GM |
17527 | |
17528 | @end table | |
17529 | ||
8a1cdce5 | 17530 | Here's an example: |
4009494e | 17531 | |
8a1cdce5 AC |
17532 | @lisp |
17533 | (setq gnus-post-method | |
17534 | '(nngateway | |
17535 | "mail2news@@replay.com" | |
17536 | (nngateway-header-transformation | |
17537 | nngateway-mail2news-header-transformation))) | |
17538 | @end lisp | |
4009494e | 17539 | |
8a1cdce5 | 17540 | So, to use this, simply say something like: |
4009494e | 17541 | |
8a1cdce5 AC |
17542 | @lisp |
17543 | (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS")) | |
17544 | @end lisp | |
4009494e | 17545 | |
4009494e | 17546 | |
c5ecc769 G |
17547 | @node The Empty Backend |
17548 | @subsection The Empty Backend | |
17549 | @cindex nnnil | |
17550 | ||
17551 | @code{nnnil} is a backend that can be used as a placeholder if you | |
17552 | have to specify a backend somewhere, but don't really want to. The | |
17553 | classical example is if you don't want to have a primary select | |
17554 | methods, but want to only use secondary ones: | |
17555 | ||
17556 | @lisp | |
17557 | (setq gnus-select-method '(nnnil "")) | |
17558 | (setq gnus-secondary-select-methods | |
17559 | '((nnimap "foo") | |
17560 | (nnml ""))) | |
17561 | @end lisp | |
17562 | ||
8a1cdce5 AC |
17563 | |
17564 | @node Combined Groups | |
17565 | @section Combined Groups | |
17566 | ||
17567 | Gnus allows combining a mixture of all the other group types into bigger | |
17568 | groups. | |
4009494e GM |
17569 | |
17570 | @menu | |
8a1cdce5 | 17571 | * Virtual Groups:: Combining articles from many groups. |
4009494e GM |
17572 | @end menu |
17573 | ||
4009494e | 17574 | |
8a1cdce5 AC |
17575 | @node Virtual Groups |
17576 | @subsection Virtual Groups | |
17577 | @cindex nnvirtual | |
17578 | @cindex virtual groups | |
17579 | @cindex merging groups | |
4009494e | 17580 | |
8a1cdce5 AC |
17581 | An @dfn{nnvirtual group} is really nothing more than a collection of |
17582 | other groups. | |
4009494e | 17583 | |
8a1cdce5 AC |
17584 | For instance, if you are tired of reading many small groups, you can |
17585 | put them all in one big group, and then grow tired of reading one | |
17586 | big, unwieldy group. The joys of computing! | |
4009494e | 17587 | |
8a1cdce5 AC |
17588 | You specify @code{nnvirtual} as the method. The address should be a |
17589 | regexp to match component groups. | |
4009494e | 17590 | |
8a1cdce5 AC |
17591 | All marks in the virtual group will stick to the articles in the |
17592 | component groups. So if you tick an article in a virtual group, the | |
17593 | article will also be ticked in the component group from whence it | |
17594 | came. (And vice versa---marks from the component groups will also be | |
17595 | shown in the virtual group.). To create an empty virtual group, run | |
17596 | @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer | |
17597 | and edit the method regexp with @kbd{M-e} | |
17598 | (@code{gnus-group-edit-group-method}) | |
4009494e | 17599 | |
8a1cdce5 AC |
17600 | Here's an example @code{nnvirtual} method that collects all Andrea Dworkin |
17601 | newsgroups into one, big, happy newsgroup: | |
4009494e | 17602 | |
8a1cdce5 AC |
17603 | @lisp |
17604 | (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*") | |
17605 | @end lisp | |
4009494e | 17606 | |
8a1cdce5 AC |
17607 | The component groups can be native or foreign; everything should work |
17608 | smoothly, but if your computer explodes, it was probably my fault. | |
4009494e | 17609 | |
8a1cdce5 AC |
17610 | Collecting the same group from several servers might actually be a good |
17611 | idea if users have set the Distribution header to limit distribution. | |
17612 | If you would like to read @samp{soc.motss} both from a server in Japan | |
17613 | and a server in Norway, you could use the following as the group regexp: | |
4009494e | 17614 | |
8a1cdce5 AC |
17615 | @example |
17616 | "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$" | |
17617 | @end example | |
4009494e | 17618 | |
8a1cdce5 AC |
17619 | (Remember, though, that if you're creating the group with @kbd{G m}, you |
17620 | shouldn't double the backslashes, and you should leave off the quote | |
17621 | characters at the beginning and the end of the string.) | |
4009494e | 17622 | |
8a1cdce5 AC |
17623 | This should work kinda smoothly---all articles from both groups should |
17624 | end up in this one, and there should be no duplicates. Threading (and | |
17625 | the rest) will still work as usual, but there might be problems with the | |
17626 | sequence of articles. Sorting on date might be an option here | |
17627 | (@pxref{Selecting a Group}). | |
4009494e | 17628 | |
8a1cdce5 AC |
17629 | One limitation, however---all groups included in a virtual |
17630 | group have to be alive (i.e., subscribed or unsubscribed). Killed or | |
17631 | zombie groups can't be component groups for @code{nnvirtual} groups. | |
4009494e | 17632 | |
8a1cdce5 AC |
17633 | @vindex nnvirtual-always-rescan |
17634 | If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which | |
17635 | is the default), @code{nnvirtual} will always scan groups for unread | |
17636 | articles when entering a virtual group. If this variable is @code{nil} | |
17637 | and you read articles in a component group after the virtual group has | |
17638 | been activated, the read articles from the component group will show up | |
17639 | when you enter the virtual group. You'll also see this effect if you | |
17640 | have two virtual groups that have a component group in common. If | |
17641 | that's the case, you should set this variable to @code{t}. Or you can | |
17642 | just tap @code{M-g} on the virtual group every time before you enter | |
17643 | it---it'll have much the same effect. | |
4009494e | 17644 | |
8a1cdce5 AC |
17645 | @code{nnvirtual} can have both mail and news groups as component groups. |
17646 | When responding to articles in @code{nnvirtual} groups, @code{nnvirtual} | |
17647 | has to ask the back end of the component group the article comes from | |
17648 | whether it is a news or mail back end. However, when you do a @kbd{^}, | |
17649 | there is typically no sure way for the component back end to know this, | |
17650 | and in that case @code{nnvirtual} tells Gnus that the article came from a | |
17651 | not-news back end. (Just to be on the safe side.) | |
4009494e | 17652 | |
8a1cdce5 AC |
17653 | @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups} |
17654 | line from the article you respond to in these cases. | |
4009494e | 17655 | |
8a1cdce5 AC |
17656 | @code{nnvirtual} groups do not inherit anything but articles and marks |
17657 | from component groups---group parameters, for instance, are not | |
17658 | inherited. | |
4009494e | 17659 | |
4009494e | 17660 | |
8a1cdce5 AC |
17661 | @node Email Based Diary |
17662 | @section Email Based Diary | |
17663 | @cindex diary | |
17664 | @cindex email based diary | |
17665 | @cindex calendar | |
4009494e | 17666 | |
8a1cdce5 AC |
17667 | This section describes a special mail back end called @code{nndiary}, |
17668 | and its companion library @code{gnus-diary}. It is ``special'' in the | |
17669 | sense that it is not meant to be one of the standard alternatives for | |
17670 | reading mail with Gnus. See @ref{Choosing a Mail Back End} for that. | |
17671 | Instead, it is used to treat @emph{some} of your mails in a special way, | |
17672 | namely, as event reminders. | |
4009494e | 17673 | |
8a1cdce5 | 17674 | Here is a typical scenario: |
4009494e | 17675 | |
8a1cdce5 AC |
17676 | @itemize @bullet |
17677 | @item | |
17678 | You've got a date with Andy Mc Dowell or Bruce Willis (select according | |
17679 | to your sexual preference) in one month. You don't want to forget it. | |
17680 | @item | |
17681 | So you send a ``reminder'' message (actually, a diary one) to yourself. | |
17682 | @item | |
17683 | You forget all about it and keep on getting and reading new mail, as usual. | |
17684 | @item | |
17685 | From time to time, as you type `g' in the group buffer and as the date | |
17686 | is getting closer, the message will pop up again to remind you of your | |
17687 | appointment, just as if it were new and unread. | |
17688 | @item | |
17689 | Read your ``new'' messages, this one included, and start dreaming again | |
17690 | of the night you're gonna have. | |
17691 | @item | |
17692 | Once the date is over (you actually fell asleep just after dinner), the | |
17693 | message will be automatically deleted if it is marked as expirable. | |
17694 | @end itemize | |
4009494e | 17695 | |
8a1cdce5 AC |
17696 | The Gnus Diary back end has the ability to handle regular appointments |
17697 | (that wouldn't ever be deleted) as well as punctual ones, operates as a | |
17698 | real mail back end and is configurable in many ways. All of this is | |
17699 | explained in the sections below. | |
4009494e | 17700 | |
8a1cdce5 AC |
17701 | @menu |
17702 | * The NNDiary Back End:: Basic setup and usage. | |
17703 | * The Gnus Diary Library:: Utility toolkit on top of nndiary. | |
17704 | * Sending or Not Sending:: A final note on sending diary messages. | |
17705 | @end menu | |
4009494e GM |
17706 | |
17707 | ||
8a1cdce5 AC |
17708 | @node The NNDiary Back End |
17709 | @subsection The NNDiary Back End | |
17710 | @cindex nndiary | |
17711 | @cindex the nndiary back end | |
4009494e | 17712 | |
8a1cdce5 AC |
17713 | @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail |
17714 | Spool}). Actually, it could appear as a mix of @code{nnml} and | |
17715 | @code{nndraft}. If you know @code{nnml}, you're already familiar with | |
17716 | the message storing scheme of @code{nndiary}: one file per message, one | |
17717 | directory per group. | |
4009494e | 17718 | |
8a1cdce5 AC |
17719 | Before anything, there is one requirement to be able to run |
17720 | @code{nndiary} properly: you @emph{must} use the group timestamp feature | |
17721 | of Gnus. This adds a timestamp to each group's parameters. @ref{Group | |
17722 | Timestamp} to see how it's done. | |
4009494e | 17723 | |
8a1cdce5 AC |
17724 | @menu |
17725 | * Diary Messages:: What makes a message valid for nndiary. | |
17726 | * Running NNDiary:: NNDiary has two modes of operation. | |
17727 | * Customizing NNDiary:: Bells and whistles. | |
17728 | @end menu | |
4009494e | 17729 | |
8a1cdce5 AC |
17730 | @node Diary Messages |
17731 | @subsubsection Diary Messages | |
17732 | @cindex nndiary messages | |
17733 | @cindex nndiary mails | |
4009494e | 17734 | |
8a1cdce5 AC |
17735 | @code{nndiary} messages are just normal ones, except for the mandatory |
17736 | presence of 7 special headers. These headers are of the form | |
17737 | @code{X-Diary-<something>}, @code{<something>} being one of | |
17738 | @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year}, | |
17739 | @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and | |
17740 | @code{dow} means ``Day of Week''. These headers actually behave like | |
17741 | crontab specifications and define the event date(s): | |
4009494e | 17742 | |
8a1cdce5 AC |
17743 | @itemize @bullet |
17744 | @item | |
17745 | For all headers except the @code{Time-Zone} one, a header value is | |
17746 | either a star (meaning all possible values), or a list of fields | |
17747 | (separated by a comma). | |
17748 | @item | |
17749 | A field is either an integer, or a range. | |
17750 | @item | |
17751 | A range is two integers separated by a dash. | |
17752 | @item | |
17753 | Possible integer values are 0--59 for @code{Minute}, 0--23 for | |
17754 | @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971 | |
17755 | for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday). | |
17756 | @item | |
17757 | As a special case, a star in either @code{Dom} or @code{Dow} doesn't | |
17758 | mean ``all possible values'', but ``use only the other field''. Note | |
17759 | that if both are star'ed, the use of either one gives the same result. | |
17760 | @item | |
17761 | The @code{Time-Zone} header is special in that it can only have one | |
17762 | value (@code{GMT}, for instance). A star doesn't mean ``all possible | |
17763 | values'' (because it makes no sense), but ``the current local time | |
17764 | zone''. Most of the time, you'll be using a star here. However, for a | |
17765 | list of available time zone values, see the variable | |
17766 | @code{nndiary-headers}. | |
17767 | @end itemize | |
4009494e | 17768 | |
8a1cdce5 AC |
17769 | As a concrete example, here are the diary headers to add to your message |
17770 | for specifying ``Each Monday and each 1st of month, at 12:00, 20:00, | |
17771 | 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find | |
17772 | what to do then): | |
4009494e | 17773 | |
8a1cdce5 AC |
17774 | @example |
17775 | X-Diary-Minute: 0 | |
17776 | X-Diary-Hour: 12, 20-24 | |
17777 | X-Diary-Dom: 1 | |
17778 | X-Diary-Month: * | |
17779 | X-Diary-Year: 1999-2010 | |
17780 | X-Diary-Dow: 1 | |
17781 | X-Diary-Time-Zone: * | |
17782 | @end example | |
4009494e | 17783 | |
8a1cdce5 AC |
17784 | @node Running NNDiary |
17785 | @subsubsection Running NNDiary | |
17786 | @cindex running nndiary | |
17787 | @cindex nndiary operation modes | |
4009494e | 17788 | |
8a1cdce5 AC |
17789 | @code{nndiary} has two modes of operation: ``traditional'' (the default) |
17790 | and ``autonomous''. In traditional mode, @code{nndiary} does not get new | |
17791 | mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails | |
17792 | from your primary mail back end to nndiary groups in order to handle them | |
17793 | as diary messages. In autonomous mode, @code{nndiary} retrieves its own | |
17794 | mail and handles it independently from your primary mail back end. | |
4009494e | 17795 | |
8a1cdce5 AC |
17796 | One should note that Gnus is not inherently designed to allow several |
17797 | ``master'' mail back ends at the same time. However, this does make | |
17798 | sense with @code{nndiary}: you really want to send and receive diary | |
17799 | messages to your diary groups directly. So, @code{nndiary} supports | |
17800 | being sort of a ``second primary mail back end'' (to my knowledge, it is | |
17801 | the only back end offering this feature). However, there is a limitation | |
17802 | (which I hope to fix some day): respooling doesn't work in autonomous | |
17803 | mode. | |
4009494e | 17804 | |
8a1cdce5 AC |
17805 | In order to use @code{nndiary} in autonomous mode, you have several |
17806 | things to do: | |
4009494e | 17807 | |
8a1cdce5 AC |
17808 | @itemize @bullet |
17809 | @item | |
17810 | Allow @code{nndiary} to retrieve new mail by itself. Put the following | |
17811 | line in your @file{~/.gnus.el} file: | |
4009494e | 17812 | |
8a1cdce5 AC |
17813 | @lisp |
17814 | (setq nndiary-get-new-mail t) | |
17815 | @end lisp | |
17816 | @item | |
17817 | You must arrange for diary messages (those containing @code{X-Diary-*} | |
17818 | headers) to be split in a private folder @emph{before} Gnus treat them. | |
17819 | Again, this is needed because Gnus cannot (yet ?) properly handle | |
17820 | multiple primary mail back ends. Getting those messages from a separate | |
17821 | source will compensate this misfeature to some extent. | |
01c52d31 | 17822 | |
8a1cdce5 AC |
17823 | As an example, here's my procmailrc entry to store diary files in |
17824 | @file{~/.nndiary} (the default @code{nndiary} mail source file): | |
4009494e | 17825 | |
8a1cdce5 AC |
17826 | @example |
17827 | :0 HD : | |
17828 | * ^X-Diary | |
17829 | .nndiary | |
17830 | @end example | |
17831 | @end itemize | |
4009494e | 17832 | |
8a1cdce5 AC |
17833 | Once this is done, you might want to customize the following two options |
17834 | that affect the diary mail retrieval and splitting processes: | |
4009494e | 17835 | |
8a1cdce5 AC |
17836 | @defvar nndiary-mail-sources |
17837 | This is the diary-specific replacement for the standard | |
17838 | @code{mail-sources} variable. It obeys the same syntax, and defaults to | |
17839 | @code{(file :path "~/.nndiary")}. | |
17840 | @end defvar | |
4009494e | 17841 | |
8a1cdce5 AC |
17842 | @defvar nndiary-split-methods |
17843 | This is the diary-specific replacement for the standard | |
17844 | @code{nnmail-split-methods} variable. It obeys the same syntax. | |
17845 | @end defvar | |
4009494e | 17846 | |
8a1cdce5 AC |
17847 | Finally, you may add a permanent @code{nndiary} virtual server |
17848 | (something like @code{(nndiary "diary")} should do) to your | |
17849 | @code{gnus-secondary-select-methods}. | |
4009494e | 17850 | |
8a1cdce5 AC |
17851 | Hopefully, almost everything (see the TODO section in |
17852 | @file{nndiary.el}) will work as expected when you restart Gnus: in | |
17853 | autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will | |
17854 | also get your new diary mails and split them according to your | |
17855 | diary-specific rules, @kbd{F} will find your new diary groups etc. | |
4009494e | 17856 | |
8a1cdce5 AC |
17857 | @node Customizing NNDiary |
17858 | @subsubsection Customizing NNDiary | |
17859 | @cindex customizing nndiary | |
17860 | @cindex nndiary customization | |
4009494e | 17861 | |
8a1cdce5 AC |
17862 | Now that @code{nndiary} is up and running, it's time to customize it. |
17863 | The custom group is called @code{nndiary} (no, really ?!). You should | |
17864 | browse it to figure out which options you'd like to tweak. The following | |
17865 | two variables are probably the only ones you will want to change: | |
4009494e | 17866 | |
8a1cdce5 AC |
17867 | @defvar nndiary-reminders |
17868 | This is the list of times when you want to be reminded of your | |
1df7defd | 17869 | appointments (e.g., 3 weeks before, then 2 days before, then 1 hour |
8a1cdce5 AC |
17870 | before and that's it). Remember that ``being reminded'' means that the |
17871 | diary message will pop up as brand new and unread again when you get new | |
17872 | mail. | |
17873 | @end defvar | |
4009494e | 17874 | |
8a1cdce5 AC |
17875 | @defvar nndiary-week-starts-on-monday |
17876 | Rather self-explanatory. Otherwise, Sunday is assumed (this is the | |
17877 | default). | |
17878 | @end defvar | |
4009494e GM |
17879 | |
17880 | ||
8a1cdce5 AC |
17881 | @node The Gnus Diary Library |
17882 | @subsection The Gnus Diary Library | |
17883 | @cindex gnus-diary | |
17884 | @cindex the gnus diary library | |
4009494e | 17885 | |
8a1cdce5 AC |
17886 | Using @code{nndiary} manually (I mean, writing the headers by hand and |
17887 | so on) would be rather boring. Fortunately, there is a library called | |
17888 | @code{gnus-diary} written on top of @code{nndiary}, that does many | |
17889 | useful things for you. | |
4009494e | 17890 | |
8a1cdce5 | 17891 | In order to use it, add the following line to your @file{~/.gnus.el} file: |
4009494e GM |
17892 | |
17893 | @lisp | |
8a1cdce5 | 17894 | (require 'gnus-diary) |
4009494e GM |
17895 | @end lisp |
17896 | ||
8a1cdce5 AC |
17897 | Also, you shouldn't use any @code{gnus-user-format-function-[d|D]} |
17898 | (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these | |
17899 | (sorry if you used them before). | |
4009494e | 17900 | |
4009494e GM |
17901 | |
17902 | @menu | |
8a1cdce5 AC |
17903 | * Diary Summary Line Format:: A nicer summary buffer line format. |
17904 | * Diary Articles Sorting:: A nicer way to sort messages. | |
17905 | * Diary Headers Generation:: Not doing it manually. | |
17906 | * Diary Group Parameters:: Not handling them manually. | |
4009494e GM |
17907 | @end menu |
17908 | ||
8a1cdce5 AC |
17909 | @node Diary Summary Line Format |
17910 | @subsubsection Diary Summary Line Format | |
17911 | @cindex diary summary buffer line | |
17912 | @cindex diary summary line format | |
4009494e | 17913 | |
8a1cdce5 AC |
17914 | Displaying diary messages in standard summary line format (usually |
17915 | something like @samp{From Joe: Subject}) is pretty useless. Most of | |
17916 | the time, you're the one who wrote the message, and you mostly want to | |
17917 | see the event's date. | |
4009494e | 17918 | |
8a1cdce5 AC |
17919 | @code{gnus-diary} provides two supplemental user formats to be used in |
17920 | summary line formats. @code{D} corresponds to a formatted time string | |
1df7defd | 17921 | for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''), |
91af3942 | 17922 | while @code{d} corresponds to an approximate remaining time until the |
1df7defd | 17923 | next occurrence of the event (e.g., ``in 6 months, 1 week''). |
4009494e | 17924 | |
8a1cdce5 AC |
17925 | For example, here's how Joe's birthday is displayed in my |
17926 | @code{nndiary+diary:birthdays} summary buffer (note that the message is | |
17927 | expirable, but will never be deleted, as it specifies a periodic event): | |
4009494e | 17928 | |
8a1cdce5 AC |
17929 | @example |
17930 | E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week) | |
17931 | @end example | |
4009494e | 17932 | |
8a1cdce5 AC |
17933 | In order to get something like the above, you would normally add the |
17934 | following line to your diary groups'parameters: | |
4009494e | 17935 | |
8a1cdce5 AC |
17936 | @lisp |
17937 | (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n") | |
17938 | @end lisp | |
4009494e | 17939 | |
8a1cdce5 AC |
17940 | However, @code{gnus-diary} does it automatically (@pxref{Diary Group |
17941 | Parameters}). You can however customize the provided summary line format | |
17942 | with the following user options: | |
4009494e | 17943 | |
8a1cdce5 AC |
17944 | @defvar gnus-diary-summary-line-format |
17945 | Defines the summary line format used for diary groups (@pxref{Summary | |
17946 | Buffer Lines}). @code{gnus-diary} uses it to automatically update the | |
17947 | diary groups'parameters. | |
17948 | @end defvar | |
4009494e | 17949 | |
8a1cdce5 AC |
17950 | @defvar gnus-diary-time-format |
17951 | Defines the format to display dates in diary summary buffers. This is | |
17952 | used by the @code{D} user format. See the docstring for details. | |
17953 | @end defvar | |
4009494e | 17954 | |
8a1cdce5 AC |
17955 | @defvar gnus-diary-delay-format-function |
17956 | Defines the format function to use for displaying delays (remaining | |
17957 | times) in diary summary buffers. This is used by the @code{d} user | |
17958 | format. There are currently built-in functions for English and French; | |
17959 | you can also define your own. See the docstring for details. | |
17960 | @end defvar | |
4009494e | 17961 | |
8a1cdce5 AC |
17962 | @node Diary Articles Sorting |
17963 | @subsubsection Diary Articles Sorting | |
17964 | @cindex diary articles sorting | |
17965 | @cindex diary summary lines sorting | |
17966 | @findex gnus-summary-sort-by-schedule | |
17967 | @findex gnus-thread-sort-by-schedule | |
17968 | @findex gnus-article-sort-by-schedule | |
4009494e | 17969 | |
8a1cdce5 AC |
17970 | @code{gnus-diary} provides new sorting functions (@pxref{Sorting the |
17971 | Summary Buffer} ) called @code{gnus-summary-sort-by-schedule}, | |
17972 | @code{gnus-thread-sort-by-schedule} and | |
17973 | @code{gnus-article-sort-by-schedule}. These functions let you organize | |
17974 | your diary summary buffers from the closest event to the farthest one. | |
4009494e | 17975 | |
8a1cdce5 AC |
17976 | @code{gnus-diary} automatically installs |
17977 | @code{gnus-summary-sort-by-schedule} as a menu item in the summary | |
17978 | buffer's ``sort'' menu, and the two others as the primary (hence | |
17979 | default) sorting functions in the group parameters (@pxref{Diary Group | |
17980 | Parameters}). | |
4009494e | 17981 | |
8a1cdce5 AC |
17982 | @node Diary Headers Generation |
17983 | @subsubsection Diary Headers Generation | |
17984 | @cindex diary headers generation | |
17985 | @findex gnus-diary-check-message | |
4009494e | 17986 | |
8a1cdce5 AC |
17987 | @code{gnus-diary} provides a function called |
17988 | @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*} | |
17989 | headers. This function ensures that the current message contains all the | |
17990 | required diary headers, and prompts you for values or corrections if | |
17991 | needed. | |
4009494e | 17992 | |
8a1cdce5 AC |
17993 | This function is hooked into the @code{nndiary} back end, so that |
17994 | moving or copying an article to a diary group will trigger it | |
17995 | automatically. It is also bound to @kbd{C-c C-f d} in | |
17996 | @code{message-mode} and @code{article-edit-mode} in order to ease the | |
17997 | process of converting a usual mail to a diary one. | |
4009494e | 17998 | |
8a1cdce5 AC |
17999 | This function takes a prefix argument which will force prompting of |
18000 | all diary headers, regardless of their presence or validity. That way, | |
18001 | you can very easily reschedule an already valid diary message, for | |
18002 | instance. | |
4009494e | 18003 | |
8a1cdce5 AC |
18004 | @node Diary Group Parameters |
18005 | @subsubsection Diary Group Parameters | |
18006 | @cindex diary group parameters | |
4009494e | 18007 | |
8a1cdce5 AC |
18008 | When you create a new diary group, or visit one, @code{gnus-diary} |
18009 | automatically checks your group parameters and if needed, sets the | |
18010 | summary line format to the diary-specific value, installs the | |
18011 | diary-specific sorting functions, and also adds the different | |
18012 | @code{X-Diary-*} headers to the group's posting-style. It is then easier | |
18013 | to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m} | |
18014 | on a diary group to prepare a message, these headers will be inserted | |
18015 | automatically (although not filled with proper values yet). | |
4009494e | 18016 | |
8a1cdce5 AC |
18017 | @node Sending or Not Sending |
18018 | @subsection Sending or Not Sending | |
4009494e | 18019 | |
8a1cdce5 AC |
18020 | Well, assuming you've read all of the above, here are two final notes on |
18021 | mail sending with @code{nndiary}: | |
4009494e | 18022 | |
8a1cdce5 AC |
18023 | @itemize @bullet |
18024 | @item | |
18025 | @code{nndiary} is a @emph{real} mail back end. You really send real diary | |
c7015153 | 18026 | messages for real. This means for instance that you can give |
8a1cdce5 AC |
18027 | appointments to anybody (provided they use Gnus and @code{nndiary}) by |
18028 | sending the diary message to them as well. | |
18029 | @item | |
18030 | However, since @code{nndiary} also has a @code{request-post} method, you | |
18031 | can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the | |
18032 | message won't actually be sent; just stored locally in the group. This | |
18033 | comes in very handy for private appointments. | |
18034 | @end itemize | |
4009494e | 18035 | |
8a1cdce5 AC |
18036 | @node Gnus Unplugged |
18037 | @section Gnus Unplugged | |
18038 | @cindex offline | |
18039 | @cindex unplugged | |
18040 | @cindex agent | |
18041 | @cindex Gnus agent | |
18042 | @cindex Gnus unplugged | |
4009494e | 18043 | |
8a1cdce5 AC |
18044 | In olden times (ca. February '88), people used to run their newsreaders |
18045 | on big machines with permanent connections to the net. News transport | |
18046 | was dealt with by news servers, and all the newsreaders had to do was to | |
18047 | read news. Believe it or not. | |
4009494e | 18048 | |
8a1cdce5 AC |
18049 | Nowadays most people read news and mail at home, and use some sort of |
18050 | modem to connect to the net. To avoid running up huge phone bills, it | |
18051 | would be nice to have a way to slurp down all the news and mail, hang up | |
18052 | the phone, read for several hours, and then upload any responses you | |
18053 | have to make. And then you repeat the procedure. | |
4009494e | 18054 | |
8a1cdce5 AC |
18055 | Of course, you can use news servers for doing this as well. I've used |
18056 | @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail} | |
18057 | for some years, but doing that's a bore. Moving the news server | |
18058 | functionality up to the newsreader makes sense if you're the only person | |
18059 | reading news on a machine. | |
4009494e | 18060 | |
8a1cdce5 AC |
18061 | Setting up Gnus as an ``offline'' newsreader is quite simple. In |
18062 | fact, you don't have to configure anything as the agent is now enabled | |
18063 | by default (@pxref{Agent Variables, gnus-agent}). | |
4009494e | 18064 | |
8a1cdce5 | 18065 | Of course, to use it as such, you have to learn a few new commands. |
4009494e | 18066 | |
8a1cdce5 AC |
18067 | @menu |
18068 | * Agent Basics:: How it all is supposed to work. | |
18069 | * Agent Categories:: How to tell the Gnus Agent what to download. | |
18070 | * Agent Commands:: New commands for all the buffers. | |
18071 | * Agent Visuals:: Ways that the agent may effect your summary buffer. | |
18072 | * Agent as Cache:: The Agent is a big cache too. | |
18073 | * Agent Expiry:: How to make old articles go away. | |
18074 | * Agent Regeneration:: How to recover from lost connections and other accidents. | |
18075 | * Agent and flags:: How the Agent maintains flags. | |
18076 | * Agent and IMAP:: How to use the Agent with @acronym{IMAP}. | |
18077 | * Outgoing Messages:: What happens when you post/mail something? | |
18078 | * Agent Variables:: Customizing is fun. | |
18079 | * Example Setup:: An example @file{~/.gnus.el} file for offline people. | |
18080 | * Batching Agents:: How to fetch news from a @code{cron} job. | |
18081 | * Agent Caveats:: What you think it'll do and what it does. | |
18082 | @end menu | |
4009494e | 18083 | |
c872595d | 18084 | |
8a1cdce5 AC |
18085 | @node Agent Basics |
18086 | @subsection Agent Basics | |
4009494e | 18087 | |
8a1cdce5 | 18088 | First, let's get some terminology out of the way. |
4009494e | 18089 | |
8a1cdce5 AC |
18090 | The Gnus Agent is said to be @dfn{unplugged} when you have severed the |
18091 | connection to the net (and notified the Agent that this is the case). | |
18092 | When the connection to the net is up again (and Gnus knows this), the | |
18093 | Agent is @dfn{plugged}. | |
4009494e | 18094 | |
8a1cdce5 AC |
18095 | The @dfn{local} machine is the one you're running on, and which isn't |
18096 | connected to the net continuously. | |
4009494e | 18097 | |
8a1cdce5 AC |
18098 | @dfn{Downloading} means fetching things from the net to your local |
18099 | machine. @dfn{Uploading} is doing the opposite. | |
4009494e | 18100 | |
8a1cdce5 AC |
18101 | You know that Gnus gives you all the opportunity you'd ever want for |
18102 | shooting yourself in the foot. Some people call it flexibility. Gnus | |
18103 | is also customizable to a great extent, which means that the user has a | |
18104 | say on how Gnus behaves. Other newsreaders might unconditionally shoot | |
18105 | you in your foot, but with Gnus, you have a choice! | |
4009494e | 18106 | |
8a1cdce5 AC |
18107 | Gnus is never really in plugged or unplugged state. Rather, it applies |
18108 | that state to each server individually. This means that some servers | |
18109 | can be plugged while others can be unplugged. Additionally, some | |
18110 | servers can be ignored by the Agent altogether (which means that | |
18111 | they're kinda like plugged always). | |
4009494e | 18112 | |
8a1cdce5 AC |
18113 | So when you unplug the Agent and then wonder why is Gnus opening a |
18114 | connection to the Net, the next step to do is to look whether all | |
18115 | servers are agentized. If there is an unagentized server, you found | |
18116 | the culprit. | |
4009494e | 18117 | |
8a1cdce5 AC |
18118 | Another thing is the @dfn{offline} state. Sometimes, servers aren't |
18119 | reachable. When Gnus notices this, it asks you whether you want the | |
18120 | server to be switched to offline state. If you say yes, then the | |
18121 | server will behave somewhat as if it was unplugged, except that Gnus | |
18122 | will ask you whether you want to switch it back online again. | |
4009494e | 18123 | |
8a1cdce5 | 18124 | Let's take a typical Gnus session using the Agent. |
4009494e | 18125 | |
8a1cdce5 | 18126 | @itemize @bullet |
4009494e | 18127 | |
8a1cdce5 AC |
18128 | @item |
18129 | @findex gnus-unplugged | |
18130 | You start Gnus with @code{gnus-unplugged}. This brings up the Gnus | |
18131 | Agent in a disconnected state. You can read all the news that you have | |
18132 | already fetched while in this mode. | |
4009494e | 18133 | |
8a1cdce5 AC |
18134 | @item |
18135 | You then decide to see whether any new news has arrived. You connect | |
18136 | your machine to the net (using PPP or whatever), and then hit @kbd{J j} | |
18137 | to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail | |
18138 | as usual. To check for new mail in unplugged mode (@pxref{Mail | |
18139 | Source Specifiers}). | |
4009494e | 18140 | |
8a1cdce5 AC |
18141 | @item |
18142 | You can then read the new news immediately, or you can download the | |
18143 | news onto your local machine. If you want to do the latter, you press | |
18144 | @kbd{g} to check if there are any new news and then @kbd{J s} to fetch | |
18145 | all the eligible articles in all the groups. (To let Gnus know which | |
18146 | articles you want to download, @pxref{Agent Categories}). | |
4009494e | 18147 | |
8a1cdce5 AC |
18148 | @item |
18149 | After fetching the articles, you press @kbd{J j} to make Gnus become | |
18150 | unplugged again, and you shut down the PPP thing (or whatever). And | |
18151 | then you read the news offline. | |
4009494e | 18152 | |
8a1cdce5 AC |
18153 | @item |
18154 | And then you go to step 2. | |
18155 | @end itemize | |
4009494e | 18156 | |
8a1cdce5 AC |
18157 | Here are some things you should do the first time (or so) that you use |
18158 | the Agent. | |
18159 | ||
18160 | @itemize @bullet | |
4009494e | 18161 | |
8a1cdce5 AC |
18162 | @item |
18163 | Decide which servers should be covered by the Agent. If you have a mail | |
18164 | back end, it would probably be nonsensical to have it covered by the | |
18165 | Agent. Go to the server buffer (@kbd{^} in the group buffer) and press | |
18166 | @kbd{J a} on the server (or servers) that you wish to have covered by the | |
18167 | Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically | |
18168 | added servers you do not wish to have covered by the Agent. By default, | |
ba775afe | 18169 | no servers are agentized. |
4009494e | 18170 | |
8a1cdce5 AC |
18171 | @item |
18172 | Decide on download policy. It's fairly simple once you decide whether | |
18173 | you are going to use agent categories, topic parameters, and/or group | |
18174 | parameters to implement your policy. If you're new to gnus, it | |
18175 | is probably best to start with a category, @xref{Agent Categories}. | |
4009494e | 18176 | |
8a1cdce5 AC |
18177 | Both topic parameters (@pxref{Topic Parameters}) and agent categories |
18178 | (@pxref{Agent Categories}) provide for setting a policy that applies | |
18179 | to multiple groups. Which you use is entirely up to you. Topic | |
18180 | parameters do override categories so, if you mix the two, you'll have | |
18181 | to take that into account. If you have a few groups that deviate from | |
18182 | your policy, you can use group parameters (@pxref{Group Parameters}) to | |
18183 | configure them. | |
4009494e | 18184 | |
8a1cdce5 AC |
18185 | @item |
18186 | Uhm@dots{} that's it. | |
18187 | @end itemize | |
4009494e | 18188 | |
4009494e | 18189 | |
8a1cdce5 AC |
18190 | @node Agent Categories |
18191 | @subsection Agent Categories | |
4009494e | 18192 | |
8a1cdce5 AC |
18193 | One of the main reasons to integrate the news transport layer into the |
18194 | newsreader is to allow greater control over what articles to download. | |
18195 | There's not much point in downloading huge amounts of articles, just to | |
18196 | find out that you're not interested in reading any of them. It's better | |
18197 | to be somewhat more conservative in choosing what to download, and then | |
18198 | mark the articles for downloading manually if it should turn out that | |
18199 | you're interested in the articles anyway. | |
4009494e | 18200 | |
8a1cdce5 AC |
18201 | One of the more effective methods for controlling what is to be |
18202 | downloaded is to create a @dfn{category} and then assign some (or all) | |
18203 | groups to this category. Groups that do not belong in any other | |
18204 | category belong to the @code{default} category. Gnus has its own | |
18205 | buffer for creating and managing categories. | |
4009494e | 18206 | |
8a1cdce5 AC |
18207 | If you prefer, you can also use group parameters (@pxref{Group |
18208 | Parameters}) and topic parameters (@pxref{Topic Parameters}) for an | |
18209 | alternative approach to controlling the agent. The only real | |
18210 | difference is that categories are specific to the agent (so there is | |
18211 | less to learn) while group and topic parameters include the kitchen | |
18212 | sink. | |
4009494e | 18213 | |
8a1cdce5 AC |
18214 | Since you can set agent parameters in several different places we have |
18215 | a rule to decide which source to believe. This rule specifies that | |
18216 | the parameter sources are checked in the following order: group | |
18217 | parameters, topic parameters, agent category, and finally customizable | |
18218 | variables. So you can mix all of these sources to produce a wide range | |
18219 | of behavior, just don't blame me if you don't remember where you put | |
18220 | your settings. | |
4009494e | 18221 | |
8a1cdce5 AC |
18222 | @menu |
18223 | * Category Syntax:: What a category looks like. | |
18224 | * Category Buffer:: A buffer for maintaining categories. | |
18225 | * Category Variables:: Customize'r'Us. | |
18226 | @end menu | |
4009494e | 18227 | |
4009494e | 18228 | |
8a1cdce5 AC |
18229 | @node Category Syntax |
18230 | @subsubsection Category Syntax | |
4009494e | 18231 | |
8a1cdce5 AC |
18232 | A category consists of a name, the list of groups belonging to the |
18233 | category, and a number of optional parameters that override the | |
18234 | customizable variables. The complete list of agent parameters are | |
18235 | listed below. | |
4009494e | 18236 | |
8a1cdce5 AC |
18237 | @cindex Agent Parameters |
18238 | @table @code | |
18239 | @item agent-groups | |
18240 | The list of groups that are in this category. | |
4009494e | 18241 | |
8a1cdce5 AC |
18242 | @item agent-predicate |
18243 | A predicate which (generally) gives a rough outline of which articles | |
18244 | are eligible for downloading; and | |
4009494e | 18245 | |
8a1cdce5 AC |
18246 | @item agent-score |
18247 | a score rule which (generally) gives you a finer granularity when | |
18248 | deciding what articles to download. (Note that this @dfn{download | |
18249 | score} is not necessarily related to normal scores.) | |
4009494e | 18250 | |
8a1cdce5 AC |
18251 | @item agent-enable-expiration |
18252 | a boolean indicating whether the agent should expire old articles in | |
18253 | this group. Most groups should be expired to conserve disk space. In | |
18254 | fact, its probably safe to say that the gnus.* hierarchy contains the | |
18255 | only groups that should not be expired. | |
4009494e | 18256 | |
8a1cdce5 AC |
18257 | @item agent-days-until-old |
18258 | an integer indicating the number of days that the agent should wait | |
18259 | before deciding that a read article is safe to expire. | |
4009494e | 18260 | |
8a1cdce5 AC |
18261 | @item agent-low-score |
18262 | an integer that overrides the value of @code{gnus-agent-low-score}. | |
4009494e | 18263 | |
8a1cdce5 AC |
18264 | @item agent-high-score |
18265 | an integer that overrides the value of @code{gnus-agent-high-score}. | |
4009494e | 18266 | |
8a1cdce5 AC |
18267 | @item agent-short-article |
18268 | an integer that overrides the value of | |
18269 | @code{gnus-agent-short-article}. | |
4009494e | 18270 | |
8a1cdce5 AC |
18271 | @item agent-long-article |
18272 | an integer that overrides the value of @code{gnus-agent-long-article}. | |
4009494e | 18273 | |
8a1cdce5 AC |
18274 | @item agent-enable-undownloaded-faces |
18275 | a symbol indicating whether the summary buffer should display | |
18276 | undownloaded articles using the @code{gnus-summary-*-undownloaded-face} | |
18277 | faces. Any symbol other than @code{nil} will enable the use of | |
18278 | undownloaded faces. | |
18279 | @end table | |
4009494e | 18280 | |
8a1cdce5 AC |
18281 | The name of a category can not be changed once the category has been |
18282 | created. | |
4009494e | 18283 | |
8a1cdce5 AC |
18284 | Each category maintains a list of groups that are exclusive members of |
18285 | that category. The exclusivity rule is automatically enforced, add a | |
18286 | group to a new category and it is automatically removed from its old | |
18287 | category. | |
4009494e | 18288 | |
8a1cdce5 AC |
18289 | A predicate in its simplest form can be a single predicate such as |
18290 | @code{true} or @code{false}. These two will download every available | |
18291 | article or nothing respectively. In the case of these two special | |
18292 | predicates an additional score rule is superfluous. | |
4009494e | 18293 | |
8a1cdce5 AC |
18294 | Predicates of @code{high} or @code{low} download articles in respect of |
18295 | their scores in relationship to @code{gnus-agent-high-score} and | |
18296 | @code{gnus-agent-low-score} as described below. | |
4009494e | 18297 | |
8a1cdce5 AC |
18298 | To gain even finer control of what is to be regarded eligible for |
18299 | download a predicate can consist of a number of predicates with logical | |
18300 | operators sprinkled in between. | |
4009494e | 18301 | |
8a1cdce5 | 18302 | Perhaps some examples are in order. |
4009494e | 18303 | |
8a1cdce5 AC |
18304 | Here's a simple predicate. (It's the default predicate, in fact, used |
18305 | for all groups that don't belong to any other category.) | |
4009494e | 18306 | |
8a1cdce5 AC |
18307 | @lisp |
18308 | short | |
18309 | @end lisp | |
4009494e | 18310 | |
8a1cdce5 AC |
18311 | Quite simple, eh? This predicate is true if and only if the article is |
18312 | short (for some value of ``short''). | |
4009494e | 18313 | |
8a1cdce5 | 18314 | Here's a more complex predicate: |
4009494e | 18315 | |
8a1cdce5 AC |
18316 | @lisp |
18317 | (or high | |
18318 | (and | |
18319 | (not low) | |
18320 | (not long))) | |
18321 | @end lisp | |
4009494e | 18322 | |
8a1cdce5 AC |
18323 | This means that an article should be downloaded if it has a high score, |
18324 | or if the score is not low and the article is not long. You get the | |
18325 | drift. | |
4009494e | 18326 | |
8a1cdce5 AC |
18327 | The available logical operators are @code{or}, @code{and} and |
18328 | @code{not}. (If you prefer, you can use the more ``C''-ish operators | |
18329 | @samp{|}, @code{&} and @code{!} instead.) | |
4009494e | 18330 | |
8a1cdce5 AC |
18331 | The following predicates are pre-defined, but if none of these fit what |
18332 | you want to do, you can write your own. | |
4009494e | 18333 | |
8a1cdce5 AC |
18334 | When evaluating each of these predicates, the named constant will be |
18335 | bound to the value determined by calling | |
18336 | @code{gnus-agent-find-parameter} on the appropriate parameter. For | |
18337 | example, gnus-agent-short-article will be bound to | |
18338 | @code{(gnus-agent-find-parameter group 'agent-short-article)}. This | |
18339 | means that you can specify a predicate in your category then tune that | |
18340 | predicate to individual groups. | |
4009494e | 18341 | |
8a1cdce5 AC |
18342 | @table @code |
18343 | @item short | |
18344 | True if the article is shorter than @code{gnus-agent-short-article} | |
18345 | lines; default 100. | |
4009494e | 18346 | |
8a1cdce5 AC |
18347 | @item long |
18348 | True if the article is longer than @code{gnus-agent-long-article} | |
18349 | lines; default 200. | |
4009494e | 18350 | |
8a1cdce5 AC |
18351 | @item low |
18352 | True if the article has a download score less than | |
18353 | @code{gnus-agent-low-score}; default 0. | |
4009494e | 18354 | |
8a1cdce5 AC |
18355 | @item high |
18356 | True if the article has a download score greater than | |
18357 | @code{gnus-agent-high-score}; default 0. | |
4009494e | 18358 | |
8a1cdce5 AC |
18359 | @item spam |
18360 | True if the Gnus Agent guesses that the article is spam. The | |
18361 | heuristics may change over time, but at present it just computes a | |
18362 | checksum and sees whether articles match. | |
4009494e | 18363 | |
8a1cdce5 AC |
18364 | @item true |
18365 | Always true. | |
4009494e | 18366 | |
8a1cdce5 AC |
18367 | @item false |
18368 | Always false. | |
4009494e GM |
18369 | @end table |
18370 | ||
8a1cdce5 AC |
18371 | If you want to create your own predicate function, here's what you have |
18372 | to know: The functions are called with no parameters, but the | |
18373 | @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to | |
18374 | useful values. | |
4009494e | 18375 | |
8a1cdce5 | 18376 | For example, you could decide that you don't want to download articles |
1df7defd | 18377 | that were posted more than a certain number of days ago (e.g., posted |
8a1cdce5 AC |
18378 | more than @code{gnus-agent-expire-days} ago) you might write a function |
18379 | something along the lines of the following: | |
4009494e GM |
18380 | |
18381 | @lisp | |
8a1cdce5 AC |
18382 | (defun my-article-old-p () |
18383 | "Say whether an article is old." | |
18384 | (< (time-to-days (date-to-time (mail-header-date gnus-headers))) | |
18385 | (- (time-to-days (current-time)) gnus-agent-expire-days))) | |
4009494e GM |
18386 | @end lisp |
18387 | ||
8a1cdce5 | 18388 | with the predicate then defined as: |
4009494e GM |
18389 | |
18390 | @lisp | |
8a1cdce5 | 18391 | (not my-article-old-p) |
4009494e GM |
18392 | @end lisp |
18393 | ||
8a1cdce5 AC |
18394 | or you could append your predicate to the predefined |
18395 | @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or | |
18396 | wherever. | |
4009494e | 18397 | |
8a1cdce5 AC |
18398 | @lisp |
18399 | (require 'gnus-agent) | |
18400 | (setq gnus-category-predicate-alist | |
18401 | (append gnus-category-predicate-alist | |
18402 | '((old . my-article-old-p)))) | |
18403 | @end lisp | |
4009494e | 18404 | |
8a1cdce5 | 18405 | and simply specify your predicate as: |
4009494e | 18406 | |
8a1cdce5 AC |
18407 | @lisp |
18408 | (not old) | |
18409 | @end lisp | |
4009494e | 18410 | |
8a1cdce5 AC |
18411 | If/when using something like the above, be aware that there are many |
18412 | misconfigured systems/mailers out there and so an article's date is not | |
18413 | always a reliable indication of when it was posted. Hell, some people | |
18414 | just don't give a damn. | |
4009494e | 18415 | |
8a1cdce5 AC |
18416 | The above predicates apply to @emph{all} the groups which belong to the |
18417 | category. However, if you wish to have a specific predicate for an | |
18418 | individual group within a category, or you're just too lazy to set up a | |
18419 | new category, you can enter a group's individual predicate in its group | |
18420 | parameters like so: | |
4009494e | 18421 | |
8a1cdce5 AC |
18422 | @lisp |
18423 | (agent-predicate . short) | |
18424 | @end lisp | |
4009494e | 18425 | |
8a1cdce5 AC |
18426 | This is the group/topic parameter equivalent of the agent category default. |
18427 | Note that when specifying a single word predicate like this, the | |
18428 | @code{agent-predicate} specification must be in dotted pair notation. | |
4009494e | 18429 | |
8a1cdce5 | 18430 | The equivalent of the longer example from above would be: |
4009494e GM |
18431 | |
18432 | @lisp | |
8a1cdce5 | 18433 | (agent-predicate or high (and (not low) (not long))) |
4009494e GM |
18434 | @end lisp |
18435 | ||
8a1cdce5 AC |
18436 | The outer parenthesis required in the category specification are not |
18437 | entered here as, not being in dotted pair notation, the value of the | |
18438 | predicate is assumed to be a list. | |
4009494e | 18439 | |
4009494e | 18440 | |
8a1cdce5 AC |
18441 | Now, the syntax of the download score is the same as the syntax of |
18442 | normal score files, except that all elements that require actually | |
18443 | seeing the article itself are verboten. This means that only the | |
18444 | following headers can be scored on: @code{Subject}, @code{From}, | |
18445 | @code{Date}, @code{Message-ID}, @code{References}, @code{Chars}, | |
18446 | @code{Lines}, and @code{Xref}. | |
4009494e | 18447 | |
8a1cdce5 AC |
18448 | As with predicates, the specification of the @code{download score rule} |
18449 | to use in respect of a group can be in either the category definition if | |
18450 | it's to be applicable to all groups in therein, or a group's parameters | |
18451 | if it's to be specific to that group. | |
4009494e | 18452 | |
8a1cdce5 AC |
18453 | In both of these places the @code{download score rule} can take one of |
18454 | three forms: | |
4009494e | 18455 | |
8a1cdce5 AC |
18456 | @enumerate |
18457 | @item | |
18458 | Score rule | |
4009494e | 18459 | |
8a1cdce5 AC |
18460 | This has the same syntax as a normal Gnus score file except only a |
18461 | subset of scoring keywords are available as mentioned above. | |
4009494e | 18462 | |
8a1cdce5 | 18463 | example: |
4009494e | 18464 | |
8a1cdce5 AC |
18465 | @itemize @bullet |
18466 | @item | |
18467 | Category specification | |
4009494e | 18468 | |
8a1cdce5 AC |
18469 | @lisp |
18470 | (("from" | |
18471 | ("Lars Ingebrigtsen" 1000000 nil s)) | |
18472 | ("lines" | |
18473 | (500 -100 nil <))) | |
18474 | @end lisp | |
4009494e | 18475 | |
8a1cdce5 AC |
18476 | @item |
18477 | Group/Topic Parameter specification | |
4009494e | 18478 | |
8a1cdce5 AC |
18479 | @lisp |
18480 | (agent-score ("from" | |
18481 | ("Lars Ingebrigtsen" 1000000 nil s)) | |
18482 | ("lines" | |
18483 | (500 -100 nil <))) | |
18484 | @end lisp | |
4009494e | 18485 | |
8a1cdce5 AC |
18486 | Again, note the omission of the outermost parenthesis here. |
18487 | @end itemize | |
4009494e | 18488 | |
8a1cdce5 AC |
18489 | @item |
18490 | Agent score file | |
18491 | ||
18492 | These score files must @emph{only} contain the permitted scoring | |
18493 | keywords stated above. | |
18494 | ||
18495 | example: | |
4009494e GM |
18496 | |
18497 | @itemize @bullet | |
18498 | @item | |
8a1cdce5 | 18499 | Category specification |
4009494e | 18500 | |
8a1cdce5 AC |
18501 | @lisp |
18502 | ("~/News/agent.SCORE") | |
18503 | @end lisp | |
4009494e | 18504 | |
8a1cdce5 | 18505 | or perhaps |
4009494e | 18506 | |
8a1cdce5 AC |
18507 | @lisp |
18508 | ("~/News/agent.SCORE" "~/News/agent.group.SCORE") | |
18509 | @end lisp | |
4009494e | 18510 | |
8a1cdce5 AC |
18511 | @item |
18512 | Group Parameter specification | |
4009494e | 18513 | |
8a1cdce5 AC |
18514 | @lisp |
18515 | (agent-score "~/News/agent.SCORE") | |
18516 | @end lisp | |
4009494e | 18517 | |
8a1cdce5 AC |
18518 | Additional score files can be specified as above. Need I say anything |
18519 | about parenthesis? | |
18520 | @end itemize | |
4009494e | 18521 | |
8a1cdce5 AC |
18522 | @item |
18523 | Use @code{normal} score files | |
4009494e | 18524 | |
8a1cdce5 AC |
18525 | If you don't want to maintain two sets of scoring rules for a group, and |
18526 | your desired @code{downloading} criteria for a group are the same as your | |
18527 | @code{reading} criteria then you can tell the agent to refer to your | |
18528 | @code{normal} score files when deciding what to download. | |
4009494e | 18529 | |
8a1cdce5 AC |
18530 | These directives in either the category definition or a group's |
18531 | parameters will cause the agent to read in all the applicable score | |
18532 | files for a group, @emph{filtering out} those sections that do not | |
18533 | relate to one of the permitted subset of scoring keywords. | |
4009494e GM |
18534 | |
18535 | @itemize @bullet | |
18536 | @item | |
8a1cdce5 AC |
18537 | Category Specification |
18538 | ||
18539 | @lisp | |
18540 | file | |
18541 | @end lisp | |
18542 | ||
4009494e | 18543 | @item |
8a1cdce5 AC |
18544 | Group Parameter specification |
18545 | ||
18546 | @lisp | |
18547 | (agent-score . file) | |
18548 | @end lisp | |
4009494e | 18549 | @end itemize |
8a1cdce5 | 18550 | @end enumerate |
4009494e | 18551 | |
8a1cdce5 AC |
18552 | @node Category Buffer |
18553 | @subsubsection Category Buffer | |
4009494e | 18554 | |
8a1cdce5 AC |
18555 | You'd normally do all category maintenance from the category buffer. |
18556 | When you enter it for the first time (with the @kbd{J c} command from | |
18557 | the group buffer), you'll only see the @code{default} category. | |
4009494e | 18558 | |
8a1cdce5 | 18559 | The following commands are available in this buffer: |
4009494e | 18560 | |
8a1cdce5 AC |
18561 | @table @kbd |
18562 | @item q | |
18563 | @kindex q (Category) | |
18564 | @findex gnus-category-exit | |
18565 | Return to the group buffer (@code{gnus-category-exit}). | |
4009494e | 18566 | |
8a1cdce5 AC |
18567 | @item e |
18568 | @kindex e (Category) | |
18569 | @findex gnus-category-customize-category | |
18570 | Use a customization buffer to set all of the selected category's | |
18571 | parameters at one time (@code{gnus-category-customize-category}). | |
4009494e | 18572 | |
8a1cdce5 AC |
18573 | @item k |
18574 | @kindex k (Category) | |
18575 | @findex gnus-category-kill | |
18576 | Kill the current category (@code{gnus-category-kill}). | |
4009494e | 18577 | |
8a1cdce5 AC |
18578 | @item c |
18579 | @kindex c (Category) | |
18580 | @findex gnus-category-copy | |
18581 | Copy the current category (@code{gnus-category-copy}). | |
4009494e | 18582 | |
8a1cdce5 AC |
18583 | @item a |
18584 | @kindex a (Category) | |
18585 | @findex gnus-category-add | |
18586 | Add a new category (@code{gnus-category-add}). | |
4009494e | 18587 | |
8a1cdce5 AC |
18588 | @item p |
18589 | @kindex p (Category) | |
18590 | @findex gnus-category-edit-predicate | |
18591 | Edit the predicate of the current category | |
18592 | (@code{gnus-category-edit-predicate}). | |
4009494e | 18593 | |
8a1cdce5 AC |
18594 | @item g |
18595 | @kindex g (Category) | |
18596 | @findex gnus-category-edit-groups | |
18597 | Edit the list of groups belonging to the current category | |
18598 | (@code{gnus-category-edit-groups}). | |
4009494e | 18599 | |
8a1cdce5 AC |
18600 | @item s |
18601 | @kindex s (Category) | |
18602 | @findex gnus-category-edit-score | |
18603 | Edit the download score rule of the current category | |
18604 | (@code{gnus-category-edit-score}). | |
4009494e | 18605 | |
8a1cdce5 AC |
18606 | @item l |
18607 | @kindex l (Category) | |
18608 | @findex gnus-category-list | |
18609 | List all the categories (@code{gnus-category-list}). | |
18610 | @end table | |
4009494e | 18611 | |
4009494e | 18612 | |
8a1cdce5 AC |
18613 | @node Category Variables |
18614 | @subsubsection Category Variables | |
4009494e | 18615 | |
8a1cdce5 AC |
18616 | @table @code |
18617 | @item gnus-category-mode-hook | |
18618 | @vindex gnus-category-mode-hook | |
18619 | Hook run in category buffers. | |
4009494e | 18620 | |
8a1cdce5 AC |
18621 | @item gnus-category-line-format |
18622 | @vindex gnus-category-line-format | |
18623 | Format of the lines in the category buffer (@pxref{Formatting | |
18624 | Variables}). Valid elements are: | |
4009494e | 18625 | |
8a1cdce5 AC |
18626 | @table @samp |
18627 | @item c | |
18628 | The name of the category. | |
4009494e | 18629 | |
8a1cdce5 AC |
18630 | @item g |
18631 | The number of groups in the category. | |
18632 | @end table | |
4009494e | 18633 | |
8a1cdce5 AC |
18634 | @item gnus-category-mode-line-format |
18635 | @vindex gnus-category-mode-line-format | |
18636 | Format of the category mode line (@pxref{Mode Line Formatting}). | |
4009494e | 18637 | |
8a1cdce5 AC |
18638 | @item gnus-agent-short-article |
18639 | @vindex gnus-agent-short-article | |
18640 | Articles that have fewer lines than this are short. Default 100. | |
4009494e | 18641 | |
8a1cdce5 AC |
18642 | @item gnus-agent-long-article |
18643 | @vindex gnus-agent-long-article | |
18644 | Articles that have more lines than this are long. Default 200. | |
4009494e | 18645 | |
8a1cdce5 AC |
18646 | @item gnus-agent-low-score |
18647 | @vindex gnus-agent-low-score | |
18648 | Articles that have a score lower than this have a low score. Default | |
18649 | 0. | |
18650 | ||
18651 | @item gnus-agent-high-score | |
18652 | @vindex gnus-agent-high-score | |
18653 | Articles that have a score higher than this have a high score. Default | |
18654 | 0. | |
18655 | ||
18656 | @item gnus-agent-expire-days | |
18657 | @vindex gnus-agent-expire-days | |
18658 | The number of days that a @samp{read} article must stay in the agent's | |
18659 | local disk before becoming eligible for expiration (While the name is | |
18660 | the same, this doesn't mean expiring the article on the server. It | |
18661 | just means deleting the local copy of the article). What is also | |
18662 | important to understand is that the counter starts with the time the | |
18663 | article was written to the local disk and not the time the article was | |
18664 | read. | |
18665 | Default 7. | |
18666 | ||
18667 | @item gnus-agent-enable-expiration | |
18668 | @vindex gnus-agent-enable-expiration | |
18669 | Determines whether articles in a group are, by default, expired or | |
18670 | retained indefinitely. The default is @code{ENABLE} which means that | |
18671 | you'll have to disable expiration when desired. On the other hand, | |
18672 | you could set this to @code{DISABLE}. In that case, you would then | |
18673 | have to enable expiration in selected groups. | |
18674 | ||
18675 | @end table | |
4009494e | 18676 | |
4009494e | 18677 | |
8a1cdce5 AC |
18678 | @node Agent Commands |
18679 | @subsection Agent Commands | |
18680 | @findex gnus-agent-toggle-plugged | |
18681 | @kindex J j (Agent) | |
4009494e | 18682 | |
8a1cdce5 AC |
18683 | All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j} |
18684 | (@code{gnus-agent-toggle-plugged}) command works in all modes, and | |
18685 | toggles the plugged/unplugged state of the Gnus Agent. | |
4009494e GM |
18686 | |
18687 | ||
18688 | @menu | |
8a1cdce5 AC |
18689 | * Group Agent Commands:: Configure groups and fetch their contents. |
18690 | * Summary Agent Commands:: Manually select then fetch specific articles. | |
18691 | * Server Agent Commands:: Select the servers that are supported by the agent. | |
4009494e GM |
18692 | @end menu |
18693 | ||
4009494e | 18694 | |
4009494e | 18695 | |
4009494e | 18696 | |
8a1cdce5 AC |
18697 | @node Group Agent Commands |
18698 | @subsubsection Group Agent Commands | |
4009494e | 18699 | |
8a1cdce5 AC |
18700 | @table @kbd |
18701 | @item J u | |
18702 | @kindex J u (Agent Group) | |
18703 | @findex gnus-agent-fetch-groups | |
18704 | Fetch all eligible articles in the current group | |
18705 | (@code{gnus-agent-fetch-groups}). | |
4009494e | 18706 | |
8a1cdce5 AC |
18707 | @item J c |
18708 | @kindex J c (Agent Group) | |
18709 | @findex gnus-enter-category-buffer | |
18710 | Enter the Agent category buffer (@code{gnus-enter-category-buffer}). | |
4009494e | 18711 | |
8a1cdce5 AC |
18712 | @item J s |
18713 | @kindex J s (Agent Group) | |
18714 | @findex gnus-agent-fetch-session | |
18715 | Fetch all eligible articles in all groups | |
18716 | (@code{gnus-agent-fetch-session}). | |
4009494e | 18717 | |
8a1cdce5 AC |
18718 | @item J S |
18719 | @kindex J S (Agent Group) | |
18720 | @findex gnus-group-send-queue | |
18721 | Send all sendable messages in the queue group | |
18722 | (@code{gnus-group-send-queue}). @xref{Drafts}. | |
4009494e | 18723 | |
8a1cdce5 AC |
18724 | @item J a |
18725 | @kindex J a (Agent Group) | |
18726 | @findex gnus-agent-add-group | |
18727 | Add the current group to an Agent category | |
18728 | (@code{gnus-agent-add-group}). This command understands the | |
18729 | process/prefix convention (@pxref{Process/Prefix}). | |
4009494e | 18730 | |
8a1cdce5 AC |
18731 | @item J r |
18732 | @kindex J r (Agent Group) | |
18733 | @findex gnus-agent-remove-group | |
18734 | Remove the current group from its category, if any | |
18735 | (@code{gnus-agent-remove-group}). This command understands the | |
18736 | process/prefix convention (@pxref{Process/Prefix}). | |
4009494e | 18737 | |
8a1cdce5 AC |
18738 | @item J Y |
18739 | @kindex J Y (Agent Group) | |
18740 | @findex gnus-agent-synchronize-flags | |
18741 | Synchronize flags changed while unplugged with remote server, if any. | |
4009494e | 18742 | |
4009494e | 18743 | |
8a1cdce5 | 18744 | @end table |
4009494e | 18745 | |
4009494e | 18746 | |
8a1cdce5 AC |
18747 | @node Summary Agent Commands |
18748 | @subsubsection Summary Agent Commands | |
4009494e | 18749 | |
8a1cdce5 AC |
18750 | @table @kbd |
18751 | @item J # | |
18752 | @kindex J # (Agent Summary) | |
18753 | @findex gnus-agent-mark-article | |
18754 | Mark the article for downloading (@code{gnus-agent-mark-article}). | |
4009494e | 18755 | |
8a1cdce5 AC |
18756 | @item J M-# |
18757 | @kindex J M-# (Agent Summary) | |
18758 | @findex gnus-agent-unmark-article | |
18759 | Remove the downloading mark from the article | |
18760 | (@code{gnus-agent-unmark-article}). | |
4009494e | 18761 | |
8a1cdce5 AC |
18762 | @cindex % |
18763 | @item @@ | |
18764 | @kindex @@ (Agent Summary) | |
18765 | @findex gnus-agent-toggle-mark | |
18766 | Toggle whether to download the article | |
18767 | (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by | |
18768 | default. | |
4009494e | 18769 | |
8a1cdce5 AC |
18770 | @item J c |
18771 | @kindex J c (Agent Summary) | |
18772 | @findex gnus-agent-catchup | |
18773 | Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable. | |
4009494e | 18774 | |
8a1cdce5 AC |
18775 | @item J S |
18776 | @kindex J S (Agent Summary) | |
18777 | @findex gnus-agent-fetch-group | |
18778 | Download all eligible (@pxref{Agent Categories}) articles in this group. | |
18779 | (@code{gnus-agent-fetch-group}). | |
4009494e | 18780 | |
8a1cdce5 AC |
18781 | @item J s |
18782 | @kindex J s (Agent Summary) | |
18783 | @findex gnus-agent-summary-fetch-series | |
18784 | Download all processable articles in this group. | |
18785 | (@code{gnus-agent-summary-fetch-series}). | |
4009494e | 18786 | |
8a1cdce5 AC |
18787 | @item J u |
18788 | @kindex J u (Agent Summary) | |
18789 | @findex gnus-agent-summary-fetch-group | |
18790 | Download all downloadable articles in the current group | |
18791 | (@code{gnus-agent-summary-fetch-group}). | |
4009494e | 18792 | |
8a1cdce5 | 18793 | @end table |
4009494e | 18794 | |
4009494e | 18795 | |
8a1cdce5 AC |
18796 | @node Server Agent Commands |
18797 | @subsubsection Server Agent Commands | |
4009494e | 18798 | |
8a1cdce5 AC |
18799 | @table @kbd |
18800 | @item J a | |
18801 | @kindex J a (Agent Server) | |
18802 | @findex gnus-agent-add-server | |
18803 | Add the current server to the list of servers covered by the Gnus Agent | |
18804 | (@code{gnus-agent-add-server}). | |
4009494e | 18805 | |
8a1cdce5 AC |
18806 | @item J r |
18807 | @kindex J r (Agent Server) | |
18808 | @findex gnus-agent-remove-server | |
18809 | Remove the current server from the list of servers covered by the Gnus | |
18810 | Agent (@code{gnus-agent-remove-server}). | |
4009494e | 18811 | |
8a1cdce5 | 18812 | @end table |
4009494e | 18813 | |
4009494e | 18814 | |
8a1cdce5 AC |
18815 | @node Agent Visuals |
18816 | @subsection Agent Visuals | |
4009494e | 18817 | |
8a1cdce5 AC |
18818 | If you open a summary while unplugged and, Gnus knows from the group's |
18819 | active range that there are more articles than the headers currently | |
18820 | stored in the Agent, you may see some articles whose subject looks | |
18821 | something like @samp{[Undownloaded article #####]}. These are | |
18822 | placeholders for the missing headers. Aside from setting a mark, | |
18823 | there is not much that can be done with one of these placeholders. | |
18824 | When Gnus finally gets a chance to fetch the group's headers, the | |
18825 | placeholders will automatically be replaced by the actual headers. | |
18826 | You can configure the summary buffer's maneuvering to skip over the | |
18827 | placeholders if you care (See @code{gnus-auto-goto-ignores}). | |
4009494e | 18828 | |
8a1cdce5 AC |
18829 | While it may be obvious to all, the only headers and articles |
18830 | available while unplugged are those headers and articles that were | |
18831 | fetched into the Agent while previously plugged. To put it another | |
18832 | way, ``If you forget to fetch something while plugged, you might have a | |
18833 | less than satisfying unplugged session''. For this reason, the Agent | |
18834 | adds two visual effects to your summary buffer. These effects display | |
18835 | the download status of each article so that you always know which | |
18836 | articles will be available when unplugged. | |
4009494e | 18837 | |
8a1cdce5 AC |
18838 | The first visual effect is the @samp{%O} spec. If you customize |
18839 | @code{gnus-summary-line-format} to include this specifier, you will add | |
18840 | a single character field that indicates an article's download status. | |
18841 | Articles that have been fetched into either the Agent or the Cache, | |
18842 | will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All | |
18843 | other articles will display @code{gnus-undownloaded-mark} (defaults to | |
18844 | @samp{-}). If you open a group that has not been agentized, a space | |
18845 | (@samp{ }) will be displayed. | |
4009494e | 18846 | |
8a1cdce5 AC |
18847 | The second visual effect are the undownloaded faces. The faces, there |
18848 | are three indicating the article's score (low, normal, high), seem to | |
18849 | result in a love/hate response from many Gnus users. The problem is | |
18850 | that the face selection is controlled by a list of condition tests and | |
18851 | face names (See @code{gnus-summary-highlight}). Each condition is | |
18852 | tested in the order in which it appears in the list so early | |
18853 | conditions have precedence over later conditions. All of this means | |
18854 | that, if you tick an undownloaded article, the article will continue | |
18855 | to be displayed in the undownloaded face rather than the ticked face. | |
4009494e | 18856 | |
8a1cdce5 AC |
18857 | If you use the Agent as a cache (to avoid downloading the same article |
18858 | each time you visit it or to minimize your connection time), the | |
18859 | undownloaded face will probably seem like a good idea. The reason | |
18860 | being that you do all of our work (marking, reading, deleting) with | |
18861 | downloaded articles so the normal faces always appear. For those | |
18862 | users using the agent to improve online performance by caching the NOV | |
18863 | database (most users since 5.10.2), the undownloaded faces may appear | |
18864 | to be an absolutely horrible idea. The issue being that, since none | |
18865 | of their articles have been fetched into the Agent, all of the | |
18866 | normal faces will be obscured by the undownloaded faces. | |
4009494e | 18867 | |
8a1cdce5 AC |
18868 | If you would like to use the undownloaded faces, you must enable the |
18869 | undownloaded faces by setting the @code{agent-enable-undownloaded-faces} | |
18870 | group parameter to @code{t}. This parameter, like all other agent | |
18871 | parameters, may be set on an Agent Category (@pxref{Agent Categories}), | |
18872 | a Group Topic (@pxref{Topic Parameters}), or an individual group | |
18873 | (@pxref{Group Parameters}). | |
4009494e | 18874 | |
8a1cdce5 AC |
18875 | The one problem common to all users using the agent is how quickly it |
18876 | can consume disk space. If you using the agent on many groups, it is | |
18877 | even more difficult to effectively recover disk space. One solution | |
18878 | is the @samp{%F} format available in @code{gnus-group-line-format}. | |
18879 | This format will display the actual disk space used by articles | |
18880 | fetched into both the agent and cache. By knowing which groups use | |
18881 | the most space, users know where to focus their efforts when ``agent | |
18882 | expiring'' articles. | |
4009494e | 18883 | |
8a1cdce5 AC |
18884 | @node Agent as Cache |
18885 | @subsection Agent as Cache | |
4009494e | 18886 | |
8a1cdce5 AC |
18887 | When Gnus is plugged, it is not efficient to download headers or |
18888 | articles from the server again, if they are already stored in the | |
18889 | Agent. So, Gnus normally only downloads headers once, and stores them | |
18890 | in the Agent. These headers are later used when generating the summary | |
18891 | buffer, regardless of whether you are plugged or unplugged. Articles | |
18892 | are not cached in the Agent by default though (that would potentially | |
18893 | consume lots of disk space), but if you have already downloaded an | |
18894 | article into the Agent, Gnus will not download the article from the | |
18895 | server again but use the locally stored copy instead. | |
4009494e | 18896 | |
8a1cdce5 AC |
18897 | If you so desire, you can configure the agent (see @code{gnus-agent-cache} |
18898 | @pxref{Agent Variables}) to always download headers and articles while | |
18899 | plugged. Gnus will almost certainly be slower, but it will be kept | |
18900 | synchronized with the server. That last point probably won't make any | |
18901 | sense if you are using a nntp or nnimap back end. | |
4009494e | 18902 | |
8a1cdce5 AC |
18903 | @node Agent Expiry |
18904 | @subsection Agent Expiry | |
4009494e | 18905 | |
8a1cdce5 AC |
18906 | @vindex gnus-agent-expire-days |
18907 | @findex gnus-agent-expire | |
18908 | @kindex M-x gnus-agent-expire | |
18909 | @kindex M-x gnus-agent-expire-group | |
18910 | @findex gnus-agent-expire-group | |
18911 | @cindex agent expiry | |
18912 | @cindex Gnus agent expiry | |
18913 | @cindex expiry, in Gnus agent | |
4009494e | 18914 | |
8a1cdce5 AC |
18915 | The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at |
18916 | least it doesn't handle it like other back ends. Instead, there are | |
18917 | special @code{gnus-agent-expire} and @code{gnus-agent-expire-group} | |
18918 | commands that will expire all read articles that are older than | |
18919 | @code{gnus-agent-expire-days} days. They can be run whenever you feel | |
18920 | that you're running out of space. Neither are particularly fast or | |
18921 | efficient, and it's not a particularly good idea to interrupt them (with | |
18922 | @kbd{C-g} or anything else) once you've started one of them. | |
4009494e | 18923 | |
0c502747 LMI |
18924 | Note that other functions might run @code{gnus-agent-expire} for you |
18925 | to keep the agent synchronized with the group. | |
4009494e | 18926 | |
8a1cdce5 AC |
18927 | The agent parameter @code{agent-enable-expiration} may be used to |
18928 | prevent expiration in selected groups. | |
4009494e | 18929 | |
8a1cdce5 AC |
18930 | @vindex gnus-agent-expire-all |
18931 | If @code{gnus-agent-expire-all} is non-@code{nil}, the agent | |
18932 | expiration commands will expire all articles---unread, read, ticked | |
18933 | and dormant. If @code{nil} (which is the default), only read articles | |
18934 | are eligible for expiry, and unread, ticked and dormant articles will | |
18935 | be kept indefinitely. | |
4009494e | 18936 | |
8a1cdce5 AC |
18937 | If you find that some articles eligible for expiry are never expired, |
18938 | perhaps some Gnus Agent files are corrupted. There's are special | |
18939 | commands, @code{gnus-agent-regenerate} and | |
18940 | @code{gnus-agent-regenerate-group}, to fix possible problems. | |
4009494e | 18941 | |
8a1cdce5 AC |
18942 | @node Agent Regeneration |
18943 | @subsection Agent Regeneration | |
4009494e | 18944 | |
8a1cdce5 AC |
18945 | @cindex agent regeneration |
18946 | @cindex Gnus agent regeneration | |
18947 | @cindex regeneration | |
4009494e | 18948 | |
8a1cdce5 AC |
18949 | The local data structures used by @code{nnagent} may become corrupted |
18950 | due to certain exceptional conditions. When this happens, | |
18951 | @code{nnagent} functionality may degrade or even fail. The solution | |
18952 | to this problem is to repair the local data structures by removing all | |
18953 | internal inconsistencies. | |
4009494e | 18954 | |
8a1cdce5 AC |
18955 | For example, if your connection to your server is lost while |
18956 | downloaded articles into the agent, the local data structures will not | |
18957 | know about articles successfully downloaded prior to the connection | |
18958 | failure. Running @code{gnus-agent-regenerate} or | |
18959 | @code{gnus-agent-regenerate-group} will update the data structures | |
18960 | such that you don't need to download these articles a second time. | |
4009494e | 18961 | |
8a1cdce5 AC |
18962 | @findex gnus-agent-regenerate |
18963 | @kindex M-x gnus-agent-regenerate | |
18964 | The command @code{gnus-agent-regenerate} will perform | |
18965 | @code{gnus-agent-regenerate-group} on every agentized group. While | |
18966 | you can run @code{gnus-agent-regenerate} in any buffer, it is strongly | |
18967 | recommended that you first close all summary buffers. | |
4009494e | 18968 | |
8a1cdce5 AC |
18969 | @findex gnus-agent-regenerate-group |
18970 | @kindex M-x gnus-agent-regenerate-group | |
18971 | The command @code{gnus-agent-regenerate-group} uses the local copies | |
18972 | of individual articles to repair the local @acronym{NOV}(header) database. It | |
18973 | then updates the internal data structures that document which articles | |
18974 | are stored locally. An optional argument will mark articles in the | |
18975 | agent as unread. | |
4009494e | 18976 | |
8a1cdce5 AC |
18977 | @node Agent and flags |
18978 | @subsection Agent and flags | |
4009494e | 18979 | |
8a1cdce5 AC |
18980 | The Agent works with any Gnus back end including those, such as |
18981 | nnimap, that store flags (read, ticked, etc) on the server. Sadly, | |
18982 | the Agent does not actually know which backends keep their flags in | |
18983 | the backend server rather than in @file{.newsrc}. This means that the | |
18984 | Agent, while unplugged or disconnected, will always record all changes | |
18985 | to the flags in its own files. | |
18986 | ||
18987 | When you plug back in, Gnus will then check to see if you have any | |
18988 | changed any flags and ask if you wish to synchronize these with the | |
18989 | server. This behavior is customizable by @code{gnus-agent-synchronize-flags}. | |
4009494e | 18990 | |
8a1cdce5 AC |
18991 | @vindex gnus-agent-synchronize-flags |
18992 | If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will | |
18993 | never automatically synchronize flags. If it is @code{ask}, which is | |
18994 | the default, the Agent will check if you made any changes and if so | |
18995 | ask if you wish to synchronize these when you re-connect. If it has | |
18996 | any other value, all flags will be synchronized automatically. | |
4009494e | 18997 | |
8a1cdce5 AC |
18998 | If you do not wish to synchronize flags automatically when you |
18999 | re-connect, you can do it manually with the | |
19000 | @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y} | |
19001 | in the group buffer. | |
4009494e | 19002 | |
8a1cdce5 AC |
19003 | Technical note: the synchronization algorithm does not work by ``pushing'' |
19004 | all local flags to the server, but rather by incrementally updated the | |
19005 | server view of flags by changing only those flags that were changed by | |
19006 | the user. Thus, if you set one flag on an article, quit the group then | |
19007 | re-select the group and remove the flag; the flag will be set and | |
19008 | removed from the server when you ``synchronize''. The queued flag | |
19009 | operations can be found in the per-server @code{flags} file in the Agent | |
19010 | directory. It's emptied when you synchronize flags. | |
4009494e | 19011 | |
8a1cdce5 AC |
19012 | @node Agent and IMAP |
19013 | @subsection Agent and IMAP | |
4009494e | 19014 | |
8a1cdce5 AC |
19015 | The Agent works with any Gnus back end, including nnimap. However, |
19016 | since there are some conceptual differences between @acronym{NNTP} and | |
19017 | @acronym{IMAP}, this section (should) provide you with some information to | |
19018 | make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client. | |
4009494e | 19019 | |
8a1cdce5 AC |
19020 | Some things are currently not implemented in the Agent that you'd might |
19021 | expect from a disconnected @acronym{IMAP} client, including: | |
4009494e | 19022 | |
8a1cdce5 | 19023 | @itemize @bullet |
4009494e | 19024 | |
8a1cdce5 AC |
19025 | @item |
19026 | Copying/moving articles into nnimap groups when unplugged. | |
4009494e | 19027 | |
8a1cdce5 AC |
19028 | @item |
19029 | Creating/deleting nnimap groups when unplugged. | |
4009494e | 19030 | |
8a1cdce5 | 19031 | @end itemize |
4009494e | 19032 | |
8a1cdce5 AC |
19033 | @node Outgoing Messages |
19034 | @subsection Outgoing Messages | |
4009494e | 19035 | |
8a1cdce5 AC |
19036 | By default, when Gnus is unplugged, all outgoing messages (both mail |
19037 | and news) are stored in the draft group ``queue'' (@pxref{Drafts}). | |
19038 | You can view them there after posting, and edit them at will. | |
4009494e | 19039 | |
8a1cdce5 AC |
19040 | You can control the circumstances under which outgoing mail is queued |
19041 | (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing | |
19042 | news is always queued when Gnus is unplugged, and never otherwise. | |
4009494e | 19043 | |
8a1cdce5 AC |
19044 | You can send the messages either from the draft group with the special |
19045 | commands available there, or you can use the @kbd{J S} command in the | |
19046 | group buffer to send all the sendable messages in the draft group. | |
19047 | Posting news will only work when Gnus is plugged, but you can send | |
19048 | mail at any time. | |
4009494e | 19049 | |
8a1cdce5 AC |
19050 | If sending mail while unplugged does not work for you and you worry |
19051 | about hitting @kbd{J S} by accident when unplugged, you can have Gnus | |
19052 | ask you to confirm your action (see | |
19053 | @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}). | |
4009494e | 19054 | |
8a1cdce5 AC |
19055 | @node Agent Variables |
19056 | @subsection Agent Variables | |
4009494e | 19057 | |
8a1cdce5 AC |
19058 | @table @code |
19059 | @item gnus-agent | |
19060 | @vindex gnus-agent | |
19061 | Is the agent enabled? The default is @code{t}. When first enabled, | |
19062 | the agent will use @code{gnus-agent-auto-agentize-methods} to | |
19063 | automatically mark some back ends as agentized. You may change which | |
19064 | back ends are agentized using the agent commands in the server buffer. | |
4009494e | 19065 | |
8a1cdce5 AC |
19066 | To enter the server buffer, use the @kbd{^} |
19067 | (@code{gnus-group-enter-server-mode}) command in the group buffer. | |
4009494e | 19068 | |
4009494e | 19069 | |
8a1cdce5 AC |
19070 | @item gnus-agent-directory |
19071 | @vindex gnus-agent-directory | |
19072 | Where the Gnus Agent will store its files. The default is | |
19073 | @file{~/News/agent/}. | |
4009494e | 19074 | |
8a1cdce5 AC |
19075 | @item gnus-agent-handle-level |
19076 | @vindex gnus-agent-handle-level | |
19077 | Groups on levels (@pxref{Group Levels}) higher than this variable will | |
19078 | be ignored by the Agent. The default is @code{gnus-level-subscribed}, | |
19079 | which means that only subscribed group will be considered by the Agent | |
19080 | by default. | |
4009494e | 19081 | |
8a1cdce5 AC |
19082 | @item gnus-agent-plugged-hook |
19083 | @vindex gnus-agent-plugged-hook | |
19084 | Hook run when connecting to the network. | |
4009494e | 19085 | |
8a1cdce5 AC |
19086 | @item gnus-agent-unplugged-hook |
19087 | @vindex gnus-agent-unplugged-hook | |
19088 | Hook run when disconnecting from the network. | |
4009494e | 19089 | |
8a1cdce5 AC |
19090 | @item gnus-agent-fetched-hook |
19091 | @vindex gnus-agent-fetched-hook | |
19092 | Hook run when finished fetching articles. | |
4009494e | 19093 | |
8a1cdce5 AC |
19094 | @item gnus-agent-cache |
19095 | @vindex gnus-agent-cache | |
19096 | Variable to control whether use the locally stored @acronym{NOV} and | |
1df7defd | 19097 | articles when plugged, e.g., essentially using the Agent as a cache. |
8a1cdce5 | 19098 | The default is non-@code{nil}, which means to use the Agent as a cache. |
4009494e | 19099 | |
8a1cdce5 AC |
19100 | @item gnus-agent-go-online |
19101 | @vindex gnus-agent-go-online | |
19102 | If @code{gnus-agent-go-online} is @code{nil}, the Agent will never | |
19103 | automatically switch offline servers into online status. If it is | |
19104 | @code{ask}, the default, the Agent will ask if you wish to switch | |
19105 | offline servers into online status when you re-connect. If it has any | |
19106 | other value, all offline servers will be automatically switched into | |
19107 | online status. | |
4009494e | 19108 | |
8a1cdce5 AC |
19109 | @item gnus-agent-mark-unread-after-downloaded |
19110 | @vindex gnus-agent-mark-unread-after-downloaded | |
19111 | If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil}, | |
19112 | mark articles as unread after downloading. This is usually a safe | |
19113 | thing to do as the newly downloaded article has obviously not been | |
19114 | read. The default is @code{t}. | |
4009494e | 19115 | |
8a1cdce5 AC |
19116 | @item gnus-agent-synchronize-flags |
19117 | @vindex gnus-agent-synchronize-flags | |
19118 | If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will | |
19119 | never automatically synchronize flags. If it is @code{ask}, which is | |
19120 | the default, the Agent will check if you made any changes and if so | |
19121 | ask if you wish to synchronize these when you re-connect. If it has | |
19122 | any other value, all flags will be synchronized automatically. | |
4009494e | 19123 | |
8a1cdce5 AC |
19124 | @item gnus-agent-consider-all-articles |
19125 | @vindex gnus-agent-consider-all-articles | |
19126 | If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the | |
19127 | agent will let the agent predicate decide whether articles need to be | |
19128 | downloaded or not, for all articles. When @code{nil}, the default, | |
19129 | the agent will only let the predicate decide whether unread articles | |
19130 | are downloaded or not. If you enable this, you may also want to look | |
19131 | into the agent expiry settings (@pxref{Category Variables}), so that | |
19132 | the agent doesn't download articles which the agent will later expire, | |
19133 | over and over again. | |
4009494e | 19134 | |
8a1cdce5 AC |
19135 | @item gnus-agent-max-fetch-size |
19136 | @vindex gnus-agent-max-fetch-size | |
19137 | The agent fetches articles into a temporary buffer prior to parsing | |
19138 | them into individual files. To avoid exceeding the max. buffer size, | |
19139 | the agent alternates between fetching and parsing until all articles | |
19140 | have been fetched. @code{gnus-agent-max-fetch-size} provides a size | |
19141 | limit to control how often the cycling occurs. A large value improves | |
19142 | performance. A small value minimizes the time lost should the | |
19143 | connection be lost while fetching (You may need to run | |
19144 | @code{gnus-agent-regenerate-group} to update the group's state. | |
19145 | However, all articles parsed prior to losing the connection will be | |
19146 | available while unplugged). The default is 10M so it is unusual to | |
19147 | see any cycling. | |
4009494e | 19148 | |
8a1cdce5 AC |
19149 | @item gnus-server-unopen-status |
19150 | @vindex gnus-server-unopen-status | |
19151 | Perhaps not an Agent variable, but closely related to the Agent, this | |
19152 | variable says what will happen if Gnus cannot open a server. If the | |
19153 | Agent is enabled, the default, @code{nil}, makes Gnus ask the user | |
19154 | whether to deny the server or whether to unplug the agent. If the | |
19155 | Agent is disabled, Gnus always simply deny the server. Other choices | |
19156 | for this variable include @code{denied} and @code{offline} the latter | |
19157 | is only valid if the Agent is used. | |
4009494e | 19158 | |
8a1cdce5 AC |
19159 | @item gnus-auto-goto-ignores |
19160 | @vindex gnus-auto-goto-ignores | |
19161 | Another variable that isn't an Agent variable, yet so closely related | |
19162 | that most will look for it here, this variable tells the summary | |
19163 | buffer how to maneuver around undownloaded (only headers stored in the | |
19164 | agent) and unfetched (neither article nor headers stored) articles. | |
4009494e | 19165 | |
8a1cdce5 AC |
19166 | The valid values are @code{nil} (maneuver to any article), |
19167 | @code{undownloaded} (maneuvering while unplugged ignores articles that | |
19168 | have not been fetched), @code{always-undownloaded} (maneuvering always | |
19169 | ignores articles that have not been fetched), @code{unfetched} | |
19170 | (maneuvering ignores articles whose headers have not been fetched). | |
4009494e | 19171 | |
8a1cdce5 AC |
19172 | @item gnus-agent-queue-mail |
19173 | @vindex gnus-agent-queue-mail | |
19174 | When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always | |
19175 | queue mail rather than sending it straight away. When @code{t}, Gnus | |
19176 | will queue mail when unplugged only. When @code{nil}, never queue | |
19177 | mail. The default is @code{t}. | |
4009494e | 19178 | |
8a1cdce5 AC |
19179 | @item gnus-agent-prompt-send-queue |
19180 | @vindex gnus-agent-prompt-send-queue | |
19181 | When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will | |
19182 | prompt you to confirm that you really wish to proceed if you hit | |
19183 | @kbd{J S} while unplugged. The default is @code{nil}. | |
4009494e | 19184 | |
8a1cdce5 AC |
19185 | @item gnus-agent-auto-agentize-methods |
19186 | @vindex gnus-agent-auto-agentize-methods | |
19187 | If you have never used the Agent before (or more technically, if | |
19188 | @file{~/News/agent/lib/servers} does not exist), Gnus will | |
19189 | automatically agentize a few servers for you. This variable control | |
19190 | which back ends should be auto-agentized. It is typically only useful | |
19191 | to agentize remote back ends. The auto-agentizing has the same effect | |
19192 | as running @kbd{J a} on the servers (@pxref{Server Agent Commands}). | |
19193 | If the file exist, you must manage the servers manually by adding or | |
19194 | removing them, this variable is only applicable the first time you | |
ba775afe | 19195 | start Gnus. The default is @samp{nil}. |
4009494e | 19196 | |
4009494e GM |
19197 | @end table |
19198 | ||
4009494e | 19199 | |
8a1cdce5 AC |
19200 | @node Example Setup |
19201 | @subsection Example Setup | |
19202 | ||
19203 | If you don't want to read this manual, and you have a fairly standard | |
19204 | setup, you may be able to use something like the following as your | |
19205 | @file{~/.gnus.el} file to get started. | |
4009494e GM |
19206 | |
19207 | @lisp | |
8a1cdce5 AC |
19208 | ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}} |
19209 | ;; @r{from your ISP's server.} | |
19210 | (setq gnus-select-method '(nntp "news.your-isp.com")) | |
4009494e | 19211 | |
8a1cdce5 AC |
19212 | ;; @r{Define how Gnus is to read your mail. We read mail from} |
19213 | ;; @r{your ISP's @acronym{POP} server.} | |
19214 | (setq mail-sources '((pop :server "pop.your-isp.com"))) | |
4009494e | 19215 | |
8a1cdce5 AC |
19216 | ;; @r{Say how Gnus is to store the mail. We use nnml groups.} |
19217 | (setq gnus-secondary-select-methods '((nnml ""))) | |
19218 | ||
19219 | ;; @r{Make Gnus into an offline newsreader.} | |
19220 | ;; (gnus-agentize) ; @r{The obsolete setting.} | |
19221 | ;; (setq gnus-agent t) ; @r{Now the default.} | |
4009494e GM |
19222 | @end lisp |
19223 | ||
8a1cdce5 AC |
19224 | That should be it, basically. Put that in your @file{~/.gnus.el} file, |
19225 | edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x | |
19226 | gnus}. | |
4009494e | 19227 | |
8a1cdce5 AC |
19228 | If this is the first time you've run Gnus, you will be subscribed |
19229 | automatically to a few default newsgroups. You'll probably want to | |
19230 | subscribe to more groups, and to do that, you have to query the | |
19231 | @acronym{NNTP} server for a complete list of groups with the @kbd{A A} | |
19232 | command. This usually takes quite a while, but you only have to do it | |
19233 | once. | |
4009494e | 19234 | |
8a1cdce5 AC |
19235 | After reading and parsing a while, you'll be presented with a list of |
19236 | groups. Subscribe to the ones you want to read with the @kbd{u} | |
19237 | command. @kbd{l} to make all the killed groups disappear after you've | |
19238 | subscribe to all the groups you want to read. (@kbd{A k} will bring | |
19239 | back all the killed groups.) | |
4009494e | 19240 | |
8a1cdce5 AC |
19241 | You can now read the groups at once, or you can download the articles |
19242 | with the @kbd{J s} command. And then read the rest of this manual to | |
19243 | find out which of the other gazillion things you want to customize. | |
4009494e | 19244 | |
4009494e | 19245 | |
8a1cdce5 AC |
19246 | @node Batching Agents |
19247 | @subsection Batching Agents | |
19248 | @findex gnus-agent-batch | |
4009494e | 19249 | |
8a1cdce5 AC |
19250 | Having the Gnus Agent fetch articles (and post whatever messages you've |
19251 | written) is quite easy once you've gotten things set up properly. The | |
19252 | following shell script will do everything that is necessary: | |
4009494e | 19253 | |
8a1cdce5 AC |
19254 | You can run a complete batch command from the command line with the |
19255 | following incantation: | |
4009494e | 19256 | |
8a1cdce5 AC |
19257 | @example |
19258 | #!/bin/sh | |
19259 | emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1 | |
19260 | @end example | |
4009494e | 19261 | |
4009494e | 19262 | |
8a1cdce5 AC |
19263 | @node Agent Caveats |
19264 | @subsection Agent Caveats | |
4009494e | 19265 | |
8a1cdce5 AC |
19266 | The Gnus Agent doesn't seem to work like most other offline |
19267 | newsreaders. Here are some common questions that some imaginary people | |
19268 | may ask: | |
4009494e | 19269 | |
8a1cdce5 AC |
19270 | @table @dfn |
19271 | @item If I read an article while plugged, do they get entered into the Agent? | |
4009494e | 19272 | |
8a1cdce5 AC |
19273 | @strong{No}. If you want this behavior, add |
19274 | @code{gnus-agent-fetch-selected-article} to | |
19275 | @code{gnus-select-article-hook}. | |
4009494e | 19276 | |
8a1cdce5 AC |
19277 | @item If I read an article while plugged, and the article already exists in |
19278 | the Agent, will it get downloaded once more? | |
4009494e | 19279 | |
8a1cdce5 | 19280 | @strong{No}, unless @code{gnus-agent-cache} is @code{nil}. |
4009494e | 19281 | |
8a1cdce5 | 19282 | @end table |
4009494e | 19283 | |
8a1cdce5 AC |
19284 | In short, when Gnus is unplugged, it only looks into the locally stored |
19285 | articles; when it's plugged, it talks to your ISP and may also use the | |
19286 | locally stored articles. | |
4009494e | 19287 | |
4009494e | 19288 | |
8a1cdce5 AC |
19289 | @node Scoring |
19290 | @chapter Scoring | |
19291 | @cindex scoring | |
4009494e | 19292 | |
8a1cdce5 AC |
19293 | Other people use @dfn{kill files}, but we here at Gnus Towers like |
19294 | scoring better than killing, so we'd rather switch than fight. They do | |
19295 | something completely different as well, so sit up straight and pay | |
19296 | attention! | |
4009494e | 19297 | |
8a1cdce5 AC |
19298 | @vindex gnus-summary-mark-below |
19299 | All articles have a default score (@code{gnus-summary-default-score}), | |
19300 | which is 0 by default. This score may be raised or lowered either | |
19301 | interactively or by score files. Articles that have a score lower than | |
19302 | @code{gnus-summary-mark-below} are marked as read. | |
4009494e | 19303 | |
8a1cdce5 AC |
19304 | Gnus will read any @dfn{score files} that apply to the current group |
19305 | before generating the summary buffer. | |
4009494e | 19306 | |
8a1cdce5 AC |
19307 | There are several commands in the summary buffer that insert score |
19308 | entries based on the current article. You can, for instance, ask Gnus to | |
19309 | lower or increase the score of all articles with a certain subject. | |
4009494e | 19310 | |
8a1cdce5 AC |
19311 | There are two sorts of scoring entries: Permanent and temporary. |
19312 | Temporary score entries are self-expiring entries. Any entries that are | |
19313 | temporary and have not been used for, say, a week, will be removed | |
19314 | silently to help keep the sizes of the score files down. | |
4009494e | 19315 | |
8a1cdce5 AC |
19316 | @menu |
19317 | * Summary Score Commands:: Adding score entries for the current group. | |
19318 | * Group Score Commands:: General score commands. | |
19319 | * Score Variables:: Customize your scoring. (My, what terminology). | |
19320 | * Score File Format:: What a score file may contain. | |
19321 | * Score File Editing:: You can edit score files by hand as well. | |
19322 | * Adaptive Scoring:: Big Sister Gnus knows what you read. | |
19323 | * Home Score File:: How to say where new score entries are to go. | |
19324 | * Followups To Yourself:: Having Gnus notice when people answer you. | |
19325 | * Scoring On Other Headers:: Scoring on non-standard headers. | |
19326 | * Scoring Tips:: How to score effectively. | |
19327 | * Reverse Scoring:: That problem child of old is not problem. | |
19328 | * Global Score Files:: Earth-spanning, ear-splitting score files. | |
19329 | * Kill Files:: They are still here, but they can be ignored. | |
19330 | * Converting Kill Files:: Translating kill files to score files. | |
19331 | * Advanced Scoring:: Using logical expressions to build score rules. | |
19332 | * Score Decays:: It can be useful to let scores wither away. | |
19333 | @end menu | |
4009494e | 19334 | |
4009494e | 19335 | |
8a1cdce5 AC |
19336 | @node Summary Score Commands |
19337 | @section Summary Score Commands | |
19338 | @cindex score commands | |
4009494e | 19339 | |
8a1cdce5 AC |
19340 | The score commands that alter score entries do not actually modify real |
19341 | score files. That would be too inefficient. Gnus maintains a cache of | |
19342 | previously loaded score files, one of which is considered the | |
19343 | @dfn{current score file alist}. The score commands simply insert | |
19344 | entries into this list, and upon group exit, this list is saved. | |
4009494e | 19345 | |
8a1cdce5 AC |
19346 | The current score file is by default the group's local score file, even |
19347 | if no such score file actually exists. To insert score commands into | |
1df7defd | 19348 | some other score file (e.g., @file{all.SCORE}), you must first make this |
8a1cdce5 AC |
19349 | score file the current one. |
19350 | ||
19351 | General score commands that don't actually change the score file: | |
4009494e | 19352 | |
8a1cdce5 | 19353 | @table @kbd |
4009494e | 19354 | |
8a1cdce5 AC |
19355 | @item V s |
19356 | @kindex V s (Summary) | |
19357 | @findex gnus-summary-set-score | |
19358 | Set the score of the current article (@code{gnus-summary-set-score}). | |
4009494e | 19359 | |
8a1cdce5 AC |
19360 | @item V S |
19361 | @kindex V S (Summary) | |
19362 | @findex gnus-summary-current-score | |
19363 | Display the score of the current article | |
19364 | (@code{gnus-summary-current-score}). | |
4009494e | 19365 | |
8a1cdce5 AC |
19366 | @item V t |
19367 | @kindex V t (Summary) | |
19368 | @findex gnus-score-find-trace | |
19369 | Display all score rules that have been used on the current article | |
19370 | (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you | |
19371 | may type @kbd{e} to edit score file corresponding to the score rule on | |
19372 | current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the | |
19373 | score file and edit it. | |
4009494e | 19374 | |
8a1cdce5 AC |
19375 | @item V w |
19376 | @kindex V w (Summary) | |
19377 | @findex gnus-score-find-favourite-words | |
19378 | List words used in scoring (@code{gnus-score-find-favourite-words}). | |
4009494e | 19379 | |
8a1cdce5 AC |
19380 | @item V R |
19381 | @kindex V R (Summary) | |
19382 | @findex gnus-summary-rescore | |
19383 | Run the current summary through the scoring process | |
19384 | (@code{gnus-summary-rescore}). This might be useful if you're playing | |
19385 | around with your score files behind Gnus' back and want to see the | |
19386 | effect you're having. | |
4009494e | 19387 | |
8a1cdce5 AC |
19388 | @item V c |
19389 | @kindex V c (Summary) | |
19390 | @findex gnus-score-change-score-file | |
19391 | Make a different score file the current | |
19392 | (@code{gnus-score-change-score-file}). | |
4009494e | 19393 | |
8a1cdce5 AC |
19394 | @item V e |
19395 | @kindex V e (Summary) | |
19396 | @findex gnus-score-edit-current-scores | |
19397 | Edit the current score file (@code{gnus-score-edit-current-scores}). | |
19398 | You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score | |
19399 | File Editing}). | |
4009494e | 19400 | |
8a1cdce5 AC |
19401 | @item V f |
19402 | @kindex V f (Summary) | |
19403 | @findex gnus-score-edit-file | |
19404 | Edit a score file and make this score file the current one | |
19405 | (@code{gnus-score-edit-file}). | |
4009494e | 19406 | |
8a1cdce5 AC |
19407 | @item V F |
19408 | @kindex V F (Summary) | |
19409 | @findex gnus-score-flush-cache | |
19410 | Flush the score cache (@code{gnus-score-flush-cache}). This is useful | |
19411 | after editing score files. | |
4009494e | 19412 | |
8a1cdce5 AC |
19413 | @item V C |
19414 | @kindex V C (Summary) | |
19415 | @findex gnus-score-customize | |
19416 | Customize a score file in a visually pleasing manner | |
19417 | (@code{gnus-score-customize}). | |
4009494e | 19418 | |
8a1cdce5 | 19419 | @end table |
4009494e | 19420 | |
8a1cdce5 | 19421 | The rest of these commands modify the local score file. |
4009494e GM |
19422 | |
19423 | @table @kbd | |
4009494e | 19424 | |
8a1cdce5 AC |
19425 | @item V m |
19426 | @kindex V m (Summary) | |
19427 | @findex gnus-score-set-mark-below | |
19428 | Prompt for a score, and mark all articles with a score below this as | |
19429 | read (@code{gnus-score-set-mark-below}). | |
4009494e | 19430 | |
8a1cdce5 AC |
19431 | @item V x |
19432 | @kindex V x (Summary) | |
19433 | @findex gnus-score-set-expunge-below | |
19434 | Prompt for a score, and add a score rule to the current score file to | |
19435 | expunge all articles below this score | |
19436 | (@code{gnus-score-set-expunge-below}). | |
19437 | @end table | |
4009494e | 19438 | |
8a1cdce5 AC |
19439 | The keystrokes for actually making score entries follow a very regular |
19440 | pattern, so there's no need to list all the commands. (Hundreds of | |
19441 | them.) | |
4009494e | 19442 | |
8a1cdce5 AC |
19443 | @findex gnus-summary-increase-score |
19444 | @findex gnus-summary-lower-score | |
4009494e | 19445 | |
8a1cdce5 AC |
19446 | @enumerate |
19447 | @item | |
19448 | The first key is either @kbd{I} (upper case i) for increasing the score | |
19449 | or @kbd{L} for lowering the score. | |
19450 | @item | |
19451 | The second key says what header you want to score on. The following | |
19452 | keys are available: | |
19453 | @table @kbd | |
4009494e | 19454 | |
8a1cdce5 AC |
19455 | @item a |
19456 | Score on the author name. | |
4009494e GM |
19457 | |
19458 | @item s | |
8a1cdce5 AC |
19459 | Score on the subject line. |
19460 | ||
19461 | @item x | |
19462 | Score on the @code{Xref} line---i.e., the cross-posting line. | |
19463 | ||
19464 | @item r | |
19465 | Score on the @code{References} line. | |
19466 | ||
19467 | @item d | |
19468 | Score on the date. | |
4009494e GM |
19469 | |
19470 | @item l | |
8a1cdce5 | 19471 | Score on the number of lines. |
4009494e | 19472 | |
8a1cdce5 AC |
19473 | @item i |
19474 | Score on the @code{Message-ID} header. | |
4009494e | 19475 | |
8a1cdce5 AC |
19476 | @item e |
19477 | Score on an ``extra'' header, that is, one of those in gnus-extra-headers, | |
19478 | if your @acronym{NNTP} server tracks additional header data in overviews. | |
4009494e | 19479 | |
8a1cdce5 AC |
19480 | @item f |
19481 | Score on followups---this matches the author name, and adds scores to | |
19482 | the followups to this author. (Using this key leads to the creation of | |
19483 | @file{ADAPT} files.) | |
4009494e | 19484 | |
8a1cdce5 AC |
19485 | @item b |
19486 | Score on the body. | |
4009494e | 19487 | |
8a1cdce5 AC |
19488 | @item h |
19489 | Score on the head. | |
19490 | ||
19491 | @item t | |
19492 | Score on thread. (Using this key leads to the creation of @file{ADAPT} | |
19493 | files.) | |
4009494e | 19494 | |
4009494e GM |
19495 | @end table |
19496 | ||
8a1cdce5 AC |
19497 | @item |
19498 | The third key is the match type. Which match types are valid depends on | |
19499 | what headers you are scoring on. | |
4009494e | 19500 | |
8a1cdce5 | 19501 | @table @code |
4009494e | 19502 | |
8a1cdce5 | 19503 | @item strings |
4009494e | 19504 | |
8a1cdce5 | 19505 | @table @kbd |
4009494e | 19506 | |
8a1cdce5 AC |
19507 | @item e |
19508 | Exact matching. | |
4009494e | 19509 | |
8a1cdce5 AC |
19510 | @item s |
19511 | Substring matching. | |
4009494e | 19512 | |
8a1cdce5 AC |
19513 | @item f |
19514 | Fuzzy matching (@pxref{Fuzzy Matching}). | |
4009494e | 19515 | |
8a1cdce5 AC |
19516 | @item r |
19517 | Regexp matching | |
4009494e GM |
19518 | @end table |
19519 | ||
8a1cdce5 AC |
19520 | @item date |
19521 | @table @kbd | |
4009494e | 19522 | |
8a1cdce5 AC |
19523 | @item b |
19524 | Before date. | |
4009494e | 19525 | |
8a1cdce5 AC |
19526 | @item a |
19527 | After date. | |
4009494e | 19528 | |
8a1cdce5 AC |
19529 | @item n |
19530 | This date. | |
19531 | @end table | |
4009494e | 19532 | |
8a1cdce5 AC |
19533 | @item number |
19534 | @table @kbd | |
4009494e | 19535 | |
8a1cdce5 AC |
19536 | @item < |
19537 | Less than number. | |
4009494e | 19538 | |
8a1cdce5 AC |
19539 | @item = |
19540 | Equal to number. | |
4009494e | 19541 | |
8a1cdce5 AC |
19542 | @item > |
19543 | Greater than number. | |
19544 | @end table | |
19545 | @end table | |
4009494e | 19546 | |
8a1cdce5 AC |
19547 | @item |
19548 | The fourth and usually final key says whether this is a temporary (i.e., | |
19549 | expiring) score entry, or a permanent (i.e., non-expiring) score entry, | |
19550 | or whether it is to be done immediately, without adding to the score | |
19551 | file. | |
4009494e | 19552 | @table @kbd |
4009494e | 19553 | |
8a1cdce5 AC |
19554 | @item t |
19555 | Temporary score entry. | |
4009494e | 19556 | |
8a1cdce5 AC |
19557 | @item p |
19558 | Permanent score entry. | |
4009494e | 19559 | |
8a1cdce5 AC |
19560 | @item i |
19561 | Immediately scoring. | |
19562 | @end table | |
4009494e | 19563 | |
8a1cdce5 AC |
19564 | @item |
19565 | If you are scoring on `e' (extra) headers, you will then be prompted for | |
19566 | the header name on which you wish to score. This must be a header named | |
19567 | in gnus-extra-headers, and @samp{TAB} completion is available. | |
4009494e | 19568 | |
8a1cdce5 | 19569 | @end enumerate |
4009494e | 19570 | |
8a1cdce5 AC |
19571 | So, let's say you want to increase the score on the current author with |
19572 | exact matching permanently: @kbd{I a e p}. If you want to lower the | |
19573 | score based on the subject line, using substring matching, and make a | |
19574 | temporary score entry: @kbd{L s s t}. Pretty easy. | |
4009494e | 19575 | |
8a1cdce5 AC |
19576 | To make things a bit more complicated, there are shortcuts. If you use |
19577 | a capital letter on either the second or third keys, Gnus will use | |
19578 | defaults for the remaining one or two keystrokes. The defaults are | |
19579 | ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s | |
19580 | t}, and @kbd{I a R} is the same as @kbd{I a r t}. | |
4009494e | 19581 | |
8a1cdce5 AC |
19582 | These functions take both the numerical prefix and the symbolic prefix |
19583 | (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower | |
19584 | (or increase) the score of the article. A symbolic prefix of @code{a} | |
19585 | says to use the @file{all.SCORE} file for the command instead of the | |
19586 | current score file. | |
4009494e | 19587 | |
8a1cdce5 AC |
19588 | @vindex gnus-score-mimic-keymap |
19589 | The @code{gnus-score-mimic-keymap} says whether these commands will | |
19590 | pretend they are keymaps or not. | |
4009494e | 19591 | |
4009494e | 19592 | |
8a1cdce5 AC |
19593 | @node Group Score Commands |
19594 | @section Group Score Commands | |
19595 | @cindex group score commands | |
4009494e | 19596 | |
8a1cdce5 | 19597 | There aren't many of these as yet, I'm afraid. |
4009494e | 19598 | |
8a1cdce5 | 19599 | @table @kbd |
4009494e | 19600 | |
8a1cdce5 AC |
19601 | @item W e |
19602 | @kindex W e (Group) | |
19603 | @findex gnus-score-edit-all-score | |
19604 | Edit the apply-to-all-groups all.SCORE file. You will be popped into | |
19605 | a @code{gnus-score-mode} buffer (@pxref{Score File Editing}). | |
4009494e | 19606 | |
8a1cdce5 AC |
19607 | @item W f |
19608 | @kindex W f (Group) | |
19609 | @findex gnus-score-flush-cache | |
19610 | Gnus maintains a cache of score alists to avoid having to reload them | |
19611 | all the time. This command will flush the cache | |
19612 | (@code{gnus-score-flush-cache}). | |
4009494e | 19613 | |
8a1cdce5 | 19614 | @end table |
4009494e | 19615 | |
8a1cdce5 | 19616 | You can do scoring from the command line by saying something like: |
4009494e | 19617 | |
8a1cdce5 AC |
19618 | @findex gnus-batch-score |
19619 | @cindex batch scoring | |
19620 | @example | |
19621 | $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score | |
19622 | @end example | |
4009494e GM |
19623 | |
19624 | ||
8a1cdce5 AC |
19625 | @node Score Variables |
19626 | @section Score Variables | |
19627 | @cindex score variables | |
4009494e | 19628 | |
8a1cdce5 | 19629 | @table @code |
4009494e | 19630 | |
8a1cdce5 AC |
19631 | @item gnus-use-scoring |
19632 | @vindex gnus-use-scoring | |
19633 | If @code{nil}, Gnus will not check for score files, and will not, in | |
19634 | general, do any score-related work. This is @code{t} by default. | |
4009494e | 19635 | |
8a1cdce5 AC |
19636 | @item gnus-kill-killed |
19637 | @vindex gnus-kill-killed | |
19638 | If this variable is @code{nil}, Gnus will never apply score files to | |
19639 | articles that have already been through the kill process. While this | |
19640 | may save you lots of time, it also means that if you apply a kill file | |
19641 | to a group, and then change the kill file and want to run it over you | |
19642 | group again to kill more articles, it won't work. You have to set this | |
19643 | variable to @code{t} to do that. (It is @code{t} by default.) | |
4009494e | 19644 | |
8a1cdce5 AC |
19645 | @item gnus-kill-files-directory |
19646 | @vindex gnus-kill-files-directory | |
19647 | All kill and score files will be stored in this directory, which is | |
19648 | initialized from the @env{SAVEDIR} environment variable by default. | |
19649 | This is @file{~/News/} by default. | |
4009494e | 19650 | |
8a1cdce5 AC |
19651 | @item gnus-score-file-suffix |
19652 | @vindex gnus-score-file-suffix | |
19653 | Suffix to add to the group name to arrive at the score file name | |
19654 | (@file{SCORE} by default.) | |
4009494e | 19655 | |
8a1cdce5 AC |
19656 | @item gnus-score-uncacheable-files |
19657 | @vindex gnus-score-uncacheable-files | |
19658 | @cindex score cache | |
19659 | All score files are normally cached to avoid excessive re-loading of | |
19660 | score files. However, this might make your Emacs grow big and | |
19661 | bloated, so this regexp can be used to weed out score files unlikely | |
19662 | to be needed again. It would be a bad idea to deny caching of | |
19663 | @file{all.SCORE}, while it might be a good idea to not cache | |
19664 | @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this | |
19665 | variable is @samp{ADAPT$} by default, so no adaptive score files will | |
19666 | be cached. | |
4009494e | 19667 | |
8a1cdce5 AC |
19668 | @item gnus-save-score |
19669 | @vindex gnus-save-score | |
19670 | If you have really complicated score files, and do lots of batch | |
19671 | scoring, then you might set this variable to @code{t}. This will make | |
19672 | Gnus save the scores into the @file{.newsrc.eld} file. | |
4009494e | 19673 | |
8a1cdce5 AC |
19674 | If you do not set this to @code{t}, then manual scores (like those set |
19675 | with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved | |
19676 | across group visits. | |
4009494e | 19677 | |
8a1cdce5 AC |
19678 | @item gnus-score-interactive-default-score |
19679 | @vindex gnus-score-interactive-default-score | |
19680 | Score used by all the interactive raise/lower commands to raise/lower | |
19681 | score with. Default is 1000, which may seem excessive, but this is to | |
19682 | ensure that the adaptive scoring scheme gets enough room to play with. | |
19683 | We don't want the small changes from the adaptive scoring to overwrite | |
19684 | manually entered data. | |
4009494e | 19685 | |
8a1cdce5 AC |
19686 | @item gnus-summary-default-score |
19687 | @vindex gnus-summary-default-score | |
19688 | Default score of an article, which is 0 by default. | |
01c52d31 | 19689 | |
8a1cdce5 AC |
19690 | @item gnus-summary-expunge-below |
19691 | @vindex gnus-summary-expunge-below | |
19692 | Don't display the summary lines of articles that have scores lower than | |
19693 | this variable. This is @code{nil} by default, which means that no | |
19694 | articles will be hidden. This variable is local to the summary buffers, | |
19695 | and has to be set from @code{gnus-summary-mode-hook}. | |
01c52d31 | 19696 | |
8a1cdce5 AC |
19697 | @item gnus-score-over-mark |
19698 | @vindex gnus-score-over-mark | |
19699 | Mark (in the third column) used for articles with a score over the | |
19700 | default. Default is @samp{+}. | |
4009494e | 19701 | |
8a1cdce5 AC |
19702 | @item gnus-score-below-mark |
19703 | @vindex gnus-score-below-mark | |
19704 | Mark (in the third column) used for articles with a score below the | |
19705 | default. Default is @samp{-}. | |
4009494e | 19706 | |
8a1cdce5 AC |
19707 | @item gnus-score-find-score-files-function |
19708 | @vindex gnus-score-find-score-files-function | |
19709 | Function used to find score files for the current group. This function | |
19710 | is called with the name of the group as the argument. | |
4009494e | 19711 | |
8a1cdce5 AC |
19712 | Predefined functions available are: |
19713 | @table @code | |
4009494e | 19714 | |
8a1cdce5 AC |
19715 | @item gnus-score-find-single |
19716 | @findex gnus-score-find-single | |
19717 | Only apply the group's own score file. | |
4009494e | 19718 | |
8a1cdce5 AC |
19719 | @item gnus-score-find-bnews |
19720 | @findex gnus-score-find-bnews | |
19721 | Apply all score files that match, using bnews syntax. This is the | |
19722 | default. If the current group is @samp{gnu.emacs.gnus}, for instance, | |
19723 | @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and | |
19724 | @file{gnu.all.SCORE} would all apply. In short, the instances of | |
19725 | @samp{all} in the score file names are translated into @samp{.*}, and | |
19726 | then a regexp match is done. | |
4009494e | 19727 | |
8a1cdce5 AC |
19728 | This means that if you have some score entries that you want to apply to |
19729 | all groups, then you put those entries in the @file{all.SCORE} file. | |
4009494e | 19730 | |
8a1cdce5 AC |
19731 | The score files are applied in a semi-random order, although Gnus will |
19732 | try to apply the more general score files before the more specific score | |
19733 | files. It does this by looking at the number of elements in the score | |
19734 | file names---discarding the @samp{all} elements. | |
4009494e | 19735 | |
8a1cdce5 AC |
19736 | @item gnus-score-find-hierarchical |
19737 | @findex gnus-score-find-hierarchical | |
19738 | Apply all score files from all the parent groups. This means that you | |
19739 | can't have score files like @file{all.SCORE}, but you can have | |
19740 | @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each | |
19741 | server. | |
4009494e | 19742 | |
8a1cdce5 AC |
19743 | @end table |
19744 | This variable can also be a list of functions. In that case, all | |
19745 | these functions will be called with the group name as argument, and | |
19746 | all the returned lists of score files will be applied. These | |
19747 | functions can also return lists of lists of score alists directly. In | |
19748 | that case, the functions that return these non-file score alists | |
19749 | should probably be placed before the ``real'' score file functions, to | |
19750 | ensure that the last score file returned is the local score file. | |
19751 | Phu. | |
4009494e | 19752 | |
8a1cdce5 AC |
19753 | For example, to do hierarchical scoring but use a non-server-specific |
19754 | overall score file, you could use the value | |
19755 | @example | |
19756 | (list (lambda (group) ("all.SCORE")) | |
19757 | 'gnus-score-find-hierarchical) | |
19758 | @end example | |
4009494e | 19759 | |
8a1cdce5 AC |
19760 | @item gnus-score-expiry-days |
19761 | @vindex gnus-score-expiry-days | |
19762 | This variable says how many days should pass before an unused score file | |
19763 | entry is expired. If this variable is @code{nil}, no score file entries | |
19764 | are expired. It's 7 by default. | |
4009494e | 19765 | |
8a1cdce5 AC |
19766 | @item gnus-update-score-entry-dates |
19767 | @vindex gnus-update-score-entry-dates | |
19768 | If this variable is non-@code{nil}, temporary score entries that have | |
19769 | been triggered (matched) will have their dates updated. (This is how Gnus | |
19770 | controls expiry---all non-matched-entries will become too old while | |
19771 | matched entries will stay fresh and young.) However, if you set this | |
19772 | variable to @code{nil}, even matched entries will grow old and will | |
19773 | have to face that oh-so grim reaper. | |
4009494e | 19774 | |
8a1cdce5 AC |
19775 | @item gnus-score-after-write-file-function |
19776 | @vindex gnus-score-after-write-file-function | |
19777 | Function called with the name of the score file just written. | |
4009494e | 19778 | |
8a1cdce5 AC |
19779 | @item gnus-score-thread-simplify |
19780 | @vindex gnus-score-thread-simplify | |
19781 | If this variable is non-@code{nil}, article subjects will be | |
19782 | simplified for subject scoring purposes in the same manner as with | |
19783 | threading---according to the current value of | |
19784 | @code{gnus-simplify-subject-functions}. If the scoring entry uses | |
19785 | @code{substring} or @code{exact} matching, the match will also be | |
19786 | simplified in this manner. | |
4009494e | 19787 | |
8a1cdce5 | 19788 | @end table |
4009494e | 19789 | |
4009494e | 19790 | |
8a1cdce5 AC |
19791 | @node Score File Format |
19792 | @section Score File Format | |
19793 | @cindex score file format | |
4009494e | 19794 | |
8a1cdce5 AC |
19795 | A score file is an @code{emacs-lisp} file that normally contains just a |
19796 | single form. Casual users are not expected to edit these files; | |
19797 | everything can be changed from the summary buffer. | |
4009494e | 19798 | |
8a1cdce5 | 19799 | Anyway, if you'd like to dig into it yourself, here's an example: |
4009494e | 19800 | |
8a1cdce5 AC |
19801 | @lisp |
19802 | (("from" | |
19803 | ("Lars Ingebrigtsen" -10000) | |
19804 | ("Per Abrahamsen") | |
19805 | ("larsi\\|lmi" -50000 nil R)) | |
19806 | ("subject" | |
19807 | ("Ding is Badd" nil 728373)) | |
19808 | ("xref" | |
19809 | ("alt.politics" -1000 728372 s)) | |
19810 | ("lines" | |
19811 | (2 -100 nil <)) | |
19812 | (mark 0) | |
19813 | (expunge -1000) | |
19814 | (mark-and-expunge -10) | |
19815 | (read-only nil) | |
19816 | (orphan -10) | |
19817 | (adapt t) | |
19818 | (files "/hom/larsi/News/gnu.SCORE") | |
19819 | (exclude-files "all.SCORE") | |
19820 | (local (gnus-newsgroup-auto-expire t) | |
19821 | (gnus-summary-make-false-root empty)) | |
19822 | (eval (ding))) | |
19823 | @end lisp | |
4009494e | 19824 | |
8a1cdce5 AC |
19825 | This example demonstrates most score file elements. @xref{Advanced |
19826 | Scoring}, for a different approach. | |
4009494e | 19827 | |
8a1cdce5 AC |
19828 | Even though this looks much like Lisp code, nothing here is actually |
19829 | @code{eval}ed. The Lisp reader is used to read this form, though, so it | |
19830 | has to be valid syntactically, if not semantically. | |
01c52d31 | 19831 | |
8a1cdce5 | 19832 | Six keys are supported by this alist: |
01c52d31 | 19833 | |
8a1cdce5 | 19834 | @table @code |
01c52d31 | 19835 | |
8a1cdce5 AC |
19836 | @item STRING |
19837 | If the key is a string, it is the name of the header to perform the | |
19838 | match on. Scoring can only be performed on these eight headers: | |
19839 | @code{From}, @code{Subject}, @code{References}, @code{Message-ID}, | |
19840 | @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to | |
19841 | these headers, there are three strings to tell Gnus to fetch the entire | |
19842 | article and do the match on larger parts of the article: @code{Body} | |
19843 | will perform the match on the body of the article, @code{Head} will | |
19844 | perform the match on the head of the article, and @code{All} will | |
19845 | perform the match on the entire article. Note that using any of these | |
19846 | last three keys will slow down group entry @emph{considerably}. The | |
19847 | final ``header'' you can score on is @code{Followup}. These score | |
19848 | entries will result in new score entries being added for all follow-ups | |
19849 | to articles that matches these score entries. | |
4009494e | 19850 | |
8a1cdce5 AC |
19851 | Following this key is an arbitrary number of score entries, where each |
19852 | score entry has one to four elements. | |
19853 | @enumerate | |
4009494e GM |
19854 | |
19855 | @item | |
8a1cdce5 AC |
19856 | The first element is the @dfn{match element}. On most headers this will |
19857 | be a string, but on the Lines and Chars headers, this must be an | |
19858 | integer. | |
4009494e GM |
19859 | |
19860 | @item | |
8a1cdce5 AC |
19861 | If the second element is present, it should be a number---the @dfn{score |
19862 | element}. This number should be an integer in the neginf to posinf | |
19863 | interval. This number is added to the score of the article if the match | |
19864 | is successful. If this element is not present, the | |
19865 | @code{gnus-score-interactive-default-score} number will be used | |
19866 | instead. This is 1000 by default. | |
4009494e | 19867 | |
8a1cdce5 AC |
19868 | @item |
19869 | If the third element is present, it should be a number---the @dfn{date | |
19870 | element}. This date says when the last time this score entry matched, | |
19871 | which provides a mechanism for expiring the score entries. It this | |
19872 | element is not present, the score entry is permanent. The date is | |
19873 | represented by the number of days since December 31, 1 BCE. | |
4009494e | 19874 | |
8a1cdce5 AC |
19875 | @item |
19876 | If the fourth element is present, it should be a symbol---the @dfn{type | |
19877 | element}. This element specifies what function should be used to see | |
19878 | whether this score entry matches the article. What match types that can | |
19879 | be used depends on what header you wish to perform the match on. | |
19880 | @table @dfn | |
4009494e | 19881 | |
8a1cdce5 AC |
19882 | @item From, Subject, References, Xref, Message-ID |
19883 | For most header types, there are the @code{r} and @code{R} (regexp), as | |
19884 | well as @code{s} and @code{S} (substring) types, and @code{e} and | |
19885 | @code{E} (exact match), and @code{w} (word match) types. If this | |
19886 | element is not present, Gnus will assume that substring matching should | |
19887 | be used. @code{R}, @code{S}, and @code{E} differ from the others in | |
19888 | that the matches will be done in a case-sensitive manner. All these | |
19889 | one-letter types are really just abbreviations for the @code{regexp}, | |
19890 | @code{string}, @code{exact}, and @code{word} types, which you can use | |
19891 | instead, if you feel like. | |
4009494e | 19892 | |
8a1cdce5 AC |
19893 | @item Extra |
19894 | Just as for the standard string overview headers, if you are using | |
19895 | gnus-extra-headers, you can score on these headers' values. In this | |
19896 | case, there is a 5th element in the score entry, being the name of the | |
19897 | header to be scored. The following entry is useful in your | |
19898 | @file{all.SCORE} file in case of spam attacks from a single origin | |
19899 | host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in | |
19900 | overviews: | |
4009494e | 19901 | |
8a1cdce5 AC |
19902 | @lisp |
19903 | ("111.222.333.444" -1000 nil s | |
19904 | "NNTP-Posting-Host") | |
19905 | @end lisp | |
4009494e | 19906 | |
8a1cdce5 AC |
19907 | @item Lines, Chars |
19908 | These two headers use different match types: @code{<}, @code{>}, | |
19909 | @code{=}, @code{>=} and @code{<=}. | |
4009494e | 19910 | |
8a1cdce5 | 19911 | These predicates are true if |
4009494e | 19912 | |
8a1cdce5 AC |
19913 | @example |
19914 | (PREDICATE HEADER MATCH) | |
19915 | @end example | |
01c52d31 | 19916 | |
8a1cdce5 AC |
19917 | evaluates to non-@code{nil}. For instance, the advanced match |
19918 | @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the | |
19919 | following form: | |
01c52d31 | 19920 | |
8a1cdce5 AC |
19921 | @lisp |
19922 | (< header-value 4) | |
19923 | @end lisp | |
01c52d31 | 19924 | |
8a1cdce5 AC |
19925 | Or to put it another way: When using @code{<} on @code{Lines} with 4 as |
19926 | the match, we get the score added if the article has less than 4 lines. | |
19927 | (It's easy to get confused and think it's the other way around. But | |
19928 | it's not. I think.) | |
4009494e | 19929 | |
8a1cdce5 AC |
19930 | When matching on @code{Lines}, be careful because some back ends (like |
19931 | @code{nndir}) do not generate @code{Lines} header, so every article ends | |
19932 | up being marked as having 0 lines. This can lead to strange results if | |
19933 | you happen to lower score of the articles with few lines. | |
4009494e | 19934 | |
8a1cdce5 AC |
19935 | @item Date |
19936 | For the Date header we have three kinda silly match types: | |
19937 | @code{before}, @code{at} and @code{after}. I can't really imagine this | |
19938 | ever being useful, but, like, it would feel kinda silly not to provide | |
19939 | this function. Just in case. You never know. Better safe than sorry. | |
19940 | Once burnt, twice shy. Don't judge a book by its cover. Never not have | |
19941 | sex on a first date. (I have been told that at least one person, and I | |
19942 | quote, ``found this function indispensable'', however.) | |
4009494e | 19943 | |
8a1cdce5 AC |
19944 | @cindex ISO8601 |
19945 | @cindex date | |
19946 | A more useful match type is @code{regexp}. With it, you can match the | |
19947 | date string using a regular expression. The date is normalized to | |
19948 | ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If | |
19949 | you want to match all articles that have been posted on April 1st in | |
19950 | every year, you could use @samp{....0401.........} as a match string, | |
19951 | for instance. (Note that the date is kept in its original time zone, so | |
19952 | this will match articles that were posted when it was April 1st where | |
19953 | the article was posted from. Time zones are such wholesome fun for the | |
19954 | whole family, eh?) | |
4009494e | 19955 | |
8a1cdce5 AC |
19956 | @item Head, Body, All |
19957 | These three match keys use the same match types as the @code{From} (etc) | |
19958 | header uses. | |
4009494e | 19959 | |
8a1cdce5 AC |
19960 | @item Followup |
19961 | This match key is somewhat special, in that it will match the | |
19962 | @code{From} header, and affect the score of not only the matching | |
19963 | articles, but also all followups to the matching articles. This allows | |
1df7defd | 19964 | you to increase the score of followups to your own articles, or |
8a1cdce5 AC |
19965 | decrease the score of followups to the articles of some known |
19966 | trouble-maker. Uses the same match types as the @code{From} header | |
19967 | uses. (Using this match key will lead to creation of @file{ADAPT} | |
19968 | files.) | |
4009494e | 19969 | |
8a1cdce5 AC |
19970 | @item Thread |
19971 | This match key works along the same lines as the @code{Followup} match | |
19972 | key. If you say that you want to score on a (sub-)thread started by an | |
19973 | article with a @code{Message-ID} @var{x}, then you add a @samp{thread} | |
19974 | match. This will add a new @samp{thread} match for each article that | |
19975 | has @var{x} in its @code{References} header. (These new @samp{thread} | |
19976 | matches will use the @code{Message-ID}s of these matching articles.) | |
19977 | This will ensure that you can raise/lower the score of an entire thread, | |
19978 | even though some articles in the thread may not have complete | |
19979 | @code{References} headers. Note that using this may lead to | |
22bcf204 | 19980 | nondeterministic scores of the articles in the thread. (Using this match |
8a1cdce5 AC |
19981 | key will lead to creation of @file{ADAPT} files.) |
19982 | @end table | |
19983 | @end enumerate | |
4009494e | 19984 | |
8a1cdce5 AC |
19985 | @cindex score file atoms |
19986 | @item mark | |
19987 | The value of this entry should be a number. Any articles with a score | |
19988 | lower than this number will be marked as read. | |
4009494e | 19989 | |
8a1cdce5 AC |
19990 | @item expunge |
19991 | The value of this entry should be a number. Any articles with a score | |
19992 | lower than this number will be removed from the summary buffer. | |
01c52d31 | 19993 | |
8a1cdce5 AC |
19994 | @item mark-and-expunge |
19995 | The value of this entry should be a number. Any articles with a score | |
19996 | lower than this number will be marked as read and removed from the | |
19997 | summary buffer. | |
19998 | ||
19999 | @item thread-mark-and-expunge | |
20000 | The value of this entry should be a number. All articles that belong to | |
20001 | a thread that has a total score below this number will be marked as read | |
20002 | and removed from the summary buffer. @code{gnus-thread-score-function} | |
20003 | says how to compute the total score for a thread. | |
20004 | ||
20005 | @item files | |
20006 | The value of this entry should be any number of file names. These files | |
20007 | are assumed to be score files as well, and will be loaded the same way | |
20008 | this one was. | |
20009 | ||
20010 | @item exclude-files | |
20011 | The clue of this entry should be any number of files. These files will | |
20012 | not be loaded, even though they would normally be so, for some reason or | |
20013 | other. | |
20014 | ||
20015 | @item eval | |
20016 | The value of this entry will be @code{eval}ed. This element will be | |
20017 | ignored when handling global score files. | |
4009494e | 20018 | |
8a1cdce5 AC |
20019 | @item read-only |
20020 | Read-only score files will not be updated or saved. Global score files | |
20021 | should feature this atom (@pxref{Global Score Files}). (Note: | |
20022 | @dfn{Global} here really means @dfn{global}; not your personal | |
20023 | apply-to-all-groups score files.) | |
4009494e | 20024 | |
8a1cdce5 AC |
20025 | @item orphan |
20026 | The value of this entry should be a number. Articles that do not have | |
20027 | parents will get this number added to their scores. Imagine you follow | |
20028 | some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you | |
20029 | will only follow a few of the threads, also want to see any new threads. | |
4009494e | 20030 | |
8a1cdce5 | 20031 | You can do this with the following two score file entries: |
4009494e | 20032 | |
8a1cdce5 AC |
20033 | @example |
20034 | (orphan -500) | |
20035 | (mark-and-expunge -100) | |
20036 | @end example | |
4009494e | 20037 | |
8a1cdce5 AC |
20038 | When you enter the group the first time, you will only see the new |
20039 | threads. You then raise the score of the threads that you find | |
20040 | interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{c y}) the | |
20041 | rest. Next time you enter the group, you will see new articles in the | |
20042 | interesting threads, plus any new threads. | |
01c52d31 | 20043 | |
1df7defd | 20044 | I.e., the orphan score atom is for high-volume groups where a few |
8a1cdce5 AC |
20045 | interesting threads which can't be found automatically by ordinary |
20046 | scoring rules exist. | |
01c52d31 | 20047 | |
8a1cdce5 AC |
20048 | @item adapt |
20049 | This entry controls the adaptive scoring. If it is @code{t}, the | |
20050 | default adaptive scoring rules will be used. If it is @code{ignore}, no | |
20051 | adaptive scoring will be performed on this group. If it is a list, this | |
20052 | list will be used as the adaptive scoring rules. If it isn't present, | |
20053 | or is something other than @code{t} or @code{ignore}, the default | |
20054 | adaptive scoring rules will be used. If you want to use adaptive | |
20055 | scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to | |
20056 | @code{t}, and insert an @code{(adapt ignore)} in the groups where you do | |
20057 | not want adaptive scoring. If you only want adaptive scoring in a few | |
20058 | groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and | |
20059 | insert @code{(adapt t)} in the score files of the groups where you want | |
20060 | it. | |
20061 | ||
20062 | @item adapt-file | |
20063 | All adaptive score entries will go to the file named by this entry. It | |
20064 | will also be applied when entering the group. This atom might be handy | |
20065 | if you want to adapt on several groups at once, using the same adaptive | |
20066 | file for a number of groups. | |
4009494e | 20067 | |
8a1cdce5 AC |
20068 | @item local |
20069 | @cindex local variables | |
20070 | The value of this entry should be a list of @code{(@var{var} | |
20071 | @var{value})} pairs. Each @var{var} will be made buffer-local to the | |
20072 | current summary buffer, and set to the value specified. This is a | |
20073 | convenient, if somewhat strange, way of setting variables in some | |
20074 | groups if you don't like hooks much. Note that the @var{value} won't | |
20075 | be evaluated. | |
4009494e GM |
20076 | @end table |
20077 | ||
20078 | ||
8a1cdce5 AC |
20079 | @node Score File Editing |
20080 | @section Score File Editing | |
4009494e | 20081 | |
8a1cdce5 AC |
20082 | You normally enter all scoring commands from the summary buffer, but you |
20083 | might feel the urge to edit them by hand as well, so we've supplied you | |
20084 | with a mode for that. | |
4009494e | 20085 | |
8a1cdce5 AC |
20086 | It's simply a slightly customized @code{emacs-lisp} mode, with these |
20087 | additional commands: | |
4009494e | 20088 | |
8a1cdce5 | 20089 | @table @kbd |
4009494e | 20090 | |
8a1cdce5 AC |
20091 | @item C-c C-c |
20092 | @kindex C-c C-c (Score) | |
20093 | @findex gnus-score-edit-exit | |
20094 | Save the changes you have made and return to the summary buffer | |
20095 | (@code{gnus-score-edit-exit}). | |
4009494e | 20096 | |
8a1cdce5 AC |
20097 | @item C-c C-d |
20098 | @kindex C-c C-d (Score) | |
20099 | @findex gnus-score-edit-insert-date | |
20100 | Insert the current date in numerical format | |
20101 | (@code{gnus-score-edit-insert-date}). This is really the day number, if | |
20102 | you were wondering. | |
4009494e | 20103 | |
8a1cdce5 AC |
20104 | @item C-c C-p |
20105 | @kindex C-c C-p (Score) | |
20106 | @findex gnus-score-pretty-print | |
20107 | The adaptive score files are saved in an unformatted fashion. If you | |
20108 | intend to read one of these files, you want to @dfn{pretty print} it | |
20109 | first. This command (@code{gnus-score-pretty-print}) does that for | |
20110 | you. | |
4009494e | 20111 | |
8a1cdce5 | 20112 | @end table |
4009494e | 20113 | |
8a1cdce5 | 20114 | Type @kbd{M-x gnus-score-mode} to use this mode. |
4009494e | 20115 | |
8a1cdce5 AC |
20116 | @vindex gnus-score-mode-hook |
20117 | @code{gnus-score-menu-hook} is run in score mode buffers. | |
4009494e | 20118 | |
8a1cdce5 AC |
20119 | In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and |
20120 | @kbd{V t} to begin editing score files. | |
4009494e | 20121 | |
4009494e | 20122 | |
8a1cdce5 AC |
20123 | @node Adaptive Scoring |
20124 | @section Adaptive Scoring | |
20125 | @cindex adaptive scoring | |
4009494e | 20126 | |
8a1cdce5 AC |
20127 | If all this scoring is getting you down, Gnus has a way of making it all |
20128 | happen automatically---as if by magic. Or rather, as if by artificial | |
20129 | stupidity, to be precise. | |
4009494e | 20130 | |
8a1cdce5 AC |
20131 | @vindex gnus-use-adaptive-scoring |
20132 | When you read an article, or mark an article as read, or kill an | |
20133 | article, you leave marks behind. On exit from the group, Gnus can sniff | |
20134 | these marks and add score elements depending on what marks it finds. | |
20135 | You turn on this ability by setting @code{gnus-use-adaptive-scoring} to | |
20136 | @code{t} or @code{(line)}. If you want score adaptively on separate | |
20137 | words appearing in the subjects, you should set this variable to | |
20138 | @code{(word)}. If you want to use both adaptive methods, set this | |
20139 | variable to @code{(word line)}. | |
4009494e | 20140 | |
8a1cdce5 AC |
20141 | @vindex gnus-default-adaptive-score-alist |
20142 | To give you complete control over the scoring process, you can customize | |
20143 | the @code{gnus-default-adaptive-score-alist} variable. For instance, it | |
20144 | might look something like this: | |
4009494e | 20145 | |
8a1cdce5 AC |
20146 | @lisp |
20147 | (setq gnus-default-adaptive-score-alist | |
20148 | '((gnus-unread-mark) | |
20149 | (gnus-ticked-mark (from 4)) | |
20150 | (gnus-dormant-mark (from 5)) | |
20151 | (gnus-del-mark (from -4) (subject -1)) | |
20152 | (gnus-read-mark (from 4) (subject 2)) | |
20153 | (gnus-expirable-mark (from -1) (subject -1)) | |
20154 | (gnus-killed-mark (from -1) (subject -3)) | |
20155 | (gnus-kill-file-mark) | |
20156 | (gnus-ancient-mark) | |
20157 | (gnus-low-score-mark) | |
20158 | (gnus-catchup-mark (from -1) (subject -1)))) | |
20159 | @end lisp | |
4009494e | 20160 | |
8a1cdce5 AC |
20161 | As you see, each element in this alist has a mark as a key (either a |
20162 | variable name or a ``real'' mark---a character). Following this key is | |
20163 | a arbitrary number of header/score pairs. If there are no header/score | |
20164 | pairs following the key, no adaptive scoring will be done on articles | |
20165 | that have that key as the article mark. For instance, articles with | |
20166 | @code{gnus-unread-mark} in the example above will not get adaptive score | |
20167 | entries. | |
4009494e | 20168 | |
8a1cdce5 AC |
20169 | Each article can have only one mark, so just a single of these rules |
20170 | will be applied to each article. | |
20171 | ||
20172 | To take @code{gnus-del-mark} as an example---this alist says that all | |
20173 | articles that have that mark (i.e., are marked with @samp{e}) will have a | |
20174 | score entry added to lower based on the @code{From} header by -4, and | |
20175 | lowered by @code{Subject} by -1. Change this to fit your prejudices. | |
20176 | ||
20177 | If you have marked 10 articles with the same subject with | |
20178 | @code{gnus-del-mark}, the rule for that mark will be applied ten times. | |
20179 | That means that that subject will get a score of ten times -1, which | |
20180 | should be, unless I'm much mistaken, -10. | |
20181 | ||
20182 | If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all | |
20183 | the read articles will be marked with the @samp{E} mark. This'll | |
20184 | probably make adaptive scoring slightly impossible, so auto-expiring and | |
20185 | adaptive scoring doesn't really mix very well. | |
20186 | ||
20187 | The headers you can score on are @code{from}, @code{subject}, | |
20188 | @code{message-id}, @code{references}, @code{xref}, @code{lines}, | |
20189 | @code{chars} and @code{date}. In addition, you can score on | |
20190 | @code{followup}, which will create an adaptive score entry that matches | |
20191 | on the @code{References} header using the @code{Message-ID} of the | |
20192 | current article, thereby matching the following thread. | |
4009494e | 20193 | |
8a1cdce5 AC |
20194 | If you use this scheme, you should set the score file atom @code{mark} |
20195 | to something small---like -300, perhaps, to avoid having small random | |
20196 | changes result in articles getting marked as read. | |
4009494e | 20197 | |
8a1cdce5 AC |
20198 | After using adaptive scoring for a week or so, Gnus should start to |
20199 | become properly trained and enhance the authors you like best, and kill | |
20200 | the authors you like least, without you having to say so explicitly. | |
4009494e | 20201 | |
8a1cdce5 AC |
20202 | You can control what groups the adaptive scoring is to be performed on |
20203 | by using the score files (@pxref{Score File Format}). This will also | |
20204 | let you use different rules in different groups. | |
4009494e | 20205 | |
8a1cdce5 AC |
20206 | @vindex gnus-adaptive-file-suffix |
20207 | The adaptive score entries will be put into a file where the name is the | |
20208 | group name with @code{gnus-adaptive-file-suffix} appended. The default | |
20209 | is @file{ADAPT}. | |
4009494e | 20210 | |
8a1cdce5 AC |
20211 | @vindex gnus-adaptive-pretty-print |
20212 | Adaptive score files can get huge and are not meant to be edited by | |
20213 | human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the | |
20214 | default) those files will not be written in a human readable way. | |
4009494e | 20215 | |
8a1cdce5 AC |
20216 | @vindex gnus-score-exact-adapt-limit |
20217 | When doing adaptive scoring, substring or fuzzy matching would probably | |
20218 | give you the best results in most cases. However, if the header one | |
20219 | matches is short, the possibility for false positives is great, so if | |
20220 | the length of the match is less than | |
20221 | @code{gnus-score-exact-adapt-limit}, exact matching will be used. If | |
20222 | this variable is @code{nil}, exact matching will always be used to avoid | |
20223 | this problem. | |
4009494e | 20224 | |
8a1cdce5 AC |
20225 | @vindex gnus-default-adaptive-word-score-alist |
20226 | As mentioned above, you can adapt either on individual words or entire | |
20227 | headers. If you adapt on words, the | |
20228 | @code{gnus-default-adaptive-word-score-alist} variable says what score | |
20229 | each instance of a word should add given a mark. | |
4009494e | 20230 | |
8a1cdce5 AC |
20231 | @lisp |
20232 | (setq gnus-default-adaptive-word-score-alist | |
20233 | `((,gnus-read-mark . 30) | |
20234 | (,gnus-catchup-mark . -10) | |
20235 | (,gnus-killed-mark . -20) | |
20236 | (,gnus-del-mark . -15))) | |
20237 | @end lisp | |
4009494e | 20238 | |
8a1cdce5 AC |
20239 | This is the default value. If you have adaption on words enabled, every |
20240 | word that appears in subjects of articles marked with | |
20241 | @code{gnus-read-mark} will result in a score rule that increase the | |
20242 | score with 30 points. | |
4009494e | 20243 | |
8a1cdce5 AC |
20244 | @vindex gnus-default-ignored-adaptive-words |
20245 | @vindex gnus-ignored-adaptive-words | |
20246 | Words that appear in the @code{gnus-default-ignored-adaptive-words} list | |
20247 | will be ignored. If you wish to add more words to be ignored, use the | |
20248 | @code{gnus-ignored-adaptive-words} list instead. | |
4009494e | 20249 | |
8a1cdce5 AC |
20250 | @vindex gnus-adaptive-word-length-limit |
20251 | Some may feel that short words shouldn't count when doing adaptive | |
20252 | scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to | |
20253 | an integer. Words shorter than this number will be ignored. This | |
20254 | variable defaults to @code{nil}. | |
4009494e | 20255 | |
8a1cdce5 AC |
20256 | @vindex gnus-adaptive-word-syntax-table |
20257 | When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the | |
20258 | syntax table in effect. It is similar to the standard syntax table, but | |
20259 | it considers numbers to be non-word-constituent characters. | |
4009494e | 20260 | |
8a1cdce5 AC |
20261 | @vindex gnus-adaptive-word-minimum |
20262 | If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive | |
20263 | word scoring process will never bring down the score of an article to | |
20264 | below this number. The default is @code{nil}. | |
4009494e | 20265 | |
8a1cdce5 AC |
20266 | @vindex gnus-adaptive-word-no-group-words |
20267 | If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus | |
20268 | won't adaptively word score any of the words in the group name. Useful | |
20269 | for groups like @samp{comp.editors.emacs}, where most of the subject | |
20270 | lines contain the word @samp{emacs}. | |
4009494e | 20271 | |
8a1cdce5 AC |
20272 | After using this scheme for a while, it might be nice to write a |
20273 | @code{gnus-psychoanalyze-user} command to go through the rules and see | |
20274 | what words you like and what words you don't like. Or perhaps not. | |
4009494e | 20275 | |
8a1cdce5 AC |
20276 | Note that the adaptive word scoring thing is highly experimental and is |
20277 | likely to change in the future. Initial impressions seem to indicate | |
20278 | that it's totally useless as it stands. Some more work (involving more | |
20279 | rigorous statistical methods) will have to be done to make this useful. | |
4009494e | 20280 | |
4009494e | 20281 | |
8a1cdce5 AC |
20282 | @node Home Score File |
20283 | @section Home Score File | |
4009494e | 20284 | |
8a1cdce5 AC |
20285 | The score file where new score file entries will go is called the |
20286 | @dfn{home score file}. This is normally (and by default) the score file | |
20287 | for the group itself. For instance, the home score file for | |
20288 | @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}. | |
4009494e | 20289 | |
8a1cdce5 AC |
20290 | However, this may not be what you want. It is often convenient to share |
20291 | a common home score file among many groups---all @samp{emacs} groups | |
20292 | could perhaps use the same home score file. | |
4009494e | 20293 | |
8a1cdce5 AC |
20294 | @vindex gnus-home-score-file |
20295 | The variable that controls this is @code{gnus-home-score-file}. It can | |
20296 | be: | |
4009494e | 20297 | |
8a1cdce5 AC |
20298 | @enumerate |
20299 | @item | |
20300 | A string. Then this file will be used as the home score file for all | |
20301 | groups. | |
4009494e | 20302 | |
8a1cdce5 AC |
20303 | @item |
20304 | A function. The result of this function will be used as the home score | |
20305 | file. The function will be called with the name of the group as the | |
20306 | parameter. | |
4009494e | 20307 | |
8a1cdce5 AC |
20308 | @item |
20309 | A list. The elements in this list can be: | |
4009494e | 20310 | |
8a1cdce5 AC |
20311 | @enumerate |
20312 | @item | |
20313 | @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the | |
20314 | group name, the @var{file-name} will be used as the home score file. | |
4009494e | 20315 | |
8a1cdce5 AC |
20316 | @item |
20317 | A function. If the function returns non-@code{nil}, the result will | |
20318 | be used as the home score file. The function will be called with the | |
20319 | name of the group as the parameter. | |
4009494e | 20320 | |
8a1cdce5 AC |
20321 | @item |
20322 | A string. Use the string as the home score file. | |
20323 | @end enumerate | |
4009494e | 20324 | |
8a1cdce5 AC |
20325 | The list will be traversed from the beginning towards the end looking |
20326 | for matches. | |
4009494e | 20327 | |
8a1cdce5 | 20328 | @end enumerate |
4009494e | 20329 | |
8a1cdce5 | 20330 | So, if you want to use just a single score file, you could say: |
4009494e | 20331 | |
8a1cdce5 AC |
20332 | @lisp |
20333 | (setq gnus-home-score-file | |
20334 | "my-total-score-file.SCORE") | |
20335 | @end lisp | |
4009494e | 20336 | |
8a1cdce5 AC |
20337 | If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and |
20338 | @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say: | |
4009494e | 20339 | |
8a1cdce5 AC |
20340 | @findex gnus-hierarchial-home-score-file |
20341 | @lisp | |
20342 | (setq gnus-home-score-file | |
20343 | 'gnus-hierarchial-home-score-file) | |
20344 | @end lisp | |
4009494e | 20345 | |
8a1cdce5 AC |
20346 | This is a ready-made function provided for your convenience. |
20347 | Other functions include | |
20348 | ||
20349 | @table @code | |
20350 | @item gnus-current-home-score-file | |
20351 | @findex gnus-current-home-score-file | |
20352 | Return the ``current'' regular score file. This will make scoring | |
20353 | commands add entry to the ``innermost'' matching score file. | |
4009494e | 20354 | |
8a1cdce5 | 20355 | @end table |
4009494e | 20356 | |
8a1cdce5 AC |
20357 | If you want to have one score file for the @samp{emacs} groups and |
20358 | another for the @samp{comp} groups, while letting all other groups use | |
20359 | their own home score files: | |
4009494e | 20360 | |
8a1cdce5 AC |
20361 | @lisp |
20362 | (setq gnus-home-score-file | |
20363 | ;; @r{All groups that match the regexp @code{"\\.emacs"}} | |
20364 | '(("\\.emacs" "emacs.SCORE") | |
20365 | ;; @r{All the comp groups in one score file} | |
20366 | ("^comp" "comp.SCORE"))) | |
20367 | @end lisp | |
4009494e | 20368 | |
8a1cdce5 AC |
20369 | @vindex gnus-home-adapt-file |
20370 | @code{gnus-home-adapt-file} works exactly the same way as | |
20371 | @code{gnus-home-score-file}, but says what the home adaptive score file | |
20372 | is instead. All new adaptive file entries will go into the file | |
20373 | specified by this variable, and the same syntax is allowed. | |
4009494e | 20374 | |
8a1cdce5 AC |
20375 | In addition to using @code{gnus-home-score-file} and |
20376 | @code{gnus-home-adapt-file}, you can also use group parameters | |
20377 | (@pxref{Group Parameters}) and topic parameters (@pxref{Topic | |
20378 | Parameters}) to achieve much the same. Group and topic parameters take | |
20379 | precedence over this variable. | |
4009494e | 20380 | |
4009494e | 20381 | |
8a1cdce5 AC |
20382 | @node Followups To Yourself |
20383 | @section Followups To Yourself | |
4009494e | 20384 | |
8a1cdce5 AC |
20385 | Gnus offers two commands for picking out the @code{Message-ID} header in |
20386 | the current buffer. Gnus will then add a score rule that scores using | |
20387 | this @code{Message-ID} on the @code{References} header of other | |
20388 | articles. This will, in effect, increase the score of all articles that | |
20389 | respond to the article in the current buffer. Quite useful if you want | |
20390 | to easily note when people answer what you've said. | |
4009494e | 20391 | |
8a1cdce5 | 20392 | @table @code |
4009494e | 20393 | |
8a1cdce5 AC |
20394 | @item gnus-score-followup-article |
20395 | @findex gnus-score-followup-article | |
20396 | This will add a score to articles that directly follow up your own | |
20397 | article. | |
4009494e | 20398 | |
8a1cdce5 AC |
20399 | @item gnus-score-followup-thread |
20400 | @findex gnus-score-followup-thread | |
20401 | This will add a score to all articles that appear in a thread ``below'' | |
20402 | your own article. | |
20403 | @end table | |
4009494e | 20404 | |
8a1cdce5 AC |
20405 | @vindex message-sent-hook |
20406 | These two functions are both primarily meant to be used in hooks like | |
20407 | @code{message-sent-hook}, like this: | |
20408 | @lisp | |
20409 | (add-hook 'message-sent-hook 'gnus-score-followup-thread) | |
20410 | @end lisp | |
4009494e | 20411 | |
4009494e | 20412 | |
8a1cdce5 AC |
20413 | If you look closely at your own @code{Message-ID}, you'll notice that |
20414 | the first two or three characters are always the same. Here's two of | |
20415 | mine: | |
4009494e | 20416 | |
8a1cdce5 AC |
20417 | @example |
20418 | <x6u3u47icf.fsf@@eyesore.no> | |
20419 | <x6sp9o7ibw.fsf@@eyesore.no> | |
20420 | @end example | |
4009494e | 20421 | |
8a1cdce5 AC |
20422 | So ``my'' ident on this machine is @samp{x6}. This can be |
20423 | exploited---the following rule will raise the score on all followups to | |
20424 | myself: | |
4009494e | 20425 | |
8a1cdce5 AC |
20426 | @lisp |
20427 | ("references" | |
20428 | ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>" | |
20429 | 1000 nil r)) | |
20430 | @end lisp | |
4009494e | 20431 | |
8a1cdce5 AC |
20432 | Whether it's the first two or first three characters that are ``yours'' |
20433 | is system-dependent. | |
4009494e | 20434 | |
4009494e | 20435 | |
8a1cdce5 AC |
20436 | @node Scoring On Other Headers |
20437 | @section Scoring On Other Headers | |
20438 | @cindex scoring on other headers | |
4009494e | 20439 | |
8a1cdce5 AC |
20440 | Gnus is quite fast when scoring the ``traditional'' |
20441 | headers---@samp{From}, @samp{Subject} and so on. However, scoring | |
20442 | other headers requires writing a @code{head} scoring rule, which means | |
20443 | that Gnus has to request every single article from the back end to find | |
20444 | matches. This takes a long time in big groups. | |
4009494e | 20445 | |
8a1cdce5 AC |
20446 | @vindex gnus-inhibit-slow-scoring |
20447 | You can inhibit this slow scoring on headers or body by setting the | |
20448 | variable @code{gnus-inhibit-slow-scoring}. If | |
20449 | @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if | |
20450 | the group matches the regexp. If it is t, slow scoring on it is | |
20451 | inhibited for all groups. | |
4009494e | 20452 | |
8a1cdce5 AC |
20453 | Now, there's not much you can do about the slowness for news groups, but for |
20454 | mail groups, you have greater control. In @ref{To From Newsgroups}, | |
20455 | it's explained in greater detail what this mechanism does, but here's | |
20456 | a cookbook example for @code{nnml} on how to allow scoring on the | |
20457 | @samp{To} and @samp{Cc} headers. | |
4009494e | 20458 | |
8a1cdce5 | 20459 | Put the following in your @file{~/.gnus.el} file. |
4009494e | 20460 | |
8a1cdce5 AC |
20461 | @lisp |
20462 | (setq gnus-extra-headers '(To Cc Newsgroups Keywords) | |
20463 | nnmail-extra-headers gnus-extra-headers) | |
20464 | @end lisp | |
4009494e | 20465 | |
8a1cdce5 AC |
20466 | Restart Gnus and rebuild your @code{nnml} overview files with the |
20467 | @kbd{M-x nnml-generate-nov-databases} command. This will take a long | |
20468 | time if you have much mail. | |
4009494e | 20469 | |
8a1cdce5 AC |
20470 | Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like |
20471 | so: @kbd{I e s p To RET <your name> RET}. | |
4009494e | 20472 | |
8a1cdce5 | 20473 | See? Simple. |
4009494e | 20474 | |
4009494e | 20475 | |
8a1cdce5 AC |
20476 | @node Scoring Tips |
20477 | @section Scoring Tips | |
20478 | @cindex scoring tips | |
4009494e | 20479 | |
8a1cdce5 | 20480 | @table @dfn |
4009494e | 20481 | |
8a1cdce5 AC |
20482 | @item Crossposts |
20483 | @cindex crossposts | |
20484 | @cindex scoring crossposts | |
20485 | If you want to lower the score of crossposts, the line to match on is | |
20486 | the @code{Xref} header. | |
20487 | @lisp | |
20488 | ("xref" (" talk.politics.misc:" -1000)) | |
20489 | @end lisp | |
4009494e | 20490 | |
8a1cdce5 AC |
20491 | @item Multiple crossposts |
20492 | If you want to lower the score of articles that have been crossposted to | |
20493 | more than, say, 3 groups: | |
20494 | @lisp | |
20495 | ("xref" | |
20496 | ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" | |
20497 | -1000 nil r)) | |
20498 | @end lisp | |
4009494e | 20499 | |
8a1cdce5 AC |
20500 | @item Matching on the body |
20501 | This is generally not a very good idea---it takes a very long time. | |
20502 | Gnus actually has to fetch each individual article from the server. But | |
20503 | you might want to anyway, I guess. Even though there are three match | |
20504 | keys (@code{Head}, @code{Body} and @code{All}), you should choose one | |
20505 | and stick with it in each score file. If you use any two, each article | |
20506 | will be fetched @emph{twice}. If you want to match a bit on the | |
20507 | @code{Head} and a bit on the @code{Body}, just use @code{All} for all | |
20508 | the matches. | |
4009494e | 20509 | |
8a1cdce5 AC |
20510 | @item Marking as read |
20511 | You will probably want to mark articles that have scores below a certain | |
20512 | number as read. This is most easily achieved by putting the following | |
20513 | in your @file{all.SCORE} file: | |
20514 | @lisp | |
20515 | ((mark -100)) | |
20516 | @end lisp | |
20517 | You may also consider doing something similar with @code{expunge}. | |
4009494e | 20518 | |
8a1cdce5 AC |
20519 | @item Negated character classes |
20520 | If you say stuff like @code{[^abcd]*}, you may get unexpected results. | |
20521 | That will match newlines, which might lead to, well, The Unknown. Say | |
20522 | @code{[^abcd\n]*} instead. | |
4009494e GM |
20523 | @end table |
20524 | ||
4009494e | 20525 | |
8a1cdce5 AC |
20526 | @node Reverse Scoring |
20527 | @section Reverse Scoring | |
20528 | @cindex reverse scoring | |
4009494e | 20529 | |
8a1cdce5 AC |
20530 | If you want to keep just articles that have @samp{Sex with Emacs} in the |
20531 | subject header, and expunge all other articles, you could put something | |
20532 | like this in your score file: | |
4009494e | 20533 | |
8a1cdce5 AC |
20534 | @lisp |
20535 | (("subject" | |
20536 | ("Sex with Emacs" 2)) | |
20537 | (mark 1) | |
20538 | (expunge 1)) | |
20539 | @end lisp | |
4009494e | 20540 | |
8a1cdce5 AC |
20541 | So, you raise all articles that match @samp{Sex with Emacs} and mark the |
20542 | rest as read, and expunge them to boot. | |
4009494e GM |
20543 | |
20544 | ||
8a1cdce5 AC |
20545 | @node Global Score Files |
20546 | @section Global Score Files | |
20547 | @cindex global score files | |
4009494e | 20548 | |
8a1cdce5 AC |
20549 | Sure, other newsreaders have ``global kill files''. These are usually |
20550 | nothing more than a single kill file that applies to all groups, stored | |
20551 | in the user's home directory. Bah! Puny, weak newsreaders! | |
4009494e | 20552 | |
8a1cdce5 AC |
20553 | What I'm talking about here are Global Score Files. Score files from |
20554 | all over the world, from users everywhere, uniting all nations in one | |
20555 | big, happy score file union! Ange-score! New and untested! | |
4009494e | 20556 | |
8a1cdce5 AC |
20557 | @vindex gnus-global-score-files |
20558 | All you have to do to use other people's score files is to set the | |
20559 | @code{gnus-global-score-files} variable. One entry for each score file, | |
20560 | or each score file directory. Gnus will decide by itself what score | |
20561 | files are applicable to which group. | |
01c52d31 | 20562 | |
8a1cdce5 AC |
20563 | To use the score file |
20564 | @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and | |
20565 | all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory, | |
20566 | say this: | |
4009494e | 20567 | |
8a1cdce5 AC |
20568 | @lisp |
20569 | (setq gnus-global-score-files | |
20570 | '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE" | |
20571 | "/ftp@@ftp.some-where:/pub/score/")) | |
20572 | @end lisp | |
4009494e | 20573 | |
8a1cdce5 AC |
20574 | @findex gnus-score-search-global-directories |
20575 | @noindent | |
20576 | Simple, eh? Directory names must end with a @samp{/}. These | |
20577 | directories are typically scanned only once during each Gnus session. | |
20578 | If you feel the need to manually re-scan the remote directories, you can | |
20579 | use the @code{gnus-score-search-global-directories} command. | |
4009494e | 20580 | |
8a1cdce5 AC |
20581 | Note that, at present, using this option will slow down group entry |
20582 | somewhat. (That is---a lot.) | |
4009494e | 20583 | |
8a1cdce5 AC |
20584 | If you want to start maintaining score files for other people to use, |
20585 | just put your score file up for anonymous ftp and announce it to the | |
20586 | world. Become a retro-moderator! Participate in the retro-moderator | |
20587 | wars sure to ensue, where retro-moderators battle it out for the | |
20588 | sympathy of the people, luring them to use their score files on false | |
20589 | premises! Yay! The net is saved! | |
4009494e | 20590 | |
8a1cdce5 AC |
20591 | Here are some tips for the would-be retro-moderator, off the top of my |
20592 | head: | |
4009494e | 20593 | |
8a1cdce5 | 20594 | @itemize @bullet |
4009494e | 20595 | |
8a1cdce5 AC |
20596 | @item |
20597 | Articles heavily crossposted are probably junk. | |
20598 | @item | |
20599 | To lower a single inappropriate article, lower by @code{Message-ID}. | |
20600 | @item | |
20601 | Particularly brilliant authors can be raised on a permanent basis. | |
20602 | @item | |
20603 | Authors that repeatedly post off-charter for the group can safely be | |
20604 | lowered out of existence. | |
20605 | @item | |
20606 | Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest | |
20607 | articles completely. | |
4009494e | 20608 | |
8a1cdce5 AC |
20609 | @item |
20610 | Use expiring score entries to keep the size of the file down. You | |
20611 | should probably have a long expiry period, though, as some sites keep | |
20612 | old articles for a long time. | |
20613 | @end itemize | |
4009494e | 20614 | |
8a1cdce5 AC |
20615 | @dots{} I wonder whether other newsreaders will support global score files |
20616 | in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue | |
20617 | Wave, xrn and 1stReader are bound to implement scoring. Should we start | |
20618 | holding our breath yet? | |
4009494e | 20619 | |
4009494e | 20620 | |
8a1cdce5 AC |
20621 | @node Kill Files |
20622 | @section Kill Files | |
20623 | @cindex kill files | |
4009494e | 20624 | |
8a1cdce5 AC |
20625 | Gnus still supports those pesky old kill files. In fact, the kill file |
20626 | entries can now be expiring, which is something I wrote before Daniel | |
20627 | Quinlan thought of doing score files, so I've left the code in there. | |
4009494e | 20628 | |
8a1cdce5 AC |
20629 | In short, kill processing is a lot slower (and I do mean @emph{a lot}) |
20630 | than score processing, so it might be a good idea to rewrite your kill | |
20631 | files into score files. | |
4009494e | 20632 | |
8a1cdce5 AC |
20633 | Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any |
20634 | forms into this file, which means that you can use kill files as some | |
20635 | sort of primitive hook function to be run on group entry, even though | |
20636 | that isn't a very good idea. | |
4009494e | 20637 | |
8a1cdce5 | 20638 | Normal kill files look like this: |
4009494e | 20639 | |
8a1cdce5 AC |
20640 | @lisp |
20641 | (gnus-kill "From" "Lars Ingebrigtsen") | |
20642 | (gnus-kill "Subject" "ding") | |
20643 | (gnus-expunge "X") | |
20644 | @end lisp | |
4009494e | 20645 | |
8a1cdce5 AC |
20646 | This will mark every article written by me as read, and remove the |
20647 | marked articles from the summary buffer. Very useful, you'll agree. | |
4009494e | 20648 | |
8a1cdce5 AC |
20649 | Other programs use a totally different kill file syntax. If Gnus |
20650 | encounters what looks like a @code{rn} kill file, it will take a stab at | |
20651 | interpreting it. | |
4009494e | 20652 | |
8a1cdce5 | 20653 | Two summary functions for editing a @sc{gnus} kill file: |
4009494e | 20654 | |
8a1cdce5 | 20655 | @table @kbd |
4009494e | 20656 | |
8a1cdce5 AC |
20657 | @item M-k |
20658 | @kindex M-k (Summary) | |
20659 | @findex gnus-summary-edit-local-kill | |
20660 | Edit this group's kill file (@code{gnus-summary-edit-local-kill}). | |
4009494e | 20661 | |
8a1cdce5 AC |
20662 | @item M-K |
20663 | @kindex M-K (Summary) | |
20664 | @findex gnus-summary-edit-global-kill | |
20665 | Edit the general kill file (@code{gnus-summary-edit-global-kill}). | |
20666 | @end table | |
4009494e | 20667 | |
8a1cdce5 | 20668 | Two group mode functions for editing the kill files: |
4009494e | 20669 | |
8a1cdce5 | 20670 | @table @kbd |
4009494e | 20671 | |
8a1cdce5 AC |
20672 | @item M-k |
20673 | @kindex M-k (Group) | |
20674 | @findex gnus-group-edit-local-kill | |
20675 | Edit this group's kill file (@code{gnus-group-edit-local-kill}). | |
4009494e | 20676 | |
8a1cdce5 AC |
20677 | @item M-K |
20678 | @kindex M-K (Group) | |
20679 | @findex gnus-group-edit-global-kill | |
20680 | Edit the general kill file (@code{gnus-group-edit-global-kill}). | |
4009494e | 20681 | @end table |
4009494e | 20682 | |
8a1cdce5 | 20683 | Kill file variables: |
4009494e | 20684 | |
8a1cdce5 AC |
20685 | @table @code |
20686 | @item gnus-kill-file-name | |
20687 | @vindex gnus-kill-file-name | |
20688 | A kill file for the group @samp{soc.motss} is normally called | |
20689 | @file{soc.motss.KILL}. The suffix appended to the group name to get | |
20690 | this file name is detailed by the @code{gnus-kill-file-name} variable. | |
20691 | The ``global'' kill file (not in the score file sense of ``global'', of | |
20692 | course) is just called @file{KILL}. | |
4009494e | 20693 | |
8a1cdce5 AC |
20694 | @vindex gnus-kill-save-kill-file |
20695 | @item gnus-kill-save-kill-file | |
20696 | If this variable is non-@code{nil}, Gnus will save the | |
20697 | kill file after processing, which is necessary if you use expiring | |
20698 | kills. | |
4009494e | 20699 | |
8a1cdce5 AC |
20700 | @item gnus-apply-kill-hook |
20701 | @vindex gnus-apply-kill-hook | |
20702 | @findex gnus-apply-kill-file-unless-scored | |
20703 | @findex gnus-apply-kill-file | |
20704 | A hook called to apply kill files to a group. It is | |
20705 | @code{(gnus-apply-kill-file)} by default. If you want to ignore the | |
20706 | kill file if you have a score file for the same group, you can set this | |
20707 | hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want | |
20708 | kill files to be processed, you should set this variable to @code{nil}. | |
4009494e | 20709 | |
8a1cdce5 AC |
20710 | @item gnus-kill-file-mode-hook |
20711 | @vindex gnus-kill-file-mode-hook | |
20712 | A hook called in kill-file mode buffers. | |
4009494e GM |
20713 | |
20714 | @end table | |
20715 | ||
20716 | ||
8a1cdce5 AC |
20717 | @node Converting Kill Files |
20718 | @section Converting Kill Files | |
20719 | @cindex kill files | |
20720 | @cindex converting kill files | |
4009494e | 20721 | |
8a1cdce5 AC |
20722 | If you have loads of old kill files, you may want to convert them into |
20723 | score files. If they are ``regular'', you can use | |
20724 | the @file{gnus-kill-to-score.el} package; if not, you'll have to do it | |
20725 | by hand. | |
4009494e | 20726 | |
8a1cdce5 AC |
20727 | The kill to score conversion package isn't included in Emacs by default. |
20728 | You can fetch it from the contrib directory of the Gnus distribution or | |
20729 | from | |
20730 | @uref{http://heim.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}. | |
4009494e | 20731 | |
8a1cdce5 AC |
20732 | If your old kill files are very complex---if they contain more |
20733 | non-@code{gnus-kill} forms than not, you'll have to convert them by | |
20734 | hand. Or just let them be as they are. Gnus will still use them as | |
20735 | before. | |
4009494e | 20736 | |
4009494e | 20737 | |
8a1cdce5 AC |
20738 | @node Advanced Scoring |
20739 | @section Advanced Scoring | |
4009494e | 20740 | |
8a1cdce5 AC |
20741 | Scoring on Subjects and From headers is nice enough, but what if you're |
20742 | really interested in what a person has to say only when she's talking | |
20743 | about a particular subject? Or what if you really don't want to | |
20744 | read what person A has to say when she's following up to person B, but | |
20745 | want to read what she says when she's following up to person C? | |
4009494e | 20746 | |
8a1cdce5 AC |
20747 | By using advanced scoring rules you may create arbitrarily complex |
20748 | scoring patterns. | |
4009494e | 20749 | |
8a1cdce5 AC |
20750 | @menu |
20751 | * Advanced Scoring Syntax:: A definition. | |
20752 | * Advanced Scoring Examples:: What they look like. | |
20753 | * Advanced Scoring Tips:: Getting the most out of it. | |
20754 | @end menu | |
4009494e | 20755 | |
4009494e | 20756 | |
8a1cdce5 AC |
20757 | @node Advanced Scoring Syntax |
20758 | @subsection Advanced Scoring Syntax | |
4009494e | 20759 | |
8a1cdce5 AC |
20760 | Ordinary scoring rules have a string as the first element in the rule. |
20761 | Advanced scoring rules have a list as the first element. The second | |
20762 | element is the score to be applied if the first element evaluated to a | |
20763 | non-@code{nil} value. | |
4009494e | 20764 | |
8a1cdce5 AC |
20765 | These lists may consist of three logical operators, one redirection |
20766 | operator, and various match operators. | |
4009494e | 20767 | |
8a1cdce5 | 20768 | Logical operators: |
4009494e | 20769 | |
8a1cdce5 AC |
20770 | @table @code |
20771 | @item & | |
20772 | @itemx and | |
20773 | This logical operator will evaluate each of its arguments until it finds | |
20774 | one that evaluates to @code{false}, and then it'll stop. If all arguments | |
20775 | evaluate to @code{true} values, then this operator will return | |
20776 | @code{true}. | |
4009494e | 20777 | |
8a1cdce5 AC |
20778 | @item | |
20779 | @itemx or | |
20780 | This logical operator will evaluate each of its arguments until it finds | |
20781 | one that evaluates to @code{true}. If no arguments are @code{true}, | |
20782 | then this operator will return @code{false}. | |
4009494e | 20783 | |
8a1cdce5 AC |
20784 | @item ! |
20785 | @itemx not | |
89b163db | 20786 | @itemx ¬ |
8a1cdce5 AC |
20787 | This logical operator only takes a single argument. It returns the |
20788 | logical negation of the value of its argument. | |
4009494e | 20789 | |
8a1cdce5 | 20790 | @end table |
4009494e | 20791 | |
8a1cdce5 AC |
20792 | There is an @dfn{indirection operator} that will make its arguments |
20793 | apply to the ancestors of the current article being scored. For | |
20794 | instance, @code{1-} will make score rules apply to the parent of the | |
20795 | current article. @code{2-} will make score rules apply to the | |
20796 | grandparent of the current article. Alternatively, you can write | |
20797 | @code{^^}, where the number of @code{^}s (carets) says how far back into | |
20798 | the ancestry you want to go. | |
4009494e | 20799 | |
8a1cdce5 AC |
20800 | Finally, we have the match operators. These are the ones that do the |
20801 | real work. Match operators are header name strings followed by a match | |
20802 | and a match type. A typical match operator looks like @samp{("from" | |
20803 | "Lars Ingebrigtsen" s)}. The header names are the same as when using | |
20804 | simple scoring, and the match types are also the same. | |
4009494e | 20805 | |
4009494e | 20806 | |
8a1cdce5 AC |
20807 | @node Advanced Scoring Examples |
20808 | @subsection Advanced Scoring Examples | |
4009494e | 20809 | |
8a1cdce5 AC |
20810 | Please note that the following examples are score file rules. To |
20811 | make a complete score file from them, surround them with another pair | |
20812 | of parentheses. | |
4009494e | 20813 | |
8a1cdce5 AC |
20814 | Let's say you want to increase the score of articles written by Lars |
20815 | when he's talking about Gnus: | |
4009494e | 20816 | |
8a1cdce5 AC |
20817 | @example |
20818 | @group | |
20819 | ((& | |
20820 | ("from" "Lars Ingebrigtsen") | |
20821 | ("subject" "Gnus")) | |
20822 | 1000) | |
20823 | @end group | |
20824 | @end example | |
4009494e | 20825 | |
8a1cdce5 | 20826 | Quite simple, huh? |
4009494e | 20827 | |
8a1cdce5 | 20828 | When he writes long articles, he sometimes has something nice to say: |
4009494e | 20829 | |
8a1cdce5 AC |
20830 | @example |
20831 | ((& | |
20832 | ("from" "Lars Ingebrigtsen") | |
20833 | (| | |
20834 | ("subject" "Gnus") | |
20835 | ("lines" 100 >))) | |
20836 | 1000) | |
20837 | @end example | |
4009494e | 20838 | |
8a1cdce5 AC |
20839 | However, when he responds to things written by Reig Eigil Logge, you |
20840 | really don't want to read what he's written: | |
4009494e | 20841 | |
8a1cdce5 AC |
20842 | @example |
20843 | ((& | |
20844 | ("from" "Lars Ingebrigtsen") | |
20845 | (1- ("from" "Reig Eigil Logge"))) | |
20846 | -100000) | |
20847 | @end example | |
4009494e | 20848 | |
8a1cdce5 AC |
20849 | Everybody that follows up Redmondo when he writes about disappearing |
20850 | socks should have their scores raised, but only when they talk about | |
20851 | white socks. However, when Lars talks about socks, it's usually not | |
20852 | very interesting: | |
4009494e | 20853 | |
8a1cdce5 AC |
20854 | @example |
20855 | ((& | |
20856 | (1- | |
20857 | (& | |
20858 | ("from" "redmondo@@.*no" r) | |
20859 | ("body" "disappearing.*socks" t))) | |
20860 | (! ("from" "Lars Ingebrigtsen")) | |
20861 | ("body" "white.*socks")) | |
20862 | 1000) | |
20863 | @end example | |
4009494e | 20864 | |
8a1cdce5 AC |
20865 | Suppose you're reading a high volume group and you're only interested |
20866 | in replies. The plan is to score down all articles that don't have | |
20867 | subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all | |
20868 | parents of articles that have subjects that begin with reply marks. | |
4009494e | 20869 | |
8a1cdce5 AC |
20870 | @example |
20871 | ((! ("subject" "re:\\|fwd?:" r)) | |
20872 | -200) | |
20873 | ((1- ("subject" "re:\\|fwd?:" r)) | |
20874 | 200) | |
20875 | @end example | |
4009494e | 20876 | |
8a1cdce5 | 20877 | The possibilities are endless. |
4009494e | 20878 | |
8a1cdce5 AC |
20879 | @node Advanced Scoring Tips |
20880 | @subsection Advanced Scoring Tips | |
4009494e | 20881 | |
8a1cdce5 AC |
20882 | The @code{&} and @code{|} logical operators do short-circuit logic. |
20883 | That is, they stop processing their arguments when it's clear what the | |
20884 | result of the operation will be. For instance, if one of the arguments | |
20885 | of an @code{&} evaluates to @code{false}, there's no point in evaluating | |
20886 | the rest of the arguments. This means that you should put slow matches | |
20887 | (@samp{body}, @samp{header}) last and quick matches (@samp{from}, | |
20888 | @samp{subject}) first. | |
4009494e | 20889 | |
8a1cdce5 AC |
20890 | The indirection arguments (@code{1-} and so on) will make their |
20891 | arguments work on previous generations of the thread. If you say | |
20892 | something like: | |
4009494e GM |
20893 | |
20894 | @example | |
8a1cdce5 AC |
20895 | ... |
20896 | (1- | |
20897 | (1- | |
20898 | ("from" "lars"))) | |
20899 | ... | |
4009494e GM |
20900 | @end example |
20901 | ||
8a1cdce5 AC |
20902 | Then that means ``score on the from header of the grandparent of the |
20903 | current article''. An indirection is quite fast, but it's better to say: | |
4009494e | 20904 | |
8a1cdce5 AC |
20905 | @example |
20906 | (1- | |
20907 | (& | |
20908 | ("from" "Lars") | |
20909 | ("subject" "Gnus"))) | |
20910 | @end example | |
4009494e | 20911 | |
8a1cdce5 | 20912 | than it is to say: |
4009494e | 20913 | |
8a1cdce5 AC |
20914 | @example |
20915 | (& | |
20916 | (1- ("from" "Lars")) | |
20917 | (1- ("subject" "Gnus"))) | |
20918 | @end example | |
4009494e GM |
20919 | |
20920 | ||
8a1cdce5 AC |
20921 | @node Score Decays |
20922 | @section Score Decays | |
20923 | @cindex score decays | |
20924 | @cindex decays | |
4009494e | 20925 | |
8a1cdce5 AC |
20926 | You may find that your scores have a tendency to grow without |
20927 | bounds, especially if you're using adaptive scoring. If scores get too | |
20928 | big, they lose all meaning---they simply max out and it's difficult to | |
20929 | use them in any sensible way. | |
4009494e | 20930 | |
8a1cdce5 AC |
20931 | @vindex gnus-decay-scores |
20932 | @findex gnus-decay-score | |
20933 | @vindex gnus-decay-score-function | |
20934 | Gnus provides a mechanism for decaying scores to help with this problem. | |
20935 | When score files are loaded and @code{gnus-decay-scores} is | |
20936 | non-@code{nil}, Gnus will run the score files through the decaying | |
20937 | mechanism thereby lowering the scores of all non-permanent score rules. | |
20938 | If @code{gnus-decay-scores} is a regexp, only score files matching this | |
1df7defd | 20939 | regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only |
8a1cdce5 AC |
20940 | @emph{adaptive} score files should be decayed. The decay itself if |
20941 | performed by the @code{gnus-decay-score-function} function, which is | |
20942 | @code{gnus-decay-score} by default. Here's the definition of that | |
20943 | function: | |
4009494e | 20944 | |
8a1cdce5 AC |
20945 | @lisp |
20946 | (defun gnus-decay-score (score) | |
20947 | "Decay SCORE according to `gnus-score-decay-constant' | |
20948 | and `gnus-score-decay-scale'." | |
20949 | (let ((n (- score | |
20950 | (* (if (< score 0) -1 1) | |
20951 | (min (abs score) | |
20952 | (max gnus-score-decay-constant | |
20953 | (* (abs score) | |
20954 | gnus-score-decay-scale))))))) | |
20955 | (if (and (featurep 'xemacs) | |
44e97401 | 20956 | ;; XEmacs's floor can handle only the floating point |
8a1cdce5 AC |
20957 | ;; number below the half of the maximum integer. |
20958 | (> (abs n) (lsh -1 -2))) | |
20959 | (string-to-number | |
20960 | (car (split-string (number-to-string n) "\\."))) | |
20961 | (floor n)))) | |
20962 | @end lisp | |
4009494e | 20963 | |
8a1cdce5 AC |
20964 | @vindex gnus-score-decay-scale |
20965 | @vindex gnus-score-decay-constant | |
20966 | @code{gnus-score-decay-constant} is 3 by default and | |
20967 | @code{gnus-score-decay-scale} is 0.05. This should cause the following: | |
4009494e | 20968 | |
8a1cdce5 AC |
20969 | @enumerate |
20970 | @item | |
20971 | Scores between -3 and 3 will be set to 0 when this function is called. | |
4009494e | 20972 | |
8a1cdce5 AC |
20973 | @item |
20974 | Scores with magnitudes between 3 and 60 will be shrunk by 3. | |
4009494e | 20975 | |
8a1cdce5 AC |
20976 | @item |
20977 | Scores with magnitudes greater than 60 will be shrunk by 5% of the | |
20978 | score. | |
20979 | @end enumerate | |
4009494e | 20980 | |
8a1cdce5 AC |
20981 | If you don't like this decay function, write your own. It is called |
20982 | with the score to be decayed as its only parameter, and it should return | |
20983 | the new score, which should be an integer. | |
4009494e | 20984 | |
8a1cdce5 AC |
20985 | Gnus will try to decay scores once a day. If you haven't run Gnus for |
20986 | four days, Gnus will decay the scores four times, for instance. | |
4009494e | 20987 | |
8a1cdce5 AC |
20988 | @node Searching |
20989 | @chapter Searching | |
20990 | @cindex searching | |
4009494e | 20991 | |
8a1cdce5 AC |
20992 | FIXME: Add a brief overview of Gnus search capabilities. A brief |
20993 | comparison of nnir, nnmairix, contrib/gnus-namazu would be nice | |
20994 | as well. | |
4009494e | 20995 | |
8a1cdce5 AC |
20996 | This chapter describes tools for searching groups and servers for |
20997 | articles matching a query and then retrieving those articles. Gnus | |
fe3c5669 PE |
20998 | provides a simpler mechanism for searching through articles in a summary buffer |
20999 | to find those matching a pattern. @xref{Searching for Articles}. | |
4009494e | 21000 | |
8a1cdce5 AC |
21001 | @menu |
21002 | * nnir:: Searching with various engines. | |
21003 | * nnmairix:: Searching with Mairix. | |
21004 | @end menu | |
4009494e | 21005 | |
8a1cdce5 AC |
21006 | @node nnir |
21007 | @section nnir | |
21008 | @cindex nnir | |
4009494e | 21009 | |
8a1cdce5 AC |
21010 | This section describes how to use @code{nnir} to search for articles |
21011 | within gnus. | |
4009494e | 21012 | |
8a1cdce5 | 21013 | @menu |
156e3f9c | 21014 | * What is nnir?:: What does @code{nnir} do? |
8a1cdce5 | 21015 | * Basic Usage:: How to perform simple searches. |
156e3f9c | 21016 | * Setting up nnir:: How to set up @code{nnir}. |
8a1cdce5 | 21017 | @end menu |
4009494e | 21018 | |
156e3f9c G |
21019 | @node What is nnir? |
21020 | @subsection What is nnir? | |
8a1cdce5 | 21021 | |
156e3f9c | 21022 | @code{nnir} is a Gnus interface to a number of tools for searching |
8a1cdce5 AC |
21023 | through mail and news repositories. Different backends (like |
21024 | @code{nnimap} and @code{nntp}) work with different tools (called | |
156e3f9c | 21025 | @dfn{engines} in @code{nnir} lingo), but all use the same basic search |
8a1cdce5 AC |
21026 | interface. |
21027 | ||
21028 | The @code{nnimap} and @code{gmane} search engines should work with no | |
21029 | configuration. Other engines require a local index that needs to be | |
fe3c5669 | 21030 | created and maintained outside of Gnus. |
8a1cdce5 | 21031 | |
156e3f9c | 21032 | |
8a1cdce5 AC |
21033 | @node Basic Usage |
21034 | @subsection Basic Usage | |
21035 | ||
21036 | In the group buffer typing @kbd{G G} will search the group on the | |
21037 | current line by calling @code{gnus-group-make-nnir-group}. This prompts | |
21038 | for a query string, creates an ephemeral @code{nnir} group containing | |
21039 | the articles that match this query, and takes you to a summary buffer | |
21040 | showing these articles. Articles may then be read, moved and deleted | |
21041 | using the usual commands. | |
21042 | ||
21043 | The @code{nnir} group made in this way is an @code{ephemeral} group, and | |
21044 | some changes are not permanent: aside from reading, moving, and | |
21045 | deleting, you can't act on the original article. But there is an | |
21046 | alternative: you can @emph{warp} to the original group for the article | |
21047 | on the current line with @kbd{A W}, aka | |
21048 | @code{gnus-warp-to-article}. Even better, the function | |
21049 | @code{gnus-summary-refer-thread}, bound by default in summary buffers to | |
21050 | @kbd{A T}, will first warp to the original group before it works its | |
21051 | magic and includes all the articles in the thread. From here you can | |
21052 | read, move and delete articles, but also copy them, alter article marks, | |
21053 | whatever. Go nuts. | |
21054 | ||
21055 | You say you want to search more than just the group on the current line? | |
21056 | No problem: just process-mark the groups you want to search. You want | |
21057 | even more? Calling for an nnir search with the cursor on a topic heading | |
21058 | will search all the groups under that heading. | |
21059 | ||
21060 | Still not enough? OK, in the server buffer | |
21061 | @code{gnus-group-make-nnir-group} (now bound to @kbd{G}) will search all | |
21062 | groups from the server on the current line. Too much? Want to ignore | |
21063 | certain groups when searching, like spam groups? Just customize | |
21064 | @code{nnir-ignored-newsgroups}. | |
21065 | ||
21066 | One more thing: individual search engines may have special search | |
21067 | features. You can access these special features by giving a prefix-arg | |
21068 | to @code{gnus-group-make-nnir-group}. If you are searching multiple | |
21069 | groups with different search engines you will be prompted for the | |
fe3c5669 | 21070 | special search features for each engine separately. |
8a1cdce5 | 21071 | |
156e3f9c | 21072 | |
8a1cdce5 AC |
21073 | @node Setting up nnir |
21074 | @subsection Setting up nnir | |
21075 | ||
21076 | To set up nnir you may need to do some prep work. Firstly, you may need | |
21077 | to configure the search engines you plan to use. Some of them, like | |
21078 | @code{imap} and @code{gmane}, need no special configuration. Others, | |
21079 | like @code{namazu} and @code{swish}, require configuration as described | |
21080 | below. Secondly, you need to associate a search engine with a server or | |
21081 | a backend. | |
21082 | ||
21083 | If you just want to use the @code{imap} engine to search @code{nnimap} | |
21084 | servers, and the @code{gmane} engine to search @code{gmane} then you | |
21085 | don't have to do anything. But you might want to read the details of the | |
21086 | query language anyway. | |
4009494e | 21087 | |
8a1cdce5 AC |
21088 | @menu |
21089 | * Associating Engines:: How to associate engines. | |
21090 | * The imap Engine:: Imap configuration and usage. | |
21091 | * The gmane Engine:: Gmane configuration and usage. | |
21092 | * The swish++ Engine:: Swish++ configuration and usage. | |
21093 | * The swish-e Engine:: Swish-e configuration and usage. | |
21094 | * The namazu Engine:: Namazu configuration and usage. | |
21095 | * The hyrex Engine:: Hyrex configuration and usage. | |
21096 | * Customizations:: User customizable settings. | |
21097 | @end menu | |
4009494e | 21098 | |
8a1cdce5 AC |
21099 | @node Associating Engines |
21100 | @subsubsection Associating Engines | |
4009494e | 21101 | |
4009494e | 21102 | |
8a1cdce5 AC |
21103 | When searching a group, @code{nnir} needs to know which search engine to |
21104 | use. You can configure a given server to use a particular engine by | |
21105 | setting the server variable @code{nnir-search-engine} to the engine | |
21106 | name. For example to use the @code{namazu} engine to search the server | |
21107 | named @code{home} you can use | |
4009494e | 21108 | |
8a1cdce5 | 21109 | @lisp |
156e3f9c | 21110 | (setq gnus-secondary-select-methods |
fe3c5669 | 21111 | '((nnml "home" |
156e3f9c G |
21112 | (nnimap-address "localhost") |
21113 | (nnir-search-engine namazu)))) | |
8a1cdce5 | 21114 | @end lisp |
4009494e | 21115 | |
8a1cdce5 AC |
21116 | Alternatively you might want to use a particular engine for all servers |
21117 | with a given backend. For example, you might want to use the @code{imap} | |
21118 | engine for all servers using the @code{nnimap} backend. In this case you | |
21119 | can customize the variable @code{nnir-method-default-engines}. This is | |
21120 | an alist of pairs of the form @code{(backend . engine)}. By default this | |
21121 | variable is set to use the @code{imap} engine for all servers using the | |
21122 | @code{nnimap} backend, and the @code{gmane} backend for @code{nntp} | |
21123 | servers. (Don't worry, the @code{gmane} search engine won't actually try | |
21124 | to search non-gmane @code{nntp} servers.) But if you wanted to use | |
21125 | @code{namazu} for all your servers with an @code{nnimap} backend you | |
21126 | could change this to | |
4009494e | 21127 | |
8a1cdce5 AC |
21128 | @lisp |
21129 | '((nnimap . namazu) | |
21130 | (nntp . gmane)) | |
21131 | @end lisp | |
4009494e | 21132 | |
8a1cdce5 AC |
21133 | @node The imap Engine |
21134 | @subsubsection The imap Engine | |
4009494e | 21135 | |
fe3c5669 | 21136 | The @code{imap} engine requires no configuration. |
4009494e | 21137 | |
fe3c5669 | 21138 | Queries using the @code{imap} engine follow a simple query language. |
8a1cdce5 AC |
21139 | The search is always case-insensitive and supports the following |
21140 | features (inspired by the Google search input language): | |
01c52d31 | 21141 | |
8a1cdce5 | 21142 | @table @samp |
4009494e | 21143 | |
8a1cdce5 AC |
21144 | @item Boolean query operators |
21145 | AND, OR, and NOT are supported, and parentheses can be used to control | |
1df7defd | 21146 | operator precedence, e.g., (emacs OR xemacs) AND linux. Note that |
8a1cdce5 | 21147 | operators must be written with all capital letters to be |
e1dbe924 | 21148 | recognized. Also preceding a term with a - sign is equivalent to NOT |
8a1cdce5 | 21149 | term. |
4009494e | 21150 | |
fe3c5669 | 21151 | @item Automatic AND queries |
8a1cdce5 AC |
21152 | If you specify multiple words then they will be treated as an AND |
21153 | expression intended to match all components. | |
4009494e | 21154 | |
8a1cdce5 AC |
21155 | @item Phrase searches |
21156 | If you wrap your query in double-quotes then it will be treated as a | |
21157 | literal string. | |
4009494e | 21158 | |
8a1cdce5 | 21159 | @end table |
4009494e | 21160 | |
8a1cdce5 AC |
21161 | By default the whole message will be searched. The query can be limited |
21162 | to a specific part of a message by using a prefix-arg. After inputting | |
21163 | the query this will prompt (with completion) for a message part. | |
21164 | Choices include ``Whole message'', ``Subject'', ``From'', and | |
21165 | ``To''. Any unrecognized input is interpreted as a header name. For | |
21166 | example, typing @kbd{Message-ID} in response to this prompt will limit | |
21167 | the query to the Message-ID header. | |
4009494e | 21168 | |
8a1cdce5 AC |
21169 | Finally selecting ``Imap'' will interpret the query as a raw |
21170 | @acronym{IMAP} search query. The format of such queries can be found in | |
21171 | RFC3501. | |
4009494e | 21172 | |
8a1cdce5 AC |
21173 | If you don't like the default of searching whole messages you can |
21174 | customize @code{nnir-imap-default-search-key}. For example to use | |
21175 | @acronym{IMAP} queries by default | |
4009494e | 21176 | |
8a1cdce5 AC |
21177 | @lisp |
21178 | (setq nnir-imap-default-search-key "Imap") | |
21179 | @end lisp | |
4009494e | 21180 | |
8a1cdce5 AC |
21181 | @node The gmane Engine |
21182 | @subsubsection The gmane Engine | |
4009494e | 21183 | |
fe3c5669 | 21184 | The @code{gmane} engine requires no configuration. |
4009494e | 21185 | |
8a1cdce5 | 21186 | Gmane queries follow a simple query language: |
4009494e | 21187 | |
8a1cdce5 AC |
21188 | @table @samp |
21189 | @item Boolean query operators | |
21190 | AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be | |
1df7defd | 21191 | used to control operator precedence, e.g., (emacs OR xemacs) AND linux. |
8a1cdce5 | 21192 | Note that operators must be written with all capital letters to be |
e1dbe924 | 21193 | recognized. |
4009494e | 21194 | |
8a1cdce5 | 21195 | @item Required and excluded terms |
1df7defd | 21196 | + and - can be used to require or exclude terms, e.g., football -american |
4009494e | 21197 | |
fe3c5669 | 21198 | @item Unicode handling |
8a1cdce5 AC |
21199 | The search engine converts all text to utf-8, so searching should work |
21200 | in any language. | |
4009494e | 21201 | |
fe3c5669 | 21202 | @item Stopwords |
8a1cdce5 | 21203 | Common English words (like 'the' and 'a') are ignored by default. You |
1df7defd PE |
21204 | can override this by prefixing such words with a + (e.g., +the) or |
21205 | enclosing the word in quotes (e.g., "the"). | |
4009494e | 21206 | |
8a1cdce5 | 21207 | @end table |
4009494e | 21208 | |
8a1cdce5 AC |
21209 | The query can be limited to articles by a specific author using a |
21210 | prefix-arg. After inputting the query this will prompt for an author | |
21211 | name (or part of a name) to match. | |
4009494e | 21212 | |
8a1cdce5 AC |
21213 | @node The swish++ Engine |
21214 | @subsubsection The swish++ Engine | |
4009494e | 21215 | |
e4920bc9 | 21216 | FIXME: Say something more here. |
4009494e | 21217 | |
8a1cdce5 AC |
21218 | Documentation for swish++ may be found at the swish++ sourceforge page: |
21219 | @uref{http://swishplusplus.sourceforge.net} | |
4009494e | 21220 | |
8151d490 AC |
21221 | @table @code |
21222 | ||
21223 | @item nnir-swish++-program | |
21224 | The name of the swish++ executable. Defaults to @code{search} | |
21225 | ||
21226 | @item nnir-swish++-additional-switches | |
21227 | A list of strings to be given as additional arguments to | |
21228 | swish++. @code{nil} by default. | |
21229 | ||
21230 | @item nnir-swish++-remove-prefix | |
21231 | The prefix to remove from each file name returned by swish++ in order | |
21232 | to get a group name. By default this is @code{$HOME/Mail}. | |
21233 | ||
21234 | @end table | |
21235 | ||
8a1cdce5 AC |
21236 | @node The swish-e Engine |
21237 | @subsubsection The swish-e Engine | |
4009494e | 21238 | |
e4920bc9 | 21239 | FIXME: Say something more here. |
4009494e | 21240 | |
8a1cdce5 AC |
21241 | Documentation for swish-e may be found at the swish-e homepage |
21242 | @uref{http://swish-e.org} | |
4009494e | 21243 | |
8151d490 AC |
21244 | @table @code |
21245 | ||
21246 | @item nnir-swish-e-program | |
21247 | The name of the swish-e search program. Defaults to @code{swish-e}. | |
21248 | ||
21249 | @item nnir-swish-e-additional-switches | |
21250 | A list of strings to be given as additional arguments to | |
21251 | swish-e. @code{nil} by default. | |
21252 | ||
21253 | @item nnir-swish-e-remove-prefix | |
21254 | The prefix to remove from each file name returned by swish-e in order | |
21255 | to get a group name. By default this is @code{$HOME/Mail}. | |
21256 | ||
21257 | @end table | |
21258 | ||
8a1cdce5 AC |
21259 | @node The namazu Engine |
21260 | @subsubsection The namazu Engine | |
4009494e | 21261 | |
8a1cdce5 AC |
21262 | Using the namazu engine requires creating and maintaining index files. |
21263 | One directory should contain all the index files, and nnir must be told | |
21264 | where to find them by setting the @code{nnir-namazu-index-directory} | |
fe3c5669 | 21265 | variable. |
4009494e | 21266 | |
8a1cdce5 AC |
21267 | To work correctly the @code{nnir-namazu-remove-prefix} variable must |
21268 | also be correct. This is the prefix to remove from each file name | |
21269 | returned by Namazu in order to get a proper group name (albeit with `/' | |
21270 | instead of `.'). | |
4009494e | 21271 | |
8a1cdce5 AC |
21272 | For example, suppose that Namazu returns file names such as |
21273 | @samp{/home/john/Mail/mail/misc/42}. For this example, use the | |
21274 | following setting: @code{(setq nnir-namazu-remove-prefix | |
21275 | "/home/john/Mail/")} Note the trailing slash. Removing this prefix from | |
21276 | the directory gives @samp{mail/misc/42}. @code{nnir} knows to remove | |
21277 | the @samp{/42} and to replace @samp{/} with @samp{.} to arrive at the | |
21278 | correct group name @samp{mail.misc}. | |
4009494e | 21279 | |
8a1cdce5 AC |
21280 | Extra switches may be passed to the namazu search command by setting the |
21281 | variable @code{nnir-namazu-additional-switches}. It is particularly | |
21282 | important not to pass any any switches to namazu that will change the | |
21283 | output format. Good switches to use include `--sort', `--ascending', | |
21284 | `--early' and `--late'. Refer to the Namazu documentation for further | |
21285 | information on valid switches. | |
4009494e | 21286 | |
8a1cdce5 AC |
21287 | Mail must first be indexed with the `mknmz' program. Read the documentation |
21288 | for namazu to create a configuration file. Here is an example: | |
4009494e | 21289 | |
8a1cdce5 AC |
21290 | @cartouche |
21291 | @example | |
21292 | package conf; # Don't remove this line! | |
4009494e | 21293 | |
8a1cdce5 AC |
21294 | # Paths which will not be indexed. Don't use `^' or `$' anchors. |
21295 | $EXCLUDE_PATH = "spam|sent"; | |
4009494e | 21296 | |
8a1cdce5 AC |
21297 | # Header fields which should be searchable. case-insensitive |
21298 | $REMAIN_HEADER = "from|date|message-id|subject"; | |
4009494e | 21299 | |
8a1cdce5 AC |
21300 | # Searchable fields. case-insensitive |
21301 | $SEARCH_FIELD = "from|date|message-id|subject"; | |
4009494e | 21302 | |
8a1cdce5 AC |
21303 | # The max length of a word. |
21304 | $WORD_LENG_MAX = 128; | |
4009494e | 21305 | |
8a1cdce5 AC |
21306 | # The max length of a field. |
21307 | $MAX_FIELD_LENGTH = 256; | |
21308 | @end example | |
21309 | @end cartouche | |
4009494e | 21310 | |
8a1cdce5 AC |
21311 | For this example, mail is stored in the directories @samp{~/Mail/mail/}, |
21312 | @samp{~/Mail/lists/} and @samp{~/Mail/archive/}, so to index them go to | |
21313 | the index directory set in @code{nnir-namazu-index-directory} and issue | |
21314 | the following command: | |
4009494e | 21315 | |
8a1cdce5 AC |
21316 | @example |
21317 | mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/ | |
21318 | @end example | |
4009494e | 21319 | |
8a1cdce5 AC |
21320 | For maximum searching efficiency you might want to have a cron job run |
21321 | this command periodically, say every four hours. | |
4009494e | 21322 | |
8a1cdce5 AC |
21323 | @node The hyrex Engine |
21324 | @subsubsection The hyrex Engine | |
156e3f9c | 21325 | This engine is obsolete. |
4009494e | 21326 | |
8a1cdce5 | 21327 | @node Customizations |
fe3c5669 | 21328 | @subsubsection Customizations |
4009494e | 21329 | |
8a1cdce5 AC |
21330 | @table @code |
21331 | ||
21332 | @item nnir-method-default-engines | |
21333 | Alist of server backend - search engine pairs. The default associations | |
21334 | are | |
21335 | @example | |
21336 | (nnimap . imap) | |
21337 | (nntp . gmane) | |
21338 | @end example | |
4009494e | 21339 | |
8a1cdce5 AC |
21340 | @item nnir-ignored-newsgroups |
21341 | A regexp to match newsgroups in the active file that should be skipped | |
21342 | when searching all groups on a server. | |
4009494e | 21343 | |
8a1cdce5 AC |
21344 | @item nnir-summary-line-format |
21345 | The format specification to be used for lines in an nnir summary buffer. | |
21346 | All the items from `gnus-summary-line-format' are available, along with | |
21347 | three items unique to nnir summary buffers: | |
4009494e GM |
21348 | |
21349 | @example | |
8a1cdce5 AC |
21350 | %Z Search retrieval score value (integer) |
21351 | %G Article original full group name (string) | |
21352 | %g Article original short group name (string) | |
4009494e GM |
21353 | @end example |
21354 | ||
8a1cdce5 | 21355 | If nil (the default) this will use @code{gnus-summary-line-format}. |
4009494e | 21356 | |
8a1cdce5 AC |
21357 | @item nnir-retrieve-headers-override-function |
21358 | If non-nil, a function that retrieves article headers rather than using | |
21359 | the gnus built-in function. This function takes an article list and | |
21360 | group as arguments and populates the `nntp-server-buffer' with the | |
21361 | retrieved headers. It should then return either 'nov or 'headers | |
21362 | indicating the retrieved header format. Failure to retrieve headers | |
21363 | should return @code{nil} | |
4009494e | 21364 | |
8a1cdce5 AC |
21365 | If this variable is nil, or if the provided function returns nil for a |
21366 | search result, @code{gnus-retrieve-headers} will be called instead." | |
4009494e GM |
21367 | |
21368 | ||
8a1cdce5 | 21369 | @end table |
4009494e | 21370 | |
4009494e | 21371 | |
8a1cdce5 AC |
21372 | @node nnmairix |
21373 | @section nnmairix | |
58333467 | 21374 | |
8a1cdce5 AC |
21375 | @cindex mairix |
21376 | @cindex nnmairix | |
21377 | This paragraph describes how to set up mairix and the back end | |
21378 | @code{nnmairix} for indexing and searching your mail from within | |
21379 | Gnus. Additionally, you can create permanent ``smart'' groups which are | |
21380 | bound to mairix searches and are automatically updated. | |
4009494e | 21381 | |
8a1cdce5 AC |
21382 | @menu |
21383 | * About mairix:: About the mairix mail search engine | |
21384 | * nnmairix requirements:: What you will need for using nnmairix | |
21385 | * What nnmairix does:: What does nnmairix actually do? | |
21386 | * Setting up mairix:: Set up your mairix installation | |
21387 | * Configuring nnmairix:: Set up the nnmairix back end | |
21388 | * nnmairix keyboard shortcuts:: List of available keyboard shortcuts | |
21389 | * Propagating marks:: How to propagate marks from nnmairix groups | |
21390 | * nnmairix tips and tricks:: Some tips, tricks and examples | |
21391 | * nnmairix caveats:: Some more stuff you might want to know | |
21392 | @end menu | |
4009494e | 21393 | |
8a1cdce5 | 21394 | @c FIXME: The markup in this section might need improvement. |
1df7defd | 21395 | @c E.g., adding @samp, @var, @file, @command, etc. |
8a1cdce5 | 21396 | @c Cf. (info "(texinfo)Indicating") |
4009494e | 21397 | |
8a1cdce5 AC |
21398 | @node About mairix |
21399 | @subsection About mairix | |
4009494e | 21400 | |
8a1cdce5 AC |
21401 | Mairix is a tool for indexing and searching words in locally stored |
21402 | mail. It was written by Richard Curnow and is licensed under the | |
1df7defd | 21403 | GPL@. Mairix comes with most popular GNU/Linux distributions, but it also |
8a1cdce5 AC |
21404 | runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can |
21405 | be found at | |
21406 | @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html} | |
4009494e | 21407 | |
8a1cdce5 AC |
21408 | Though mairix might not be as flexible as other search tools like |
21409 | swish++ or namazu, which you can use via the @code{nnir} back end, it | |
21410 | has the prime advantage of being incredibly fast. On current systems, it | |
21411 | can easily search through headers and message bodies of thousands and | |
21412 | thousands of mails in well under a second. Building the database | |
21413 | necessary for searching might take a minute or two, but only has to be | |
21414 | done once fully. Afterwards, the updates are done incrementally and | |
21415 | therefore are really fast, too. Additionally, mairix is very easy to set | |
21416 | up. | |
4009494e | 21417 | |
8a1cdce5 AC |
21418 | For maximum speed though, mairix should be used with mails stored in |
21419 | @code{Maildir} or @code{MH} format (this includes the @code{nnml} back | |
21420 | end), although it also works with mbox. Mairix presents the search | |
21421 | results by populating a @emph{virtual} maildir/MH folder with symlinks | |
21422 | which point to the ``real'' message files (if mbox is used, copies are | |
21423 | made). Since mairix already presents search results in such a virtual | |
21424 | mail folder, it is very well suited for using it as an external program | |
21425 | for creating @emph{smart} mail folders, which represent certain mail | |
21426 | searches. | |
4009494e | 21427 | |
8a1cdce5 AC |
21428 | @node nnmairix requirements |
21429 | @subsection nnmairix requirements | |
4009494e | 21430 | |
8a1cdce5 AC |
21431 | Mairix searches local mail---that means, mairix absolutely must have |
21432 | direct access to your mail folders. If your mail resides on another | |
1df7defd PE |
21433 | server (e.g., an @acronym{IMAP} server) and you happen to have shell |
21434 | access, @code{nnmairix} supports running mairix remotely, e.g., via ssh. | |
4009494e | 21435 | |
8a1cdce5 AC |
21436 | Additionally, @code{nnmairix} only supports the following Gnus back |
21437 | ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use | |
21438 | one of these back ends for using @code{nnmairix}. Other back ends, like | |
21439 | @code{nnmbox}, @code{nnfolder} or @code{nnmh}, won't work. | |
4009494e | 21440 | |
8a1cdce5 AC |
21441 | If you absolutely must use mbox and still want to use @code{nnmairix}, |
21442 | you can set up a local @acronym{IMAP} server, which you then access via | |
21443 | @code{nnimap}. This is a rather massive setup for accessing some mbox | |
21444 | files, so just change to MH or Maildir already... However, if you're | |
21445 | really, really passionate about using mbox, you might want to look into | |
21446 | the package @file{mairix.el}, which comes with Emacs 23. | |
4009494e | 21447 | |
8a1cdce5 AC |
21448 | @node What nnmairix does |
21449 | @subsection What nnmairix does | |
4009494e | 21450 | |
8a1cdce5 AC |
21451 | The back end @code{nnmairix} enables you to call mairix from within Gnus, |
21452 | either to query mairix with a search term or to update the | |
21453 | database. While visiting a message in the summary buffer, you can use | |
1df7defd | 21454 | several pre-defined shortcuts for calling mairix, e.g., to quickly |
8a1cdce5 AC |
21455 | search for all mails from the sender of the current message or to |
21456 | display the whole thread associated with the message, even if the | |
21457 | mails are in different folders. | |
4009494e | 21458 | |
8a1cdce5 AC |
21459 | Additionally, you can create permanent @code{nnmairix} groups which are bound |
21460 | to certain mairix searches. This way, you can easily create a group | |
21461 | containing mails from a certain sender, with a certain subject line or | |
1df7defd PE |
21462 | even for one specific thread based on the Message-ID@. If you check for |
21463 | new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they | |
8a1cdce5 AC |
21464 | automatically update themselves by calling mairix. |
21465 | ||
21466 | You might ask why you need @code{nnmairix} at all, since mairix already | |
21467 | creates the group, populates it with links to the mails so that you can | |
21468 | then access it with Gnus, right? Well, this @emph{might} work, but often | |
21469 | does not---at least not without problems. Most probably you will get | |
21470 | strange article counts, and sometimes you might see mails which Gnus | |
21471 | claims have already been canceled and are inaccessible. This is due to | |
21472 | the fact that Gnus isn't really amused when things are happening behind | |
1df7defd | 21473 | its back. Another problem can be the mail back end itself, e.g., if you |
8a1cdce5 AC |
21474 | use mairix with an @acronym{IMAP} server (I had Dovecot complaining |
21475 | about corrupt index files when mairix changed the contents of the search | |
21476 | group). Using @code{nnmairix} should circumvent these problems. | |
4009494e | 21477 | |
8a1cdce5 AC |
21478 | @code{nnmairix} is not really a mail back end---it's actually more like |
21479 | a wrapper, sitting between a ``real'' mail back end where mairix stores | |
21480 | the searches and the Gnus front end. You can choose between three | |
21481 | different mail back ends for the mairix folders: @code{nnml}, | |
21482 | @code{nnmaildir} or @code{nnimap}. @code{nnmairix} will call the mairix | |
21483 | binary so that the search results are stored in folders named | |
21484 | @code{zz_mairix-<NAME>-<NUMBER>} on this mail back end, but it will | |
21485 | present these folders in the Gnus front end only with @code{<NAME>}. | |
21486 | You can use an existing mail back end where you already store your mail, | |
21487 | but if you're uncomfortable with @code{nnmairix} creating new mail | |
1df7defd | 21488 | groups alongside your other mail, you can also create, e.g., a new |
8a1cdce5 AC |
21489 | @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then |
21490 | make sure those servers do not accidentally receive your new mail | |
21491 | (@pxref{nnmairix caveats}). A special case exists if you want to use | |
21492 | mairix remotely on an IMAP server with @code{nnimap}---here the mairix | |
21493 | folders and your other mail must be on the same @code{nnimap} back end. | |
4009494e | 21494 | |
8a1cdce5 AC |
21495 | @node Setting up mairix |
21496 | @subsection Setting up mairix | |
4009494e | 21497 | |
8a1cdce5 | 21498 | First: create a backup of your mail folders (@pxref{nnmairix caveats}). |
4009494e | 21499 | |
8a1cdce5 AC |
21500 | Setting up mairix is easy: simply create a @file{.mairixrc} file with |
21501 | (at least) the following entries: | |
4009494e | 21502 | |
8a1cdce5 AC |
21503 | @example |
21504 | # Your Maildir/MH base folder | |
21505 | base=~/Maildir | |
21506 | @end example | |
4009494e | 21507 | |
8a1cdce5 AC |
21508 | This is the base folder for your mails. All the following directories |
21509 | are relative to this base folder. If you want to use @code{nnmairix} | |
21510 | with @code{nnimap}, this base directory has to point to the mail | |
21511 | directory where the @acronym{IMAP} server stores the mail folders! | |
4009494e | 21512 | |
8a1cdce5 AC |
21513 | @example |
21514 | maildir= ... your maildir folders which should be indexed ... | |
21515 | mh= ... your nnml/mh folders which should be indexed ... | |
21516 | mbox = ... your mbox files which should be indexed ... | |
21517 | @end example | |
21518 | ||
21519 | This specifies all your mail folders and mbox files (relative to the | |
21520 | base directory!) you want to index with mairix. Note that the | |
21521 | @code{nnml} back end saves mails in MH format, so you have to put those | |
21522 | directories in the @code{mh} line. See the example at the end of this | |
21523 | section and mairixrc's man-page for further details. | |
21524 | ||
21525 | @example | |
21526 | omit=zz_mairix-* | |
21527 | @end example | |
4009494e | 21528 | |
8a1cdce5 AC |
21529 | @vindex nnmairix-group-prefix |
21530 | This should make sure that you don't accidentally index the mairix | |
21531 | search results. You can change the prefix of these folders with the | |
21532 | variable @code{nnmairix-group-prefix}. | |
4009494e | 21533 | |
8a1cdce5 AC |
21534 | @example |
21535 | mformat= ... 'maildir' or 'mh' ... | |
21536 | database= ... location of database file ... | |
21537 | @end example | |
4009494e | 21538 | |
8a1cdce5 AC |
21539 | The @code{format} setting specifies the output format for the mairix |
21540 | search folder. Set this to @code{mh} if you want to access search results | |
21541 | with @code{nnml}. Otherwise choose @code{maildir}. | |
4009494e | 21542 | |
8a1cdce5 | 21543 | To summarize, here is my shortened @file{.mairixrc} file as an example: |
4009494e | 21544 | |
8a1cdce5 AC |
21545 | @example |
21546 | base=~/Maildir | |
21547 | maildir=.personal:.work:.logcheck:.sent | |
21548 | mh=../Mail/nnml/*... | |
21549 | mbox=../mboxmail/mailarchive_year* | |
21550 | mformat=maildir | |
21551 | omit=zz_mairix-* | |
21552 | database=~/.mairixdatabase | |
21553 | @end example | |
4009494e | 21554 | |
8a1cdce5 AC |
21555 | In this case, the base directory is @file{~/Maildir}, where all my Maildir |
21556 | folders are stored. As you can see, the folders are separated by | |
21557 | colons. If you wonder why every folder begins with a dot: this is | |
21558 | because I use Dovecot as @acronym{IMAP} server, which again uses | |
21559 | @code{Maildir++} folders. For testing nnmairix, I also have some | |
21560 | @code{nnml} mail, which is saved in @file{~/Mail/nnml}. Since this has | |
21561 | to be specified relative to the @code{base} directory, the @code{../Mail} | |
21562 | notation is needed. Note that the line ends in @code{*...}, which means | |
21563 | to recursively scan all files under this directory. Without the three | |
21564 | dots, the wildcard @code{*} will not work recursively. I also have some | |
21565 | old mbox files with archived mail lying around in @file{~/mboxmail}. | |
21566 | The other lines should be obvious. | |
4009494e | 21567 | |
8a1cdce5 AC |
21568 | See the man page for @code{mairixrc} for details and further options, |
21569 | especially regarding wildcard usage, which may be a little different | |
21570 | than you are used to. | |
4009494e | 21571 | |
8a1cdce5 AC |
21572 | Now simply call @code{mairix} to create the index for the first time. |
21573 | Note that this may take a few minutes, but every following index will do | |
21574 | the updates incrementally and hence is very fast. | |
4009494e | 21575 | |
8a1cdce5 AC |
21576 | @node Configuring nnmairix |
21577 | @subsection Configuring nnmairix | |
21578 | ||
21579 | In group mode, type @kbd{G b c} | |
21580 | (@code{nnmairix-create-server-and-default-group}). This will ask you for all | |
21581 | necessary information and create a @code{nnmairix} server as a foreign | |
21582 | server. You will have to specify the following: | |
4009494e GM |
21583 | |
21584 | @itemize @bullet | |
21585 | ||
21586 | @item | |
8a1cdce5 AC |
21587 | The @strong{name} of the @code{nnmairix} server---choose whatever you |
21588 | want. | |
4009494e GM |
21589 | |
21590 | @item | |
8a1cdce5 AC |
21591 | The name of the @strong{back end server} where mairix should store its |
21592 | searches. This must be a full server name, like @code{nnml:mymail}. | |
21593 | Just hit @kbd{TAB} to see the available servers. Currently, servers | |
21594 | which are accessed through @code{nnmaildir}, @code{nnimap} and | |
21595 | @code{nnml} are supported. As explained above, for locally stored | |
21596 | mails, this can be an existing server where you store your mails. | |
1df7defd | 21597 | However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml} |
8a1cdce5 AC |
21598 | server exclusively for @code{nnmairix} in your secondary select methods |
21599 | (@pxref{Finding the News}). If you use a secondary @code{nnml} server | |
21600 | just for mairix, make sure that you explicitly set the server variable | |
21601 | @code{nnml-get-new-mail} to @code{nil}, or you might lose mail | |
21602 | (@pxref{nnmairix caveats}). If you want to use mairix remotely on an | |
21603 | @acronym{IMAP} server, you have to choose the corresponding | |
21604 | @code{nnimap} server here. | |
4009494e | 21605 | |
8a1cdce5 AC |
21606 | @item |
21607 | @vindex nnmairix-mairix-search-options | |
21608 | The @strong{command} to call the mairix binary. This will usually just | |
21609 | be @code{mairix}, but you can also choose something like @code{ssh | |
1df7defd | 21610 | SERVER mairix} if you want to call mairix remotely, e.g., on your |
8a1cdce5 AC |
21611 | @acronym{IMAP} server. If you want to add some default options to |
21612 | mairix, you could do this here, but better use the variable | |
21613 | @code{nnmairix-mairix-search-options} instead. | |
4009494e | 21614 | |
8a1cdce5 AC |
21615 | @item |
21616 | The name of the @strong{default search group}. This will be the group | |
1df7defd | 21617 | where all temporary mairix searches are stored, i.e., all searches which |
8a1cdce5 AC |
21618 | are not bound to permanent @code{nnmairix} groups. Choose whatever you |
21619 | like. | |
4009494e | 21620 | |
8a1cdce5 AC |
21621 | @item |
21622 | If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be | |
1df7defd | 21623 | asked if you work with @strong{Maildir++}, i.e., with hidden maildir |
8a1cdce5 AC |
21624 | folders (=beginning with a dot). For example, you have to answer |
21625 | @samp{yes} here if you work with the Dovecot @acronym{IMAP} | |
21626 | server. Otherwise, you should answer @samp{no} here. | |
4009494e | 21627 | |
8a1cdce5 | 21628 | @end itemize |
4009494e | 21629 | |
8a1cdce5 AC |
21630 | @node nnmairix keyboard shortcuts |
21631 | @subsection nnmairix keyboard shortcuts | |
4009494e | 21632 | |
8a1cdce5 | 21633 | In group mode: |
4009494e | 21634 | |
8a1cdce5 | 21635 | @table @kbd |
4009494e | 21636 | |
8a1cdce5 AC |
21637 | @item G b c |
21638 | @kindex G b c (Group) | |
21639 | @findex nnmairix-create-server-and-default-group | |
21640 | Creates @code{nnmairix} server and default search group for this server | |
21641 | (@code{nnmairix-create-server-and-default-group}). You should have done | |
21642 | this by now (@pxref{Configuring nnmairix}). | |
4009494e | 21643 | |
8a1cdce5 AC |
21644 | @item G b s |
21645 | @kindex G b s (Group) | |
21646 | @findex nnmairix-search | |
21647 | Prompts for query which is then sent to the mairix binary. Search | |
21648 | results are put into the default search group which is automatically | |
21649 | displayed (@code{nnmairix-search}). | |
4009494e | 21650 | |
8a1cdce5 AC |
21651 | @item G b m |
21652 | @kindex G b m (Group) | |
21653 | @findex nnmairix-widget-search | |
21654 | Allows you to create a mairix search or a permanent group more | |
21655 | comfortably using graphical widgets, similar to a customization | |
21656 | group. Just try it to see how it works (@code{nnmairix-widget-search}). | |
4009494e | 21657 | |
8a1cdce5 AC |
21658 | @item G b i |
21659 | @kindex G b i (Group) | |
21660 | @findex nnmairix-search-interactive | |
21661 | Another command for creating a mairix query more comfortably, but uses | |
21662 | only the minibuffer (@code{nnmairix-search-interactive}). | |
4009494e | 21663 | |
8a1cdce5 AC |
21664 | @item G b g |
21665 | @kindex G b g (Group) | |
21666 | @findex nnmairix-create-search-group | |
21667 | Creates a permanent group which is associated with a search query | |
21668 | (@code{nnmairix-create-search-group}). The @code{nnmairix} back end | |
21669 | automatically calls mairix when you update this group with @kbd{g} or | |
21670 | @kbd{M-g}. | |
4009494e | 21671 | |
8a1cdce5 AC |
21672 | @item G b q |
21673 | @kindex G b q (Group) | |
21674 | @findex nnmairix-group-change-query-this-group | |
21675 | Changes the search query for the @code{nnmairix} group under cursor | |
21676 | (@code{nnmairix-group-change-query-this-group}). | |
4009494e | 21677 | |
8a1cdce5 AC |
21678 | @item G b t |
21679 | @kindex G b t (Group) | |
21680 | @findex nnmairix-group-toggle-threads-this-group | |
21681 | Toggles the 'threads' parameter for the @code{nnmairix} group under cursor, | |
1df7defd | 21682 | i.e., if you want see the whole threads of the found messages |
8a1cdce5 | 21683 | (@code{nnmairix-group-toggle-threads-this-group}). |
4009494e | 21684 | |
8a1cdce5 AC |
21685 | @item G b u |
21686 | @kindex G b u (Group) | |
21687 | @findex nnmairix-update-database | |
21688 | @vindex nnmairix-mairix-update-options | |
21689 | Calls mairix binary for updating the database | |
21690 | (@code{nnmairix-update-database}). The default parameters are @code{-F} | |
21691 | and @code{-Q} for making this as fast as possible (see variable | |
21692 | @code{nnmairix-mairix-update-options} for defining these default | |
21693 | options). | |
4009494e | 21694 | |
8a1cdce5 AC |
21695 | @item G b r |
21696 | @kindex G b r (Group) | |
21697 | @findex nnmairix-group-toggle-readmarks-this-group | |
21698 | Keep articles in this @code{nnmairix} group always read or unread, or leave the | |
21699 | marks unchanged (@code{nnmairix-group-toggle-readmarks-this-group}). | |
4009494e | 21700 | |
8a1cdce5 AC |
21701 | @item G b d |
21702 | @kindex G b d (Group) | |
21703 | @findex nnmairix-group-delete-recreate-this-group | |
21704 | Recreate @code{nnmairix} group on the ``real'' mail back end | |
21705 | (@code{nnmairix-group-delete-recreate-this-group}). You can do this if | |
21706 | you always get wrong article counts with a @code{nnmairix} group. | |
4009494e | 21707 | |
8a1cdce5 AC |
21708 | @item G b a |
21709 | @kindex G b a (Group) | |
21710 | @findex nnmairix-group-toggle-allowfast-this-group | |
21711 | Toggles the @code{allow-fast} parameters for group under cursor | |
21712 | (@code{nnmairix-group-toggle-allowfast-this-group}). The default | |
21713 | behavior of @code{nnmairix} is to do a mairix search every time you | |
21714 | update or enter the group. With the @code{allow-fast} parameter set, | |
21715 | mairix will only be called when you explicitly update the group, but not | |
21716 | upon entering. This makes entering the group faster, but it may also | |
21717 | lead to dangling symlinks if something changed between updating and | |
21718 | entering the group which is not yet in the mairix database. | |
4009494e | 21719 | |
8a1cdce5 AC |
21720 | @item G b p |
21721 | @kindex G b p (Group) | |
21722 | @findex nnmairix-group-toggle-propmarks-this-group | |
21723 | Toggle marks propagation for this group | |
21724 | (@code{nnmairix-group-toggle-propmarks-this-group}). (@pxref{Propagating | |
21725 | marks}). | |
4009494e | 21726 | |
8a1cdce5 AC |
21727 | @item G b o |
21728 | @kindex G b o (Group) | |
21729 | @findex nnmairix-propagate-marks | |
21730 | Manually propagate marks (@code{nnmairix-propagate-marks}); needed only when | |
21731 | @code{nnmairix-propagate-marks-upon-close} is set to @code{nil}. | |
4009494e GM |
21732 | |
21733 | @end table | |
21734 | ||
8a1cdce5 | 21735 | In summary mode: |
4009494e | 21736 | |
8a1cdce5 | 21737 | @table @kbd |
4009494e | 21738 | |
8a1cdce5 AC |
21739 | @item $ m |
21740 | @kindex $ m (Summary) | |
21741 | @findex nnmairix-widget-search-from-this-article | |
21742 | Allows you to create a mairix query or group based on the current | |
21743 | message using graphical widgets (same as @code{nnmairix-widget-search}) | |
21744 | (@code{nnmairix-widget-search-from-this-article}). | |
4009494e | 21745 | |
8a1cdce5 AC |
21746 | @item $ g |
21747 | @kindex $ g (Summary) | |
21748 | @findex nnmairix-create-search-group-from-message | |
21749 | Interactively creates a new search group with query based on the current | |
21750 | message, but uses the minibuffer instead of graphical widgets | |
21751 | (@code{nnmairix-create-search-group-from-message}). | |
4009494e | 21752 | |
8a1cdce5 AC |
21753 | @item $ t |
21754 | @kindex $ t (Summary) | |
21755 | @findex nnmairix-search-thread-this-article | |
21756 | Searches thread for the current article | |
21757 | (@code{nnmairix-search-thread-this-article}). This is effectively a | |
21758 | shortcut for calling @code{nnmairix-search} with @samp{m:msgid} of the | |
21759 | current article and enabled threads. | |
4009494e | 21760 | |
8a1cdce5 AC |
21761 | @item $ f |
21762 | @kindex $ f (Summary) | |
21763 | @findex nnmairix-search-from-this-article | |
21764 | Searches all messages from sender of the current article | |
21765 | (@code{nnmairix-search-from-this-article}). This is a shortcut for | |
21766 | calling @code{nnmairix-search} with @samp{f:From}. | |
4009494e | 21767 | |
8a1cdce5 AC |
21768 | @item $ o |
21769 | @kindex $ o (Summary) | |
21770 | @findex nnmairix-goto-original-article | |
21771 | (Only in @code{nnmairix} groups!) Tries determine the group this article | |
1df7defd PE |
21772 | originally came from and displays the article in this group, so that, |
21773 | e.g., replying to this article the correct posting styles/group | |
8a1cdce5 AC |
21774 | parameters are applied (@code{nnmairix-goto-original-article}). This |
21775 | function will use the registry if available, but can also parse the | |
21776 | article file name as a fallback method. | |
4009494e | 21777 | |
8a1cdce5 AC |
21778 | @item $ u |
21779 | @kindex $ u (Summary) | |
21780 | @findex nnmairix-remove-tick-mark-original-article | |
21781 | Remove possibly existing tick mark from original article | |
21782 | (@code{nnmairix-remove-tick-mark-original-article}). (@pxref{nnmairix | |
21783 | tips and tricks}). | |
4009494e | 21784 | |
8a1cdce5 | 21785 | @end table |
4009494e | 21786 | |
8a1cdce5 AC |
21787 | @node Propagating marks |
21788 | @subsection Propagating marks | |
4009494e | 21789 | |
8a1cdce5 AC |
21790 | First of: you really need a patched mairix binary for using the marks |
21791 | propagation feature efficiently. Otherwise, you would have to update | |
21792 | the mairix database all the time. You can get the patch at | |
4009494e | 21793 | |
8a1cdce5 | 21794 | @uref{http://www.randomsample.de/mairix-maildir-patch.tar} |
4009494e | 21795 | |
8a1cdce5 AC |
21796 | You need the mairix v0.21 source code for this patch; everything else |
21797 | is explained in the accompanied readme file. If you don't want to use | |
21798 | marks propagation, you don't have to apply these patches, but they also | |
21799 | fix some annoyances regarding changing maildir flags, so it might still | |
21800 | be useful to you. | |
4009494e | 21801 | |
8a1cdce5 AC |
21802 | With the patched mairix binary, you can use @code{nnmairix} as an |
21803 | alternative to mail splitting (@pxref{Fancy Mail Splitting}). For | |
21804 | example, instead of splitting all mails from @samp{david@@foobar.com} | |
21805 | into a group, you can simply create a search group with the query | |
21806 | @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are | |
21807 | all about: simply put everything in one mail folder and dynamically | |
21808 | create searches instead of splitting. This is more flexible, since you | |
21809 | can dynamically change your folders any time you want to. This also | |
21810 | implies that you will usually read your mails in the @code{nnmairix} | |
21811 | groups instead of your ``real'' mail groups. | |
4009494e | 21812 | |
8a1cdce5 AC |
21813 | There is one problem, though: say you got a new mail from |
21814 | @samp{david@@foobar.com}; it will now show up in two groups, the | |
21815 | ``real'' group (your INBOX, for example) and in the @code{nnmairix} | |
21816 | search group (provided you have updated the mairix database). Now you | |
21817 | enter the @code{nnmairix} group and read the mail. The mail will be | |
21818 | marked as read, but only in the @code{nnmairix} group---in the ``real'' | |
21819 | mail group it will be still shown as unread. | |
4009494e | 21820 | |
8a1cdce5 AC |
21821 | You could now catch up the mail group (@pxref{Group Data}), but this is |
21822 | tedious and error prone, since you may overlook mails you don't have | |
21823 | created @code{nnmairix} groups for. Of course, you could first use | |
21824 | @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard | |
21825 | shortcuts}) and then read the mail in the original group, but that's | |
21826 | even more cumbersome. | |
4009494e | 21827 | |
8a1cdce5 AC |
21828 | Clearly, the easiest way would be if marks could somehow be |
21829 | automatically set for the original article. This is exactly what | |
21830 | @emph{marks propagation} is about. | |
4009494e | 21831 | |
e9a452d9 | 21832 | Marks propagation is inactive by default. You can activate it for a |
8a1cdce5 AC |
21833 | certain @code{nnmairix} group with |
21834 | @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b | |
21835 | p}). This function will warn you if you try to use it with your default | |
21836 | search group; the reason is that the default search group is used for | |
21837 | temporary searches, and it's easy to accidentally propagate marks from | |
21838 | this group. However, you can ignore this warning if you really want to. | |
4009494e | 21839 | |
8a1cdce5 AC |
21840 | With marks propagation enabled, all the marks you set in a @code{nnmairix} |
21841 | group should now be propagated to the original article. For example, | |
21842 | you can now tick an article (by default with @kbd{!}) and this mark should | |
21843 | magically be set for the original article, too. | |
4009494e | 21844 | |
8a1cdce5 | 21845 | A few more remarks which you may or may not want to know: |
4009494e | 21846 | |
8a1cdce5 AC |
21847 | @vindex nnmairix-propagate-marks-upon-close |
21848 | Marks will not be set immediately, but only upon closing a group. This | |
21849 | not only makes marks propagation faster, it also avoids problems with | |
21850 | dangling symlinks when dealing with maildir files (since changing flags | |
21851 | will change the file name). You can also control when to propagate marks | |
21852 | via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for | |
21853 | details). | |
4009494e | 21854 | |
8a1cdce5 AC |
21855 | Obviously, @code{nnmairix} will have to look up the original group for every |
21856 | article you want to set marks for. If available, @code{nnmairix} will first use | |
21857 | the registry for determining the original group. The registry is very | |
21858 | fast, hence you should really, really enable the registry when using | |
21859 | marks propagation. If you don't have to worry about RAM and disc space, | |
21860 | set @code{gnus-registry-max-entries} to a large enough value; to be on | |
21861 | the safe side, choose roughly the amount of mails you index with mairix. | |
4009494e | 21862 | |
8a1cdce5 AC |
21863 | @vindex nnmairix-only-use-registry |
21864 | If you don't want to use the registry or the registry hasn't seen the | |
21865 | original article yet, @code{nnmairix} will use an additional mairix | |
21866 | search for determining the file name of the article. This, of course, is | |
21867 | way slower than the registry---if you set hundreds or even thousands of | |
21868 | marks this way, it might take some time. You can avoid this situation by | |
21869 | setting @code{nnmairix-only-use-registry} to t. | |
4009494e | 21870 | |
1df7defd | 21871 | Maybe you also want to propagate marks the other way round, i.e., if you |
8a1cdce5 AC |
21872 | tick an article in a "real" mail group, you'd like to have the same |
21873 | article in a @code{nnmairix} group ticked, too. For several good | |
21874 | reasons, this can only be done efficiently if you use maildir. To | |
21875 | immediately contradict myself, let me mention that it WON'T work with | |
21876 | @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and | |
21877 | not in the file name. Therefore, propagating marks to @code{nnmairix} | |
21878 | groups will usually only work if you use an IMAP server which uses | |
21879 | maildir as its file format. | |
4009494e | 21880 | |
8a1cdce5 AC |
21881 | @vindex nnmairix-propagate-marks-to-nnmairix-groups |
21882 | If you work with this setup, just set | |
21883 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what | |
21884 | happens. If you don't like what you see, just set it to @code{nil} again. One | |
21885 | problem might be that you get a wrong number of unread articles; this | |
21886 | usually happens when you delete or expire articles in the original | |
21887 | groups. When this happens, you can recreate the @code{nnmairix} group on the | |
21888 | back end using @kbd{G b d}. | |
4009494e | 21889 | |
8a1cdce5 AC |
21890 | @node nnmairix tips and tricks |
21891 | @subsection nnmairix tips and tricks | |
21892 | ||
21893 | @itemize | |
21894 | @item | |
21895 | Checking Mail | |
4009494e | 21896 | |
8a1cdce5 AC |
21897 | @findex nnmairix-update-groups |
21898 | I put all my important mail groups at group level 1. The mairix groups | |
21899 | have group level 5, so they do not get checked at start up (@pxref{Group | |
21900 | Levels}). | |
4009494e | 21901 | |
8a1cdce5 | 21902 | I use the following to check for mails: |
4009494e | 21903 | |
8a1cdce5 AC |
21904 | @lisp |
21905 | (defun my-check-mail-mairix-update (level) | |
21906 | (interactive "P") | |
21907 | ;; if no prefix given, set level=1 | |
21908 | (gnus-group-get-new-news (or level 1)) | |
21909 | (nnmairix-update-groups "mairixsearch" t t) | |
21910 | (gnus-group-list-groups)) | |
4009494e | 21911 | |
8a1cdce5 AC |
21912 | (define-key gnus-group-mode-map "g" 'my-check-mail-mairix-update) |
21913 | @end lisp | |
4009494e | 21914 | |
8a1cdce5 AC |
21915 | Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix} |
21916 | server. See the doc string for @code{nnmairix-update-groups} for | |
21917 | details. | |
4009494e | 21918 | |
8a1cdce5 AC |
21919 | @item |
21920 | Example: search group for ticked articles | |
4009494e | 21921 | |
8a1cdce5 AC |
21922 | For example, you can create a group for all ticked articles, where the |
21923 | articles always stay unread: | |
4009494e | 21924 | |
1df7defd | 21925 | Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use |
8a1cdce5 | 21926 | @samp{F:f} as query and do not include threads. |
4009494e | 21927 | |
8a1cdce5 AC |
21928 | Now activate marks propagation for this group by using @kbd{G b p}. Then |
21929 | activate the always-unread feature by using @kbd{G b r} twice. | |
4009494e | 21930 | |
8a1cdce5 AC |
21931 | So far so good---but how do you remove the tick marks in the @code{nnmairix} |
21932 | group? There are two options: You may simply use | |
21933 | @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove | |
21934 | tick marks from the original article. The other possibility is to set | |
21935 | @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above | |
21936 | comments about this option. If it works for you, the tick marks should | |
21937 | also exist in the @code{nnmairix} group and you can remove them as usual, | |
1df7defd | 21938 | e.g., by marking an article as read. |
4009494e | 21939 | |
8a1cdce5 AC |
21940 | When you have removed a tick mark from the original article, this |
21941 | article should vanish from the @code{nnmairix} group after you have updated the | |
21942 | mairix database and updated the group. Fortunately, there is a function | |
21943 | for doing exactly that: @code{nnmairix-update-groups}. See the previous code | |
21944 | snippet and the doc string for details. | |
4009494e | 21945 | |
8a1cdce5 AC |
21946 | @item |
21947 | Dealing with auto-subscription of mail groups | |
4009494e | 21948 | |
8a1cdce5 AC |
21949 | As described before, all @code{nnmairix} groups are in fact stored on |
21950 | the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can | |
21951 | see them when you enter the back end server in the server buffer. You | |
21952 | should not subscribe these groups! Unfortunately, these groups will | |
21953 | usually get @emph{auto-subscribed} when you use @code{nnmaildir} or | |
1df7defd | 21954 | @code{nnml}, i.e., you will suddenly see groups of the form |
8a1cdce5 AC |
21955 | @samp{zz_mairix*} pop up in your group buffer. If this happens to you, |
21956 | simply kill these groups with C-k. For avoiding this, turn off | |
21957 | auto-subscription completely by setting the variable | |
21958 | @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New | |
21959 | Groups}), or if you like to keep this feature use the following kludge | |
21960 | for turning it off for all groups beginning with @samp{zz_}: | |
4009494e | 21961 | |
8a1cdce5 AC |
21962 | @lisp |
21963 | (setq gnus-auto-subscribed-groups | |
21964 | "^\\(nnml\\|nnfolder\\|nnmbox\\|nnmh\\|nnbabyl\\|nnmaildir\\).*:\\([^z]\\|z$\\|\\z[^z]\\|zz$\\|zz[^_]\\|zz_$\\).*") | |
21965 | @end lisp | |
4009494e | 21966 | |
8a1cdce5 | 21967 | @end itemize |
4009494e | 21968 | |
8a1cdce5 AC |
21969 | @node nnmairix caveats |
21970 | @subsection nnmairix caveats | |
4009494e | 21971 | |
8a1cdce5 AC |
21972 | @itemize |
21973 | @item | |
21974 | You can create a secondary @code{nnml} server just for nnmairix, but then | |
21975 | you have to explicitly set the corresponding server variable | |
21976 | @code{nnml-get-new-mail} to @code{nil}. Otherwise, new mail might get | |
21977 | put into this secondary server (and would never show up again). Here's | |
21978 | an example server definition: | |
4009494e | 21979 | |
8a1cdce5 AC |
21980 | @lisp |
21981 | (nnml "mairix" (nnml-directory "mairix") (nnml-get-new-mail nil)) | |
21982 | @end lisp | |
4009494e | 21983 | |
ee7683eb | 21984 | (The @code{nnmaildir} back end also has a server variable |
8a1cdce5 AC |
21985 | @code{get-new-mail}, but its default value is @code{nil}, so you don't |
21986 | have to explicitly set it if you use a @code{nnmaildir} server just for | |
21987 | mairix.) | |
4009494e | 21988 | |
8a1cdce5 AC |
21989 | @item |
21990 | If you use the Gnus registry: don't use the registry with | |
21991 | @code{nnmairix} groups (put them in | |
c3c65d73 TZ |
21992 | @code{gnus-registry-unfollowed-groups}; this is the default). Be |
21993 | @emph{extra careful} if you use | |
21994 | @code{gnus-registry-split-fancy-with-parent}; mails which are split | |
21995 | into @code{nnmairix} groups are usually gone for good as soon as you | |
21996 | check the group for new mail (yes, it has happened to me...). | |
4009494e | 21997 | |
8a1cdce5 AC |
21998 | @item |
21999 | Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix} | |
22000 | groups (you shouldn't be able to, anyway). | |
4009494e | 22001 | |
8a1cdce5 AC |
22002 | @item |
22003 | If you use the Gnus agent (@pxref{Gnus Unplugged}): don't agentize | |
22004 | @code{nnmairix} groups (though I have no idea what happens if you do). | |
4009494e | 22005 | |
8a1cdce5 AC |
22006 | @item |
22007 | mairix does only support us-ascii characters. | |
4009494e | 22008 | |
8a1cdce5 AC |
22009 | @item |
22010 | @code{nnmairix} uses a rather brute force method to force Gnus to | |
22011 | completely reread the group on the mail back end after mairix was | |
22012 | called---it simply deletes and re-creates the group on the mail | |
22013 | back end. So far, this has worked for me without any problems, and I | |
22014 | don't see how @code{nnmairix} could delete other mail groups than its | |
22015 | own, but anyway: you really should have a backup of your mail | |
22016 | folders. | |
4009494e | 22017 | |
4009494e | 22018 | @item |
8a1cdce5 AC |
22019 | All necessary information is stored in the group parameters |
22020 | (@pxref{Group Parameters}). This has the advantage that no active file | |
22021 | is needed, but also implies that when you kill a @code{nnmairix} group, | |
22022 | it is gone for good. | |
4009494e GM |
22023 | |
22024 | @item | |
8a1cdce5 AC |
22025 | @findex nnmairix-purge-old-groups |
22026 | If you create and kill a lot of @code{nnmairix} groups, the | |
22027 | ``zz_mairix-*'' groups will accumulate on the mail back end server. To | |
22028 | delete old groups which are no longer needed, call | |
22029 | @code{nnmairix-purge-old-groups}. Note that this assumes that you don't | |
22030 | save any ``real'' mail in folders of the form | |
22031 | @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of | |
22032 | @code{nnmairix} groups by changing the variable | |
22033 | @code{nnmairix-group-prefix}. | |
4009494e GM |
22034 | |
22035 | @item | |
8a1cdce5 AC |
22036 | The following only applies if you @emph{don't} use the mentioned patch |
22037 | for mairix (@pxref{Propagating marks}): | |
4009494e | 22038 | |
8a1cdce5 AC |
22039 | A problem can occur when using @code{nnmairix} with maildir folders and |
22040 | comes with the fact that maildir stores mail flags like @samp{Seen} or | |
22041 | @samp{Replied} by appending chars @samp{S} and @samp{R} to the message | |
22042 | file name, respectively. This implies that currently you would have to | |
22043 | update the mairix database not only when new mail arrives, but also when | |
22044 | mail flags are changing. The same applies to new mails which are indexed | |
22045 | while they are still in the @samp{new} folder but then get moved to | |
22046 | @samp{cur} when Gnus has seen the mail. If you don't update the database | |
22047 | after this has happened, a mairix query can lead to symlinks pointing to | |
22048 | non-existing files. In Gnus, these messages will usually appear with | |
22049 | ``(none)'' entries in the header and can't be accessed. If this happens | |
22050 | to you, using @kbd{G b u} and updating the group will usually fix this. | |
4009494e | 22051 | |
8a1cdce5 | 22052 | @end itemize |
4009494e GM |
22053 | |
22054 | @iftex | |
22055 | @iflatex | |
22056 | @chapter Message | |
22057 | @include message.texi | |
22058 | @chapter Emacs MIME | |
22059 | @include emacs-mime.texi | |
22060 | @chapter Sieve | |
22061 | @include sieve.texi | |
3d439cd1 CY |
22062 | @chapter EasyPG |
22063 | @include epa.texi | |
01c52d31 MB |
22064 | @chapter SASL |
22065 | @include sasl.texi | |
4009494e GM |
22066 | @end iflatex |
22067 | @end iftex | |
22068 | ||
22069 | @node Various | |
22070 | @chapter Various | |
22071 | ||
22072 | @menu | |
22073 | * Process/Prefix:: A convention used by many treatment commands. | |
22074 | * Interactive:: Making Gnus ask you many questions. | |
22075 | * Symbolic Prefixes:: How to supply some Gnus functions with options. | |
22076 | * Formatting Variables:: You can specify what buffers should look like. | |
22077 | * Window Layout:: Configuring the Gnus buffer windows. | |
22078 | * Faces and Fonts:: How to change how faces look. | |
4009494e GM |
22079 | * Mode Lines:: Displaying information in the mode lines. |
22080 | * Highlighting and Menus:: Making buffers look all nice and cozy. | |
4009494e | 22081 | * Daemons:: Gnus can do things behind your back. |
4009494e GM |
22082 | * Undo:: Some actions can be undone. |
22083 | * Predicate Specifiers:: Specifying predicates. | |
22084 | * Moderation:: What to do if you're a moderator. | |
22085 | * Fetching a Group:: Starting Gnus just to read a group. | |
22086 | * Image Enhancements:: Modern versions of Emacs/XEmacs can display images. | |
22087 | * Fuzzy Matching:: What's the big fuzz? | |
22088 | * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email. | |
22089 | * Spam Package:: A package for filtering and processing spam. | |
64763fe3 | 22090 | * The Gnus Registry:: A package for tracking messages by Message-ID. |
4009494e GM |
22091 | * Other modes:: Interaction with other modes. |
22092 | * Various Various:: Things that are really various. | |
22093 | @end menu | |
22094 | ||
22095 | ||
22096 | @node Process/Prefix | |
22097 | @section Process/Prefix | |
22098 | @cindex process/prefix convention | |
22099 | ||
22100 | Many functions, among them functions for moving, decoding and saving | |
22101 | articles, use what is known as the @dfn{Process/Prefix convention}. | |
22102 | ||
22103 | This is a method for figuring out what articles the user wants the | |
22104 | command to be performed on. | |
22105 | ||
22106 | It goes like this: | |
22107 | ||
22108 | If the numeric prefix is N, perform the operation on the next N | |
22109 | articles, starting with the current one. If the numeric prefix is | |
22110 | negative, perform the operation on the previous N articles, starting | |
22111 | with the current one. | |
22112 | ||
22113 | @vindex transient-mark-mode | |
22114 | If @code{transient-mark-mode} in non-@code{nil} and the region is | |
22115 | active, all articles in the region will be worked upon. | |
22116 | ||
22117 | If there is no numeric prefix, but some articles are marked with the | |
22118 | process mark, perform the operation on the articles marked with | |
22119 | the process mark. | |
22120 | ||
22121 | If there is neither a numeric prefix nor any articles marked with the | |
22122 | process mark, just perform the operation on the current article. | |
22123 | ||
22124 | Quite simple, really, but it needs to be made clear so that surprises | |
22125 | are avoided. | |
22126 | ||
22127 | Commands that react to the process mark will push the current list of | |
22128 | process marked articles onto a stack and will then clear all process | |
22129 | marked articles. You can restore the previous configuration with the | |
22130 | @kbd{M P y} command (@pxref{Setting Process Marks}). | |
22131 | ||
22132 | @vindex gnus-summary-goto-unread | |
22133 | One thing that seems to shock & horrify lots of people is that, for | |
22134 | instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}. | |
22135 | Since each @kbd{d} (which marks the current article as read) by default | |
22136 | goes to the next unread article after marking, this means that @kbd{3 d} | |
22137 | will mark the next three unread articles as read, no matter what the | |
22138 | summary buffer looks like. Set @code{gnus-summary-goto-unread} to | |
22139 | @code{nil} for a more straightforward action. | |
22140 | ||
22141 | Many commands do not use the process/prefix convention. All commands | |
22142 | that do explicitly say so in this manual. To apply the process/prefix | |
22143 | convention to commands that do not use it, you can use the @kbd{M-&} | |
22144 | command. For instance, to mark all the articles in the group as | |
22145 | expirable, you could say @kbd{M P b M-& E}. | |
22146 | ||
22147 | ||
22148 | @node Interactive | |
22149 | @section Interactive | |
22150 | @cindex interaction | |
22151 | ||
22152 | @table @code | |
22153 | ||
22154 | @item gnus-novice-user | |
22155 | @vindex gnus-novice-user | |
22156 | If this variable is non-@code{nil}, you are either a newcomer to the | |
22157 | World of Usenet, or you are very cautious, which is a nice thing to be, | |
22158 | really. You will be given questions of the type ``Are you sure you want | |
22159 | to do this?'' before doing anything dangerous. This is @code{t} by | |
22160 | default. | |
22161 | ||
22162 | @item gnus-expert-user | |
22163 | @vindex gnus-expert-user | |
22164 | If this variable is non-@code{nil}, you will seldom be asked any | |
5e7d4a75 KY |
22165 | questions by Gnus. It will simply assume you know what you're doing, |
22166 | no matter how strange. For example, quitting Gnus, exiting a group | |
22167 | without an update, catching up with a group, deleting expired | |
22168 | articles, and replying by mail to a news message will not require | |
22169 | confirmation. | |
4009494e GM |
22170 | |
22171 | @item gnus-interactive-catchup | |
22172 | @vindex gnus-interactive-catchup | |
22173 | Require confirmation before catching up a group if non-@code{nil}. It | |
22174 | is @code{t} by default. | |
22175 | ||
22176 | @item gnus-interactive-exit | |
22177 | @vindex gnus-interactive-exit | |
e21bac42 G |
22178 | If non-@code{nil}, require a confirmation when exiting Gnus. If |
22179 | @code{quiet}, update any active summary buffers automatically without | |
22180 | querying. The default value is @code{t}. | |
4009494e GM |
22181 | @end table |
22182 | ||
22183 | ||
22184 | @node Symbolic Prefixes | |
22185 | @section Symbolic Prefixes | |
22186 | @cindex symbolic prefixes | |
22187 | ||
22188 | Quite a lot of Emacs commands react to the (numeric) prefix. For | |
22189 | instance, @kbd{C-u 4 C-f} moves point four characters forward, and | |
22190 | @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score | |
22191 | rule of 900 to the current article. | |
22192 | ||
22193 | This is all nice and well, but what if you want to give a command some | |
22194 | additional information? Well, what most commands do is interpret the | |
22195 | ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one | |
22196 | doesn't want a backup file to be created when saving the current buffer, | |
22197 | for instance. But what if you want to save without making a backup | |
22198 | file, and you want Emacs to flash lights and play a nice tune at the | |
22199 | same time? You can't, and you're probably perfectly happy that way. | |
22200 | ||
22201 | @kindex M-i (Summary) | |
22202 | @findex gnus-symbolic-argument | |
22203 | I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The | |
22204 | prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next | |
22205 | character typed in is the value. You can stack as many @kbd{M-i} | |
22206 | prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u} | |
22207 | command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means | |
22208 | ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and | |
22209 | @code{b}''. You get the drift. | |
22210 | ||
22211 | Typing in symbolic prefixes to commands that don't accept them doesn't | |
22212 | hurt, but it doesn't do any good either. Currently not many Gnus | |
22213 | functions make use of the symbolic prefix. | |
22214 | ||
22215 | If you're interested in how Gnus implements this, @pxref{Extended | |
22216 | Interactive}. | |
22217 | ||
22218 | ||
22219 | @node Formatting Variables | |
22220 | @section Formatting Variables | |
22221 | @cindex formatting variables | |
22222 | ||
22223 | Throughout this manual you've probably noticed lots of variables called | |
22224 | things like @code{gnus-group-line-format} and | |
22225 | @code{gnus-summary-mode-line-format}. These control how Gnus is to | |
22226 | output lines in the various buffers. There's quite a lot of them. | |
22227 | Fortunately, they all use the same syntax, so there's not that much to | |
22228 | be annoyed by. | |
22229 | ||
22230 | Here's an example format spec (from the group buffer): @samp{%M%S%5y: | |
22231 | %(%g%)\n}. We see that it is indeed extremely ugly, and that there are | |
22232 | lots of percentages everywhere. | |
22233 | ||
22234 | @menu | |
22235 | * Formatting Basics:: A formatting variable is basically a format string. | |
22236 | * Mode Line Formatting:: Some rules about mode line formatting variables. | |
22237 | * Advanced Formatting:: Modifying output in various ways. | |
22238 | * User-Defined Specs:: Having Gnus call your own functions. | |
22239 | * Formatting Fonts:: Making the formatting look colorful and nice. | |
22240 | * Positioning Point:: Moving point to a position after an operation. | |
22241 | * Tabulation:: Tabulating your output. | |
22242 | * Wide Characters:: Dealing with wide characters. | |
22243 | @end menu | |
22244 | ||
22245 | Currently Gnus uses the following formatting variables: | |
22246 | @code{gnus-group-line-format}, @code{gnus-summary-line-format}, | |
22247 | @code{gnus-server-line-format}, @code{gnus-topic-line-format}, | |
22248 | @code{gnus-group-mode-line-format}, | |
22249 | @code{gnus-summary-mode-line-format}, | |
22250 | @code{gnus-article-mode-line-format}, | |
22251 | @code{gnus-server-mode-line-format}, and | |
22252 | @code{gnus-summary-pick-line-format}. | |
22253 | ||
22254 | All these format variables can also be arbitrary elisp forms. In that | |
22255 | case, they will be @code{eval}ed to insert the required lines. | |
22256 | ||
22257 | @kindex M-x gnus-update-format | |
22258 | @findex gnus-update-format | |
22259 | Gnus includes a command to help you while creating your own format | |
22260 | specs. @kbd{M-x gnus-update-format} will @code{eval} the current form, | |
22261 | update the spec in question and pop you to a buffer where you can | |
22262 | examine the resulting Lisp code to be run to generate the line. | |
22263 | ||
22264 | ||
22265 | ||
22266 | @node Formatting Basics | |
22267 | @subsection Formatting Basics | |
22268 | ||
22269 | Each @samp{%} element will be replaced by some string or other when the | |
22270 | buffer in question is generated. @samp{%5y} means ``insert the @samp{y} | |
22271 | spec, and pad with spaces to get a 5-character field''. | |
22272 | ||
22273 | As with normal C and Emacs Lisp formatting strings, the numerical | |
22274 | modifier between the @samp{%} and the formatting type character will | |
22275 | @dfn{pad} the output so that it is always at least that long. | |
22276 | @samp{%5y} will make the field always (at least) five characters wide by | |
22277 | padding with spaces to the left. If you say @samp{%-5y}, it will pad to | |
22278 | the right instead. | |
22279 | ||
22280 | You may also wish to limit the length of the field to protect against | |
22281 | particularly wide values. For that you can say @samp{%4,6y}, which | |
22282 | means that the field will never be more than 6 characters wide and never | |
22283 | less than 4 characters wide. | |
22284 | ||
22285 | Also Gnus supports some extended format specifications, such as | |
22286 | @samp{%&user-date;}. | |
22287 | ||
22288 | ||
22289 | @node Mode Line Formatting | |
22290 | @subsection Mode Line Formatting | |
22291 | ||
22292 | Mode line formatting variables (e.g., | |
22293 | @code{gnus-summary-mode-line-format}) follow the same rules as other, | |
22294 | buffer line oriented formatting variables (@pxref{Formatting Basics}) | |
22295 | with the following two differences: | |
22296 | ||
22297 | @enumerate | |
22298 | ||
22299 | @item | |
22300 | There must be no newline (@samp{\n}) at the end. | |
22301 | ||
22302 | @item | |
22303 | The special @samp{%%b} spec can be used to display the buffer name. | |
22304 | Well, it's no spec at all, really---@samp{%%} is just a way to quote | |
22305 | @samp{%} to allow it to pass through the formatting machinery unmangled, | |
22306 | so that Emacs receives @samp{%b}, which is something the Emacs mode line | |
22307 | display interprets to mean ``show the buffer name''. For a full list of | |
22308 | mode line specs Emacs understands, see the documentation of the | |
22309 | @code{mode-line-format} variable. | |
22310 | ||
22311 | @end enumerate | |
22312 | ||
22313 | ||
22314 | @node Advanced Formatting | |
22315 | @subsection Advanced Formatting | |
22316 | ||
22317 | It is frequently useful to post-process the fields in some way. | |
22318 | Padding, limiting, cutting off parts and suppressing certain values can | |
22319 | be achieved by using @dfn{tilde modifiers}. A typical tilde spec might | |
22320 | look like @samp{%~(cut 3)~(ignore "0")y}. | |
22321 | ||
22322 | These are the valid modifiers: | |
22323 | ||
22324 | @table @code | |
22325 | @item pad | |
22326 | @itemx pad-left | |
22327 | Pad the field to the left with spaces until it reaches the required | |
22328 | length. | |
22329 | ||
22330 | @item pad-right | |
22331 | Pad the field to the right with spaces until it reaches the required | |
22332 | length. | |
22333 | ||
22334 | @item max | |
22335 | @itemx max-left | |
22336 | Cut off characters from the left until it reaches the specified length. | |
22337 | ||
22338 | @item max-right | |
22339 | Cut off characters from the right until it reaches the specified | |
22340 | length. | |
22341 | ||
22342 | @item cut | |
22343 | @itemx cut-left | |
22344 | Cut off the specified number of characters from the left. | |
22345 | ||
22346 | @item cut-right | |
22347 | Cut off the specified number of characters from the right. | |
22348 | ||
22349 | @item ignore | |
22350 | Return an empty string if the field is equal to the specified value. | |
22351 | ||
22352 | @item form | |
22353 | Use the specified form as the field value when the @samp{@@} spec is | |
22354 | used. | |
22355 | ||
22356 | Here's an example: | |
22357 | ||
22358 | @lisp | |
22359 | "~(form (current-time-string))@@" | |
22360 | @end lisp | |
22361 | ||
22362 | @end table | |
22363 | ||
22364 | Let's take an example. The @samp{%o} spec in the summary mode lines | |
22365 | will return a date in compact ISO8601 format---@samp{19960809T230410}. | |
22366 | This is quite a mouthful, so we want to shave off the century number and | |
22367 | the time, leaving us with a six-character date. That would be | |
22368 | @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before | |
22369 | maxing, and we need the padding to ensure that the date is never less | |
22370 | than 6 characters to make it look nice in columns.) | |
22371 | ||
22372 | Ignoring is done first; then cutting; then maxing; and then as the very | |
22373 | last operation, padding. | |
22374 | ||
4009494e GM |
22375 | |
22376 | @node User-Defined Specs | |
22377 | @subsection User-Defined Specs | |
22378 | ||
22379 | All the specs allow for inserting user defined specifiers---@samp{u}. | |
22380 | The next character in the format string should be a letter. Gnus | |
22381 | will call the function @code{gnus-user-format-function-}@samp{X}, where | |
22382 | @samp{X} is the letter following @samp{%u}. The function will be passed | |
22383 | a single parameter---what the parameter means depends on what buffer | |
22384 | it's being called from. The function should return a string, which will | |
22385 | be inserted into the buffer just like information from any other | |
22386 | specifier. This function may also be called with dummy values, so it | |
22387 | should protect against that. | |
22388 | ||
22389 | Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}. | |
22390 | Gnus will call the function @code{gnus-user-format-function-}@samp{foo}. | |
22391 | ||
22392 | You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve | |
22393 | much the same without defining new functions. Here's an example: | |
22394 | @samp{%~(form (count-lines (point-min) (point)))@@}. The form | |
22395 | given here will be evaluated to yield the current line number, and then | |
22396 | inserted. | |
22397 | ||
22398 | ||
22399 | @node Formatting Fonts | |
22400 | @subsection Formatting Fonts | |
22401 | ||
9b3ebcb6 MB |
22402 | @cindex %(, %) |
22403 | @vindex gnus-mouse-face | |
4009494e GM |
22404 | There are specs for highlighting, and these are shared by all the format |
22405 | variables. Text inside the @samp{%(} and @samp{%)} specifiers will get | |
22406 | the special @code{mouse-face} property set, which means that it will be | |
22407 | highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer | |
22408 | over it. | |
22409 | ||
9b3ebcb6 MB |
22410 | @cindex %@{, %@} |
22411 | @vindex gnus-face-0 | |
4009494e GM |
22412 | Text inside the @samp{%@{} and @samp{%@}} specifiers will have their |
22413 | normal faces set using @code{gnus-face-0}, which is @code{bold} by | |
22414 | default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead, | |
22415 | and so on. Create as many faces as you wish. The same goes for the | |
22416 | @code{mouse-face} specs---you can say @samp{%3(hello%)} to have | |
22417 | @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}. | |
22418 | ||
9b3ebcb6 | 22419 | @cindex %<<, %>>, guillemets |
89b163db | 22420 | @c @cindex %<<, %>>, %«, %», guillemets |
9b3ebcb6 | 22421 | @vindex gnus-balloon-face-0 |
4009494e GM |
22422 | Text inside the @samp{%<<} and @samp{%>>} specifiers will get the |
22423 | special @code{balloon-help} property set to | |
22424 | @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get | |
22425 | @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*} | |
22426 | variables should be either strings or symbols naming functions that | |
22427 | return a string. When the mouse passes over text with this property | |
22428 | set, a balloon window will appear and display the string. Please | |
22429 | refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual}, | |
47301027 | 22430 | (in Emacs) or the doc string of @code{balloon-help-mode} (in |
4009494e GM |
22431 | XEmacs) for more information on this. (For technical reasons, the |
22432 | guillemets have been approximated as @samp{<<} and @samp{>>} in this | |
22433 | paragraph.) | |
22434 | ||
22435 | Here's an alternative recipe for the group buffer: | |
22436 | ||
22437 | @lisp | |
22438 | ;; @r{Create three face types.} | |
22439 | (setq gnus-face-1 'bold) | |
22440 | (setq gnus-face-3 'italic) | |
22441 | ||
22442 | ;; @r{We want the article count to be in} | |
22443 | ;; @r{a bold and green face. So we create} | |
22444 | ;; @r{a new face called @code{my-green-bold}.} | |
22445 | (copy-face 'bold 'my-green-bold) | |
22446 | ;; @r{Set the color.} | |
22447 | (set-face-foreground 'my-green-bold "ForestGreen") | |
22448 | (setq gnus-face-2 'my-green-bold) | |
22449 | ||
22450 | ;; @r{Set the new & fancy format.} | |
22451 | (setq gnus-group-line-format | |
22452 | "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n") | |
22453 | @end lisp | |
22454 | ||
22455 | I'm sure you'll be able to use this scheme to create totally unreadable | |
22456 | and extremely vulgar displays. Have fun! | |
22457 | ||
22458 | Note that the @samp{%(} specs (and friends) do not make any sense on the | |
22459 | mode-line variables. | |
22460 | ||
22461 | @node Positioning Point | |
22462 | @subsection Positioning Point | |
22463 | ||
22464 | Gnus usually moves point to a pre-defined place on each line in most | |
22465 | buffers. By default, point move to the first colon character on the | |
22466 | line. You can customize this behavior in three different ways. | |
22467 | ||
22468 | You can move the colon character to somewhere else on the line. | |
22469 | ||
22470 | @findex gnus-goto-colon | |
22471 | You can redefine the function that moves the point to the colon. The | |
22472 | function is called @code{gnus-goto-colon}. | |
22473 | ||
22474 | But perhaps the most convenient way to deal with this, if you don't want | |
22475 | to have a colon in your line, is to use the @samp{%*} specifier. If you | |
22476 | put a @samp{%*} somewhere in your format line definition, Gnus will | |
22477 | place point there. | |
22478 | ||
22479 | ||
22480 | @node Tabulation | |
22481 | @subsection Tabulation | |
22482 | ||
22483 | You can usually line up your displays by padding and cutting your | |
22484 | strings. However, when combining various strings of different size, it | |
22485 | can often be more convenient to just output the strings, and then worry | |
22486 | about lining up the following text afterwards. | |
22487 | ||
22488 | To do that, Gnus supplies tabulator specs---@samp{%=}. There are two | |
22489 | different types---@dfn{hard tabulators} and @dfn{soft tabulators}. | |
22490 | ||
22491 | @samp{%50=} will insert space characters to pad the line up to column | |
22492 | 50. If the text is already past column 50, nothing will be inserted. | |
22493 | This is the soft tabulator. | |
22494 | ||
22495 | @samp{%-50=} will insert space characters to pad the line up to column | |
22496 | 50. If the text is already past column 50, the excess text past column | |
22497 | 50 will be removed. This is the hard tabulator. | |
22498 | ||
22499 | ||
22500 | @node Wide Characters | |
22501 | @subsection Wide Characters | |
22502 | ||
22503 | Fixed width fonts in most countries have characters of the same width. | |
22504 | Some countries, however, use Latin characters mixed with wider | |
22505 | characters---most notable East Asian countries. | |
22506 | ||
22507 | The problem is that when formatting, Gnus assumes that if a string is 10 | |
22508 | characters wide, it'll be 10 Latin characters wide on the screen. In | |
22509 | these countries, that's not true. | |
22510 | ||
22511 | @vindex gnus-use-correct-string-widths | |
22512 | To help fix this, you can set @code{gnus-use-correct-string-widths} to | |
22513 | @code{t}. This makes buffer generation slower, but the results will be | |
22514 | prettier. The default value under XEmacs is @code{t} but @code{nil} | |
22515 | for Emacs. | |
22516 | ||
22517 | ||
22518 | @node Window Layout | |
22519 | @section Window Layout | |
22520 | @cindex window layout | |
22521 | ||
22522 | No, there's nothing here about X, so be quiet. | |
22523 | ||
22524 | @vindex gnus-use-full-window | |
22525 | If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all | |
22526 | other windows and occupy the entire Emacs screen by itself. It is | |
22527 | @code{t} by default. | |
22528 | ||
22529 | Setting this variable to @code{nil} kinda works, but there are | |
22530 | glitches. Use at your own peril. | |
22531 | ||
22532 | @vindex gnus-buffer-configuration | |
22533 | @code{gnus-buffer-configuration} describes how much space each Gnus | |
22534 | buffer should be given. Here's an excerpt of this variable: | |
22535 | ||
22536 | @lisp | |
71e691a5 | 22537 | ((group (vertical 1.0 (group 1.0 point))) |
4009494e GM |
22538 | (article (vertical 1.0 (summary 0.25 point) |
22539 | (article 1.0)))) | |
22540 | @end lisp | |
22541 | ||
22542 | This is an alist. The @dfn{key} is a symbol that names some action or | |
22543 | other. For instance, when displaying the group buffer, the window | |
22544 | configuration function will use @code{group} as the key. A full list of | |
22545 | possible names is listed below. | |
22546 | ||
22547 | The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer | |
22548 | should occupy. To take the @code{article} split as an example - | |
22549 | ||
22550 | @lisp | |
22551 | (article (vertical 1.0 (summary 0.25 point) | |
22552 | (article 1.0))) | |
22553 | @end lisp | |
22554 | ||
22555 | This @dfn{split} says that the summary buffer should occupy 25% of upper | |
22556 | half of the screen, and that it is placed over the article buffer. As | |
22557 | you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all | |
22558 | reaching for that calculator there). However, the special number | |
22559 | @code{1.0} is used to signal that this buffer should soak up all the | |
22560 | rest of the space available after the rest of the buffers have taken | |
22561 | whatever they need. There should be only one buffer with the @code{1.0} | |
22562 | size spec per split. | |
22563 | ||
22564 | Point will be put in the buffer that has the optional third element | |
22565 | @code{point}. In a @code{frame} split, the last subsplit having a leaf | |
1df7defd | 22566 | split where the tag @code{frame-focus} is a member (i.e., is the third or |
4009494e GM |
22567 | fourth element in the list, depending on whether the @code{point} tag is |
22568 | present) gets focus. | |
22569 | ||
22570 | Here's a more complicated example: | |
22571 | ||
22572 | @lisp | |
22573 | (article (vertical 1.0 (group 4) | |
22574 | (summary 0.25 point) | |
4009494e GM |
22575 | (article 1.0))) |
22576 | @end lisp | |
22577 | ||
22578 | If the size spec is an integer instead of a floating point number, | |
22579 | then that number will be used to say how many lines a buffer should | |
22580 | occupy, not a percentage. | |
22581 | ||
22582 | If the @dfn{split} looks like something that can be @code{eval}ed (to be | |
22583 | precise---if the @code{car} of the split is a function or a subr), this | |
22584 | split will be @code{eval}ed. If the result is non-@code{nil}, it will | |
71e691a5 | 22585 | be used as a split. |
4009494e GM |
22586 | |
22587 | Not complicated enough for you? Well, try this on for size: | |
22588 | ||
22589 | @lisp | |
22590 | (article (horizontal 1.0 | |
22591 | (vertical 0.5 | |
71e691a5 | 22592 | (group 1.0)) |
4009494e GM |
22593 | (vertical 1.0 |
22594 | (summary 0.25 point) | |
4009494e GM |
22595 | (article 1.0)))) |
22596 | @end lisp | |
22597 | ||
22598 | Whoops. Two buffers with the mystery 100% tag. And what's that | |
22599 | @code{horizontal} thingie? | |
22600 | ||
22601 | If the first element in one of the split is @code{horizontal}, Gnus will | |
22602 | split the window horizontally, giving you two windows side-by-side. | |
22603 | Inside each of these strips you may carry on all you like in the normal | |
22604 | fashion. The number following @code{horizontal} says what percentage of | |
22605 | the screen is to be given to this strip. | |
22606 | ||
22607 | For each split, there @emph{must} be one element that has the 100% tag. | |
22608 | The splitting is never accurate, and this buffer will eat any leftover | |
22609 | lines from the splits. | |
22610 | ||
22611 | To be slightly more formal, here's a definition of what a valid split | |
22612 | may look like: | |
22613 | ||
22614 | @example | |
22615 | @group | |
22616 | split = frame | horizontal | vertical | buffer | form | |
22617 | frame = "(frame " size *split ")" | |
22618 | horizontal = "(horizontal " size *split ")" | |
22619 | vertical = "(vertical " size *split ")" | |
22620 | buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")" | |
22621 | size = number | frame-params | |
22622 | buf-name = group | article | summary ... | |
22623 | @end group | |
22624 | @end example | |
22625 | ||
22626 | The limitations are that the @code{frame} split can only appear as the | |
22627 | top-level split. @var{form} should be an Emacs Lisp form that should | |
22628 | return a valid split. We see that each split is fully recursive, and | |
22629 | may contain any number of @code{vertical} and @code{horizontal} splits. | |
22630 | ||
22631 | @vindex gnus-window-min-width | |
22632 | @vindex gnus-window-min-height | |
22633 | @cindex window height | |
22634 | @cindex window width | |
22635 | Finding the right sizes can be a bit complicated. No window may be less | |
22636 | than @code{gnus-window-min-height} (default 1) characters high, and all | |
22637 | windows must be at least @code{gnus-window-min-width} (default 1) | |
22638 | characters wide. Gnus will try to enforce this before applying the | |
22639 | splits. If you want to use the normal Emacs window width/height limit, | |
22640 | you can just set these two variables to @code{nil}. | |
22641 | ||
22642 | If you're not familiar with Emacs terminology, @code{horizontal} and | |
22643 | @code{vertical} splits may work the opposite way of what you'd expect. | |
22644 | Windows inside a @code{horizontal} split are shown side-by-side, and | |
22645 | windows within a @code{vertical} split are shown above each other. | |
22646 | ||
22647 | @findex gnus-configure-frame | |
22648 | If you want to experiment with window placement, a good tip is to call | |
22649 | @code{gnus-configure-frame} directly with a split. This is the function | |
22650 | that does all the real work when splitting buffers. Below is a pretty | |
22651 | nonsensical configuration with 5 windows; two for the group buffer and | |
22652 | three for the article buffer. (I said it was nonsensical.) If you | |
22653 | @code{eval} the statement below, you can get an idea of how that would | |
22654 | look straight away, without going through the normal Gnus channels. | |
22655 | Play with it until you're satisfied, and then use | |
22656 | @code{gnus-add-configuration} to add your new creation to the buffer | |
22657 | configuration list. | |
22658 | ||
22659 | @lisp | |
22660 | (gnus-configure-frame | |
22661 | '(horizontal 1.0 | |
22662 | (vertical 10 | |
22663 | (group 1.0) | |
22664 | (article 0.3 point)) | |
22665 | (vertical 1.0 | |
22666 | (article 1.0) | |
22667 | (horizontal 4 | |
22668 | (group 1.0) | |
22669 | (article 10))))) | |
22670 | @end lisp | |
22671 | ||
22672 | You might want to have several frames as well. No prob---just use the | |
22673 | @code{frame} split: | |
22674 | ||
22675 | @lisp | |
22676 | (gnus-configure-frame | |
22677 | '(frame 1.0 | |
22678 | (vertical 1.0 | |
22679 | (summary 0.25 point frame-focus) | |
22680 | (article 1.0)) | |
22681 | (vertical ((height . 5) (width . 15) | |
22682 | (user-position . t) | |
22683 | (left . -1) (top . 1)) | |
22684 | (picon 1.0)))) | |
22685 | ||
22686 | @end lisp | |
22687 | ||
22688 | This split will result in the familiar summary/article window | |
22689 | configuration in the first (or ``main'') frame, while a small additional | |
22690 | frame will be created where picons will be shown. As you can see, | |
22691 | instead of the normal @code{1.0} top-level spec, each additional split | |
22692 | should have a frame parameter alist as the size spec. | |
22693 | @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp | |
22694 | Reference Manual}. Under XEmacs, a frame property list will be | |
22695 | accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)} | |
22696 | is such a plist. | |
22697 | The list of all possible keys for @code{gnus-buffer-configuration} can | |
22698 | be found in its default value. | |
22699 | ||
22700 | Note that the @code{message} key is used for both | |
22701 | @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If | |
22702 | it is desirable to distinguish between the two, something like this | |
22703 | might be used: | |
22704 | ||
22705 | @lisp | |
22706 | (message (horizontal 1.0 | |
22707 | (vertical 1.0 (message 1.0 point)) | |
22708 | (vertical 0.24 | |
22709 | (if (buffer-live-p gnus-summary-buffer) | |
22710 | '(summary 0.5)) | |
22711 | (group 1.0)))) | |
22712 | @end lisp | |
22713 | ||
22714 | One common desire for a multiple frame split is to have a separate frame | |
22715 | for composing mail and news while leaving the original frame intact. To | |
22716 | accomplish that, something like the following can be done: | |
22717 | ||
22718 | @lisp | |
22719 | (message | |
22720 | (frame 1.0 | |
22721 | (if (not (buffer-live-p gnus-summary-buffer)) | |
22722 | (car (cdr (assoc 'group gnus-buffer-configuration))) | |
22723 | (car (cdr (assoc 'summary gnus-buffer-configuration)))) | |
22724 | (vertical ((user-position . t) (top . 1) (left . 1) | |
22725 | (name . "Message")) | |
22726 | (message 1.0 point)))) | |
22727 | @end lisp | |
22728 | ||
22729 | @findex gnus-add-configuration | |
22730 | Since the @code{gnus-buffer-configuration} variable is so long and | |
22731 | complicated, there's a function you can use to ease changing the config | |
22732 | of a single setting: @code{gnus-add-configuration}. If, for instance, | |
22733 | you want to change the @code{article} setting, you could say: | |
22734 | ||
22735 | @lisp | |
22736 | (gnus-add-configuration | |
22737 | '(article (vertical 1.0 | |
22738 | (group 4) | |
22739 | (summary .25 point) | |
22740 | (article 1.0)))) | |
22741 | @end lisp | |
22742 | ||
22743 | You'd typically stick these @code{gnus-add-configuration} calls in your | |
22744 | @file{~/.gnus.el} file or in some startup hook---they should be run after | |
22745 | Gnus has been loaded. | |
22746 | ||
22747 | @vindex gnus-always-force-window-configuration | |
22748 | If all windows mentioned in the configuration are already visible, Gnus | |
22749 | won't change the window configuration. If you always want to force the | |
22750 | ``right'' window configuration, you can set | |
22751 | @code{gnus-always-force-window-configuration} to non-@code{nil}. | |
22752 | ||
22753 | If you're using tree displays (@pxref{Tree Display}), and the tree | |
22754 | window is displayed vertically next to another window, you may also want | |
22755 | to fiddle with @code{gnus-tree-minimize-window} to avoid having the | |
22756 | windows resized. | |
22757 | ||
06b840e0 LI |
22758 | @subsection Window Configuration Names |
22759 | ||
22760 | Here's a list of most of the currently known window configurations, | |
22761 | and when they're used: | |
22762 | ||
1e3b6001 | 22763 | @table @code |
06b840e0 LI |
22764 | @item group |
22765 | The group buffer. | |
22766 | ||
22767 | @item summary | |
22768 | Entering a group and showing only the summary. | |
22769 | ||
22770 | @item article | |
22771 | Selecting an article. | |
22772 | ||
22773 | @item server | |
22774 | The server buffer. | |
22775 | ||
22776 | @item browse | |
22777 | Browsing groups from the server buffer. | |
22778 | ||
22779 | @item message | |
22780 | Composing a (new) message. | |
22781 | ||
22782 | @item only-article | |
22783 | Showing only the article buffer. | |
22784 | ||
22785 | @item edit-article | |
22786 | Editing an article. | |
22787 | ||
22788 | @item edit-form | |
22789 | Editing group parameters and the like. | |
22790 | ||
22791 | @item edit-score | |
22792 | Editing a server definition. | |
22793 | ||
22794 | @item post | |
22795 | Composing a news message. | |
22796 | ||
22797 | @item reply | |
22798 | Replying or following up an article without yanking the text. | |
22799 | ||
22800 | @item forward | |
22801 | Forwarding a message. | |
22802 | ||
22803 | @item reply-yank | |
22804 | Replying or following up an article with yanking the text. | |
22805 | ||
22806 | @item mail-bound | |
22807 | Bouncing a message. | |
22808 | ||
22809 | @item pipe | |
22810 | Sending an article to an external process. | |
22811 | ||
22812 | @item bug | |
22813 | Sending a bug report. | |
22814 | ||
22815 | @item score-trace | |
22816 | Displaying the score trace. | |
22817 | ||
22818 | @item score-words | |
22819 | Displaying the score words. | |
22820 | ||
22821 | @item split-trace | |
22822 | Displaying the split trace. | |
22823 | ||
22824 | @item compose-bounce | |
22825 | Composing a bounce message. | |
22826 | ||
22827 | @item mml-preview | |
22828 | Previewing a @acronym{MIME} part. | |
22829 | ||
1e3b6001 | 22830 | @end table |
06b840e0 LI |
22831 | |
22832 | ||
4009494e GM |
22833 | @subsection Example Window Configurations |
22834 | ||
22835 | @itemize @bullet | |
22836 | @item | |
22837 | Narrow left hand side occupied by group buffer. Right hand side split | |
22838 | between summary buffer (top one-sixth) and article buffer (bottom). | |
22839 | ||
22840 | @ifinfo | |
22841 | @example | |
22842 | +---+---------+ | |
22843 | | G | Summary | | |
22844 | | r +---------+ | |
22845 | | o | | | |
22846 | | u | Article | | |
22847 | | p | | | |
22848 | +---+---------+ | |
22849 | @end example | |
22850 | @end ifinfo | |
22851 | ||
22852 | @lisp | |
22853 | (gnus-add-configuration | |
22854 | '(article | |
22855 | (horizontal 1.0 | |
22856 | (vertical 25 (group 1.0)) | |
22857 | (vertical 1.0 | |
22858 | (summary 0.16 point) | |
22859 | (article 1.0))))) | |
22860 | ||
22861 | (gnus-add-configuration | |
22862 | '(summary | |
22863 | (horizontal 1.0 | |
22864 | (vertical 25 (group 1.0)) | |
22865 | (vertical 1.0 (summary 1.0 point))))) | |
22866 | @end lisp | |
22867 | ||
22868 | @end itemize | |
22869 | ||
22870 | ||
22871 | @node Faces and Fonts | |
22872 | @section Faces and Fonts | |
22873 | @cindex faces | |
22874 | @cindex fonts | |
22875 | @cindex colors | |
22876 | ||
22877 | Fiddling with fonts and faces used to be very difficult, but these days | |
22878 | it is very simple. You simply say @kbd{M-x customize-face}, pick out | |
22879 | the face you want to alter, and alter it via the standard Customize | |
22880 | interface. | |
22881 | ||
22882 | ||
4009494e GM |
22883 | @node Mode Lines |
22884 | @section Mode Lines | |
22885 | @cindex mode lines | |
22886 | ||
22887 | @vindex gnus-updated-mode-lines | |
22888 | @code{gnus-updated-mode-lines} says what buffers should keep their mode | |
22889 | lines updated. It is a list of symbols. Supported symbols include | |
22890 | @code{group}, @code{article}, @code{summary}, @code{server}, | |
22891 | @code{browse}, and @code{tree}. If the corresponding symbol is present, | |
22892 | Gnus will keep that mode line updated with information that may be | |
22893 | pertinent. If this variable is @code{nil}, screen refresh may be | |
22894 | quicker. | |
22895 | ||
22896 | @cindex display-time | |
22897 | ||
22898 | @vindex gnus-mode-non-string-length | |
22899 | By default, Gnus displays information on the current article in the mode | |
22900 | lines of the summary and article buffers. The information Gnus wishes | |
1df7defd | 22901 | to display (e.g., the subject of the article) is often longer than the |
4009494e GM |
22902 | mode lines, and therefore have to be cut off at some point. The |
22903 | @code{gnus-mode-non-string-length} variable says how long the other | |
22904 | elements on the line is (i.e., the non-info part). If you put | |
1df7defd | 22905 | additional elements on the mode line (e.g., a clock), you should modify |
4009494e GM |
22906 | this variable: |
22907 | ||
22908 | @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it> | |
22909 | @lisp | |
22910 | (add-hook 'display-time-hook | |
22911 | (lambda () (setq gnus-mode-non-string-length | |
22912 | (+ 21 | |
22913 | (if line-number-mode 5 0) | |
22914 | (if column-number-mode 4 0) | |
22915 | (length display-time-string))))) | |
22916 | @end lisp | |
22917 | ||
22918 | If this variable is @code{nil} (which is the default), the mode line | |
22919 | strings won't be chopped off, and they won't be padded either. Note | |
22920 | that the default is unlikely to be desirable, as even the percentage | |
22921 | complete in the buffer may be crowded off the mode line; the user should | |
22922 | configure this variable appropriately for her configuration. | |
22923 | ||
22924 | ||
22925 | @node Highlighting and Menus | |
22926 | @section Highlighting and Menus | |
22927 | @cindex visual | |
22928 | @cindex highlighting | |
22929 | @cindex menus | |
22930 | ||
22931 | @vindex gnus-visual | |
22932 | The @code{gnus-visual} variable controls most of the Gnus-prettifying | |
22933 | aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy | |
22934 | colors or fonts. This will also inhibit loading the @file{gnus-vis.el} | |
22935 | file. | |
22936 | ||
22937 | This variable can be a list of visual properties that are enabled. The | |
22938 | following elements are valid, and are all included by default: | |
22939 | ||
22940 | @table @code | |
22941 | @item group-highlight | |
22942 | Do highlights in the group buffer. | |
22943 | @item summary-highlight | |
22944 | Do highlights in the summary buffer. | |
22945 | @item article-highlight | |
22946 | Do highlights in the article buffer. | |
22947 | @item highlight | |
22948 | Turn on highlighting in all buffers. | |
22949 | @item group-menu | |
22950 | Create menus in the group buffer. | |
22951 | @item summary-menu | |
22952 | Create menus in the summary buffers. | |
22953 | @item article-menu | |
22954 | Create menus in the article buffer. | |
22955 | @item browse-menu | |
22956 | Create menus in the browse buffer. | |
22957 | @item server-menu | |
22958 | Create menus in the server buffer. | |
22959 | @item score-menu | |
22960 | Create menus in the score buffers. | |
22961 | @item menu | |
22962 | Create menus in all buffers. | |
22963 | @end table | |
22964 | ||
22965 | So if you only want highlighting in the article buffer and menus in all | |
22966 | buffers, you could say something like: | |
22967 | ||
22968 | @lisp | |
22969 | (setq gnus-visual '(article-highlight menu)) | |
22970 | @end lisp | |
22971 | ||
22972 | If you want highlighting only and no menus whatsoever, you'd say: | |
22973 | ||
22974 | @lisp | |
22975 | (setq gnus-visual '(highlight)) | |
22976 | @end lisp | |
22977 | ||
22978 | If @code{gnus-visual} is @code{t}, highlighting and menus will be used | |
22979 | in all Gnus buffers. | |
22980 | ||
22981 | Other general variables that influence the look of all buffers include: | |
22982 | ||
22983 | @table @code | |
22984 | @item gnus-mouse-face | |
22985 | @vindex gnus-mouse-face | |
22986 | This is the face (i.e., font) used for mouse highlighting in Gnus. No | |
22987 | mouse highlights will be done if @code{gnus-visual} is @code{nil}. | |
22988 | ||
22989 | @end table | |
22990 | ||
22991 | There are hooks associated with the creation of all the different menus: | |
22992 | ||
22993 | @table @code | |
22994 | ||
22995 | @item gnus-article-menu-hook | |
22996 | @vindex gnus-article-menu-hook | |
22997 | Hook called after creating the article mode menu. | |
22998 | ||
22999 | @item gnus-group-menu-hook | |
23000 | @vindex gnus-group-menu-hook | |
23001 | Hook called after creating the group mode menu. | |
23002 | ||
23003 | @item gnus-summary-menu-hook | |
23004 | @vindex gnus-summary-menu-hook | |
23005 | Hook called after creating the summary mode menu. | |
23006 | ||
23007 | @item gnus-server-menu-hook | |
23008 | @vindex gnus-server-menu-hook | |
23009 | Hook called after creating the server mode menu. | |
23010 | ||
23011 | @item gnus-browse-menu-hook | |
23012 | @vindex gnus-browse-menu-hook | |
23013 | Hook called after creating the browse mode menu. | |
23014 | ||
23015 | @item gnus-score-menu-hook | |
23016 | @vindex gnus-score-menu-hook | |
23017 | Hook called after creating the score mode menu. | |
23018 | ||
23019 | @end table | |
23020 | ||
23021 | ||
4009494e GM |
23022 | @node Daemons |
23023 | @section Daemons | |
23024 | @cindex demons | |
23025 | @cindex daemons | |
23026 | ||
23027 | Gnus, being larger than any program ever written (allegedly), does lots | |
23028 | of strange stuff that you may wish to have done while you're not | |
23029 | present. For instance, you may want it to check for new mail once in a | |
23030 | while. Or you may want it to close down all connections to all servers | |
23031 | when you leave Emacs idle. And stuff like that. | |
23032 | ||
23033 | Gnus will let you do stuff like that by defining various | |
23034 | @dfn{handlers}. Each handler consists of three elements: A | |
23035 | @var{function}, a @var{time}, and an @var{idle} parameter. | |
23036 | ||
23037 | Here's an example of a handler that closes connections when Emacs has | |
23038 | been idle for thirty minutes: | |
23039 | ||
23040 | @lisp | |
23041 | (gnus-demon-close-connections nil 30) | |
23042 | @end lisp | |
23043 | ||
23044 | Here's a handler that scans for @acronym{PGP} headers every hour when | |
23045 | Emacs is idle: | |
23046 | ||
23047 | @lisp | |
23048 | (gnus-demon-scan-pgp 60 t) | |
23049 | @end lisp | |
23050 | ||
23051 | This @var{time} parameter and that @var{idle} parameter work together | |
23052 | in a strange, but wonderful fashion. Basically, if @var{idle} is | |
23053 | @code{nil}, then the function will be called every @var{time} minutes. | |
23054 | ||
23055 | If @var{idle} is @code{t}, then the function will be called after | |
23056 | @var{time} minutes only if Emacs is idle. So if Emacs is never idle, | |
23057 | the function will never be called. But once Emacs goes idle, the | |
23058 | function will be called every @var{time} minutes. | |
23059 | ||
23060 | If @var{idle} is a number and @var{time} is a number, the function will | |
23061 | be called every @var{time} minutes only when Emacs has been idle for | |
23062 | @var{idle} minutes. | |
23063 | ||
23064 | If @var{idle} is a number and @var{time} is @code{nil}, the function | |
23065 | will be called once every time Emacs has been idle for @var{idle} | |
23066 | minutes. | |
23067 | ||
23068 | And if @var{time} is a string, it should look like @samp{07:31}, and | |
23069 | the function will then be called once every day somewhere near that | |
23070 | time. Modified by the @var{idle} parameter, of course. | |
23071 | ||
23072 | @vindex gnus-demon-timestep | |
23073 | (When I say ``minute'' here, I really mean @code{gnus-demon-timestep} | |
23074 | seconds. This is 60 by default. If you change that variable, | |
23075 | all the timings in the handlers will be affected.) | |
23076 | ||
23077 | So, if you want to add a handler, you could put something like this in | |
23078 | your @file{~/.gnus.el} file: | |
23079 | ||
23080 | @findex gnus-demon-add-handler | |
23081 | @lisp | |
23082 | (gnus-demon-add-handler 'gnus-demon-close-connections 30 t) | |
23083 | @end lisp | |
23084 | ||
4009494e GM |
23085 | @findex gnus-demon-add-scanmail |
23086 | @findex gnus-demon-add-rescan | |
23087 | @findex gnus-demon-add-scan-timestamps | |
23088 | @findex gnus-demon-add-disconnection | |
23089 | Some ready-made functions to do this have been created: | |
8ccbef23 | 23090 | @code{gnus-demon-add-disconnection}, |
4009494e GM |
23091 | @code{gnus-demon-add-nntp-close-connection}, |
23092 | @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and | |
23093 | @code{gnus-demon-add-scanmail}. Just put those functions in your | |
23094 | @file{~/.gnus.el} if you want those abilities. | |
23095 | ||
23096 | @findex gnus-demon-init | |
23097 | @findex gnus-demon-cancel | |
23098 | @vindex gnus-demon-handlers | |
23099 | If you add handlers to @code{gnus-demon-handlers} directly, you should | |
23100 | run @code{gnus-demon-init} to make the changes take hold. To cancel all | |
23101 | daemons, you can use the @code{gnus-demon-cancel} function. | |
23102 | ||
23103 | Note that adding daemons can be pretty naughty if you over do it. Adding | |
23104 | functions that scan all news and mail from all servers every two seconds | |
23105 | is a sure-fire way of getting booted off any respectable system. So | |
23106 | behave. | |
23107 | ||
23108 | ||
4009494e GM |
23109 | @node Undo |
23110 | @section Undo | |
23111 | @cindex undo | |
23112 | ||
23113 | It is very useful to be able to undo actions one has done. In normal | |
23114 | Emacs buffers, it's easy enough---you just push the @code{undo} button. | |
23115 | In Gnus buffers, however, it isn't that simple. | |
23116 | ||
23117 | The things Gnus displays in its buffer is of no value whatsoever to | |
23118 | Gnus---it's all just data designed to look nice to the user. | |
23119 | Killing a group in the group buffer with @kbd{C-k} makes the line | |
23120 | disappear, but that's just a side-effect of the real action---the | |
23121 | removal of the group in question from the internal Gnus structures. | |
23122 | Undoing something like that can't be done by the normal Emacs | |
23123 | @code{undo} function. | |
23124 | ||
23125 | Gnus tries to remedy this somewhat by keeping track of what the user | |
23126 | does and coming up with actions that would reverse the actions the user | |
23127 | takes. When the user then presses the @code{undo} key, Gnus will run | |
23128 | the code to reverse the previous action, or the previous actions. | |
23129 | However, not all actions are easily reversible, so Gnus currently offers | |
23130 | a few key functions to be undoable. These include killing groups, | |
23131 | yanking groups, and changing the list of read articles of groups. | |
23132 | That's it, really. More functions may be added in the future, but each | |
23133 | added function means an increase in data to be stored, so Gnus will | |
23134 | never be totally undoable. | |
23135 | ||
23136 | @findex gnus-undo-mode | |
23137 | @vindex gnus-use-undo | |
23138 | @findex gnus-undo | |
23139 | The undoability is provided by the @code{gnus-undo-mode} minor mode. It | |
23140 | is used if @code{gnus-use-undo} is non-@code{nil}, which is the | |
23141 | default. The @kbd{C-M-_} key performs the @code{gnus-undo} | |
23142 | command, which should feel kinda like the normal Emacs @code{undo} | |
23143 | command. | |
23144 | ||
23145 | ||
23146 | @node Predicate Specifiers | |
23147 | @section Predicate Specifiers | |
23148 | @cindex predicate specifiers | |
23149 | ||
23150 | Some Gnus variables are @dfn{predicate specifiers}. This is a special | |
23151 | form that allows flexible specification of predicates without having | |
23152 | to type all that much. | |
23153 | ||
23154 | These specifiers are lists consisting of functions, symbols and lists. | |
23155 | ||
23156 | Here's an example: | |
23157 | ||
23158 | @lisp | |
23159 | (or gnus-article-unseen-p | |
23160 | gnus-article-unread-p) | |
23161 | @end lisp | |
23162 | ||
23163 | The available symbols are @code{or}, @code{and} and @code{not}. The | |
23164 | functions all take one parameter. | |
23165 | ||
23166 | @findex gnus-make-predicate | |
23167 | Internally, Gnus calls @code{gnus-make-predicate} on these specifiers | |
23168 | to create a function that can be called. This input parameter to this | |
23169 | function will be passed along to all the functions in the predicate | |
23170 | specifier. | |
23171 | ||
23172 | ||
23173 | @node Moderation | |
23174 | @section Moderation | |
23175 | @cindex moderation | |
23176 | ||
23177 | If you are a moderator, you can use the @file{gnus-mdrtn.el} package. | |
23178 | It is not included in the standard Gnus package. Write a mail to | |
23179 | @samp{larsi@@gnus.org} and state what group you moderate, and you'll | |
23180 | get a copy. | |
23181 | ||
23182 | The moderation package is implemented as a minor mode for summary | |
23183 | buffers. Put | |
23184 | ||
23185 | @lisp | |
23186 | (add-hook 'gnus-summary-mode-hook 'gnus-moderate) | |
23187 | @end lisp | |
23188 | ||
23189 | in your @file{~/.gnus.el} file. | |
23190 | ||
23191 | If you are the moderator of @samp{rec.zoofle}, this is how it's | |
23192 | supposed to work: | |
23193 | ||
23194 | @enumerate | |
23195 | @item | |
23196 | You split your incoming mail by matching on | |
23197 | @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted | |
23198 | articles in some mail group---for instance, @samp{nnml:rec.zoofle}. | |
23199 | ||
23200 | @item | |
23201 | You enter that group once in a while and post articles using the @kbd{e} | |
23202 | (edit-and-post) or @kbd{s} (just send unedited) commands. | |
23203 | ||
23204 | @item | |
23205 | If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some | |
23206 | articles that weren't approved by you, you can cancel them with the | |
23207 | @kbd{c} command. | |
23208 | @end enumerate | |
23209 | ||
23210 | To use moderation mode in these two groups, say: | |
23211 | ||
23212 | @lisp | |
23213 | (setq gnus-moderated-list | |
23214 | "^nnml:rec.zoofle$\\|^rec.zoofle$") | |
23215 | @end lisp | |
23216 | ||
23217 | ||
23218 | @node Fetching a Group | |
23219 | @section Fetching a Group | |
23220 | @cindex fetching a group | |
23221 | ||
23222 | @findex gnus-fetch-group | |
23223 | It is sometimes convenient to be able to just say ``I want to read this | |
23224 | group and I don't care whether Gnus has been started or not''. This is | |
23225 | perhaps more useful for people who write code than for users, but the | |
23226 | command @code{gnus-fetch-group} provides this functionality in any case. | |
23227 | It takes the group name as a parameter. | |
23228 | ||
23229 | ||
23230 | @node Image Enhancements | |
23231 | @section Image Enhancements | |
23232 | ||
23233 | XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't | |
23234 | support images, Emacs 22 does.} and up, are able to display pictures and | |
23235 | stuff, so Gnus has taken advantage of that. | |
23236 | ||
23237 | @menu | |
23238 | * X-Face:: Display a funky, teensy black-and-white image. | |
23239 | * Face:: Display a funkier, teensier colored image. | |
23240 | * Smileys:: Show all those happy faces the way they were meant to be shown. | |
23241 | * Picons:: How to display pictures of what you're reading. | |
61b1af82 | 23242 | * Gravatars:: Display the avatar of people you read. |
4009494e GM |
23243 | * XVarious:: Other XEmacsy Gnusey variables. |
23244 | @end menu | |
23245 | ||
23246 | ||
23247 | @node X-Face | |
23248 | @subsection X-Face | |
23249 | @cindex x-face | |
23250 | ||
23251 | @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit | |
23252 | depth) image that's supposed to represent the author of the message. | |
23253 | It seems to be supported by an ever-growing number of mail and news | |
23254 | readers. | |
23255 | ||
23256 | @cindex x-face | |
23257 | @findex gnus-article-display-x-face | |
23258 | @vindex gnus-article-x-face-command | |
23259 | @vindex gnus-article-x-face-too-ugly | |
23260 | @iftex | |
23261 | @iflatex | |
23262 | \include{xface} | |
23263 | @end iflatex | |
23264 | @end iftex | |
23265 | @c @anchor{X-Face} | |
23266 | ||
23267 | Viewing an @code{X-Face} header either requires an Emacs that has | |
4b70e299 | 23268 | @samp{compface} support (which most XEmacs versions have), or that you |
4009494e GM |
23269 | have suitable conversion or display programs installed. If your Emacs |
23270 | has image support the default action is to display the face before the | |
23271 | @code{From} header. If there's no native @code{X-Face} support, Gnus | |
23272 | will try to convert the @code{X-Face} header using external programs | |
23273 | from the @code{pbmplus} package and friends, see below. For XEmacs it's | |
23274 | faster if XEmacs has been compiled with @code{X-Face} support. The | |
23275 | default action under Emacs without image support is to fork off the | |
23276 | @code{display} program. | |
23277 | ||
23278 | On a GNU/Linux system, the @code{display} program is included in the | |
23279 | ImageMagick package. For external conversion programs look for packages | |
23280 | with names like @code{netpbm}, @code{libgr-progs} and @code{compface}. | |
23281 | On Windows, you may use the packages @code{netpbm} and @code{compface} | |
23282 | from @url{http://gnuwin32.sourceforge.net}. You need to add the | |
23283 | @code{bin} directory to your @code{PATH} environment variable. | |
23284 | @c In fact only the following DLLs and binaries seem to be required: | |
23285 | @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe | |
23286 | ||
23287 | The variable @code{gnus-article-x-face-command} controls which programs | |
23288 | are used to display the @code{X-Face} header. If this variable is a | |
23289 | string, this string will be executed in a sub-shell. If it is a | |
23290 | function, this function will be called with the face as the argument. | |
23291 | If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the | |
23292 | @code{From} header, the face will not be shown. | |
23293 | ||
23294 | (Note: @code{x-face} is used in the variable/function names, not | |
23295 | @code{xface}). | |
23296 | ||
23297 | @noindent | |
23298 | Face and variable: | |
23299 | ||
23300 | @table @code | |
23301 | @item gnus-x-face | |
23302 | @vindex gnus-x-face | |
23303 | Face to show X-Face. The colors from this face are used as the | |
23304 | foreground and background colors of the displayed X-Faces. The | |
23305 | default colors are black and white. | |
01c52d31 MB |
23306 | |
23307 | @item gnus-face-properties-alist | |
23308 | @vindex gnus-face-properties-alist | |
23309 | Alist of image types and properties applied to Face (@pxref{Face}) and | |
23310 | X-Face images. The default value is @code{((pbm . (:face gnus-x-face)) | |
23311 | (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for | |
23312 | XEmacs. Here are examples: | |
23313 | ||
23314 | @lisp | |
23315 | ;; Specify the altitude of Face and X-Face images in the From header. | |
23316 | (setq gnus-face-properties-alist | |
23317 | '((pbm . (:face gnus-x-face :ascent 80)) | |
23318 | (png . (:ascent 80)))) | |
23319 | ||
23320 | ;; Show Face and X-Face images as pressed buttons. | |
23321 | (setq gnus-face-properties-alist | |
23322 | '((pbm . (:face gnus-x-face :relief -2)) | |
23323 | (png . (:relief -2)))) | |
23324 | @end lisp | |
23325 | ||
23326 | @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp | |
23327 | Reference Manual} for the valid properties for various image types. | |
23328 | Currently, @code{pbm} is used for X-Face images and @code{png} is used | |
23329 | for Face images in Emacs. Only the @code{:face} property is effective | |
23330 | on the @code{xface} image type in XEmacs if it is built with the | |
23331 | @samp{libcompface} library. | |
4009494e GM |
23332 | @end table |
23333 | ||
23334 | If you use posting styles, you can use an @code{x-face-file} entry in | |
23335 | @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus | |
23336 | provides a few convenience functions and variables to allow easier | |
23337 | insertion of X-Face headers in outgoing messages. You also need the | |
23338 | above mentioned ImageMagick, netpbm or other image conversion packages | |
23339 | (depending the values of the variables below) for these functions. | |
23340 | ||
23341 | @findex gnus-random-x-face | |
23342 | @vindex gnus-convert-pbm-to-x-face-command | |
23343 | @vindex gnus-x-face-directory | |
23344 | @code{gnus-random-x-face} goes through all the @samp{pbm} files in | |
23345 | @code{gnus-x-face-directory} and picks one at random, and then | |
23346 | converts it to the X-Face format by using the | |
23347 | @code{gnus-convert-pbm-to-x-face-command} shell command. The | |
23348 | @samp{pbm} files should be 48x48 pixels big. It returns the X-Face | |
23349 | header data as a string. | |
23350 | ||
23351 | @findex gnus-insert-random-x-face-header | |
23352 | @code{gnus-insert-random-x-face-header} calls | |
23353 | @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the | |
23354 | randomly generated data. | |
23355 | ||
23356 | @findex gnus-x-face-from-file | |
23357 | @vindex gnus-convert-image-to-x-face-command | |
23358 | @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then | |
23359 | converts the file to X-Face format by using the | |
23360 | @code{gnus-convert-image-to-x-face-command} shell command. | |
23361 | ||
23362 | Here's how you would typically use the first function. Put something | |
23363 | like the following in your @file{~/.gnus.el} file: | |
23364 | ||
23365 | @lisp | |
23366 | (setq message-required-news-headers | |
23367 | (nconc message-required-news-headers | |
23368 | (list '(X-Face . gnus-random-x-face)))) | |
23369 | @end lisp | |
23370 | ||
23371 | Using the last function would be something like this: | |
23372 | ||
23373 | @lisp | |
23374 | (setq message-required-news-headers | |
23375 | (nconc message-required-news-headers | |
23376 | (list '(X-Face . (lambda () | |
23377 | (gnus-x-face-from-file | |
23378 | "~/My-face.gif")))))) | |
23379 | @end lisp | |
23380 | ||
23381 | ||
23382 | @node Face | |
23383 | @subsection Face | |
23384 | @cindex face | |
23385 | ||
23386 | @c #### FIXME: faces and x-faces' implementations should really be harmonized. | |
23387 | ||
23388 | @code{Face} headers are essentially a funkier version of @code{X-Face} | |
23389 | ones. They describe a 48x48 pixel colored image that's supposed to | |
23390 | represent the author of the message. | |
23391 | ||
23392 | @cindex face | |
23393 | @findex gnus-article-display-face | |
23394 | The contents of a @code{Face} header must be a base64 encoded PNG image. | |
23395 | See @uref{http://quimby.gnus.org/circus/face/} for the precise | |
23396 | specifications. | |
23397 | ||
01c52d31 MB |
23398 | The @code{gnus-face-properties-alist} variable affects the appearance of |
23399 | displayed Face images. @xref{X-Face}. | |
23400 | ||
85d870a9 | 23401 | Viewing a @code{Face} header requires an Emacs that is able to display |
4009494e GM |
23402 | PNG images. |
23403 | @c Maybe add this: | |
23404 | @c (if (featurep 'xemacs) | |
23405 | @c (featurep 'png) | |
23406 | @c (image-type-available-p 'png)) | |
23407 | ||
23408 | Gnus provides a few convenience functions and variables to allow | |
23409 | easier insertion of Face headers in outgoing messages. | |
23410 | ||
23411 | @findex gnus-convert-png-to-face | |
23412 | @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than | |
23413 | 726 bytes long, and converts it to a face. | |
23414 | ||
23415 | @findex gnus-face-from-file | |
23416 | @vindex gnus-convert-image-to-face-command | |
23417 | @code{gnus-face-from-file} takes a JPEG file as the parameter, and then | |
23418 | converts the file to Face format by using the | |
23419 | @code{gnus-convert-image-to-face-command} shell command. | |
23420 | ||
23421 | Here's how you would typically use this function. Put something like the | |
23422 | following in your @file{~/.gnus.el} file: | |
23423 | ||
23424 | @lisp | |
23425 | (setq message-required-news-headers | |
23426 | (nconc message-required-news-headers | |
23427 | (list '(Face . (lambda () | |
23428 | (gnus-face-from-file "~/face.jpg")))))) | |
23429 | @end lisp | |
23430 | ||
23431 | ||
23432 | @node Smileys | |
23433 | @subsection Smileys | |
23434 | @cindex smileys | |
23435 | ||
23436 | @iftex | |
23437 | @iflatex | |
23438 | \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}} | |
23439 | \input{smiley} | |
23440 | @end iflatex | |
23441 | @end iftex | |
23442 | ||
23443 | @dfn{Smiley} is a package separate from Gnus, but since Gnus is | |
23444 | currently the only package that uses Smiley, it is documented here. | |
23445 | ||
23446 | In short---to use Smiley in Gnus, put the following in your | |
23447 | @file{~/.gnus.el} file: | |
23448 | ||
23449 | @lisp | |
23450 | (setq gnus-treat-display-smileys t) | |
23451 | @end lisp | |
23452 | ||
23453 | Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and | |
23454 | the like---to pictures and displays those instead of the text smiley | |
23455 | faces. The conversion is controlled by a list of regexps that matches | |
23456 | text and maps that to file names. | |
23457 | ||
23458 | @vindex smiley-regexp-alist | |
23459 | The alist used is specified by the @code{smiley-regexp-alist} | |
23460 | variable. The first item in each element is the regexp to be matched; | |
23461 | the second element is the regexp match group that is to be replaced by | |
23462 | the picture; and the third element is the name of the file to be | |
23463 | displayed. | |
23464 | ||
9b3ebcb6 | 23465 | The following variables customize the appearance of the smileys: |
4009494e GM |
23466 | |
23467 | @table @code | |
23468 | ||
9b3ebcb6 MB |
23469 | @item smiley-style |
23470 | @vindex smiley-style | |
23471 | Specifies the smiley style. Predefined smiley styles include | |
23472 | @code{low-color} (small 13x14 pixel, three-color images), @code{medium} | |
23473 | (more colorful images, 16x16 pixel), and @code{grayscale} (grayscale | |
23474 | images, 14x14 pixel). The default depends on the height of the default | |
23475 | face. | |
23476 | ||
4009494e GM |
23477 | @item smiley-data-directory |
23478 | @vindex smiley-data-directory | |
9b3ebcb6 MB |
23479 | Where Smiley will look for smiley faces files. You shouldn't set this |
23480 | variable anymore. Customize @code{smiley-style} instead. | |
4009494e GM |
23481 | |
23482 | @item gnus-smiley-file-types | |
23483 | @vindex gnus-smiley-file-types | |
23484 | List of suffixes on smiley file names to try. | |
23485 | ||
23486 | @end table | |
23487 | ||
23488 | ||
23489 | @node Picons | |
23490 | @subsection Picons | |
23491 | ||
23492 | @iftex | |
23493 | @iflatex | |
23494 | \include{picons} | |
23495 | @end iflatex | |
23496 | @end iftex | |
23497 | ||
23498 | So@dots{} You want to slow down your news reader even more! This is a | |
23499 | good way to do so. It's also a great way to impress people staring | |
23500 | over your shoulder as you read news. | |
23501 | ||
23502 | What are Picons? To quote directly from the Picons Web site: | |
23503 | ||
23504 | @iftex | |
23505 | @iflatex | |
23506 | \margindex{} | |
23507 | @end iflatex | |
23508 | @end iftex | |
23509 | ||
23510 | @quotation | |
23511 | @dfn{Picons} is short for ``personal icons''. They're small, | |
23512 | constrained images used to represent users and domains on the net, | |
23513 | organized into databases so that the appropriate image for a given | |
23514 | e-mail address can be found. Besides users and domains, there are picon | |
23515 | databases for Usenet newsgroups and weather forecasts. The picons are | |
23516 | in either monochrome @code{XBM} format or color @code{XPM} and | |
23517 | @code{GIF} formats. | |
23518 | @end quotation | |
23519 | ||
23520 | @vindex gnus-picon-databases | |
23521 | For instructions on obtaining and installing the picons databases, | |
23522 | point your Web browser at | |
23523 | @uref{http://www.cs.indiana.edu/picons/ftp/index.html}. | |
23524 | ||
23525 | If you are using Debian GNU/Linux, saying @samp{apt-get install | |
23526 | picons.*} will install the picons where Gnus can find them. | |
23527 | ||
23528 | To enable displaying picons, simply make sure that | |
23529 | @code{gnus-picon-databases} points to the directory containing the | |
23530 | Picons databases. | |
23531 | ||
01c52d31 MB |
23532 | @vindex gnus-picon-style |
23533 | The variable @code{gnus-picon-style} controls how picons are displayed. | |
23534 | If @code{inline}, the textual representation is replaced. If | |
23535 | @code{right}, picons are added right to the textual representation. | |
23536 | ||
89b163db G |
23537 | @vindex gnus-picon-properties |
23538 | The value of the variable @code{gnus-picon-properties} is a list of | |
23539 | properties applied to picons. | |
23540 | ||
4009494e GM |
23541 | The following variables offer control over where things are located. |
23542 | ||
23543 | @table @code | |
23544 | ||
23545 | @item gnus-picon-databases | |
23546 | @vindex gnus-picon-databases | |
23547 | The location of the picons database. This is a list of directories | |
23548 | containing the @file{news}, @file{domains}, @file{users} (and so on) | |
23549 | subdirectories. Defaults to @code{("/usr/lib/picon" | |
23550 | "/usr/local/faces")}. | |
23551 | ||
23552 | @item gnus-picon-news-directories | |
23553 | @vindex gnus-picon-news-directories | |
23554 | List of subdirectories to search in @code{gnus-picon-databases} for | |
23555 | newsgroups faces. @code{("news")} is the default. | |
23556 | ||
23557 | @item gnus-picon-user-directories | |
23558 | @vindex gnus-picon-user-directories | |
23559 | List of subdirectories to search in @code{gnus-picon-databases} for user | |
23560 | faces. @code{("users" "usenix" "local" "misc")} is the default. | |
23561 | ||
23562 | @item gnus-picon-domain-directories | |
23563 | @vindex gnus-picon-domain-directories | |
23564 | List of subdirectories to search in @code{gnus-picon-databases} for | |
23565 | domain name faces. Defaults to @code{("domains")}. Some people may | |
23566 | want to add @samp{"unknown"} to this list. | |
23567 | ||
23568 | @item gnus-picon-file-types | |
23569 | @vindex gnus-picon-file-types | |
23570 | Ordered list of suffixes on picon file names to try. Defaults to | |
23571 | @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs. | |
23572 | ||
4478e074 G |
23573 | @item gnus-picon-inhibit-top-level-domains |
23574 | @vindex gnus-picon-inhibit-top-level-domains | |
23575 | If non-@code{nil} (which is the default), don't display picons for | |
23576 | things like @samp{.net} and @samp{.de}, which aren't usually very | |
23577 | interesting. | |
23578 | ||
4009494e GM |
23579 | @end table |
23580 | ||
61b1af82 G |
23581 | @node Gravatars |
23582 | @subsection Gravatars | |
23583 | ||
23584 | @iftex | |
23585 | @iflatex | |
23586 | \include{gravatars} | |
23587 | @end iflatex | |
23588 | @end iftex | |
23589 | ||
23590 | A gravatar is an image registered to an e-mail address. | |
23591 | ||
23592 | You can submit yours on-line at @uref{http://www.gravatar.com}. | |
23593 | ||
23594 | The following variables offer control over how things are displayed. | |
23595 | ||
23596 | @table @code | |
23597 | ||
23598 | @item gnus-gravatar-size | |
23599 | @vindex gnus-gravatar-size | |
23600 | The size in pixels of gravatars. Gravatars are always square, so one | |
23601 | number for the size is enough. | |
23602 | ||
229b59da G |
23603 | @item gnus-gravatar-properties |
23604 | @vindex gnus-gravatar-properties | |
23605 | List of image properties applied to Gravatar images. | |
61b1af82 | 23606 | |
fcf2d385 KY |
23607 | @item gnus-gravatar-too-ugly |
23608 | @vindex gnus-gravatar-too-ugly | |
23609 | Regexp that matches mail addresses or names of people of which avatars | |
23610 | should not be displayed, or @code{nil}. It default to the value of | |
23611 | @code{gnus-article-x-face-too-ugly} (@pxref{X-Face}). | |
23612 | ||
61b1af82 G |
23613 | @end table |
23614 | ||
23615 | If you want to see them in the From field, set: | |
23616 | @lisp | |
23617 | (setq gnus-treat-from-gravatar 'head) | |
23618 | @end lisp | |
23619 | ||
23620 | If you want to see them in the Cc and To fields, set: | |
23621 | ||
23622 | @lisp | |
23623 | (setq gnus-treat-mail-gravatar 'head) | |
23624 | @end lisp | |
23625 | ||
4009494e GM |
23626 | |
23627 | @node XVarious | |
23628 | @subsection Various XEmacs Variables | |
23629 | ||
23630 | @table @code | |
23631 | @item gnus-xmas-glyph-directory | |
23632 | @vindex gnus-xmas-glyph-directory | |
23633 | This is where Gnus will look for pictures. Gnus will normally | |
23634 | auto-detect this directory, but you may set it manually if you have an | |
23635 | unusual directory structure. | |
23636 | ||
23637 | @item gnus-xmas-modeline-glyph | |
23638 | @vindex gnus-xmas-modeline-glyph | |
23639 | A glyph displayed in all Gnus mode lines. It is a tiny gnu head by | |
23640 | default. | |
23641 | ||
23642 | @end table | |
23643 | ||
23644 | @subsubsection Toolbar | |
23645 | ||
23646 | @table @code | |
23647 | ||
23648 | @item gnus-use-toolbar | |
23649 | @vindex gnus-use-toolbar | |
23650 | This variable specifies the position to display the toolbar. If | |
23651 | @code{nil}, don't display toolbars. If it is non-@code{nil}, it should | |
23652 | be one of the symbols @code{default}, @code{top}, @code{bottom}, | |
23653 | @code{right}, and @code{left}. @code{default} means to use the default | |
23654 | toolbar, the rest mean to display the toolbar on the place which those | |
23655 | names show. The default is @code{default}. | |
23656 | ||
23657 | @item gnus-toolbar-thickness | |
23658 | @vindex gnus-toolbar-thickness | |
23659 | Cons of the height and the width specifying the thickness of a toolbar. | |
23660 | The height is used for the toolbar displayed on the top or the bottom, | |
23661 | the width is used for the toolbar displayed on the right or the left. | |
23662 | The default is that of the default toolbar. | |
23663 | ||
23664 | @item gnus-group-toolbar | |
23665 | @vindex gnus-group-toolbar | |
23666 | The toolbar in the group buffer. | |
23667 | ||
23668 | @item gnus-summary-toolbar | |
23669 | @vindex gnus-summary-toolbar | |
23670 | The toolbar in the summary buffer. | |
23671 | ||
23672 | @item gnus-summary-mail-toolbar | |
23673 | @vindex gnus-summary-mail-toolbar | |
23674 | The toolbar in the summary buffer of mail groups. | |
23675 | ||
23676 | @end table | |
23677 | ||
23678 | @iftex | |
23679 | @iflatex | |
23680 | \margindex{} | |
23681 | @end iflatex | |
23682 | @end iftex | |
23683 | ||
23684 | ||
23685 | @node Fuzzy Matching | |
23686 | @section Fuzzy Matching | |
23687 | @cindex fuzzy matching | |
23688 | ||
23689 | Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing | |
23690 | things like scoring, thread gathering and thread comparison. | |
23691 | ||
23692 | As opposed to regular expression matching, fuzzy matching is very fuzzy. | |
23693 | It's so fuzzy that there's not even a definition of what @dfn{fuzziness} | |
23694 | means, and the implementation has changed over time. | |
23695 | ||
23696 | Basically, it tries to remove all noise from lines before comparing. | |
23697 | @samp{Re: }, parenthetical remarks, white space, and so on, are filtered | |
23698 | out of the strings before comparing the results. This often leads to | |
23699 | adequate results---even when faced with strings generated by text | |
23700 | manglers masquerading as newsreaders. | |
23701 | ||
23702 | ||
23703 | @node Thwarting Email Spam | |
23704 | @section Thwarting Email Spam | |
23705 | @cindex email spam | |
23706 | @cindex spam | |
23707 | @cindex UCE | |
23708 | @cindex unsolicited commercial email | |
23709 | ||
23710 | In these last days of the Usenet, commercial vultures are hanging about | |
23711 | and grepping through news like crazy to find email addresses they can | |
23712 | foist off their scams and products to. As a reaction to this, many | |
23713 | people have started putting nonsense addresses into their @code{From} | |
23714 | lines. I think this is counterproductive---it makes it difficult for | |
23715 | people to send you legitimate mail in response to things you write, as | |
23716 | well as making it difficult to see who wrote what. This rewriting may | |
23717 | perhaps be a bigger menace than the unsolicited commercial email itself | |
23718 | in the end. | |
23719 | ||
23720 | The biggest problem I have with email spam is that it comes in under | |
23721 | false pretenses. I press @kbd{g} and Gnus merrily informs me that I | |
23722 | have 10 new emails. I say ``Golly gee! Happy is me!'' and select the | |
23723 | mail group, only to find two pyramid schemes, seven advertisements | |
23724 | (``New! Miracle tonic for growing full, lustrous hair on your toes!'') | |
23725 | and one mail asking me to repent and find some god. | |
23726 | ||
23727 | This is annoying. Here's what you can do about it. | |
23728 | ||
23729 | @menu | |
23730 | * The problem of spam:: Some background, and some solutions | |
23731 | * Anti-Spam Basics:: Simple steps to reduce the amount of spam. | |
23732 | * SpamAssassin:: How to use external anti-spam tools. | |
23733 | * Hashcash:: Reduce spam by burning CPU time. | |
23734 | @end menu | |
23735 | ||
23736 | @node The problem of spam | |
23737 | @subsection The problem of spam | |
23738 | @cindex email spam | |
23739 | @cindex spam filtering approaches | |
23740 | @cindex filtering approaches, spam | |
23741 | @cindex UCE | |
23742 | @cindex unsolicited commercial email | |
23743 | ||
23744 | First, some background on spam. | |
23745 | ||
23746 | If you have access to e-mail, you are familiar with spam (technically | |
23747 | termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it | |
23748 | exists because e-mail delivery is very cheap compared to paper mail, | |
23749 | so only a very small percentage of people need to respond to an UCE to | |
23750 | make it worthwhile to the advertiser. Ironically, one of the most | |
23751 | common spams is the one offering a database of e-mail addresses for | |
23752 | further spamming. Senders of spam are usually called @emph{spammers}, | |
23753 | but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and | |
23754 | @emph{morons} are in common use as well. | |
23755 | ||
23756 | Spam comes from a wide variety of sources. It is simply impossible to | |
23757 | dispose of all spam without discarding useful messages. A good | |
23758 | example is the TMDA system, which requires senders | |
23759 | unknown to you to confirm themselves as legitimate senders before | |
23760 | their e-mail can reach you. Without getting into the technical side | |
23761 | of TMDA, a downside is clearly that e-mail from legitimate sources may | |
23762 | be discarded if those sources can't or won't confirm themselves | |
23763 | through the TMDA system. Another problem with TMDA is that it | |
23764 | requires its users to have a basic understanding of e-mail delivery | |
23765 | and processing. | |
23766 | ||
23767 | The simplest approach to filtering spam is filtering, at the mail | |
23768 | server or when you sort through incoming mail. If you get 200 spam | |
23769 | messages per day from @samp{random-address@@vmadmin.com}, you block | |
23770 | @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you | |
23771 | discard all messages with @samp{VIAGRA} in the message. If you get | |
23772 | lots of spam from Bulgaria, for example, you try to filter all mail | |
23773 | from Bulgarian IPs. | |
23774 | ||
23775 | This, unfortunately, is a great way to discard legitimate e-mail. The | |
23776 | risks of blocking a whole country (Bulgaria, Norway, Nigeria, China, | |
23777 | etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting | |
23778 | you should be obvious, so don't do it if you have the choice. | |
23779 | ||
23780 | In another instance, the very informative and useful RISKS digest has | |
23781 | been blocked by overzealous mail filters because it @strong{contained} | |
23782 | words that were common in spam messages. Nevertheless, in isolated | |
23783 | cases, with great care, direct filtering of mail can be useful. | |
23784 | ||
23785 | Another approach to filtering e-mail is the distributed spam | |
23786 | processing, for instance DCC implements such a system. In essence, | |
23787 | @var{N} systems around the world agree that a machine @var{X} in | |
23788 | Ghana, Estonia, or California is sending out spam e-mail, and these | |
23789 | @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a | |
23790 | database. The criteria for spam detection vary---it may be the number | |
23791 | of messages sent, the content of the messages, and so on. When a user | |
23792 | of the distributed processing system wants to find out if a message is | |
23793 | spam, he consults one of those @var{N} systems. | |
23794 | ||
23795 | Distributed spam processing works very well against spammers that send | |
23796 | a large number of messages at once, but it requires the user to set up | |
23797 | fairly complicated checks. There are commercial and free distributed | |
23798 | spam processing systems. Distributed spam processing has its risks as | |
23799 | well. For instance legitimate e-mail senders have been accused of | |
23800 | sending spam, and their web sites and mailing lists have been shut | |
23801 | down for some time because of the incident. | |
23802 | ||
23803 | The statistical approach to spam filtering is also popular. It is | |
23804 | based on a statistical analysis of previous spam messages. Usually | |
23805 | the analysis is a simple word frequency count, with perhaps pairs of | |
23806 | words or 3-word combinations thrown into the mix. Statistical | |
23807 | analysis of spam works very well in most of the cases, but it can | |
23808 | classify legitimate e-mail as spam in some cases. It takes time to | |
23809 | run the analysis, the full message must be analyzed, and the user has | |
23810 | to store the database of spam analysis. Statistical analysis on the | |
23811 | server is gaining popularity. This has the advantage of letting the | |
23812 | user Just Read Mail, but has the disadvantage that it's harder to tell | |
23813 | the server that it has misclassified mail. | |
23814 | ||
23815 | Fighting spam is not easy, no matter what anyone says. There is no | |
23816 | magic switch that will distinguish Viagra ads from Mom's e-mails. | |
23817 | Even people are having a hard time telling spam apart from non-spam, | |
23818 | because spammers are actively looking to fool us into thinking they | |
23819 | are Mom, essentially. Spamming is irritating, irresponsible, and | |
23820 | idiotic behavior from a bunch of people who think the world owes them | |
23821 | a favor. We hope the following sections will help you in fighting the | |
23822 | spam plague. | |
23823 | ||
23824 | @node Anti-Spam Basics | |
23825 | @subsection Anti-Spam Basics | |
23826 | @cindex email spam | |
23827 | @cindex spam | |
23828 | @cindex UCE | |
23829 | @cindex unsolicited commercial email | |
23830 | ||
23831 | One way of dealing with spam is having Gnus split out all spam into a | |
23832 | @samp{spam} mail group (@pxref{Splitting Mail}). | |
23833 | ||
23834 | First, pick one (1) valid mail address that you can be reached at, and | |
23835 | put it in your @code{From} header of all your news articles. (I've | |
23836 | chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form | |
23837 | @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your | |
23838 | sysadmin whether your sendmail installation accepts keywords in the local | |
23839 | part of the mail address.) | |
23840 | ||
23841 | @lisp | |
23842 | (setq message-default-news-headers | |
23843 | "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n") | |
23844 | @end lisp | |
23845 | ||
23846 | Then put the following split rule in @code{nnmail-split-fancy} | |
23847 | (@pxref{Fancy Mail Splitting}): | |
23848 | ||
23849 | @lisp | |
23850 | (... | |
23851 | (to "larsi@@trym.ifi.uio.no" | |
23852 | (| ("subject" "re:.*" "misc") | |
23853 | ("references" ".*@@.*" "misc") | |
23854 | "spam")) | |
23855 | ...) | |
23856 | @end lisp | |
23857 | ||
23858 | This says that all mail to this address is suspect, but if it has a | |
23859 | @code{Subject} that starts with a @samp{Re:} or has a @code{References} | |
23860 | header, it's probably ok. All the rest goes to the @samp{spam} group. | |
23861 | (This idea probably comes from Tim Pierce.) | |
23862 | ||
23863 | In addition, many mail spammers talk directly to your @acronym{SMTP} server | |
23864 | and do not include your email address explicitly in the @code{To} | |
23865 | header. Why they do this is unknown---perhaps it's to thwart this | |
23866 | thwarting scheme? In any case, this is trivial to deal with---you just | |
23867 | put anything not addressed to you in the @samp{spam} group by ending | |
23868 | your fancy split rule in this way: | |
23869 | ||
23870 | @lisp | |
23871 | ( | |
23872 | ... | |
23873 | (to "larsi" "misc") | |
23874 | "spam") | |
23875 | @end lisp | |
23876 | ||
23877 | In my experience, this will sort virtually everything into the right | |
23878 | group. You still have to check the @samp{spam} group from time to time to | |
23879 | check for legitimate mail, though. If you feel like being a good net | |
23880 | citizen, you can even send off complaints to the proper authorities on | |
23881 | each unsolicited commercial email---at your leisure. | |
23882 | ||
23883 | This works for me. It allows people an easy way to contact me (they can | |
23884 | just press @kbd{r} in the usual way), and I'm not bothered at all with | |
23885 | spam. It's a win-win situation. Forging @code{From} headers to point | |
23886 | to non-existent domains is yucky, in my opinion. | |
23887 | ||
23888 | Be careful with this approach. Spammers are wise to it. | |
23889 | ||
23890 | ||
23891 | @node SpamAssassin | |
23892 | @subsection SpamAssassin, Vipul's Razor, DCC, etc | |
23893 | @cindex SpamAssassin | |
23894 | @cindex Vipul's Razor | |
23895 | @cindex DCC | |
23896 | ||
23897 | The days where the hints in the previous section were sufficient in | |
23898 | avoiding spam are coming to an end. There are many tools out there | |
23899 | that claim to reduce the amount of spam you get. This section could | |
23900 | easily become outdated fast, as new products replace old, but | |
23901 | fortunately most of these tools seem to have similar interfaces. Even | |
23902 | though this section will use SpamAssassin as an example, it should be | |
23903 | easy to adapt it to most other tools. | |
23904 | ||
23905 | Note that this section does not involve the @code{spam.el} package, | |
23906 | which is discussed in the next section. If you don't care for all | |
23907 | the features of @code{spam.el}, you can make do with these simple | |
23908 | recipes. | |
23909 | ||
23910 | If the tool you are using is not installed on the mail server, you | |
23911 | need to invoke it yourself. Ideas on how to use the | |
23912 | @code{:postscript} mail source parameter (@pxref{Mail Source | |
23913 | Specifiers}) follow. | |
23914 | ||
23915 | @lisp | |
23916 | (setq mail-sources | |
23917 | '((file :prescript "formail -bs spamassassin < /var/mail/%u") | |
23918 | (pop :user "jrl" | |
23919 | :server "pophost" | |
23920 | :postscript | |
23921 | "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t"))) | |
23922 | @end lisp | |
23923 | ||
23924 | Once you manage to process your incoming spool somehow, thus making | |
1df7defd | 23925 | the mail contain, e.g., a header indicating it is spam, you are ready to |
4009494e GM |
23926 | filter it out. Using normal split methods (@pxref{Splitting Mail}): |
23927 | ||
23928 | @lisp | |
23929 | (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES") | |
23930 | ...)) | |
23931 | @end lisp | |
23932 | ||
23933 | Or using fancy split methods (@pxref{Fancy Mail Splitting}): | |
23934 | ||
23935 | @lisp | |
23936 | (setq nnmail-split-methods 'nnmail-split-fancy | |
23937 | nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam") | |
23938 | ...)) | |
23939 | @end lisp | |
23940 | ||
23941 | Some people might not like the idea of piping the mail through various | |
23942 | programs using a @code{:prescript} (if some program is buggy, you | |
23943 | might lose all mail). If you are one of them, another solution is to | |
23944 | call the external tools during splitting. Example fancy split method: | |
23945 | ||
23946 | @lisp | |
23947 | (setq nnmail-split-fancy '(| (: kevin-spamassassin) | |
23948 | ...)) | |
23949 | (defun kevin-spamassassin () | |
23950 | (save-excursion | |
23951 | (save-restriction | |
23952 | (widen) | |
23953 | (if (eq 1 (call-process-region (point-min) (point-max) | |
23954 | "spamc" nil nil nil "-c")) | |
23955 | "spam")))) | |
23956 | @end lisp | |
23957 | ||
01c52d31 | 23958 | Note that with the nnimap back end, message bodies will not be |
4009494e GM |
23959 | downloaded by default. You need to set |
23960 | @code{nnimap-split-download-body} to @code{t} to do that | |
229b59da | 23961 | (@pxref{Client-Side IMAP Splitting}). |
4009494e GM |
23962 | |
23963 | That is about it. As some spam is likely to get through anyway, you | |
23964 | might want to have a nifty function to call when you happen to read | |
23965 | spam. And here is the nifty function: | |
23966 | ||
23967 | @lisp | |
d62672f3 | 23968 | (defun my-gnus-raze-spam () |
4009494e GM |
23969 | "Submit SPAM to Vipul's Razor, then mark it as expirable." |
23970 | (interactive) | |
d62672f3 | 23971 | (gnus-summary-save-in-pipe "razor-report -f -d" t) |
4009494e GM |
23972 | (gnus-summary-mark-as-expirable 1)) |
23973 | @end lisp | |
23974 | ||
23975 | @node Hashcash | |
23976 | @subsection Hashcash | |
23977 | @cindex hashcash | |
23978 | ||
23979 | A novel technique to fight spam is to require senders to do something | |
01c52d31 MB |
23980 | costly and demonstrably unique for each message they send. This has |
23981 | the obvious drawback that you cannot rely on everyone in the world | |
23982 | using this technique, since it is not part of the Internet standards, | |
23983 | but it may be useful in smaller communities. | |
4009494e GM |
23984 | |
23985 | While the tools in the previous section work well in practice, they | |
23986 | work only because the tools are constantly maintained and updated as | |
23987 | new form of spam appears. This means that a small percentage of spam | |
23988 | will always get through. It also means that somewhere, someone needs | |
23989 | to read lots of spam to update these tools. Hashcash avoids that, but | |
23990 | instead prefers that everyone you contact through e-mail supports the | |
23991 | scheme. You can view the two approaches as pragmatic vs dogmatic. | |
23992 | The approaches have their own advantages and disadvantages, but as | |
23993 | often in the real world, a combination of them is stronger than either | |
23994 | one of them separately. | |
23995 | ||
23996 | @cindex X-Hashcash | |
23997 | The ``something costly'' is to burn CPU time, more specifically to | |
23998 | compute a hash collision up to a certain number of bits. The | |
01c52d31 MB |
23999 | resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header. |
24000 | For more details, and for the external application @code{hashcash} you | |
24001 | need to install to use this feature, see | |
24002 | @uref{http://www.hashcash.org/}. Even more information can be found | |
24003 | at @uref{http://www.camram.org/}. | |
4009494e | 24004 | |
01c52d31 MB |
24005 | If you wish to generate hashcash for each message you send, you can |
24006 | customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail | |
24007 | Headers,message, The Message Manual}), as in: | |
4009494e GM |
24008 | |
24009 | @lisp | |
01c52d31 | 24010 | (setq message-generate-hashcash t) |
4009494e GM |
24011 | @end lisp |
24012 | ||
4009494e GM |
24013 | You will need to set up some additional variables as well: |
24014 | ||
24015 | @table @code | |
24016 | ||
24017 | @item hashcash-default-payment | |
24018 | @vindex hashcash-default-payment | |
24019 | This variable indicates the default number of bits the hash collision | |
01c52d31 MB |
24020 | should consist of. By default this is 20. Suggested useful values |
24021 | include 17 to 29. | |
4009494e GM |
24022 | |
24023 | @item hashcash-payment-alist | |
24024 | @vindex hashcash-payment-alist | |
24025 | Some receivers may require you to spend burn more CPU time than the | |
24026 | default. This variable contains a list of @samp{(@var{addr} | |
24027 | @var{amount})} cells, where @var{addr} is the receiver (email address | |
24028 | or newsgroup) and @var{amount} is the number of bits in the collision | |
24029 | that is needed. It can also contain @samp{(@var{addr} @var{string} | |
24030 | @var{amount})} cells, where the @var{string} is the string to use | |
24031 | (normally the email address or newsgroup name is used). | |
24032 | ||
01c52d31 MB |
24033 | @item hashcash-path |
24034 | @vindex hashcash-path | |
24035 | Where the @code{hashcash} binary is installed. This variable should | |
24036 | be automatically set by @code{executable-find}, but if it's @code{nil} | |
24037 | (usually because the @code{hashcash} binary is not in your path) | |
24038 | you'll get a warning when you check hashcash payments and an error | |
24039 | when you generate hashcash payments. | |
4009494e GM |
24040 | |
24041 | @end table | |
24042 | ||
01c52d31 MB |
24043 | Gnus can verify hashcash cookies, although this can also be done by |
24044 | hand customized mail filtering scripts. To verify a hashcash cookie | |
24045 | in a message, use the @code{mail-check-payment} function in the | |
24046 | @code{hashcash.el} library. You can also use the @code{spam.el} | |
24047 | package with the @code{spam-use-hashcash} back end to validate hashcash | |
24048 | cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam | |
24049 | Hashcash Payments}). | |
4009494e GM |
24050 | |
24051 | @node Spam Package | |
24052 | @section Spam Package | |
24053 | @cindex spam filtering | |
24054 | @cindex spam | |
24055 | ||
24056 | The Spam package provides Gnus with a centralized mechanism for | |
24057 | detecting and filtering spam. It filters new mail, and processes | |
24058 | messages according to whether they are spam or ham. (@dfn{Ham} is the | |
24059 | name used throughout this manual to indicate non-spam messages.) | |
24060 | ||
24061 | @menu | |
24062 | * Spam Package Introduction:: | |
24063 | * Filtering Incoming Mail:: | |
24064 | * Detecting Spam in Groups:: | |
24065 | * Spam and Ham Processors:: | |
24066 | * Spam Package Configuration Examples:: | |
24067 | * Spam Back Ends:: | |
24068 | * Extending the Spam package:: | |
24069 | * Spam Statistics Package:: | |
24070 | @end menu | |
24071 | ||
24072 | @node Spam Package Introduction | |
24073 | @subsection Spam Package Introduction | |
24074 | @cindex spam filtering | |
24075 | @cindex spam filtering sequence of events | |
24076 | @cindex spam | |
24077 | ||
24078 | You must read this section to understand how the Spam package works. | |
24079 | Do not skip, speed-read, or glance through this section. | |
24080 | ||
01c52d31 MB |
24081 | Make sure you read the section on the @code{spam.el} sequence of |
24082 | events. See @xref{Extending the Spam package}. | |
24083 | ||
4009494e GM |
24084 | @cindex spam-initialize |
24085 | @vindex spam-use-stat | |
24086 | To use the Spam package, you @strong{must} first run the function | |
24087 | @code{spam-initialize}: | |
24088 | ||
24089 | @example | |
24090 | (spam-initialize) | |
24091 | @end example | |
24092 | ||
24093 | This autoloads @code{spam.el} and installs the various hooks necessary | |
24094 | to let the Spam package do its job. In order to make use of the Spam | |
24095 | package, you have to set up certain group parameters and variables, | |
24096 | which we will describe below. All of the variables controlling the | |
24097 | Spam package can be found in the @samp{spam} customization group. | |
24098 | ||
24099 | There are two ``contact points'' between the Spam package and the rest | |
24100 | of Gnus: checking new mail for spam, and leaving a group. | |
24101 | ||
24102 | Checking new mail for spam is done in one of two ways: while splitting | |
24103 | incoming mail, or when you enter a group. | |
24104 | ||
24105 | The first way, checking for spam while splitting incoming mail, is | |
24106 | suited to mail back ends such as @code{nnml} or @code{nnimap}, where | |
24107 | new mail appears in a single spool file. The Spam package processes | |
24108 | incoming mail, and sends mail considered to be spam to a designated | |
24109 | ``spam'' group. @xref{Filtering Incoming Mail}. | |
24110 | ||
24111 | The second way is suited to back ends such as @code{nntp}, which have | |
24112 | no incoming mail spool, or back ends where the server is in charge of | |
24113 | splitting incoming mail. In this case, when you enter a Gnus group, | |
24114 | the unseen or unread messages in that group are checked for spam. | |
24115 | Detected spam messages are marked as spam. @xref{Detecting Spam in | |
24116 | Groups}. | |
24117 | ||
24118 | @cindex spam back ends | |
24119 | In either case, you have to tell the Spam package what method to use | |
24120 | to detect spam messages. There are several methods, or @dfn{spam back | |
24121 | ends} (not to be confused with Gnus back ends!) to choose from: spam | |
24122 | ``blacklists'' and ``whitelists'', dictionary-based filters, and so | |
24123 | forth. @xref{Spam Back Ends}. | |
24124 | ||
24125 | In the Gnus summary buffer, messages that have been identified as spam | |
24126 | always appear with a @samp{$} symbol. | |
24127 | ||
24128 | The Spam package divides Gnus groups into three categories: ham | |
24129 | groups, spam groups, and unclassified groups. You should mark each of | |
24130 | the groups you subscribe to as either a ham group or a spam group, | |
24131 | using the @code{spam-contents} group parameter (@pxref{Group | |
24132 | Parameters}). Spam groups have a special property: when you enter a | |
24133 | spam group, all unseen articles are marked as spam. Thus, mail split | |
24134 | into a spam group is automatically marked as spam. | |
24135 | ||
24136 | Identifying spam messages is only half of the Spam package's job. The | |
24137 | second half comes into play whenever you exit a group buffer. At this | |
24138 | point, the Spam package does several things: | |
24139 | ||
24140 | First, it calls @dfn{spam and ham processors} to process the articles | |
24141 | according to whether they are spam or ham. There is a pair of spam | |
24142 | and ham processors associated with each spam back end, and what the | |
24143 | processors do depends on the back end. At present, the main role of | |
24144 | spam and ham processors is for dictionary-based spam filters: they add | |
24145 | the contents of the messages in the group to the filter's dictionary, | |
24146 | to improve its ability to detect future spam. The @code{spam-process} | |
24147 | group parameter specifies what spam processors to use. @xref{Spam and | |
24148 | Ham Processors}. | |
24149 | ||
24150 | If the spam filter failed to mark a spam message, you can mark it | |
24151 | yourself, so that the message is processed as spam when you exit the | |
24152 | group: | |
24153 | ||
24154 | @table @kbd | |
f7aa248a G |
24155 | @item $ |
24156 | @itemx M-d | |
4009494e GM |
24157 | @itemx M s x |
24158 | @itemx S x | |
f7aa248a G |
24159 | @kindex $ (Summary) |
24160 | @kindex M-d (Summary) | |
24161 | @kindex S x (Summary) | |
24162 | @kindex M s x (Summary) | |
4009494e GM |
24163 | @findex gnus-summary-mark-as-spam |
24164 | @findex gnus-summary-mark-as-spam | |
24165 | Mark current article as spam, showing it with the @samp{$} mark | |
24166 | (@code{gnus-summary-mark-as-spam}). | |
24167 | @end table | |
24168 | ||
24169 | @noindent | |
24170 | Similarly, you can unmark an article if it has been erroneously marked | |
24171 | as spam. @xref{Setting Marks}. | |
24172 | ||
24173 | Normally, a ham message found in a non-ham group is not processed as | |
24174 | ham---the rationale is that it should be moved into a ham group for | |
24175 | further processing (see below). However, you can force these articles | |
24176 | to be processed as ham by setting | |
24177 | @code{spam-process-ham-in-spam-groups} and | |
24178 | @code{spam-process-ham-in-nonham-groups}. | |
24179 | ||
24180 | @vindex gnus-ham-process-destinations | |
24181 | @vindex gnus-spam-process-destinations | |
24182 | The second thing that the Spam package does when you exit a group is | |
24183 | to move ham articles out of spam groups, and spam articles out of ham | |
24184 | groups. Ham in a spam group is moved to the group specified by the | |
24185 | variable @code{gnus-ham-process-destinations}, or the group parameter | |
24186 | @code{ham-process-destination}. Spam in a ham group is moved to the | |
24187 | group specified by the variable @code{gnus-spam-process-destinations}, | |
24188 | or the group parameter @code{spam-process-destination}. If these | |
24189 | variables are not set, the articles are left in their current group. | |
24190 | If an article cannot be moved (e.g., with a read-only backend such | |
24191 | as @acronym{NNTP}), it is copied. | |
24192 | ||
24193 | If an article is moved to another group, it is processed again when | |
24194 | you visit the new group. Normally, this is not a problem, but if you | |
24195 | want each article to be processed only once, load the | |
24196 | @code{gnus-registry.el} package and set the variable | |
24197 | @code{spam-log-to-registry} to @code{t}. @xref{Spam Package | |
24198 | Configuration Examples}. | |
24199 | ||
24200 | Normally, spam groups ignore @code{gnus-spam-process-destinations}. | |
24201 | However, if you set @code{spam-move-spam-nonspam-groups-only} to | |
24202 | @code{nil}, spam will also be moved out of spam groups, depending on | |
24203 | the @code{spam-process-destination} parameter. | |
24204 | ||
24205 | The final thing the Spam package does is to mark spam articles as | |
24206 | expired, which is usually the right thing to do. | |
24207 | ||
24208 | If all this seems confusing, don't worry. Soon it will be as natural | |
24209 | as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's | |
24210 | 50 years in the future yet. Just trust us, it's not so bad. | |
24211 | ||
24212 | @node Filtering Incoming Mail | |
24213 | @subsection Filtering Incoming Mail | |
24214 | @cindex spam filtering | |
24215 | @cindex spam filtering incoming mail | |
24216 | @cindex spam | |
24217 | ||
24218 | To use the Spam package to filter incoming mail, you must first set up | |
24219 | fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package | |
24220 | defines a special splitting function that you can add to your fancy | |
24221 | split variable (either @code{nnmail-split-fancy} or | |
24222 | @code{nnimap-split-fancy}, depending on your mail back end): | |
24223 | ||
24224 | @example | |
24225 | (: spam-split) | |
24226 | @end example | |
24227 | ||
24228 | @vindex spam-split-group | |
24229 | @noindent | |
24230 | The @code{spam-split} function scans incoming mail according to your | |
24231 | chosen spam back end(s), and sends messages identified as spam to a | |
24232 | spam group. By default, the spam group is a group named @samp{spam}, | |
24233 | but you can change this by customizing @code{spam-split-group}. Make | |
24234 | sure the contents of @code{spam-split-group} are an unqualified group | |
24235 | name. For instance, in an @code{nnimap} server @samp{your-server}, | |
24236 | the value @samp{spam} means @samp{nnimap+your-server:spam}. The value | |
24237 | @samp{nnimap+server:spam} is therefore wrong---it gives the group | |
24238 | @samp{nnimap+your-server:nnimap+server:spam}. | |
24239 | ||
24240 | @code{spam-split} does not modify the contents of messages in any way. | |
24241 | ||
24242 | @vindex nnimap-split-download-body | |
24243 | Note for IMAP users: if you use the @code{spam-check-bogofilter}, | |
24244 | @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends, | |
8ccbef23 G |
24245 | you should also set the variable @code{nnimap-split-download-body} to |
24246 | @code{t}. These spam back ends are most useful when they can ``scan'' | |
24247 | the full message body. By default, the nnimap back end only retrieves | |
24248 | the message headers; @code{nnimap-split-download-body} tells it to | |
24249 | retrieve the message bodies as well. We don't set this by default | |
24250 | because it will slow @acronym{IMAP} down, and that is not an | |
24251 | appropriate decision to make on behalf of the user. @xref{Client-Side | |
229b59da | 24252 | IMAP Splitting}. |
4009494e GM |
24253 | |
24254 | You have to specify one or more spam back ends for @code{spam-split} | |
24255 | to use, by setting the @code{spam-use-*} variables. @xref{Spam Back | |
24256 | Ends}. Normally, @code{spam-split} simply uses all the spam back ends | |
24257 | you enabled in this way. However, you can tell @code{spam-split} to | |
24258 | use only some of them. Why this is useful? Suppose you are using the | |
24259 | @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back | |
24260 | ends, and the following split rule: | |
24261 | ||
24262 | @example | |
24263 | nnimap-split-fancy '(| | |
24264 | (any "ding" "ding") | |
24265 | (: spam-split) | |
24266 | ;; @r{default mailbox} | |
24267 | "mail") | |
24268 | @end example | |
24269 | ||
24270 | @noindent | |
24271 | The problem is that you want all ding messages to make it to the ding | |
24272 | folder. But that will let obvious spam (for example, spam detected by | |
24273 | SpamAssassin, and @code{spam-use-regex-headers}) through, when it's | |
24274 | sent to the ding list. On the other hand, some messages to the ding | |
24275 | list are from a mail server in the blackhole list, so the invocation | |
24276 | of @code{spam-split} can't be before the ding rule. | |
24277 | ||
24278 | The solution is to let SpamAssassin headers supersede ding rules, and | |
24279 | perform the other @code{spam-split} rules (including a second | |
24280 | invocation of the regex-headers check) after the ding rule. This is | |
24281 | done by passing a parameter to @code{spam-split}: | |
24282 | ||
24283 | @example | |
24284 | nnimap-split-fancy | |
24285 | '(| | |
24286 | ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}} | |
24287 | (: spam-split "regex-spam" 'spam-use-regex-headers) | |
24288 | (any "ding" "ding") | |
24289 | ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}} | |
24290 | (: spam-split) | |
24291 | ;; @r{default mailbox} | |
24292 | "mail") | |
24293 | @end example | |
24294 | ||
24295 | @noindent | |
24296 | This lets you invoke specific @code{spam-split} checks depending on | |
24297 | your particular needs, and target the results of those checks to a | |
24298 | particular spam group. You don't have to throw all mail into all the | |
24299 | spam tests. Another reason why this is nice is that messages to | |
24300 | mailing lists you have rules for don't have to have resource-intensive | |
24301 | blackhole checks performed on them. You could also specify different | |
24302 | spam checks for your nnmail split vs. your nnimap split. Go crazy. | |
24303 | ||
24304 | You should set the @code{spam-use-*} variables for whatever spam back | |
24305 | ends you intend to use. The reason is that when loading | |
24306 | @file{spam.el}, some conditional loading is done depending on what | |
24307 | @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}. | |
24308 | ||
24309 | @c @emph{TODO: spam.el needs to provide a uniform way of training all the | |
24310 | @c statistical databases. Some have that functionality built-in, others | |
24311 | @c don't.} | |
24312 | ||
24313 | @node Detecting Spam in Groups | |
24314 | @subsection Detecting Spam in Groups | |
24315 | ||
24316 | To detect spam when visiting a group, set the group's | |
24317 | @code{spam-autodetect} and @code{spam-autodetect-methods} group | |
24318 | parameters. These are accessible with @kbd{G c} or @kbd{G p}, as | |
24319 | usual (@pxref{Group Parameters}). | |
24320 | ||
24321 | You should set the @code{spam-use-*} variables for whatever spam back | |
24322 | ends you intend to use. The reason is that when loading | |
24323 | @file{spam.el}, some conditional loading is done depending on what | |
24324 | @code{spam-use-xyz} variables you have set. | |
24325 | ||
24326 | By default, only unseen articles are processed for spam. You can | |
24327 | force Gnus to recheck all messages in the group by setting the | |
24328 | variable @code{spam-autodetect-recheck-messages} to @code{t}. | |
24329 | ||
24330 | If you use the @code{spam-autodetect} method of checking for spam, you | |
24331 | can specify different spam detection methods for different groups. | |
24332 | For instance, the @samp{ding} group may have @code{spam-use-BBDB} as | |
24333 | the autodetection method, while the @samp{suspect} group may have the | |
24334 | @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods | |
24335 | enabled. Unlike with @code{spam-split}, you don't have any control | |
24336 | over the @emph{sequence} of checks, but this is probably unimportant. | |
24337 | ||
24338 | @node Spam and Ham Processors | |
24339 | @subsection Spam and Ham Processors | |
24340 | @cindex spam filtering | |
24341 | @cindex spam filtering variables | |
24342 | @cindex spam variables | |
24343 | @cindex spam | |
24344 | ||
24345 | @vindex gnus-spam-process-newsgroups | |
24346 | Spam and ham processors specify special actions to take when you exit | |
24347 | a group buffer. Spam processors act on spam messages, and ham | |
24348 | processors on ham messages. At present, the main role of these | |
24349 | processors is to update the dictionaries of dictionary-based spam back | |
24350 | ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics | |
24351 | package (@pxref{Spam Statistics Filtering}). | |
24352 | ||
24353 | The spam and ham processors that apply to each group are determined by | |
24354 | the group's@code{spam-process} group parameter. If this group | |
24355 | parameter is not defined, they are determined by the variable | |
24356 | @code{gnus-spam-process-newsgroups}. | |
24357 | ||
24358 | @vindex gnus-spam-newsgroup-contents | |
24359 | Gnus learns from the spam you get. You have to collect your spam in | |
24360 | one or more spam groups, and set or customize the variable | |
24361 | @code{spam-junk-mailgroups} as appropriate. You can also declare | |
24362 | groups to contain spam by setting their group parameter | |
24363 | @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or | |
24364 | by customizing the corresponding variable | |
24365 | @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group | |
24366 | parameter and the @code{gnus-spam-newsgroup-contents} variable can | |
24367 | also be used to declare groups as @emph{ham} groups if you set their | |
24368 | classification to @code{gnus-group-spam-classification-ham}. If | |
24369 | groups are not classified by means of @code{spam-junk-mailgroups}, | |
24370 | @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are | |
24371 | considered @emph{unclassified}. All groups are unclassified by | |
24372 | default. | |
24373 | ||
24374 | @vindex gnus-spam-mark | |
24375 | @cindex $ | |
24376 | In spam groups, all messages are considered to be spam by default: | |
24377 | they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the | |
24378 | group. If you have seen a message, had it marked as spam, then | |
24379 | unmarked it, it won't be marked as spam when you enter the group | |
24380 | thereafter. You can disable that behavior, so all unread messages | |
24381 | will get the @samp{$} mark, if you set the | |
24382 | @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You | |
24383 | should remove the @samp{$} mark when you are in the group summary | |
24384 | buffer for every message that is not spam after all. To remove the | |
24385 | @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or | |
24386 | @kbd{d} for declaring it read the non-spam way. When you leave a | |
24387 | group, all spam-marked (@samp{$}) articles are sent to a spam | |
24388 | processor which will study them as spam samples. | |
24389 | ||
24390 | Messages may also be deleted in various other ways, and unless | |
24391 | @code{ham-marks} group parameter gets overridden below, marks @samp{R} | |
24392 | and @samp{r} for default read or explicit delete, marks @samp{X} and | |
24393 | @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for | |
24394 | low scores, are all considered to be associated with articles which | |
24395 | are not spam. This assumption might be false, in particular if you | |
24396 | use kill files or score files as means for detecting genuine spam, you | |
24397 | should then adjust the @code{ham-marks} group parameter. | |
24398 | ||
24399 | @defvar ham-marks | |
24400 | You can customize this group or topic parameter to be the list of | |
24401 | marks you want to consider ham. By default, the list contains the | |
24402 | deleted, read, killed, kill-filed, and low-score marks (the idea is | |
24403 | that these articles have been read, but are not spam). It can be | |
24404 | useful to also include the tick mark in the ham marks. It is not | |
24405 | recommended to make the unread mark a ham mark, because it normally | |
24406 | indicates a lack of classification. But you can do it, and we'll be | |
24407 | happy for you. | |
24408 | @end defvar | |
24409 | ||
24410 | @defvar spam-marks | |
24411 | You can customize this group or topic parameter to be the list of | |
24412 | marks you want to consider spam. By default, the list contains only | |
24413 | the spam mark. It is not recommended to change that, but you can if | |
24414 | you really want to. | |
24415 | @end defvar | |
24416 | ||
24417 | When you leave @emph{any} group, regardless of its | |
24418 | @code{spam-contents} classification, all spam-marked articles are sent | |
24419 | to a spam processor, which will study these as spam samples. If you | |
24420 | explicit kill a lot, you might sometimes end up with articles marked | |
24421 | @samp{K} which you never saw, and which might accidentally contain | |
24422 | spam. Best is to make sure that real spam is marked with @samp{$}, | |
24423 | and nothing else. | |
24424 | ||
24425 | @vindex gnus-ham-process-destinations | |
24426 | When you leave a @emph{spam} group, all spam-marked articles are | |
24427 | marked as expired after processing with the spam processor. This is | |
24428 | not done for @emph{unclassified} or @emph{ham} groups. Also, any | |
24429 | @strong{ham} articles in a spam group will be moved to a location | |
24430 | determined by either the @code{ham-process-destination} group | |
24431 | parameter or a match in the @code{gnus-ham-process-destinations} | |
24432 | variable, which is a list of regular expressions matched with group | |
24433 | names (it's easiest to customize this variable with @kbd{M-x | |
24434 | customize-variable @key{RET} gnus-ham-process-destinations}). Each | |
24435 | group name list is a standard Lisp list, if you prefer to customize | |
24436 | the variable manually. If the @code{ham-process-destination} | |
24437 | parameter is not set, ham articles are left in place. If the | |
24438 | @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is | |
24439 | set, the ham articles are marked as unread before being moved. | |
24440 | ||
01c52d31 | 24441 | If ham can not be moved---because of a read-only back end such as |
4009494e GM |
24442 | @acronym{NNTP}, for example, it will be copied. |
24443 | ||
24444 | Note that you can use multiples destinations per group or regular | |
24445 | expression! This enables you to send your ham to a regular mail | |
24446 | group and to a @emph{ham training} group. | |
24447 | ||
24448 | When you leave a @emph{ham} group, all ham-marked articles are sent to | |
24449 | a ham processor, which will study these as non-spam samples. | |
24450 | ||
24451 | @vindex spam-process-ham-in-spam-groups | |
24452 | By default the variable @code{spam-process-ham-in-spam-groups} is | |
24453 | @code{nil}. Set it to @code{t} if you want ham found in spam groups | |
24454 | to be processed. Normally this is not done, you are expected instead | |
24455 | to send your ham to a ham group and process it there. | |
24456 | ||
24457 | @vindex spam-process-ham-in-nonham-groups | |
24458 | By default the variable @code{spam-process-ham-in-nonham-groups} is | |
24459 | @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam | |
24460 | or unclassified) groups to be processed. Normally this is not done, | |
24461 | you are expected instead to send your ham to a ham group and process | |
24462 | it there. | |
24463 | ||
24464 | @vindex gnus-spam-process-destinations | |
24465 | When you leave a @emph{ham} or @emph{unclassified} group, all | |
24466 | @strong{spam} articles are moved to a location determined by either | |
24467 | the @code{spam-process-destination} group parameter or a match in the | |
24468 | @code{gnus-spam-process-destinations} variable, which is a list of | |
24469 | regular expressions matched with group names (it's easiest to | |
24470 | customize this variable with @kbd{M-x customize-variable @key{RET} | |
24471 | gnus-spam-process-destinations}). Each group name list is a standard | |
24472 | Lisp list, if you prefer to customize the variable manually. If the | |
24473 | @code{spam-process-destination} parameter is not set, the spam | |
24474 | articles are only expired. The group name is fully qualified, meaning | |
24475 | that if you see @samp{nntp:servername} before the group name in the | |
24476 | group buffer then you need it here as well. | |
24477 | ||
01c52d31 | 24478 | If spam can not be moved---because of a read-only back end such as |
4009494e GM |
24479 | @acronym{NNTP}, for example, it will be copied. |
24480 | ||
24481 | Note that you can use multiples destinations per group or regular | |
24482 | expression! This enables you to send your spam to multiple @emph{spam | |
24483 | training} groups. | |
24484 | ||
24485 | @vindex spam-log-to-registry | |
24486 | The problem with processing ham and spam is that Gnus doesn't track | |
24487 | this processing by default. Enable the @code{spam-log-to-registry} | |
24488 | variable so @code{spam.el} will use @code{gnus-registry.el} to track | |
24489 | what articles have been processed, and avoid processing articles | |
24490 | multiple times. Keep in mind that if you limit the number of registry | |
24491 | entries, this won't work as well as it does without a limit. | |
24492 | ||
24493 | @vindex spam-mark-only-unseen-as-spam | |
24494 | Set this variable if you want only unseen articles in spam groups to | |
24495 | be marked as spam. By default, it is set. If you set it to | |
24496 | @code{nil}, unread articles will also be marked as spam. | |
24497 | ||
24498 | @vindex spam-mark-ham-unread-before-move-from-spam-group | |
24499 | Set this variable if you want ham to be unmarked before it is moved | |
24500 | out of the spam group. This is very useful when you use something | |
24501 | like the tick mark @samp{!} to mark ham---the article will be placed | |
24502 | in your @code{ham-process-destination}, unmarked as if it came fresh | |
24503 | from the mail server. | |
24504 | ||
24505 | @vindex spam-autodetect-recheck-messages | |
24506 | When autodetecting spam, this variable tells @code{spam.el} whether | |
24507 | only unseen articles or all unread articles should be checked for | |
24508 | spam. It is recommended that you leave it off. | |
24509 | ||
24510 | @node Spam Package Configuration Examples | |
24511 | @subsection Spam Package Configuration Examples | |
24512 | @cindex spam filtering | |
24513 | @cindex spam filtering configuration examples | |
24514 | @cindex spam configuration examples | |
24515 | @cindex spam | |
24516 | ||
24517 | @subsubheading Ted's setup | |
24518 | ||
24519 | From Ted Zlatanov <tzz@@lifelogs.com>. | |
24520 | @example | |
24521 | ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection} | |
24522 | ;; @r{see @file{gnus-registry.el} for more information} | |
24523 | (gnus-registry-initialize) | |
24524 | (spam-initialize) | |
24525 | ||
24526 | (setq | |
24527 | spam-log-to-registry t ; @r{for spam autodetection} | |
24528 | spam-use-BBDB t | |
24529 | spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)} | |
24530 | ;; @r{all groups with @samp{spam} in the name contain spam} | |
24531 | gnus-spam-newsgroup-contents | |
24532 | '(("spam" gnus-group-spam-classification-spam)) | |
24533 | ;; @r{see documentation for these} | |
24534 | spam-move-spam-nonspam-groups-only nil | |
24535 | spam-mark-only-unseen-as-spam t | |
24536 | spam-mark-ham-unread-before-move-from-spam-group t | |
4009494e | 24537 | ;; @r{understand what this does before you copy it to your own setup!} |
6b958814 | 24538 | ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual} |
4009494e GM |
24539 | nnimap-split-fancy '(| |
24540 | ;; @r{trace references to parents and put in their group} | |
24541 | (: gnus-registry-split-fancy-with-parent) | |
24542 | ;; @r{this will catch server-side SpamAssassin tags} | |
24543 | (: spam-split 'spam-use-regex-headers) | |
24544 | (any "ding" "ding") | |
24545 | ;; @r{note that spam by default will go to @samp{spam}} | |
24546 | (: spam-split) | |
24547 | ;; @r{default mailbox} | |
24548 | "mail")) | |
24549 | ||
24550 | ;; @r{my parameters, set with @kbd{G p}} | |
24551 | ||
24552 | ;; @r{all nnml groups, and all nnimap groups except} | |
24553 | ;; @r{@samp{nnimap+mail.lifelogs.com:train} and} | |
24554 | ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,} | |
24555 | ;; @r{because it must have been detected manually} | |
24556 | ||
24557 | ((spam-process-destination . "nnimap+mail.lifelogs.com:train")) | |
24558 | ||
24559 | ;; @r{all @acronym{NNTP} groups} | |
24560 | ;; @r{autodetect spam with the blacklist and ham with the BBDB} | |
24561 | ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB) | |
24562 | ;; @r{send all spam to the training group} | |
24563 | (spam-process-destination . "nnimap+mail.lifelogs.com:train")) | |
24564 | ||
24565 | ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam} | |
24566 | ((spam-autodetect . t)) | |
24567 | ||
24568 | ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group} | |
24569 | ||
24570 | ;; @r{this is a spam group} | |
24571 | ((spam-contents gnus-group-spam-classification-spam) | |
24572 | ||
24573 | ;; @r{any spam (which happens when I enter for all unseen messages,} | |
24574 | ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to} | |
24575 | ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham} | |
24576 | ||
24577 | (spam-process-destination "nnimap+mail.lifelogs.com:train") | |
24578 | ||
24579 | ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but} | |
24580 | ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training} | |
24581 | ||
24582 | (ham-process-destination "nnimap+mail.lifelogs.com:mail" | |
24583 | "nnimap+mail.lifelogs.com:trainham") | |
24584 | ;; @r{in this group, only @samp{!} marks are ham} | |
24585 | (ham-marks | |
24586 | (gnus-ticked-mark)) | |
24587 | ;; @r{remembers senders in the blacklist on the way out---this is} | |
24588 | ;; @r{definitely not needed, it just makes me feel better} | |
24589 | (spam-process (gnus-group-spam-exit-processor-blacklist))) | |
24590 | ||
24591 | ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training} | |
24592 | ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora} | |
24593 | ;; @r{recognizing ham---but Gnus has nothing to do with it.} | |
24594 | ||
24595 | @end example | |
24596 | ||
01c52d31 | 24597 | @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server |
4009494e GM |
24598 | From Reiner Steib <reiner.steib@@gmx.de>. |
24599 | ||
24600 | My provider has set up bogofilter (in combination with @acronym{DCC}) on | |
24601 | the mail server (@acronym{IMAP}). Recognized spam goes to | |
24602 | @samp{spam.detected}, the rest goes through the normal filter rules, | |
1df7defd | 24603 | i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false |
4009494e GM |
24604 | positives or negatives is done by copying or moving the article to |
24605 | @samp{training.ham} or @samp{training.spam} respectively. A cron job on | |
24606 | the server feeds those to bogofilter with the suitable ham or spam | |
24607 | options and deletes them from the @samp{training.ham} and | |
24608 | @samp{training.spam} folders. | |
24609 | ||
24610 | With the following entries in @code{gnus-parameters}, @code{spam.el} | |
24611 | does most of the job for me: | |
24612 | ||
24613 | @lisp | |
24614 | ("nnimap:spam\\.detected" | |
24615 | (gnus-article-sort-functions '(gnus-article-sort-by-chars)) | |
24616 | (ham-process-destination "nnimap:INBOX" "nnimap:training.ham") | |
24617 | (spam-contents gnus-group-spam-classification-spam)) | |
24618 | ("nnimap:\\(INBOX\\|other-folders\\)" | |
24619 | (spam-process-destination . "nnimap:training.spam") | |
24620 | (spam-contents gnus-group-spam-classification-ham)) | |
24621 | @end lisp | |
24622 | ||
24623 | @itemize | |
24624 | ||
24625 | @item @b{The Spam folder:} | |
24626 | ||
24627 | In the folder @samp{spam.detected}, I have to check for false positives | |
1df7defd | 24628 | (i.e., legitimate mails, that were wrongly judged as spam by |
4009494e GM |
24629 | bogofilter or DCC). |
24630 | ||
24631 | Because of the @code{gnus-group-spam-classification-spam} entry, all | |
24632 | messages are marked as spam (with @code{$}). When I find a false | |
24633 | positive, I mark the message with some other ham mark | |
24634 | (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit, | |
24635 | those messages are copied to both groups, @samp{INBOX} (where I want | |
24636 | to have the article) and @samp{training.ham} (for training bogofilter) | |
24637 | and deleted from the @samp{spam.detected} folder. | |
24638 | ||
24639 | The @code{gnus-article-sort-by-chars} entry simplifies detection of | |
24640 | false positives for me. I receive lots of worms (sweN, @dots{}), that all | |
1df7defd | 24641 | have a similar size. Grouping them by size (i.e., chars) makes finding |
4009494e GM |
24642 | other false positives easier. (Of course worms aren't @i{spam} |
24643 | (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is | |
24644 | an excellent tool for filtering those unwanted mails for me.) | |
24645 | ||
24646 | @item @b{Ham folders:} | |
24647 | ||
24648 | In my ham folders, I just hit @kbd{S x} | |
24649 | (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam | |
24650 | mail (false negative). On group exit, those messages are moved to | |
01c52d31 | 24651 | @samp{training.spam}. |
4009494e GM |
24652 | @end itemize |
24653 | ||
24654 | @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el} | |
24655 | ||
24656 | From Reiner Steib <reiner.steib@@gmx.de>. | |
24657 | ||
24658 | With following entry in @code{gnus-parameters}, @kbd{S x} | |
24659 | (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*} | |
24660 | groups as spam and reports the to Gmane at group exit: | |
24661 | ||
24662 | @lisp | |
24663 | ("^gmane\\." | |
24664 | (spam-process (gnus-group-spam-exit-processor-report-gmane))) | |
24665 | @end lisp | |
24666 | ||
24667 | Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)} | |
24668 | because I don't read the groups directly from news.gmane.org, but | |
1df7defd | 24669 | through my local news server (leafnode). I.e., the article numbers are |
4009494e GM |
24670 | not the same as on news.gmane.org, thus @code{spam-report.el} has to check |
24671 | the @code{X-Report-Spam} header to find the correct number. | |
24672 | ||
24673 | @node Spam Back Ends | |
24674 | @subsection Spam Back Ends | |
24675 | @cindex spam back ends | |
24676 | ||
24677 | The spam package offers a variety of back ends for detecting spam. | |
24678 | Each back end defines a set of methods for detecting spam | |
24679 | (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}), | |
24680 | and a pair of spam and ham processors (@pxref{Spam and Ham | |
24681 | Processors}). | |
24682 | ||
24683 | @menu | |
24684 | * Blacklists and Whitelists:: | |
24685 | * BBDB Whitelists:: | |
24686 | * Gmane Spam Reporting:: | |
24687 | * Anti-spam Hashcash Payments:: | |
24688 | * Blackholes:: | |
24689 | * Regular Expressions Header Matching:: | |
24690 | * Bogofilter:: | |
01c52d31 | 24691 | * SpamAssassin back end:: |
4009494e GM |
24692 | * ifile spam filtering:: |
24693 | * Spam Statistics Filtering:: | |
24694 | * SpamOracle:: | |
24695 | @end menu | |
24696 | ||
24697 | @node Blacklists and Whitelists | |
24698 | @subsubsection Blacklists and Whitelists | |
24699 | @cindex spam filtering | |
24700 | @cindex whitelists, spam filtering | |
24701 | @cindex blacklists, spam filtering | |
24702 | @cindex spam | |
24703 | ||
24704 | @defvar spam-use-blacklist | |
24705 | ||
24706 | Set this variable to @code{t} if you want to use blacklists when | |
24707 | splitting incoming mail. Messages whose senders are in the blacklist | |
24708 | will be sent to the @code{spam-split-group}. This is an explicit | |
24709 | filter, meaning that it acts only on mail senders @emph{declared} to | |
24710 | be spammers. | |
24711 | ||
24712 | @end defvar | |
24713 | ||
24714 | @defvar spam-use-whitelist | |
24715 | ||
24716 | Set this variable to @code{t} if you want to use whitelists when | |
24717 | splitting incoming mail. Messages whose senders are not in the | |
24718 | whitelist will be sent to the next spam-split rule. This is an | |
24719 | explicit filter, meaning that unless someone is in the whitelist, their | |
24720 | messages are not assumed to be spam or ham. | |
24721 | ||
24722 | @end defvar | |
24723 | ||
24724 | @defvar spam-use-whitelist-exclusive | |
24725 | ||
24726 | Set this variable to @code{t} if you want to use whitelists as an | |
24727 | implicit filter, meaning that every message will be considered spam | |
24728 | unless the sender is in the whitelist. Use with care. | |
24729 | ||
24730 | @end defvar | |
24731 | ||
24732 | @defvar gnus-group-spam-exit-processor-blacklist | |
24733 | ||
24734 | Add this symbol to a group's @code{spam-process} parameter by | |
24735 | customizing the group parameters or the | |
24736 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
24737 | added to a group's @code{spam-process} parameter, the senders of | |
24738 | spam-marked articles will be added to the blacklist. | |
24739 | ||
24740 | @emph{WARNING} | |
24741 | ||
24742 | Instead of the obsolete | |
24743 | @code{gnus-group-spam-exit-processor-blacklist}, it is recommended | |
01c52d31 | 24744 | that you use @code{(spam spam-use-blacklist)}. Everything will work |
4009494e GM |
24745 | the same way, we promise. |
24746 | ||
24747 | @end defvar | |
24748 | ||
24749 | @defvar gnus-group-ham-exit-processor-whitelist | |
24750 | ||
24751 | Add this symbol to a group's @code{spam-process} parameter by | |
24752 | customizing the group parameters or the | |
24753 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
24754 | added to a group's @code{spam-process} parameter, the senders of | |
24755 | ham-marked articles in @emph{ham} groups will be added to the | |
01c52d31 | 24756 | whitelist. |
4009494e GM |
24757 | |
24758 | @emph{WARNING} | |
24759 | ||
24760 | Instead of the obsolete | |
24761 | @code{gnus-group-ham-exit-processor-whitelist}, it is recommended | |
01c52d31 | 24762 | that you use @code{(ham spam-use-whitelist)}. Everything will work |
4009494e GM |
24763 | the same way, we promise. |
24764 | ||
24765 | @end defvar | |
24766 | ||
24767 | Blacklists are lists of regular expressions matching addresses you | |
24768 | consider to be spam senders. For instance, to block mail from any | |
24769 | sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your | |
24770 | blacklist. You start out with an empty blacklist. Blacklist entries | |
24771 | use the Emacs regular expression syntax. | |
24772 | ||
24773 | Conversely, whitelists tell Gnus what addresses are considered | |
24774 | legitimate. All messages from whitelisted addresses are considered | |
24775 | non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the | |
24776 | Emacs regular expression syntax. | |
24777 | ||
24778 | The blacklist and whitelist file locations can be customized with the | |
24779 | @code{spam-directory} variable (@file{~/News/spam} by default), or | |
24780 | the @code{spam-whitelist} and @code{spam-blacklist} variables | |
24781 | directly. The whitelist and blacklist files will by default be in the | |
24782 | @code{spam-directory} directory, named @file{whitelist} and | |
24783 | @file{blacklist} respectively. | |
24784 | ||
24785 | @node BBDB Whitelists | |
24786 | @subsubsection BBDB Whitelists | |
24787 | @cindex spam filtering | |
24788 | @cindex BBDB whitelists, spam filtering | |
24789 | @cindex BBDB, spam filtering | |
24790 | @cindex spam | |
24791 | ||
24792 | @defvar spam-use-BBDB | |
24793 | ||
24794 | Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and | |
24795 | Whitelists}), but uses the BBDB as the source of whitelisted | |
24796 | addresses, without regular expressions. You must have the BBDB loaded | |
24797 | for @code{spam-use-BBDB} to work properly. Messages whose senders are | |
24798 | not in the BBDB will be sent to the next spam-split rule. This is an | |
24799 | explicit filter, meaning that unless someone is in the BBDB, their | |
24800 | messages are not assumed to be spam or ham. | |
24801 | ||
24802 | @end defvar | |
24803 | ||
24804 | @defvar spam-use-BBDB-exclusive | |
24805 | ||
24806 | Set this variable to @code{t} if you want to use the BBDB as an | |
24807 | implicit filter, meaning that every message will be considered spam | |
1df7defd | 24808 | unless the sender is in the BBDB@. Use with care. Only sender |
4009494e GM |
24809 | addresses in the BBDB will be allowed through; all others will be |
24810 | classified as spammers. | |
24811 | ||
01c52d31 MB |
24812 | While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias |
24813 | for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is | |
24814 | @emph{not} a separate back end. If you set | |
24815 | @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting | |
24816 | will be exclusive. | |
24817 | ||
4009494e GM |
24818 | @end defvar |
24819 | ||
24820 | @defvar gnus-group-ham-exit-processor-BBDB | |
24821 | ||
24822 | Add this symbol to a group's @code{spam-process} parameter by | |
24823 | customizing the group parameters or the | |
24824 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
24825 | added to a group's @code{spam-process} parameter, the senders of | |
24826 | ham-marked articles in @emph{ham} groups will be added to the | |
01c52d31 | 24827 | BBDB. |
4009494e GM |
24828 | |
24829 | @emph{WARNING} | |
24830 | ||
24831 | Instead of the obsolete | |
24832 | @code{gnus-group-ham-exit-processor-BBDB}, it is recommended | |
01c52d31 | 24833 | that you use @code{(ham spam-use-BBDB)}. Everything will work |
4009494e GM |
24834 | the same way, we promise. |
24835 | ||
24836 | @end defvar | |
24837 | ||
24838 | @node Gmane Spam Reporting | |
24839 | @subsubsection Gmane Spam Reporting | |
24840 | @cindex spam reporting | |
24841 | @cindex Gmane, spam reporting | |
24842 | @cindex Gmane, spam reporting | |
24843 | @cindex spam | |
24844 | ||
24845 | @defvar gnus-group-spam-exit-processor-report-gmane | |
24846 | ||
24847 | Add this symbol to a group's @code{spam-process} parameter by | |
24848 | customizing the group parameters or the | |
24849 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
24850 | added to a group's @code{spam-process} parameter, the spam-marked | |
24851 | articles groups will be reported to the Gmane administrators via a | |
24852 | HTTP request. | |
24853 | ||
24854 | Gmane can be found at @uref{http://gmane.org}. | |
24855 | ||
24856 | @emph{WARNING} | |
24857 | ||
24858 | Instead of the obsolete | |
24859 | @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended | |
01c52d31 | 24860 | that you use @code{(spam spam-use-gmane)}. Everything will work the |
4009494e GM |
24861 | same way, we promise. |
24862 | ||
24863 | @end defvar | |
24864 | ||
24865 | @defvar spam-report-gmane-use-article-number | |
24866 | ||
24867 | This variable is @code{t} by default. Set it to @code{nil} if you are | |
24868 | running your own news server, for instance, and the local article | |
24869 | numbers don't correspond to the Gmane article numbers. When | |
24870 | @code{spam-report-gmane-use-article-number} is @code{nil}, | |
01c52d31 MB |
24871 | @code{spam-report.el} will fetch the number from the article headers. |
24872 | ||
24873 | @end defvar | |
24874 | ||
24875 | @defvar spam-report-user-mail-address | |
24876 | ||
24877 | Mail address exposed in the User-Agent spam reports to Gmane. It allows | |
24878 | the Gmane administrators to contact you in case of misreports. The | |
24879 | default is @code{user-mail-address}. | |
4009494e GM |
24880 | |
24881 | @end defvar | |
24882 | ||
24883 | @node Anti-spam Hashcash Payments | |
24884 | @subsubsection Anti-spam Hashcash Payments | |
24885 | @cindex spam filtering | |
24886 | @cindex hashcash, spam filtering | |
24887 | @cindex spam | |
24888 | ||
24889 | @defvar spam-use-hashcash | |
24890 | ||
24891 | Similar to @code{spam-use-whitelist} (@pxref{Blacklists and | |
24892 | Whitelists}), but uses hashcash tokens for whitelisting messages | |
01c52d31 MB |
24893 | instead of the sender address. Messages without a hashcash payment |
24894 | token will be sent to the next spam-split rule. This is an explicit | |
24895 | filter, meaning that unless a hashcash token is found, the messages | |
24896 | are not assumed to be spam or ham. | |
4009494e GM |
24897 | |
24898 | @end defvar | |
24899 | ||
24900 | @node Blackholes | |
24901 | @subsubsection Blackholes | |
24902 | @cindex spam filtering | |
24903 | @cindex blackholes, spam filtering | |
24904 | @cindex spam | |
24905 | ||
24906 | @defvar spam-use-blackholes | |
24907 | ||
24908 | This option is disabled by default. You can let Gnus consult the | |
24909 | blackhole-type distributed spam processing systems (DCC, for instance) | |
24910 | when you set this option. The variable @code{spam-blackhole-servers} | |
24911 | holds the list of blackhole servers Gnus will consult. The current | |
24912 | list is fairly comprehensive, but make sure to let us know if it | |
24913 | contains outdated servers. | |
24914 | ||
24915 | The blackhole check uses the @code{dig.el} package, but you can tell | |
01c52d31 | 24916 | @code{spam.el} to use @code{dns.el} instead for better performance if |
4009494e GM |
24917 | you set @code{spam-use-dig} to @code{nil}. It is not recommended at |
24918 | this time to set @code{spam-use-dig} to @code{nil} despite the | |
24919 | possible performance improvements, because some users may be unable to | |
24920 | use it, but you can try it and see if it works for you. | |
24921 | ||
24922 | @end defvar | |
24923 | ||
24924 | @defvar spam-blackhole-servers | |
24925 | ||
24926 | The list of servers to consult for blackhole checks. | |
24927 | ||
24928 | @end defvar | |
24929 | ||
24930 | @defvar spam-blackhole-good-server-regex | |
24931 | ||
24932 | A regular expression for IPs that should not be checked against the | |
24933 | blackhole server list. When set to @code{nil}, it has no effect. | |
24934 | ||
24935 | @end defvar | |
24936 | ||
24937 | @defvar spam-use-dig | |
24938 | ||
24939 | Use the @code{dig.el} package instead of the @code{dns.el} package. | |
24940 | The default setting of @code{t} is recommended. | |
24941 | ||
24942 | @end defvar | |
24943 | ||
24944 | Blackhole checks are done only on incoming mail. There is no spam or | |
24945 | ham processor for blackholes. | |
24946 | ||
24947 | @node Regular Expressions Header Matching | |
24948 | @subsubsection Regular Expressions Header Matching | |
24949 | @cindex spam filtering | |
24950 | @cindex regular expressions header matching, spam filtering | |
24951 | @cindex spam | |
24952 | ||
24953 | @defvar spam-use-regex-headers | |
24954 | ||
24955 | This option is disabled by default. You can let Gnus check the | |
24956 | message headers against lists of regular expressions when you set this | |
24957 | option. The variables @code{spam-regex-headers-spam} and | |
24958 | @code{spam-regex-headers-ham} hold the list of regular expressions. | |
24959 | Gnus will check against the message headers to determine if the | |
24960 | message is spam or ham, respectively. | |
24961 | ||
24962 | @end defvar | |
24963 | ||
24964 | @defvar spam-regex-headers-spam | |
24965 | ||
24966 | The list of regular expressions that, when matched in the headers of | |
24967 | the message, positively identify it as spam. | |
24968 | ||
24969 | @end defvar | |
24970 | ||
24971 | @defvar spam-regex-headers-ham | |
24972 | ||
24973 | The list of regular expressions that, when matched in the headers of | |
24974 | the message, positively identify it as ham. | |
24975 | ||
24976 | @end defvar | |
24977 | ||
24978 | Regular expression header checks are done only on incoming mail. | |
24979 | There is no specific spam or ham processor for regular expressions. | |
24980 | ||
24981 | @node Bogofilter | |
24982 | @subsubsection Bogofilter | |
24983 | @cindex spam filtering | |
24984 | @cindex bogofilter, spam filtering | |
24985 | @cindex spam | |
24986 | ||
24987 | @defvar spam-use-bogofilter | |
24988 | ||
24989 | Set this variable if you want @code{spam-split} to use Eric Raymond's | |
24990 | speedy Bogofilter. | |
24991 | ||
24992 | With a minimum of care for associating the @samp{$} mark for spam | |
24993 | articles only, Bogofilter training all gets fairly automatic. You | |
24994 | should do this until you get a few hundreds of articles in each | |
24995 | category, spam or not. The command @kbd{S t} in summary mode, either | |
24996 | for debugging or for curiosity, shows the @emph{spamicity} score of | |
24997 | the current article (between 0.0 and 1.0). | |
24998 | ||
24999 | Bogofilter determines if a message is spam based on a specific | |
25000 | threshold. That threshold can be customized, consult the Bogofilter | |
25001 | documentation. | |
25002 | ||
25003 | If the @code{bogofilter} executable is not in your path, Bogofilter | |
25004 | processing will be turned off. | |
25005 | ||
25006 | You should not enable this if you use @code{spam-use-bogofilter-headers}. | |
25007 | ||
25008 | @end defvar | |
25009 | ||
25010 | @table @kbd | |
25011 | @item M s t | |
25012 | @itemx S t | |
25013 | @kindex M s t | |
25014 | @kindex S t | |
25015 | @findex spam-bogofilter-score | |
25016 | Get the Bogofilter spamicity score (@code{spam-bogofilter-score}). | |
25017 | @end table | |
25018 | ||
25019 | @defvar spam-use-bogofilter-headers | |
25020 | ||
25021 | Set this variable if you want @code{spam-split} to use Eric Raymond's | |
25022 | speedy Bogofilter, looking only at the message headers. It works | |
25023 | similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header | |
25024 | must be in the message already. Normally you would do this with a | |
25025 | procmail recipe or something similar; consult the Bogofilter | |
25026 | installation documents for details. | |
25027 | ||
25028 | You should not enable this if you use @code{spam-use-bogofilter}. | |
25029 | ||
25030 | @end defvar | |
25031 | ||
25032 | @defvar gnus-group-spam-exit-processor-bogofilter | |
25033 | Add this symbol to a group's @code{spam-process} parameter by | |
25034 | customizing the group parameters or the | |
25035 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
25036 | added to a group's @code{spam-process} parameter, spam-marked articles | |
25037 | will be added to the Bogofilter spam database. | |
25038 | ||
25039 | @emph{WARNING} | |
25040 | ||
25041 | Instead of the obsolete | |
25042 | @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended | |
01c52d31 | 25043 | that you use @code{(spam spam-use-bogofilter)}. Everything will work |
4009494e GM |
25044 | the same way, we promise. |
25045 | @end defvar | |
25046 | ||
25047 | @defvar gnus-group-ham-exit-processor-bogofilter | |
25048 | Add this symbol to a group's @code{spam-process} parameter by | |
25049 | customizing the group parameters or the | |
25050 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
25051 | added to a group's @code{spam-process} parameter, the ham-marked | |
25052 | articles in @emph{ham} groups will be added to the Bogofilter database | |
01c52d31 | 25053 | of non-spam messages. |
4009494e GM |
25054 | |
25055 | @emph{WARNING} | |
25056 | ||
25057 | Instead of the obsolete | |
25058 | @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended | |
01c52d31 | 25059 | that you use @code{(ham spam-use-bogofilter)}. Everything will work |
4009494e GM |
25060 | the same way, we promise. |
25061 | @end defvar | |
25062 | ||
25063 | @defvar spam-bogofilter-database-directory | |
25064 | ||
25065 | This is the directory where Bogofilter will store its databases. It | |
25066 | is not specified by default, so Bogofilter will use its own default | |
25067 | database directory. | |
25068 | ||
25069 | @end defvar | |
25070 | ||
25071 | The Bogofilter mail classifier is similar to @command{ifile} in intent and | |
25072 | purpose. A ham and a spam processor are provided, plus the | |
25073 | @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers} | |
25074 | variables to indicate to spam-split that Bogofilter should either be | |
25075 | used, or has already been used on the article. The 0.9.2.1 version of | |
25076 | Bogofilter was used to test this functionality. | |
25077 | ||
01c52d31 MB |
25078 | @node SpamAssassin back end |
25079 | @subsubsection SpamAssassin back end | |
25080 | @cindex spam filtering | |
25081 | @cindex spamassassin, spam filtering | |
25082 | @cindex spam | |
25083 | ||
25084 | @defvar spam-use-spamassassin | |
25085 | ||
25086 | Set this variable if you want @code{spam-split} to use SpamAssassin. | |
25087 | ||
25088 | SpamAssassin assigns a score to each article based on a set of rules | |
25089 | and tests, including a Bayesian filter. The Bayesian filter can be | |
25090 | trained by associating the @samp{$} mark for spam articles. The | |
25091 | spam score can be viewed by using the command @kbd{S t} in summary | |
25092 | mode. | |
25093 | ||
25094 | If you set this variable, each article will be processed by | |
25095 | SpamAssassin when @code{spam-split} is called. If your mail is | |
25096 | preprocessed by SpamAssassin, and you want to just use the | |
25097 | SpamAssassin headers, set @code{spam-use-spamassassin-headers} | |
25098 | instead. | |
25099 | ||
25100 | You should not enable this if you use | |
25101 | @code{spam-use-spamassassin-headers}. | |
25102 | ||
25103 | @end defvar | |
25104 | ||
25105 | @defvar spam-use-spamassassin-headers | |
25106 | ||
25107 | Set this variable if your mail is preprocessed by SpamAssassin and | |
25108 | want @code{spam-split} to split based on the SpamAssassin headers. | |
25109 | ||
25110 | You should not enable this if you use @code{spam-use-spamassassin}. | |
25111 | ||
25112 | @end defvar | |
25113 | ||
25114 | @defvar spam-spamassassin-program | |
25115 | ||
25116 | This variable points to the SpamAssassin executable. If you have | |
25117 | @code{spamd} running, you can set this variable to the @code{spamc} | |
25118 | executable for faster processing. See the SpamAssassin documentation | |
25119 | for more information on @code{spamd}/@code{spamc}. | |
25120 | ||
25121 | @end defvar | |
25122 | ||
25123 | SpamAssassin is a powerful and flexible spam filter that uses a wide | |
25124 | variety of tests to identify spam. A ham and a spam processors are | |
25125 | provided, plus the @code{spam-use-spamassassin} and | |
25126 | @code{spam-use-spamassassin-headers} variables to indicate to | |
25127 | spam-split that SpamAssassin should be either used, or has already | |
25128 | been used on the article. The 2.63 version of SpamAssassin was used | |
25129 | to test this functionality. | |
25130 | ||
4009494e GM |
25131 | @node ifile spam filtering |
25132 | @subsubsection ifile spam filtering | |
25133 | @cindex spam filtering | |
25134 | @cindex ifile, spam filtering | |
25135 | @cindex spam | |
25136 | ||
25137 | @defvar spam-use-ifile | |
25138 | ||
25139 | Enable this variable if you want @code{spam-split} to use @command{ifile}, a | |
25140 | statistical analyzer similar to Bogofilter. | |
25141 | ||
25142 | @end defvar | |
25143 | ||
25144 | @defvar spam-ifile-all-categories | |
25145 | ||
25146 | Enable this variable if you want @code{spam-use-ifile} to give you all | |
25147 | the ifile categories, not just spam/non-spam. If you use this, make | |
25148 | sure you train ifile as described in its documentation. | |
25149 | ||
25150 | @end defvar | |
25151 | ||
25152 | @defvar spam-ifile-spam-category | |
25153 | ||
25154 | This is the category of spam messages as far as ifile is concerned. | |
25155 | The actual string used is irrelevant, but you probably want to leave | |
25156 | the default value of @samp{spam}. | |
25157 | @end defvar | |
25158 | ||
25159 | @defvar spam-ifile-database | |
25160 | ||
25161 | This is the filename for the ifile database. It is not specified by | |
25162 | default, so ifile will use its own default database name. | |
25163 | ||
25164 | @end defvar | |
25165 | ||
25166 | The ifile mail classifier is similar to Bogofilter in intent and | |
25167 | purpose. A ham and a spam processor are provided, plus the | |
25168 | @code{spam-use-ifile} variable to indicate to spam-split that ifile | |
25169 | should be used. The 1.2.1 version of ifile was used to test this | |
25170 | functionality. | |
25171 | ||
25172 | @node Spam Statistics Filtering | |
25173 | @subsubsection Spam Statistics Filtering | |
25174 | @cindex spam filtering | |
25175 | @cindex spam-stat, spam filtering | |
25176 | @cindex spam-stat | |
25177 | @cindex spam | |
25178 | ||
25179 | This back end uses the Spam Statistics Emacs Lisp package to perform | |
25180 | statistics-based filtering (@pxref{Spam Statistics Package}). Before | |
25181 | using this, you may want to perform some additional steps to | |
25182 | initialize your Spam Statistics dictionary. @xref{Creating a | |
25183 | spam-stat dictionary}. | |
25184 | ||
25185 | @defvar spam-use-stat | |
25186 | ||
25187 | @end defvar | |
25188 | ||
25189 | @defvar gnus-group-spam-exit-processor-stat | |
25190 | Add this symbol to a group's @code{spam-process} parameter by | |
25191 | customizing the group parameters or the | |
25192 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
25193 | added to a group's @code{spam-process} parameter, the spam-marked | |
25194 | articles will be added to the spam-stat database of spam messages. | |
25195 | ||
25196 | @emph{WARNING} | |
25197 | ||
25198 | Instead of the obsolete | |
25199 | @code{gnus-group-spam-exit-processor-stat}, it is recommended | |
01c52d31 | 25200 | that you use @code{(spam spam-use-stat)}. Everything will work |
4009494e GM |
25201 | the same way, we promise. |
25202 | @end defvar | |
25203 | ||
25204 | @defvar gnus-group-ham-exit-processor-stat | |
25205 | Add this symbol to a group's @code{spam-process} parameter by | |
25206 | customizing the group parameters or the | |
25207 | @code{gnus-spam-process-newsgroups} variable. When this symbol is | |
25208 | added to a group's @code{spam-process} parameter, the ham-marked | |
25209 | articles in @emph{ham} groups will be added to the spam-stat database | |
01c52d31 | 25210 | of non-spam messages. |
4009494e GM |
25211 | |
25212 | @emph{WARNING} | |
25213 | ||
25214 | Instead of the obsolete | |
25215 | @code{gnus-group-ham-exit-processor-stat}, it is recommended | |
01c52d31 | 25216 | that you use @code{(ham spam-use-stat)}. Everything will work |
4009494e GM |
25217 | the same way, we promise. |
25218 | @end defvar | |
25219 | ||
01c52d31 | 25220 | This enables @code{spam.el} to cooperate with @file{spam-stat.el}. |
4009494e GM |
25221 | @file{spam-stat.el} provides an internal (Lisp-only) spam database, |
25222 | which unlike ifile or Bogofilter does not require external programs. | |
25223 | A spam and a ham processor, and the @code{spam-use-stat} variable for | |
25224 | @code{spam-split} are provided. | |
25225 | ||
25226 | @node SpamOracle | |
25227 | @subsubsection Using SpamOracle with Gnus | |
25228 | @cindex spam filtering | |
25229 | @cindex SpamOracle | |
25230 | @cindex spam | |
25231 | ||
25232 | An easy way to filter out spam is to use SpamOracle. SpamOracle is an | |
25233 | statistical mail filtering tool written by Xavier Leroy and needs to be | |
25234 | installed separately. | |
25235 | ||
25236 | There are several ways to use SpamOracle with Gnus. In all cases, your | |
25237 | mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will | |
25238 | then enter an @samp{X-Spam} header indicating whether it regards the | |
25239 | mail as a spam mail or not. | |
25240 | ||
25241 | One possibility is to run SpamOracle as a @code{:prescript} from the | |
25242 | @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has | |
25243 | the advantage that the user can see the @emph{X-Spam} headers. | |
25244 | ||
25245 | The easiest method is to make @file{spam.el} (@pxref{Spam Package}) | |
25246 | call SpamOracle. | |
25247 | ||
25248 | @vindex spam-use-spamoracle | |
01c52d31 | 25249 | To enable SpamOracle usage by @code{spam.el}, set the variable |
4009494e GM |
25250 | @code{spam-use-spamoracle} to @code{t} and configure the |
25251 | @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam | |
25252 | Package}. In this example the @samp{INBOX} of an nnimap server is | |
25253 | filtered using SpamOracle. Mails recognized as spam mails will be | |
25254 | moved to @code{spam-split-group}, @samp{Junk} in this case. Ham | |
25255 | messages stay in @samp{INBOX}: | |
25256 | ||
25257 | @example | |
25258 | (setq spam-use-spamoracle t | |
25259 | spam-split-group "Junk" | |
6b958814 | 25260 | ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual} |
4009494e | 25261 | nnimap-split-inbox '("INBOX") |
4009494e GM |
25262 | nnimap-split-fancy '(| (: spam-split) "INBOX")) |
25263 | @end example | |
25264 | ||
25265 | @defvar spam-use-spamoracle | |
25266 | Set to @code{t} if you want Gnus to enable spam filtering using | |
25267 | SpamOracle. | |
25268 | @end defvar | |
25269 | ||
25270 | @defvar spam-spamoracle-binary | |
25271 | Gnus uses the SpamOracle binary called @file{spamoracle} found in the | |
1df7defd | 25272 | user's PATH@. Using the variable @code{spam-spamoracle-binary}, this |
4009494e GM |
25273 | can be customized. |
25274 | @end defvar | |
25275 | ||
25276 | @defvar spam-spamoracle-database | |
25277 | By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to | |
25278 | store its analysis. This is controlled by the variable | |
25279 | @code{spam-spamoracle-database} which defaults to @code{nil}. That means | |
25280 | the default SpamOracle database will be used. In case you want your | |
25281 | database to live somewhere special, set | |
25282 | @code{spam-spamoracle-database} to this path. | |
25283 | @end defvar | |
25284 | ||
25285 | SpamOracle employs a statistical algorithm to determine whether a | |
25286 | message is spam or ham. In order to get good results, meaning few | |
25287 | false hits or misses, SpamOracle needs training. SpamOracle learns | |
25288 | the characteristics of your spam mails. Using the @emph{add} mode | |
25289 | (training mode) one has to feed good (ham) and spam mails to | |
25290 | SpamOracle. This can be done by pressing @kbd{|} in the Summary | |
25291 | buffer and pipe the mail to a SpamOracle process or using | |
25292 | @file{spam.el}'s spam- and ham-processors, which is much more | |
25293 | convenient. For a detailed description of spam- and ham-processors, | |
25294 | @xref{Spam Package}. | |
25295 | ||
25296 | @defvar gnus-group-spam-exit-processor-spamoracle | |
25297 | Add this symbol to a group's @code{spam-process} parameter by | |
25298 | customizing the group parameter or the | |
25299 | @code{gnus-spam-process-newsgroups} variable. When this symbol is added | |
25300 | to a group's @code{spam-process} parameter, spam-marked articles will be | |
25301 | sent to SpamOracle as spam samples. | |
25302 | ||
25303 | @emph{WARNING} | |
25304 | ||
25305 | Instead of the obsolete | |
25306 | @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended | |
01c52d31 | 25307 | that you use @code{(spam spam-use-spamoracle)}. Everything will work |
4009494e GM |
25308 | the same way, we promise. |
25309 | @end defvar | |
25310 | ||
25311 | @defvar gnus-group-ham-exit-processor-spamoracle | |
25312 | Add this symbol to a group's @code{spam-process} parameter by | |
25313 | customizing the group parameter or the | |
25314 | @code{gnus-spam-process-newsgroups} variable. When this symbol is added | |
25315 | to a group's @code{spam-process} parameter, the ham-marked articles in | |
25316 | @emph{ham} groups will be sent to the SpamOracle as samples of ham | |
01c52d31 | 25317 | messages. |
4009494e GM |
25318 | |
25319 | @emph{WARNING} | |
25320 | ||
25321 | Instead of the obsolete | |
25322 | @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended | |
01c52d31 | 25323 | that you use @code{(ham spam-use-spamoracle)}. Everything will work |
4009494e GM |
25324 | the same way, we promise. |
25325 | @end defvar | |
25326 | ||
25327 | @emph{Example:} These are the Group Parameters of a group that has been | |
25328 | classified as a ham group, meaning that it should only contain ham | |
25329 | messages. | |
25330 | @example | |
25331 | ((spam-contents gnus-group-spam-classification-ham) | |
25332 | (spam-process ((ham spam-use-spamoracle) | |
25333 | (spam spam-use-spamoracle)))) | |
25334 | @end example | |
25335 | For this group the @code{spam-use-spamoracle} is installed for both | |
25336 | ham and spam processing. If the group contains spam message | |
1df7defd | 25337 | (e.g., because SpamOracle has not had enough sample messages yet) and |
4009494e GM |
25338 | the user marks some messages as spam messages, these messages will be |
25339 | processed by SpamOracle. The processor sends the messages to | |
25340 | SpamOracle as new samples for spam. | |
25341 | ||
25342 | @node Extending the Spam package | |
25343 | @subsection Extending the Spam package | |
25344 | @cindex spam filtering | |
25345 | @cindex spam elisp package, extending | |
25346 | @cindex extending the spam elisp package | |
25347 | ||
25348 | Say you want to add a new back end called blackbox. For filtering | |
25349 | incoming mail, provide the following: | |
25350 | ||
25351 | @enumerate | |
25352 | ||
25353 | @item | |
25354 | Code | |
25355 | ||
25356 | @lisp | |
25357 | (defvar spam-use-blackbox nil | |
25358 | "True if blackbox should be used.") | |
25359 | @end lisp | |
25360 | ||
01c52d31 | 25361 | Write @code{spam-check-blackbox} if Blackbox can check incoming mail. |
4009494e | 25362 | |
01c52d31 MB |
25363 | Write @code{spam-blackbox-register-routine} and |
25364 | @code{spam-blackbox-unregister-routine} using the bogofilter | |
40ba43b4 | 25365 | register/unregister routines as a start, or other register/unregister |
01c52d31 MB |
25366 | routines more appropriate to Blackbox, if Blackbox can |
25367 | register/unregister spam and ham. | |
4009494e GM |
25368 | |
25369 | @item | |
25370 | Functionality | |
25371 | ||
01c52d31 MB |
25372 | The @code{spam-check-blackbox} function should return @samp{nil} or |
25373 | @code{spam-split-group}, observing the other conventions. See the | |
25374 | existing @code{spam-check-*} functions for examples of what you can | |
25375 | do, and stick to the template unless you fully understand the reasons | |
25376 | why you aren't. | |
4009494e GM |
25377 | |
25378 | @end enumerate | |
25379 | ||
25380 | For processing spam and ham messages, provide the following: | |
25381 | ||
25382 | @enumerate | |
25383 | ||
25384 | @item | |
25385 | Code | |
25386 | ||
25387 | Note you don't have to provide a spam or a ham processor. Only | |
25388 | provide them if Blackbox supports spam or ham processing. | |
25389 | ||
25390 | Also, ham and spam processors are being phased out as single | |
01c52d31 MB |
25391 | variables. Instead the form @code{(spam spam-use-blackbox)} or |
25392 | @code{(ham spam-use-blackbox)} is favored. For now, spam/ham | |
4009494e GM |
25393 | processor variables are still around but they won't be for long. |
25394 | ||
25395 | @lisp | |
25396 | (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam" | |
25397 | "The Blackbox summary exit spam processor. | |
25398 | Only applicable to spam groups.") | |
25399 | ||
25400 | (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham" | |
25401 | "The whitelist summary exit ham processor. | |
25402 | Only applicable to non-spam (unclassified and ham) groups.") | |
25403 | ||
25404 | @end lisp | |
25405 | ||
25406 | @item | |
25407 | Gnus parameters | |
25408 | ||
25409 | Add | |
25410 | @lisp | |
25411 | (const :tag "Spam: Blackbox" (spam spam-use-blackbox)) | |
25412 | (const :tag "Ham: Blackbox" (ham spam-use-blackbox)) | |
25413 | @end lisp | |
25414 | to the @code{spam-process} group parameter in @code{gnus.el}. Make | |
25415 | sure you do it twice, once for the parameter and once for the | |
25416 | variable customization. | |
25417 | ||
25418 | Add | |
25419 | @lisp | |
25420 | (variable-item spam-use-blackbox) | |
25421 | @end lisp | |
25422 | to the @code{spam-autodetect-methods} group parameter in | |
01c52d31 MB |
25423 | @code{gnus.el} if Blackbox can check incoming mail for spam contents. |
25424 | ||
25425 | Finally, use the appropriate @code{spam-install-*-backend} function in | |
25426 | @code{spam.el}. Here are the available functions. | |
25427 | ||
25428 | ||
25429 | @enumerate | |
25430 | ||
25431 | @item | |
25432 | @code{spam-install-backend-alias} | |
25433 | ||
25434 | This function will simply install an alias for a back end that does | |
25435 | everything like the original back end. It is currently only used to | |
25436 | make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}. | |
25437 | ||
25438 | @item | |
25439 | @code{spam-install-nocheck-backend} | |
25440 | ||
25441 | This function installs a back end that has no check function, but can | |
25442 | register/unregister ham or spam. The @code{spam-use-gmane} back end is | |
25443 | such a back end. | |
25444 | ||
25445 | @item | |
25446 | @code{spam-install-checkonly-backend} | |
25447 | ||
25448 | This function will install a back end that can only check incoming mail | |
25449 | for spam contents. It can't register or unregister messages. | |
25450 | @code{spam-use-blackholes} and @code{spam-use-hashcash} are such | |
25451 | back ends. | |
25452 | ||
25453 | @item | |
25454 | @code{spam-install-statistical-checkonly-backend} | |
25455 | ||
25456 | This function installs a statistical back end (one which requires the | |
25457 | full body of a message to check it) that can only check incoming mail | |
25458 | for contents. @code{spam-use-regex-body} is such a filter. | |
25459 | ||
25460 | @item | |
25461 | @code{spam-install-statistical-backend} | |
25462 | ||
25463 | This function install a statistical back end with incoming checks and | |
25464 | registration/unregistration routines. @code{spam-use-bogofilter} is | |
25465 | set up this way. | |
25466 | ||
25467 | @item | |
25468 | @code{spam-install-backend} | |
25469 | ||
25470 | This is the most normal back end installation, where a back end that can | |
25471 | check and register/unregister messages is set up without statistical | |
25472 | abilities. The @code{spam-use-BBDB} is such a back end. | |
25473 | ||
25474 | @item | |
25475 | @code{spam-install-mover-backend} | |
25476 | ||
25477 | Mover back ends are internal to @code{spam.el} and specifically move | |
25478 | articles around when the summary is exited. You will very probably | |
25479 | never install such a back end. | |
25480 | @end enumerate | |
4009494e GM |
25481 | |
25482 | @end enumerate | |
25483 | ||
25484 | @node Spam Statistics Package | |
25485 | @subsection Spam Statistics Package | |
25486 | @cindex Paul Graham | |
25487 | @cindex Graham, Paul | |
25488 | @cindex naive Bayesian spam filtering | |
25489 | @cindex Bayesian spam filtering, naive | |
25490 | @cindex spam filtering, naive Bayesian | |
25491 | ||
25492 | Paul Graham has written an excellent essay about spam filtering using | |
25493 | statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for | |
25494 | Spam}. In it he describes the inherent deficiency of rule-based | |
25495 | filtering as used by SpamAssassin, for example: Somebody has to write | |
25496 | the rules, and everybody else has to install these rules. You are | |
25497 | always late. It would be much better, he argues, to filter mail based | |
25498 | on whether it somehow resembles spam or non-spam. One way to measure | |
25499 | this is word distribution. He then goes on to describe a solution | |
25500 | that checks whether a new mail resembles any of your other spam mails | |
25501 | or not. | |
25502 | ||
25503 | The basic idea is this: Create a two collections of your mail, one | |
25504 | with spam, one with non-spam. Count how often each word appears in | |
25505 | either collection, weight this by the total number of mails in the | |
25506 | collections, and store this information in a dictionary. For every | |
25507 | word in a new mail, determine its probability to belong to a spam or a | |
25508 | non-spam mail. Use the 15 most conspicuous words, compute the total | |
25509 | probability of the mail being spam. If this probability is higher | |
25510 | than a certain threshold, the mail is considered to be spam. | |
25511 | ||
25512 | The Spam Statistics package adds support to Gnus for this kind of | |
25513 | filtering. It can be used as one of the back ends of the Spam package | |
25514 | (@pxref{Spam Package}), or by itself. | |
25515 | ||
25516 | Before using the Spam Statistics package, you need to set it up. | |
25517 | First, you need two collections of your mail, one with spam, one with | |
25518 | non-spam. Then you need to create a dictionary using these two | |
25519 | collections, and save it. And last but not least, you need to use | |
25520 | this dictionary in your fancy mail splitting rules. | |
25521 | ||
25522 | @menu | |
25523 | * Creating a spam-stat dictionary:: | |
25524 | * Splitting mail using spam-stat:: | |
25525 | * Low-level interface to the spam-stat dictionary:: | |
25526 | @end menu | |
25527 | ||
25528 | @node Creating a spam-stat dictionary | |
25529 | @subsubsection Creating a spam-stat dictionary | |
25530 | ||
25531 | Before you can begin to filter spam based on statistics, you must | |
25532 | create these statistics based on two mail collections, one with spam, | |
25533 | one with non-spam. These statistics are then stored in a dictionary | |
25534 | for later use. In order for these statistics to be meaningful, you | |
25535 | need several hundred emails in both collections. | |
25536 | ||
25537 | Gnus currently supports only the nnml back end for automated dictionary | |
25538 | creation. The nnml back end stores all mails in a directory, one file | |
25539 | per mail. Use the following: | |
25540 | ||
25541 | @defun spam-stat-process-spam-directory | |
25542 | Create spam statistics for every file in this directory. Every file | |
25543 | is treated as one spam mail. | |
25544 | @end defun | |
25545 | ||
25546 | @defun spam-stat-process-non-spam-directory | |
25547 | Create non-spam statistics for every file in this directory. Every | |
25548 | file is treated as one non-spam mail. | |
25549 | @end defun | |
25550 | ||
25551 | Usually you would call @code{spam-stat-process-spam-directory} on a | |
25552 | directory such as @file{~/Mail/mail/spam} (this usually corresponds to | |
25553 | the group @samp{nnml:mail.spam}), and you would call | |
25554 | @code{spam-stat-process-non-spam-directory} on a directory such as | |
25555 | @file{~/Mail/mail/misc} (this usually corresponds to the group | |
25556 | @samp{nnml:mail.misc}). | |
25557 | ||
25558 | When you are using @acronym{IMAP}, you won't have the mails available | |
25559 | locally, so that will not work. One solution is to use the Gnus Agent | |
25560 | to cache the articles. Then you can use directories such as | |
25561 | @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for | |
25562 | @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}. | |
25563 | ||
25564 | @defvar spam-stat | |
25565 | This variable holds the hash-table with all the statistics---the | |
25566 | dictionary we have been talking about. For every word in either | |
25567 | collection, this hash-table stores a vector describing how often the | |
25568 | word appeared in spam and often it appeared in non-spam mails. | |
25569 | @end defvar | |
25570 | ||
25571 | If you want to regenerate the statistics from scratch, you need to | |
25572 | reset the dictionary. | |
25573 | ||
25574 | @defun spam-stat-reset | |
25575 | Reset the @code{spam-stat} hash-table, deleting all the statistics. | |
25576 | @end defun | |
25577 | ||
25578 | When you are done, you must save the dictionary. The dictionary may | |
25579 | be rather large. If you will not update the dictionary incrementally | |
25580 | (instead, you will recreate it once a month, for example), then you | |
25581 | can reduce the size of the dictionary by deleting all words that did | |
25582 | not appear often enough or that do not clearly belong to only spam or | |
25583 | only non-spam mails. | |
25584 | ||
25585 | @defun spam-stat-reduce-size | |
25586 | Reduce the size of the dictionary. Use this only if you do not want | |
25587 | to update the dictionary incrementally. | |
25588 | @end defun | |
25589 | ||
25590 | @defun spam-stat-save | |
25591 | Save the dictionary. | |
25592 | @end defun | |
25593 | ||
25594 | @defvar spam-stat-file | |
25595 | The filename used to store the dictionary. This defaults to | |
25596 | @file{~/.spam-stat.el}. | |
25597 | @end defvar | |
25598 | ||
25599 | @node Splitting mail using spam-stat | |
25600 | @subsubsection Splitting mail using spam-stat | |
25601 | ||
25602 | This section describes how to use the Spam statistics | |
25603 | @emph{independently} of the @xref{Spam Package}. | |
25604 | ||
25605 | First, add the following to your @file{~/.gnus.el} file: | |
25606 | ||
25607 | @lisp | |
25608 | (require 'spam-stat) | |
25609 | (spam-stat-load) | |
25610 | @end lisp | |
25611 | ||
25612 | This will load the necessary Gnus code, and the dictionary you | |
25613 | created. | |
25614 | ||
25615 | Next, you need to adapt your fancy splitting rules: You need to | |
25616 | determine how to use @code{spam-stat}. The following examples are for | |
25617 | the nnml back end. Using the nnimap back end works just as well. Just | |
25618 | use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}. | |
25619 | ||
25620 | In the simplest case, you only have two groups, @samp{mail.misc} and | |
25621 | @samp{mail.spam}. The following expression says that mail is either | |
25622 | spam or it should go into @samp{mail.misc}. If it is spam, then | |
25623 | @code{spam-stat-split-fancy} will return @samp{mail.spam}. | |
25624 | ||
25625 | @lisp | |
25626 | (setq nnmail-split-fancy | |
25627 | `(| (: spam-stat-split-fancy) | |
25628 | "mail.misc")) | |
25629 | @end lisp | |
25630 | ||
25631 | @defvar spam-stat-split-fancy-spam-group | |
25632 | The group to use for spam. Default is @samp{mail.spam}. | |
25633 | @end defvar | |
25634 | ||
25635 | If you also filter mail with specific subjects into other groups, use | |
25636 | the following expression. Only mails not matching the regular | |
25637 | expression are considered potential spam. | |
25638 | ||
25639 | @lisp | |
25640 | (setq nnmail-split-fancy | |
25641 | `(| ("Subject" "\\bspam-stat\\b" "mail.emacs") | |
25642 | (: spam-stat-split-fancy) | |
25643 | "mail.misc")) | |
25644 | @end lisp | |
25645 | ||
25646 | If you want to filter for spam first, then you must be careful when | |
25647 | creating the dictionary. Note that @code{spam-stat-split-fancy} must | |
25648 | consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as | |
25649 | non-spam, therefore both should be in your collection of non-spam | |
25650 | mails, when creating the dictionary! | |
25651 | ||
25652 | @lisp | |
25653 | (setq nnmail-split-fancy | |
25654 | `(| (: spam-stat-split-fancy) | |
25655 | ("Subject" "\\bspam-stat\\b" "mail.emacs") | |
25656 | "mail.misc")) | |
25657 | @end lisp | |
25658 | ||
25659 | You can combine this with traditional filtering. Here, we move all | |
25660 | HTML-only mails into the @samp{mail.spam.filtered} group. Note that since | |
25661 | @code{spam-stat-split-fancy} will never see them, the mails in | |
25662 | @samp{mail.spam.filtered} should be neither in your collection of spam mails, | |
25663 | nor in your collection of non-spam mails, when creating the | |
25664 | dictionary! | |
25665 | ||
25666 | @lisp | |
25667 | (setq nnmail-split-fancy | |
25668 | `(| ("Content-Type" "text/html" "mail.spam.filtered") | |
25669 | (: spam-stat-split-fancy) | |
25670 | ("Subject" "\\bspam-stat\\b" "mail.emacs") | |
25671 | "mail.misc")) | |
25672 | @end lisp | |
25673 | ||
25674 | ||
25675 | @node Low-level interface to the spam-stat dictionary | |
25676 | @subsubsection Low-level interface to the spam-stat dictionary | |
25677 | ||
25678 | The main interface to using @code{spam-stat}, are the following functions: | |
25679 | ||
25680 | @defun spam-stat-buffer-is-spam | |
25681 | Called in a buffer, that buffer is considered to be a new spam mail. | |
25682 | Use this for new mail that has not been processed before. | |
25683 | @end defun | |
25684 | ||
25685 | @defun spam-stat-buffer-is-no-spam | |
25686 | Called in a buffer, that buffer is considered to be a new non-spam | |
25687 | mail. Use this for new mail that has not been processed before. | |
25688 | @end defun | |
25689 | ||
25690 | @defun spam-stat-buffer-change-to-spam | |
25691 | Called in a buffer, that buffer is no longer considered to be normal | |
25692 | mail but spam. Use this to change the status of a mail that has | |
25693 | already been processed as non-spam. | |
25694 | @end defun | |
25695 | ||
25696 | @defun spam-stat-buffer-change-to-non-spam | |
25697 | Called in a buffer, that buffer is no longer considered to be spam but | |
25698 | normal mail. Use this to change the status of a mail that has already | |
25699 | been processed as spam. | |
25700 | @end defun | |
25701 | ||
25702 | @defun spam-stat-save | |
25703 | Save the hash table to the file. The filename used is stored in the | |
25704 | variable @code{spam-stat-file}. | |
25705 | @end defun | |
25706 | ||
25707 | @defun spam-stat-load | |
25708 | Load the hash table from a file. The filename used is stored in the | |
25709 | variable @code{spam-stat-file}. | |
25710 | @end defun | |
25711 | ||
25712 | @defun spam-stat-score-word | |
25713 | Return the spam score for a word. | |
25714 | @end defun | |
25715 | ||
25716 | @defun spam-stat-score-buffer | |
25717 | Return the spam score for a buffer. | |
25718 | @end defun | |
25719 | ||
25720 | @defun spam-stat-split-fancy | |
25721 | Use this function for fancy mail splitting. Add the rule @samp{(: | |
25722 | spam-stat-split-fancy)} to @code{nnmail-split-fancy} | |
25723 | @end defun | |
25724 | ||
25725 | Make sure you load the dictionary before using it. This requires the | |
25726 | following in your @file{~/.gnus.el} file: | |
25727 | ||
25728 | @lisp | |
25729 | (require 'spam-stat) | |
25730 | (spam-stat-load) | |
25731 | @end lisp | |
25732 | ||
25733 | Typical test will involve calls to the following functions: | |
25734 | ||
25735 | @smallexample | |
25736 | Reset: (setq spam-stat (make-hash-table :test 'equal)) | |
25737 | Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam") | |
25738 | Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc") | |
25739 | Save table: (spam-stat-save) | |
25740 | File size: (nth 7 (file-attributes spam-stat-file)) | |
25741 | Number of words: (hash-table-count spam-stat) | |
25742 | Test spam: (spam-stat-test-directory "~/Mail/mail/spam") | |
25743 | Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc") | |
25744 | Reduce table size: (spam-stat-reduce-size) | |
25745 | Save table: (spam-stat-save) | |
25746 | File size: (nth 7 (file-attributes spam-stat-file)) | |
25747 | Number of words: (hash-table-count spam-stat) | |
25748 | Test spam: (spam-stat-test-directory "~/Mail/mail/spam") | |
25749 | Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc") | |
25750 | @end smallexample | |
25751 | ||
25752 | Here is how you would create your dictionary: | |
25753 | ||
25754 | @smallexample | |
25755 | Reset: (setq spam-stat (make-hash-table :test 'equal)) | |
25756 | Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam") | |
25757 | Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc") | |
25758 | Repeat for any other non-spam group you need... | |
25759 | Reduce table size: (spam-stat-reduce-size) | |
25760 | Save table: (spam-stat-save) | |
25761 | @end smallexample | |
25762 | ||
64763fe3 MB |
25763 | @node The Gnus Registry |
25764 | @section The Gnus Registry | |
64763fe3 MB |
25765 | @cindex registry |
25766 | @cindex split | |
25767 | @cindex track | |
25768 | ||
25769 | The Gnus registry is a package that tracks messages by their | |
25770 | Message-ID across all backends. This allows Gnus users to do several | |
25771 | cool things, be the envy of the locals, get free haircuts, and be | |
25772 | experts on world issues. Well, maybe not all of those, but the | |
25773 | features are pretty cool. | |
25774 | ||
25775 | Although they will be explained in detail shortly, here's a quick list | |
25776 | of said features in case your attention span is... never mind. | |
25777 | ||
25778 | @enumerate | |
e52cac88 MB |
25779 | @item |
25780 | Split messages to their parent | |
64763fe3 | 25781 | |
64763fe3 | 25782 | This keeps discussions in the same group. You can use the subject and |
1df7defd | 25783 | the sender in addition to the Message-ID@. Several strategies are |
64763fe3 MB |
25784 | available. |
25785 | ||
36d3245f G |
25786 | @item |
25787 | Refer to messages by ID | |
25788 | ||
25789 | Commands like @code{gnus-summary-refer-parent-article} can take | |
25790 | advantage of the registry to jump to the referred article, regardless | |
25791 | of the group the message is in. | |
25792 | ||
e52cac88 MB |
25793 | @item |
25794 | Store custom flags and keywords | |
25795 | ||
64763fe3 MB |
25796 | The registry can store custom flags and keywords for a message. For |
25797 | instance, you can mark a message ``To-Do'' this way and the flag will | |
25798 | persist whether the message is in the nnimap, nnml, nnmaildir, | |
25799 | etc. backends. | |
25800 | ||
e52cac88 MB |
25801 | @item |
25802 | Store arbitrary data | |
25803 | ||
64763fe3 MB |
25804 | Through a simple ELisp API, the registry can remember any data for a |
25805 | message. A built-in inverse map, when activated, allows quick lookups | |
25806 | of all messages matching a particular set of criteria. | |
64763fe3 MB |
25807 | @end enumerate |
25808 | ||
64763fe3 | 25809 | @menu |
627abcdd | 25810 | * Gnus Registry Setup:: |
867d4bb3 | 25811 | * Fancy splitting to parent:: |
36d3245f | 25812 | * Registry Article Refer Method:: |
867d4bb3 JB |
25813 | * Store custom flags and keywords:: |
25814 | * Store arbitrary data:: | |
64763fe3 MB |
25815 | @end menu |
25816 | ||
627abcdd TZ |
25817 | @node Gnus Registry Setup |
25818 | @subsection Gnus Registry Setup | |
64763fe3 MB |
25819 | |
25820 | Fortunately, setting up the Gnus registry is pretty easy: | |
25821 | ||
25822 | @lisp | |
c3c65d73 | 25823 | (setq gnus-registry-max-entries 2500) |
64763fe3 MB |
25824 | |
25825 | (gnus-registry-initialize) | |
25826 | @end lisp | |
25827 | ||
25828 | This adds registry saves to Gnus newsrc saves (which happen on exit | |
25829 | and when you press @kbd{s} from the @code{*Group*} buffer. It also | |
25830 | adds registry calls to article actions in Gnus (copy, move, etc.) so | |
25831 | it's not easy to undo the initialization. See | |
25832 | @code{gnus-registry-initialize} for the gory details. | |
25833 | ||
25834 | Here are other settings used by the author of the registry (understand | |
25835 | what they do before you copy them blindly). | |
25836 | ||
25837 | @lisp | |
25838 | (setq | |
25839 | gnus-registry-split-strategy 'majority | |
25840 | gnus-registry-ignored-groups '(("nntp" t) | |
25841 | ("nnrss" t) | |
25842 | ("spam" t) | |
25843 | ("train" t)) | |
25844 | gnus-registry-max-entries 500000 | |
c3c65d73 | 25845 | ;; this is the default |
64763fe3 MB |
25846 | gnus-registry-track-extra '(sender subject)) |
25847 | @end lisp | |
25848 | ||
c3c65d73 TZ |
25849 | They say: keep a lot of messages around, track messages by sender and |
25850 | subject (not just parent Message-ID), and when the registry splits | |
25851 | incoming mail, use a majority rule to decide where messages should go | |
25852 | if there's more than one possibility. In addition, the registry | |
25853 | should ignore messages in groups that match ``nntp'', ``nnrss'', | |
25854 | ``spam'', or ``train.'' | |
64763fe3 MB |
25855 | |
25856 | You are doubtless impressed by all this, but you ask: ``I am a Gnus | |
25857 | user, I customize to live. Give me more.'' Here you go, these are | |
25858 | the general settings. | |
25859 | ||
25860 | @defvar gnus-registry-unfollowed-groups | |
25861 | The groups that will not be followed by | |
25862 | @code{gnus-registry-split-fancy-with-parent}. They will still be | |
25863 | remembered by the registry. This is a list of regular expressions. | |
54a8f337 KY |
25864 | By default any group name that ends with ``delayed'', ``drafts'', |
25865 | ``queue'', or ``INBOX'', belongs to the nnmairix backend, or contains | |
c3c65d73 | 25866 | the word ``archive'' is not followed. |
64763fe3 MB |
25867 | @end defvar |
25868 | ||
25869 | @defvar gnus-registry-max-entries | |
25870 | The number (an integer or @code{nil} for unlimited) of entries the | |
25871 | registry will keep. | |
25872 | @end defvar | |
25873 | ||
c3c65d73 TZ |
25874 | @defvar gnus-registry-max-pruned-entries |
25875 | The maximum number (an integer or @code{nil} for unlimited) of entries | |
25876 | the registry will keep after pruning. | |
25877 | @end defvar | |
25878 | ||
64763fe3 | 25879 | @defvar gnus-registry-cache-file |
c3c65d73 TZ |
25880 | The file where the registry will be stored between Gnus sessions. By |
25881 | default the file name is @code{.gnus.registry.eioio} in the same | |
25882 | directory as your @code{.newsrc.eld}. | |
64763fe3 MB |
25883 | @end defvar |
25884 | ||
36d3245f G |
25885 | @node Registry Article Refer Method |
25886 | @subsection Fetching by @code{Message-ID} Using the Registry | |
25887 | ||
25888 | The registry knows how to map each @code{Message-ID} to the group it's | |
25889 | in. This can be leveraged to enhance the ``article refer method'', | |
25890 | the thing that tells Gnus how to look up an article given its | |
25891 | Message-ID (@pxref{Finding the Parent}). | |
25892 | ||
25893 | @vindex nnregistry | |
25894 | @vindex gnus-refer-article-method | |
25895 | ||
25896 | The @code{nnregistry} refer method does exactly that. It has the | |
25897 | advantage that an article may be found regardless of the group it's | |
25898 | in---provided its @code{Message-ID} is known to the registry. It can | |
25899 | be enabled by augmenting the start-up file with something along these | |
25900 | lines: | |
25901 | ||
25902 | @example | |
25903 | ;; Keep enough entries to have a good hit rate when referring to an | |
25904 | ;; article using the registry. Use long group names so that Gnus | |
25905 | ;; knows where the article is. | |
c3c65d73 | 25906 | (setq gnus-registry-max-entries 2500) |
36d3245f G |
25907 | |
25908 | (gnus-registry-initialize) | |
25909 | ||
25910 | (setq gnus-refer-article-method | |
25911 | '(current | |
e08ea0f8 KY |
25912 | (nnregistry) |
25913 | (nnweb "gmane" (nnweb-type gmane)))) | |
36d3245f G |
25914 | @end example |
25915 | ||
25916 | The example above instructs Gnus to first look up the article in the | |
25917 | current group, or, alternatively, using the registry, and finally, if | |
25918 | all else fails, using Gmane. | |
25919 | ||
64763fe3 MB |
25920 | @node Fancy splitting to parent |
25921 | @subsection Fancy splitting to parent | |
25922 | ||
25923 | Simply put, this lets you put followup e-mail where it belongs. | |
25924 | ||
25925 | Every message has a Message-ID, which is unique, and the registry | |
25926 | remembers it. When the message is moved or copied, the registry will | |
25927 | notice this and offer the new group as a choice to the splitting | |
25928 | strategy. | |
25929 | ||
25930 | When a followup is made, usually it mentions the original message's | |
25931 | Message-ID in the headers. The registry knows this and uses that | |
25932 | mention to find the group where the original message lives. You only | |
25933 | have to put a rule like this: | |
25934 | ||
25935 | @lisp | |
25936 | (setq nnimap-my-split-fancy '(| | |
25937 | ||
25938 | ;; split to parent: you need this | |
25939 | (: gnus-registry-split-fancy-with-parent) | |
25940 | ||
25941 | ;; other rules, as an example | |
25942 | (: spam-split) | |
25943 | ;; default mailbox | |
25944 | "mail") | |
25945 | @end lisp | |
25946 | ||
25947 | in your fancy split setup. In addition, you may want to customize the | |
25948 | following variables. | |
25949 | ||
25950 | @defvar gnus-registry-track-extra | |
25951 | This is a list of symbols, so it's best to change it from the | |
c3c65d73 TZ |
25952 | Customize interface. By default it's @code{(subject sender)}, which |
25953 | may work for you. It can be annoying if your mail flow is large and | |
64763fe3 MB |
25954 | people don't stick to the same groups. |
25955 | @end defvar | |
25956 | ||
25957 | @defvar gnus-registry-split-strategy | |
25958 | This is a symbol, so it's best to change it from the Customize | |
25959 | interface. By default it's @code{nil}, but you may want to set it to | |
25960 | @code{majority} or @code{first} to split by sender or subject based on | |
c3c65d73 TZ |
25961 | the majority of matches or on the first found. I find @code{majority} |
25962 | works best. | |
64763fe3 MB |
25963 | @end defvar |
25964 | ||
25965 | @node Store custom flags and keywords | |
25966 | @subsection Store custom flags and keywords | |
25967 | ||
25968 | The registry lets you set custom flags and keywords per message. You | |
25969 | can use the Gnus->Registry Marks menu or the @kbd{M M x} keyboard | |
25970 | shortcuts, where @code{x} is the first letter of the mark's name. | |
25971 | ||
25972 | @defvar gnus-registry-marks | |
25973 | The custom marks that the registry can use. You can modify the | |
25974 | default list, if you like. If you do, you'll have to exit Emacs | |
25975 | before they take effect (you can also unload the registry and reload | |
25976 | it or evaluate the specific macros you'll need, but you probably don't | |
25977 | want to bother). Use the Customize interface to modify the list. | |
25978 | ||
25979 | By default this list has the @code{Important}, @code{Work}, | |
25980 | @code{Personal}, @code{To-Do}, and @code{Later} marks. They all have | |
25981 | keyboard shortcuts like @kbd{M M i} for Important, using the first | |
25982 | letter. | |
25983 | @end defvar | |
25984 | ||
25985 | @defun gnus-registry-mark-article | |
25986 | Call this function to mark an article with a custom registry mark. It | |
25987 | will offer the available marks for completion. | |
25988 | @end defun | |
25989 | ||
627abcdd TZ |
25990 | You can use @code{defalias} to install a summary line formatting |
25991 | function that will show the registry marks. There are two flavors of | |
25992 | this function, either showing the marks as single characters, using | |
25993 | their @code{:char} property, or showing the marks as full strings. | |
25994 | ||
25995 | @lisp | |
25996 | ;; show the marks as single characters (see the :char property in | |
25997 | ;; `gnus-registry-marks'): | |
2da9c605 | 25998 | ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-chars) |
627abcdd TZ |
25999 | |
26000 | ;; show the marks by name (see `gnus-registry-marks'): | |
2da9c605 | 26001 | ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-names) |
627abcdd TZ |
26002 | @end lisp |
26003 | ||
26004 | ||
64763fe3 MB |
26005 | @node Store arbitrary data |
26006 | @subsection Store arbitrary data | |
26007 | ||
26008 | The registry has a simple API that uses a Message-ID as the key to | |
26009 | store arbitrary data (as long as it can be converted to a list for | |
26010 | storage). | |
26011 | ||
c3c65d73 TZ |
26012 | @defun gnus-registry-set-id-key (id key value) |
26013 | Store @code{value} under @code{key} for message @code{id}. | |
64763fe3 MB |
26014 | @end defun |
26015 | ||
c3c65d73 TZ |
26016 | @defun gnus-registry-get-id-key (id key) |
26017 | Get the data under @code{key} for message @code{id}. | |
64763fe3 MB |
26018 | @end defun |
26019 | ||
26020 | @defvar gnus-registry-extra-entries-precious | |
26021 | If any extra entries are precious, their presence will make the | |
26022 | registry keep the whole entry forever, even if there are no groups for | |
26023 | the Message-ID and if the size limit of the registry is reached. By | |
26024 | default this is just @code{(marks)} so the custom registry marks are | |
26025 | precious. | |
26026 | @end defvar | |
26027 | ||
4009494e GM |
26028 | @node Other modes |
26029 | @section Interaction with other modes | |
26030 | ||
26031 | @subsection Dired | |
26032 | @cindex dired | |
26033 | ||
26034 | @code{gnus-dired-minor-mode} provides some useful functions for dired | |
26035 | buffers. It is enabled with | |
26036 | @lisp | |
26037 | (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode) | |
26038 | @end lisp | |
26039 | ||
26040 | @table @kbd | |
26041 | @item C-c C-m C-a | |
26042 | @findex gnus-dired-attach | |
26043 | @cindex attachments, selection via dired | |
26044 | Send dired's marked files as an attachment (@code{gnus-dired-attach}). | |
26045 | You will be prompted for a message buffer. | |
26046 | ||
26047 | @item C-c C-m C-l | |
26048 | @findex gnus-dired-find-file-mailcap | |
26049 | Visit a file according to the appropriate mailcap entry | |
26050 | (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new | |
26051 | buffer. | |
26052 | ||
26053 | @item C-c C-m C-p | |
26054 | @findex gnus-dired-print | |
26055 | Print file according to the mailcap entry (@code{gnus-dired-print}). If | |
26056 | there is no print command, print in a PostScript image. | |
26057 | @end table | |
26058 | ||
26059 | @node Various Various | |
26060 | @section Various Various | |
26061 | @cindex mode lines | |
26062 | @cindex highlights | |
26063 | ||
26064 | @table @code | |
26065 | ||
26066 | @item gnus-home-directory | |
26067 | @vindex gnus-home-directory | |
26068 | All Gnus file and directory variables will be initialized from this | |
26069 | variable, which defaults to @file{~/}. | |
26070 | ||
26071 | @item gnus-directory | |
26072 | @vindex gnus-directory | |
26073 | Most Gnus storage file and directory variables will be initialized from | |
26074 | this variable, which defaults to the @env{SAVEDIR} environment | |
26075 | variable, or @file{~/News/} if that variable isn't set. | |
26076 | ||
26077 | Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read. | |
26078 | This means that other directory variables that are initialized from this | |
26079 | variable won't be set properly if you set this variable in | |
26080 | @file{~/.gnus.el}. Set this variable in @file{.emacs} instead. | |
26081 | ||
26082 | @item gnus-default-directory | |
26083 | @vindex gnus-default-directory | |
26084 | Not related to the above variable at all---this variable says what the | |
26085 | default directory of all Gnus buffers should be. If you issue commands | |
26086 | like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's | |
26087 | default directory. If this variable is @code{nil} (which is the | |
26088 | default), the default directory will be the default directory of the | |
26089 | buffer you were in when you started Gnus. | |
26090 | ||
26091 | @item gnus-verbose | |
26092 | @vindex gnus-verbose | |
26093 | This variable is an integer between zero and ten. The higher the value, | |
26094 | the more messages will be displayed. If this variable is zero, Gnus | |
26095 | will never flash any messages, if it is seven (which is the default), | |
26096 | most important messages will be shown, and if it is ten, Gnus won't ever | |
26097 | shut up, but will flash so many messages it will make your head swim. | |
26098 | ||
26099 | @item gnus-verbose-backends | |
26100 | @vindex gnus-verbose-backends | |
26101 | This variable works the same way as @code{gnus-verbose}, but it applies | |
26102 | to the Gnus back ends instead of Gnus proper. | |
26103 | ||
01c52d31 MB |
26104 | @item gnus-add-timestamp-to-message |
26105 | @vindex gnus-add-timestamp-to-message | |
26106 | This variable controls whether to add timestamps to messages that are | |
26107 | controlled by @code{gnus-verbose} and @code{gnus-verbose-backends} and | |
26108 | are issued. The default value is @code{nil} which means never to add | |
26109 | timestamp. If it is @code{log}, add timestamps to only the messages | |
26110 | that go into the @samp{*Messages*} buffer (in XEmacs, it is the | |
26111 | @w{@samp{ *Message-Log*}} buffer). If it is neither @code{nil} nor | |
26112 | @code{log}, add timestamps not only to log messages but also to the ones | |
26113 | displayed in the echo area. | |
26114 | ||
4009494e GM |
26115 | @item nnheader-max-head-length |
26116 | @vindex nnheader-max-head-length | |
26117 | When the back ends read straight heads of articles, they all try to read | |
26118 | as little as possible. This variable (default 8192) specifies | |
26119 | the absolute max length the back ends will try to read before giving up | |
26120 | on finding a separator line between the head and the body. If this | |
26121 | variable is @code{nil}, there is no upper read bound. If it is | |
26122 | @code{t}, the back ends won't try to read the articles piece by piece, | |
26123 | but read the entire articles. This makes sense with some versions of | |
26124 | @code{ange-ftp} or @code{efs}. | |
26125 | ||
26126 | @item nnheader-head-chop-length | |
26127 | @vindex nnheader-head-chop-length | |
26128 | This variable (default 2048) says how big a piece of each article to | |
26129 | read when doing the operation described above. | |
26130 | ||
26131 | @item nnheader-file-name-translation-alist | |
26132 | @vindex nnheader-file-name-translation-alist | |
26133 | @cindex file names | |
26134 | @cindex invalid characters in file names | |
26135 | @cindex characters in file names | |
26136 | This is an alist that says how to translate characters in file names. | |
26137 | For instance, if @samp{:} is invalid as a file character in file names | |
26138 | on your system (you OS/2 user you), you could say something like: | |
26139 | ||
26140 | @lisp | |
26141 | @group | |
26142 | (setq nnheader-file-name-translation-alist | |
26143 | '((?: . ?_))) | |
26144 | @end group | |
26145 | @end lisp | |
26146 | ||
26147 | In fact, this is the default value for this variable on OS/2 and MS | |
26148 | Windows (phooey) systems. | |
26149 | ||
26150 | @item gnus-hidden-properties | |
26151 | @vindex gnus-hidden-properties | |
26152 | This is a list of properties to use to hide ``invisible'' text. It is | |
26153 | @code{(invisible t intangible t)} by default on most systems, which | |
26154 | makes invisible text invisible and intangible. | |
26155 | ||
26156 | @item gnus-parse-headers-hook | |
26157 | @vindex gnus-parse-headers-hook | |
26158 | A hook called before parsing headers. It can be used, for instance, to | |
26159 | gather statistics on the headers fetched, or perhaps you'd like to prune | |
26160 | some headers. I don't see why you'd want that, though. | |
26161 | ||
26162 | @item gnus-shell-command-separator | |
26163 | @vindex gnus-shell-command-separator | |
26164 | String used to separate two shell commands. The default is @samp{;}. | |
26165 | ||
26166 | @item gnus-invalid-group-regexp | |
26167 | @vindex gnus-invalid-group-regexp | |
26168 | ||
26169 | Regexp to match ``invalid'' group names when querying user for a group | |
26170 | name. The default value catches some @strong{really} invalid group | |
26171 | names who could possibly mess up Gnus internally (like allowing | |
26172 | @samp{:} in a group name, which is normally used to delimit method and | |
26173 | group). | |
26174 | ||
26175 | @acronym{IMAP} users might want to allow @samp{/} in group names though. | |
26176 | ||
b0b63450 MB |
26177 | @item gnus-safe-html-newsgroups |
26178 | @vindex gnus-safe-html-newsgroups | |
26179 | Groups in which links in html articles are considered all safe. The | |
26180 | value may be a regexp matching those groups, a list of group names, or | |
26181 | @code{nil}. This overrides @code{mm-w3m-safe-url-regexp}. The default | |
26182 | value is @code{"\\`nnrss[+:]"}. This is effective only when emacs-w3m | |
26183 | renders html articles, i.e., in the case @code{mm-text-html-renderer} is | |
26184 | set to @code{w3m}. @xref{Display Customization, ,Display Customization, | |
26185 | emacs-mime, The Emacs MIME Manual}. | |
4009494e GM |
26186 | |
26187 | @end table | |
26188 | ||
26189 | @node The End | |
26190 | @chapter The End | |
26191 | ||
26192 | Well, that's the manual---you can get on with your life now. Keep in | |
26193 | touch. Say hello to your cats from me. | |
26194 | ||
26195 | My @strong{ghod}---I just can't stand goodbyes. Sniffle. | |
26196 | ||
26197 | Ol' Charles Reznikoff said it pretty well, so I leave the floor to him: | |
26198 | ||
26199 | @quotation | |
26200 | @strong{Te Deum} | |
26201 | ||
26202 | @sp 1 | |
26203 | Not because of victories @* | |
26204 | I sing,@* | |
26205 | having none,@* | |
26206 | but for the common sunshine,@* | |
26207 | the breeze,@* | |
26208 | the largess of the spring. | |
26209 | ||
26210 | @sp 1 | |
26211 | Not for victory@* | |
26212 | but for the day's work done@* | |
26213 | as well as I was able;@* | |
26214 | not for a seat upon the dais@* | |
26215 | but at the common table.@* | |
26216 | @end quotation | |
26217 | ||
26218 | ||
26219 | @node Appendices | |
26220 | @chapter Appendices | |
26221 | ||
26222 | @menu | |
26223 | * XEmacs:: Requirements for installing under XEmacs. | |
26224 | * History:: How Gnus got where it is today. | |
26225 | * On Writing Manuals:: Why this is not a beginner's guide. | |
26226 | * Terminology:: We use really difficult, like, words here. | |
26227 | * Customization:: Tailoring Gnus to your needs. | |
26228 | * Troubleshooting:: What you might try if things do not work. | |
26229 | * Gnus Reference Guide:: Rilly, rilly technical stuff. | |
26230 | * Emacs for Heathens:: A short introduction to Emacsian terms. | |
26231 | * Frequently Asked Questions:: The Gnus FAQ | |
26232 | @end menu | |
26233 | ||
26234 | ||
26235 | @node XEmacs | |
26236 | @section XEmacs | |
26237 | @cindex XEmacs | |
26238 | @cindex installing under XEmacs | |
26239 | ||
26240 | XEmacs is distributed as a collection of packages. You should install | |
26241 | whatever packages the Gnus XEmacs package requires. The current | |
26242 | requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base}, | |
26243 | @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils}, | |
26244 | @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3}, | |
26245 | @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}. | |
26246 | ||
26247 | ||
26248 | @node History | |
26249 | @section History | |
26250 | ||
26251 | @cindex history | |
26252 | @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in | |
26253 | '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus. | |
26254 | ||
26255 | If you want to investigate the person responsible for this outrage, | |
26256 | you can point your (feh!) web browser to | |
26257 | @uref{http://quimby.gnus.org/}. This is also the primary | |
26258 | distribution point for the new and spiffy versions of Gnus, and is | |
26259 | known as The Site That Destroys Newsrcs And Drives People Mad. | |
26260 | ||
26261 | During the first extended alpha period of development, the new Gnus was | |
26262 | called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for | |
26263 | @dfn{ding is not Gnus}, which is a total and utter lie, but who cares? | |
26264 | (Besides, the ``Gnus'' in this abbreviation should probably be | |
26265 | pronounced ``news'' as @sc{Umeda} intended, which makes it a more | |
26266 | appropriate name, don't you think?) | |
26267 | ||
26268 | In any case, after spending all that energy on coming up with a new and | |
26269 | spunky name, we decided that the name was @emph{too} spunky, so we | |
26270 | renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs. | |
26271 | ``@sc{gnus}''. New vs. old. | |
26272 | ||
26273 | @menu | |
26274 | * Gnus Versions:: What Gnus versions have been released. | |
4009494e GM |
26275 | * Why?:: What's the point of Gnus? |
26276 | * Compatibility:: Just how compatible is Gnus with @sc{gnus}? | |
26277 | * Conformity:: Gnus tries to conform to all standards. | |
26278 | * Emacsen:: Gnus can be run on a few modern Emacsen. | |
26279 | * Gnus Development:: How Gnus is developed. | |
26280 | * Contributors:: Oodles of people. | |
26281 | * New Features:: Pointers to some of the new stuff in Gnus. | |
26282 | @end menu | |
26283 | ||
26284 | ||
26285 | @node Gnus Versions | |
26286 | @subsection Gnus Versions | |
26287 | @cindex ding Gnus | |
26288 | @cindex September Gnus | |
26289 | @cindex Red Gnus | |
26290 | @cindex Quassia Gnus | |
26291 | @cindex Pterodactyl Gnus | |
26292 | @cindex Oort Gnus | |
26293 | @cindex No Gnus | |
89b163db | 26294 | @cindex Ma Gnus |
4009494e GM |
26295 | @cindex Gnus versions |
26296 | ||
26297 | The first ``proper'' release of Gnus 5 was done in November 1995 when it | |
26298 | was included in the Emacs 19.30 distribution (132 (ding) Gnus releases | |
26299 | plus 15 Gnus 5.0 releases). | |
26300 | ||
26301 | In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99 | |
26302 | releases)) was released under the name ``Gnus 5.2'' (40 releases). | |
26303 | ||
26304 | On July 28th 1996 work on Red Gnus was begun, and it was released on | |
26305 | January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases). | |
26306 | ||
26307 | On September 13th 1997, Quassia Gnus was started and lasted 37 releases. | |
26308 | It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases). | |
26309 | ||
26310 | Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as | |
26311 | ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd | |
26312 | 1999. | |
26313 | ||
26314 | On the 26th of October 2000, Oort Gnus was begun and was released as | |
26315 | Gnus 5.10 on May 1st 2003 (24 releases). | |
26316 | ||
26317 | On the January 4th 2004, No Gnus was begun. | |
26318 | ||
bff3818b KY |
26319 | On April 19, 2010 Gnus development was moved to Git. See |
26320 | http://git.gnus.org for details (http://www.gnus.org will be updated | |
26321 | with the information when possible). | |
26322 | ||
89b163db G |
26323 | On the January 31th 2012, Ma Gnus was begun. |
26324 | ||
4009494e GM |
26325 | If you happen upon a version of Gnus that has a prefixed name -- |
26326 | ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'', | |
89b163db G |
26327 | ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'', ``Ma Gnus'' -- don't |
26328 | panic. Don't let it know that you're frightened. Back away. Slowly. | |
26329 | Whatever you do, don't run. Walk away, calmly, until you're out of | |
26330 | its reach. Find a proper released version of Gnus and snuggle up to | |
26331 | that instead. | |
4009494e GM |
26332 | |
26333 | ||
4009494e GM |
26334 | @node Why? |
26335 | @subsection Why? | |
26336 | ||
26337 | What's the point of Gnus? | |
26338 | ||
26339 | I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep'' | |
26340 | newsreader, that lets you do anything you can think of. That was my | |
26341 | original motivation, but while working on Gnus, it has become clear to | |
26342 | me that this generation of newsreaders really belong in the stone age. | |
26343 | Newsreaders haven't developed much since the infancy of the net. If the | |
26344 | volume continues to rise with the current rate of increase, all current | |
26345 | newsreaders will be pretty much useless. How do you deal with | |
26346 | newsgroups that have thousands of new articles each day? How do you | |
26347 | keep track of millions of people who post? | |
26348 | ||
26349 | Gnus offers no real solutions to these questions, but I would very much | |
26350 | like to see Gnus being used as a testing ground for new methods of | |
26351 | reading and fetching news. Expanding on @sc{Umeda}-san's wise decision | |
26352 | to separate the newsreader from the back ends, Gnus now offers a simple | |
26353 | interface for anybody who wants to write new back ends for fetching mail | |
26354 | and news from different sources. I have added hooks for customizations | |
26355 | everywhere I could imagine it being useful. By doing so, I'm inviting | |
26356 | every one of you to explore and invent. | |
26357 | ||
26358 | May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and | |
26359 | @kbd{C-u 100 M-x all-hail-xemacs}. | |
26360 | ||
26361 | ||
26362 | @node Compatibility | |
26363 | @subsection Compatibility | |
26364 | ||
26365 | @cindex compatibility | |
26366 | Gnus was designed to be fully compatible with @sc{gnus}. Almost all key | |
26367 | bindings have been kept. More key bindings have been added, of course, | |
26368 | but only in one or two obscure cases have old bindings been changed. | |
26369 | ||
26370 | Our motto is: | |
26371 | @quotation | |
26372 | @cartouche | |
26373 | @center In a cloud bones of steel. | |
26374 | @end cartouche | |
26375 | @end quotation | |
26376 | ||
26377 | All commands have kept their names. Some internal functions have changed | |
26378 | their names. | |
26379 | ||
26380 | The @code{gnus-uu} package has changed drastically. @xref{Decoding | |
26381 | Articles}. | |
26382 | ||
26383 | One major compatibility question is the presence of several summary | |
26384 | buffers. All variables relevant while reading a group are | |
26385 | buffer-local to the summary buffer they belong in. Although many | |
26386 | important variables have their values copied into their global | |
26387 | counterparts whenever a command is executed in the summary buffer, this | |
26388 | change might lead to incorrect values being used unless you are careful. | |
26389 | ||
26390 | All code that relies on knowledge of @sc{gnus} internals will probably | |
26391 | fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or | |
26392 | changing it in any way, as a matter of fact) is strictly verboten. Gnus | |
26393 | maintains a hash table that points to the entries in this alist (which | |
26394 | speeds up many functions), and changing the alist directly will lead to | |
26395 | peculiar results. | |
26396 | ||
26397 | @cindex hilit19 | |
26398 | @cindex highlighting | |
26399 | Old hilit19 code does not work at all. In fact, you should probably | |
26400 | remove all hilit code from all Gnus hooks | |
26401 | (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}). | |
26402 | Gnus provides various integrated functions for highlighting. These are | |
26403 | faster and more accurate. To make life easier for everybody, Gnus will | |
26404 | by default remove all hilit calls from all hilit hooks. Uncleanliness! | |
26405 | Away! | |
26406 | ||
26407 | Packages like @code{expire-kill} will no longer work. As a matter of | |
26408 | fact, you should probably remove all old @sc{gnus} packages (and other | |
26409 | code) when you start using Gnus. More likely than not, Gnus already | |
26410 | does what you have written code to make @sc{gnus} do. (Snicker.) | |
26411 | ||
26412 | Even though old methods of doing things are still supported, only the | |
26413 | new methods are documented in this manual. If you detect a new method of | |
26414 | doing something while reading this manual, that does not mean you have | |
26415 | to stop doing it the old way. | |
26416 | ||
26417 | Gnus understands all @sc{gnus} startup files. | |
26418 | ||
26419 | @kindex M-x gnus-bug | |
26420 | @findex gnus-bug | |
26421 | @cindex reporting bugs | |
26422 | @cindex bugs | |
26423 | Overall, a casual user who hasn't written much code that depends on | |
26424 | @sc{gnus} internals should suffer no problems. If problems occur, | |
26425 | please let me know by issuing that magic command @kbd{M-x gnus-bug}. | |
26426 | ||
26427 | @vindex gnus-bug-create-help-buffer | |
26428 | If you are in the habit of sending bug reports @emph{very} often, you | |
26429 | may find the helpful help buffer annoying after a while. If so, set | |
26430 | @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop | |
26431 | up at you. | |
26432 | ||
26433 | ||
26434 | @node Conformity | |
26435 | @subsection Conformity | |
26436 | ||
26437 | No rebels without a clue here, ma'am. We conform to all standards known | |
26438 | to (wo)man. Except for those standards and/or conventions we disagree | |
26439 | with, of course. | |
26440 | ||
26441 | @table @strong | |
26442 | ||
26443 | @item RFC (2)822 | |
26444 | @cindex RFC 822 | |
26445 | @cindex RFC 2822 | |
26446 | There are no known breaches of this standard. | |
26447 | ||
26448 | @item RFC 1036 | |
26449 | @cindex RFC 1036 | |
26450 | There are no known breaches of this standard, either. | |
26451 | ||
26452 | @item Son-of-RFC 1036 | |
26453 | @cindex Son-of-RFC 1036 | |
26454 | We do have some breaches to this one. | |
26455 | ||
26456 | @table @emph | |
26457 | ||
26458 | @item X-Newsreader | |
26459 | @itemx User-Agent | |
26460 | These are considered to be ``vanity headers'', while I consider them | |
26461 | to be consumer information. After seeing so many badly formatted | |
26462 | articles coming from @code{tin} and @code{Netscape} I know not to use | |
26463 | either of those for posting articles. I would not have known that if | |
26464 | it wasn't for the @code{X-Newsreader} header. | |
26465 | @end table | |
26466 | ||
26467 | @item USEFOR | |
26468 | @cindex USEFOR | |
26469 | USEFOR is an IETF working group writing a successor to RFC 1036, based | |
26470 | on Son-of-RFC 1036. They have produced a number of drafts proposing | |
26471 | various changes to the format of news articles. The Gnus towers will | |
26472 | look into implementing the changes when the draft is accepted as an RFC. | |
26473 | ||
26474 | @item MIME - RFC 2045-2049 etc | |
26475 | @cindex @acronym{MIME} | |
26476 | All the various @acronym{MIME} RFCs are supported. | |
26477 | ||
26478 | @item Disposition Notifications - RFC 2298 | |
26479 | Message Mode is able to request notifications from the receiver. | |
26480 | ||
26481 | @item PGP - RFC 1991 and RFC 2440 | |
26482 | @cindex RFC 1991 | |
26483 | @cindex RFC 2440 | |
26484 | RFC 1991 is the original @acronym{PGP} message specification, | |
1df7defd | 26485 | published as an informational RFC@. RFC 2440 was the follow-up, now |
4009494e GM |
26486 | called Open PGP, and put on the Standards Track. Both document a |
26487 | non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both | |
26488 | encoding (signing and encryption) and decoding (verification and | |
26489 | decryption). | |
26490 | ||
26491 | @item PGP/MIME - RFC 2015/3156 | |
26492 | RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC | |
26493 | 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format. | |
26494 | Gnus supports both encoding and decoding. | |
26495 | ||
26496 | @item S/MIME - RFC 2633 | |
26497 | RFC 2633 describes the @acronym{S/MIME} format. | |
26498 | ||
26499 | @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731 | |
26500 | RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060 | |
26501 | (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5 | |
26502 | authentication for @acronym{IMAP}. RFC 2086 describes access control | |
26503 | lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP} | |
26504 | protocol enhancement. RFC 2595 describes the proper @acronym{TLS} | |
26505 | integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the | |
26506 | GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}. | |
26507 | ||
26508 | @end table | |
26509 | ||
26510 | If you ever notice Gnus acting non-compliant with regards to the texts | |
26511 | mentioned above, don't hesitate to drop a note to Gnus Towers and let us | |
26512 | know. | |
26513 | ||
26514 | ||
26515 | @node Emacsen | |
26516 | @subsection Emacsen | |
26517 | @cindex Emacsen | |
26518 | @cindex XEmacs | |
26519 | @cindex Mule | |
26520 | @cindex Emacs | |
26521 | ||
d55fe5bb | 26522 | This version of Gnus should work on: |
4009494e GM |
26523 | |
26524 | @itemize @bullet | |
26525 | ||
26526 | @item | |
26527 | Emacs 21.1 and up. | |
26528 | ||
26529 | @item | |
26530 | XEmacs 21.4 and up. | |
26531 | ||
26532 | @end itemize | |
26533 | ||
26534 | This Gnus version will absolutely not work on any Emacsen older than | |
26535 | that. Not reliably, at least. Older versions of Gnus may work on older | |
26536 | Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs | |
26537 | 20.7 and XEmacs 21.1. | |
26538 | ||
d55fe5bb MB |
26539 | @c No-merge comment: The paragraph added in v5-10 here must not be |
26540 | @c synced here! | |
4009494e GM |
26541 | |
26542 | @node Gnus Development | |
26543 | @subsection Gnus Development | |
26544 | ||
26545 | Gnus is developed in a two-phased cycle. The first phase involves much | |
9b3ebcb6 | 26546 | discussion on the development mailing list @samp{ding@@gnus.org}, where people |
4009494e GM |
26547 | propose changes and new features, post patches and new back ends. This |
26548 | phase is called the @dfn{alpha} phase, since the Gnusae released in this | |
26549 | phase are @dfn{alpha releases}, or (perhaps more commonly in other | |
26550 | circles) @dfn{snapshots}. During this phase, Gnus is assumed to be | |
26551 | unstable and should not be used by casual users. Gnus alpha releases | |
9b3ebcb6 | 26552 | have names like ``Oort Gnus'' and ``No Gnus''. @xref{Gnus Versions}. |
4009494e | 26553 | |
9b3ebcb6 | 26554 | After futzing around for 10-100 alpha releases, Gnus is declared |
4009494e | 26555 | @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix, |
9b3ebcb6 | 26556 | and is called things like ``Gnus 5.10.1'' instead. Normal people are |
4009494e | 26557 | supposed to be able to use these, and these are mostly discussed on the |
9b3ebcb6 MB |
26558 | @samp{gnu.emacs.gnus} newsgroup. This newgroup is mirrored to the |
26559 | mailing list @samp{info-gnus-english@@gnu.org} which is carried on Gmane | |
26560 | as @samp{gmane.emacs.gnus.user}. These releases are finally integrated | |
26561 | in Emacs. | |
4009494e GM |
26562 | |
26563 | @cindex Incoming* | |
26564 | @vindex mail-source-delete-incoming | |
37a68866 MB |
26565 | Some variable defaults differ between alpha Gnusae and released Gnusae, |
26566 | in particular, @code{mail-source-delete-incoming}. This is to prevent | |
4009494e | 26567 | lossage of mail if an alpha release hiccups while handling the mail. |
37a68866 | 26568 | @xref{Mail Source Customization}. |
4009494e GM |
26569 | |
26570 | The division of discussion between the ding mailing list and the Gnus | |
26571 | newsgroup is not purely based on publicity concerns. It's true that | |
26572 | having people write about the horrible things that an alpha Gnus release | |
26573 | can do (sometimes) in a public forum may scare people off, but more | |
26574 | importantly, talking about new experimental features that have been | |
26575 | introduced may confuse casual users. New features are frequently | |
26576 | introduced, fiddled with, and judged to be found wanting, and then | |
26577 | either discarded or totally rewritten. People reading the mailing list | |
26578 | usually keep up with these rapid changes, while people on the newsgroup | |
26579 | can't be assumed to do so. | |
26580 | ||
9b3ebcb6 MB |
26581 | So if you have problems with or questions about the alpha versions, |
26582 | direct those to the ding mailing list @samp{ding@@gnus.org}. This list | |
26583 | is also available on Gmane as @samp{gmane.emacs.gnus.general}. | |
4009494e | 26584 | |
9b3ebcb6 MB |
26585 | @cindex Incoming* |
26586 | @vindex mail-source-delete-incoming | |
26587 | Some variable defaults differ between alpha Gnusae and released Gnusae, | |
26588 | in particular, @code{mail-source-delete-incoming}. This is to prevent | |
26589 | lossage of mail if an alpha release hiccups while handling the mail. | |
26590 | @xref{Mail Source Customization}. | |
4009494e GM |
26591 | |
26592 | @node Contributors | |
26593 | @subsection Contributors | |
26594 | @cindex contributors | |
26595 | ||
26596 | The new Gnus version couldn't have been done without the help of all the | |
26597 | people on the (ding) mailing list. Every day for over a year I have | |
26598 | gotten billions of nice bug reports from them, filling me with joy, | |
26599 | every single one of them. Smooches. The people on the list have been | |
26600 | tried beyond endurance, what with my ``oh, that's a neat idea <type | |
26601 | type>, yup, I'll release it right away <ship off> no wait, that doesn't | |
26602 | work at all <type type>, yup, I'll ship that one off right away <ship | |
26603 | off> no, wait, that absolutely does not work'' policy for releases. | |
26604 | Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that | |
26605 | ``worser''? ``much worser''? ``worsest''?) | |
26606 | ||
26607 | I would like to take this opportunity to thank the Academy for@dots{} oops, | |
26608 | wrong show. | |
26609 | ||
26610 | @itemize @bullet | |
26611 | ||
26612 | @item | |
26613 | Masanobu @sc{Umeda}---the writer of the original @sc{gnus}. | |
26614 | ||
26615 | @item | |
6b958814 | 26616 | Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, |
4009494e GM |
26617 | nnwarchive and many, many other things connected with @acronym{MIME} and |
26618 | other types of en/decoding, as well as general bug fixing, new | |
26619 | functionality and stuff. | |
26620 | ||
26621 | @item | |
26622 | Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as | |
26623 | well as numerous other things). | |
26624 | ||
26625 | @item | |
26626 | Luis Fernandes---design and graphics. | |
26627 | ||
26628 | @item | |
26629 | Joe Reiss---creator of the smiley faces. | |
26630 | ||
26631 | @item | |
26632 | Justin Sheehy---the @acronym{FAQ} maintainer. | |
26633 | ||
26634 | @item | |
26635 | Erik Naggum---help, ideas, support, code and stuff. | |
26636 | ||
26637 | @item | |
26638 | Wes Hardaker---@file{gnus-picon.el} and the manual section on | |
26639 | @dfn{picons} (@pxref{Picons}). | |
26640 | ||
26641 | @item | |
26642 | Kim-Minh Kaplan---further work on the picon code. | |
26643 | ||
26644 | @item | |
01c52d31 | 26645 | Brad Miller---@file{gnus-gl.el} and the GroupLens manual section. |
4009494e GM |
26646 | |
26647 | @item | |
26648 | Sudish Joseph---innumerable bug fixes. | |
26649 | ||
26650 | @item | |
26651 | Ilja Weis---@file{gnus-topic.el}. | |
26652 | ||
26653 | @item | |
4c36be58 | 26654 | Steven L. Baur---lots and lots and lots of bug detection and fixes. |
4009494e GM |
26655 | |
26656 | @item | |
26657 | Vladimir Alexiev---the refcard and reference booklets. | |
26658 | ||
26659 | @item | |
26660 | Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus | |
26661 | distribution by Felix Lee and JWZ. | |
26662 | ||
26663 | @item | |
26664 | Scott Byer---@file{nnfolder.el} enhancements & rewrite. | |
26665 | ||
26666 | @item | |
26667 | Peter Mutsaers---orphan article scoring code. | |
26668 | ||
26669 | @item | |
26670 | Ken Raeburn---POP mail support. | |
26671 | ||
26672 | @item | |
26673 | Hallvard B Furuseth---various bits and pieces, especially dealing with | |
26674 | .newsrc files. | |
26675 | ||
26676 | @item | |
26677 | Brian Edmonds---@file{gnus-bbdb.el}. | |
26678 | ||
26679 | @item | |
26680 | David Moore---rewrite of @file{nnvirtual.el} and many other things. | |
26681 | ||
26682 | @item | |
26683 | Kevin Davidson---came up with the name @dfn{ding}, so blame him. | |
26684 | ||
26685 | @item | |
01c52d31 | 26686 | Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as |
4009494e GM |
26687 | well as autoconf support. |
26688 | ||
26689 | @end itemize | |
26690 | ||
26691 | This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark | |
26692 | Borges, and Jost Krieger proof-reading parts of the manual. | |
26693 | ||
26694 | The following people have contributed many patches and suggestions: | |
26695 | ||
26696 | Christopher Davis, | |
26697 | Andrew Eskilsson, | |
26698 | Kai Grossjohann, | |
26699 | Kevin Greiner, | |
26700 | Jesper Harder, | |
26701 | Paul Jarc, | |
26702 | Simon Josefsson, | |
01c52d31 | 26703 | David K@aa{}gedal, |
4009494e GM |
26704 | Richard Pieri, |
26705 | Fabrice Popineau, | |
26706 | Daniel Quinlan, | |
26707 | Michael Shields, | |
26708 | Reiner Steib, | |
26709 | Jason L. Tibbitts, III, | |
26710 | Jack Vinson, | |
26711 | Katsumi Yamaoka, @c Yamaoka | |
26712 | and | |
26713 | Teodor Zlatanov. | |
26714 | ||
26715 | Also thanks to the following for patches and stuff: | |
26716 | ||
26717 | Jari Aalto, | |
26718 | Adrian Aichner, | |
26719 | Vladimir Alexiev, | |
26720 | Russ Allbery, | |
26721 | Peter Arius, | |
26722 | Matt Armstrong, | |
26723 | Marc Auslander, | |
26724 | Miles Bader, | |
26725 | Alexei V. Barantsev, | |
26726 | Frank Bennett, | |
26727 | Robert Bihlmeyer, | |
26728 | Chris Bone, | |
26729 | Mark Borges, | |
26730 | Mark Boyns, | |
26731 | Lance A. Brown, | |
26732 | Rob Browning, | |
26733 | Kees de Bruin, | |
26734 | Martin Buchholz, | |
26735 | Joe Buehler, | |
26736 | Kevin Buhr, | |
26737 | Alastair Burt, | |
26738 | Joao Cachopo, | |
26739 | Zlatko Calusic, | |
26740 | Massimo Campostrini, | |
26741 | Castor, | |
26742 | David Charlap, | |
26743 | Dan Christensen, | |
26744 | Kevin Christian, | |
26745 | Jae-you Chung, @c ? | |
26746 | James H. Cloos, Jr., | |
26747 | Laura Conrad, | |
26748 | Michael R. Cook, | |
26749 | Glenn Coombs, | |
26750 | Andrew J. Cosgriff, | |
26751 | Neil Crellin, | |
26752 | Frank D. Cringle, | |
26753 | Geoffrey T. Dairiki, | |
26754 | Andre Deparade, | |
26755 | Ulrik Dickow, | |
26756 | Dave Disser, | |
26757 | Rui-Tao Dong, @c ? | |
26758 | Joev Dubach, | |
26759 | Michael Welsh Duggan, | |
26760 | Dave Edmondson, | |
26761 | Paul Eggert, | |
26762 | Mark W. Eichin, | |
26763 | Karl Eichwalder, | |
26764 | Enami Tsugutomo, @c Enami | |
26765 | Michael Ernst, | |
26766 | Luc Van Eycken, | |
26767 | Sam Falkner, | |
26768 | Nelson Jose dos Santos Ferreira, | |
26769 | Sigbjorn Finne, | |
26770 | Sven Fischer, | |
26771 | Paul Fisher, | |
26772 | Decklin Foster, | |
26773 | Gary D. Foster, | |
26774 | Paul Franklin, | |
26775 | Guy Geens, | |
26776 | Arne Georg Gleditsch, | |
26777 | David S. Goldberg, | |
26778 | Michelangelo Grigni, | |
26779 | Dale Hagglund, | |
26780 | D. Hall, | |
26781 | Magnus Hammerin, | |
26782 | Kenichi Handa, @c Handa | |
26783 | Raja R. Harinath, | |
26784 | Yoshiki Hayashi, @c Hayashi | |
26785 | P. E. Jareth Hein, | |
26786 | Hisashige Kenji, @c Hisashige | |
26787 | Scott Hofmann, | |
01c52d31 | 26788 | Tassilo Horn, |
4009494e GM |
26789 | Marc Horowitz, |
26790 | Gunnar Horrigmo, | |
26791 | Richard Hoskins, | |
26792 | Brad Howes, | |
26793 | Miguel de Icaza, | |
01c52d31 | 26794 | Fran@,{c}ois Felix Ingrand, |
4009494e GM |
26795 | Tatsuya Ichikawa, @c Ichikawa |
26796 | Ishikawa Ichiro, @c Ishikawa | |
26797 | Lee Iverson, | |
26798 | Iwamuro Motonori, @c Iwamuro | |
26799 | Rajappa Iyer, | |
26800 | Andreas Jaeger, | |
26801 | Adam P. Jenkins, | |
26802 | Randell Jesup, | |
26803 | Fred Johansen, | |
26804 | Gareth Jones, | |
26805 | Greg Klanderman, | |
26806 | Karl Kleinpaste, | |
26807 | Michael Klingbeil, | |
26808 | Peter Skov Knudsen, | |
26809 | Shuhei Kobayashi, @c Kobayashi | |
26810 | Petr Konecny, | |
26811 | Koseki Yoshinori, @c Koseki | |
26812 | Thor Kristoffersen, | |
26813 | Jens Lautenbacher, | |
26814 | Martin Larose, | |
26815 | Seokchan Lee, @c Lee | |
26816 | Joerg Lenneis, | |
26817 | Carsten Leonhardt, | |
26818 | James LewisMoss, | |
26819 | Christian Limpach, | |
26820 | Markus Linnala, | |
26821 | Dave Love, | |
26822 | Mike McEwan, | |
26823 | Tonny Madsen, | |
26824 | Shlomo Mahlab, | |
26825 | Nat Makarevitch, | |
26826 | Istvan Marko, | |
26827 | David Martin, | |
26828 | Jason R. Mastaler, | |
26829 | Gordon Matzigkeit, | |
26830 | Timo Metzemakers, | |
26831 | Richard Mlynarik, | |
26832 | Lantz Moore, | |
26833 | Morioka Tomohiko, @c Morioka | |
26834 | Erik Toubro Nielsen, | |
26835 | Hrvoje Niksic, | |
26836 | Andy Norman, | |
26837 | Fred Oberhauser, | |
26838 | C. R. Oldham, | |
26839 | Alexandre Oliva, | |
26840 | Ken Olstad, | |
26841 | Masaharu Onishi, @c Onishi | |
26842 | Hideki Ono, @c Ono | |
26843 | Ettore Perazzoli, | |
26844 | William Perry, | |
26845 | Stephen Peters, | |
26846 | Jens-Ulrik Holger Petersen, | |
26847 | Ulrich Pfeifer, | |
26848 | Matt Pharr, | |
26849 | Andy Piper, | |
26850 | John McClary Prevost, | |
26851 | Bill Pringlemeir, | |
26852 | Mike Pullen, | |
26853 | Jim Radford, | |
26854 | Colin Rafferty, | |
26855 | Lasse Rasinen, | |
26856 | Lars Balker Rasmussen, | |
26857 | Joe Reiss, | |
26858 | Renaud Rioboo, | |
26859 | Roland B. Roberts, | |
26860 | Bart Robinson, | |
26861 | Christian von Roques, | |
26862 | Markus Rost, | |
26863 | Jason Rumney, | |
26864 | Wolfgang Rupprecht, | |
26865 | Jay Sachs, | |
26866 | Dewey M. Sasser, | |
26867 | Conrad Sauerwald, | |
26868 | Loren Schall, | |
26869 | Dan Schmidt, | |
26870 | Ralph Schleicher, | |
26871 | Philippe Schnoebelen, | |
26872 | Andreas Schwab, | |
26873 | Randal L. Schwartz, | |
26874 | Danny Siu, | |
26875 | Matt Simmons, | |
26876 | Paul D. Smith, | |
26877 | Jeff Sparkes, | |
26878 | Toby Speight, | |
26879 | Michael Sperber, | |
26880 | Darren Stalder, | |
26881 | Richard Stallman, | |
26882 | Greg Stark, | |
26883 | Sam Steingold, | |
26884 | Paul Stevenson, | |
26885 | Jonas Steverud, | |
26886 | Paul Stodghill, | |
26887 | Kiyokazu Suto, @c Suto | |
26888 | Kurt Swanson, | |
26889 | Samuel Tardieu, | |
26890 | Teddy, | |
26891 | Chuck Thompson, | |
26892 | Tozawa Akihiko, @c Tozawa | |
26893 | Philippe Troin, | |
26894 | James Troup, | |
26895 | Trung Tran-Duc, | |
26896 | Jack Twilley, | |
26897 | Aaron M. Ucko, | |
26898 | Aki Vehtari, | |
26899 | Didier Verna, | |
26900 | Vladimir Volovich, | |
26901 | Jan Vroonhof, | |
26902 | Stefan Waldherr, | |
26903 | Pete Ware, | |
26904 | Barry A. Warsaw, | |
26905 | Christoph Wedler, | |
26906 | Joe Wells, | |
26907 | Lee Willis, | |
26908 | and | |
26909 | Lloyd Zusman. | |
26910 | ||
26911 | ||
26912 | For a full overview of what each person has done, the ChangeLogs | |
26913 | included in the Gnus alpha distributions should give ample reading | |
26914 | (550kB and counting). | |
26915 | ||
26916 | Apologies to everybody that I've forgotten, of which there are many, I'm | |
26917 | sure. | |
26918 | ||
26919 | Gee, that's quite a list of people. I guess that must mean that there | |
26920 | actually are people who are using Gnus. Who'd'a thunk it! | |
26921 | ||
26922 | ||
26923 | @node New Features | |
26924 | @subsection New Features | |
26925 | @cindex new features | |
26926 | ||
26927 | @menu | |
26928 | * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus. | |
26929 | * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3. | |
26930 | * Red Gnus:: Third time best---Gnus 5.4/5.5. | |
26931 | * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7. | |
26932 | * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9. | |
26933 | * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11. | |
89b163db G |
26934 | * No Gnus:: Very punny. Gnus 5.12/5.13. |
26935 | * Ma Gnus:: Celebrating 25 years of Gnus. | |
4009494e GM |
26936 | @end menu |
26937 | ||
26938 | These lists are, of course, just @emph{short} overviews of the | |
26939 | @emph{most} important new features. No, really. There are tons more. | |
26940 | Yes, we have feeping creaturism in full effect. | |
26941 | ||
26942 | @node ding Gnus | |
26943 | @subsubsection (ding) Gnus | |
26944 | ||
26945 | New features in Gnus 5.0/5.1: | |
26946 | ||
26947 | @itemize @bullet | |
26948 | ||
26949 | @item | |
26950 | The look of all buffers can be changed by setting format-like variables | |
26951 | (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). | |
26952 | ||
26953 | @item | |
26954 | Local spool and several @acronym{NNTP} servers can be used at once | |
26955 | (@pxref{Select Methods}). | |
26956 | ||
26957 | @item | |
26958 | You can combine groups into virtual groups (@pxref{Virtual Groups}). | |
26959 | ||
26960 | @item | |
26961 | You can read a number of different mail formats (@pxref{Getting Mail}). | |
26962 | All the mail back ends implement a convenient mail expiry scheme | |
26963 | (@pxref{Expiring Mail}). | |
26964 | ||
26965 | @item | |
26966 | Gnus can use various strategies for gathering threads that have lost | |
26967 | their roots (thereby gathering loose sub-threads into one thread) or it | |
26968 | can go back and retrieve enough headers to build a complete thread | |
26969 | (@pxref{Customizing Threading}). | |
26970 | ||
26971 | @item | |
26972 | Killed groups can be displayed in the group buffer, and you can read | |
26973 | them as well (@pxref{Listing Groups}). | |
26974 | ||
26975 | @item | |
26976 | Gnus can do partial group updates---you do not have to retrieve the | |
26977 | entire active file just to check for new articles in a few groups | |
26978 | (@pxref{The Active File}). | |
26979 | ||
26980 | @item | |
26981 | Gnus implements a sliding scale of subscribedness to groups | |
26982 | (@pxref{Group Levels}). | |
26983 | ||
26984 | @item | |
26985 | You can score articles according to any number of criteria | |
26986 | (@pxref{Scoring}). You can even get Gnus to find out how to score | |
26987 | articles for you (@pxref{Adaptive Scoring}). | |
26988 | ||
26989 | @item | |
26990 | Gnus maintains a dribble buffer that is auto-saved the normal Emacs | |
26991 | manner, so it should be difficult to lose much data on what you have | |
26992 | read if your machine should go down (@pxref{Auto Save}). | |
26993 | ||
26994 | @item | |
26995 | Gnus now has its own startup file (@file{~/.gnus.el}) to avoid | |
26996 | cluttering up the @file{.emacs} file. | |
26997 | ||
26998 | @item | |
26999 | You can set the process mark on both groups and articles and perform | |
27000 | operations on all the marked items (@pxref{Process/Prefix}). | |
27001 | ||
4009494e GM |
27002 | @item |
27003 | You can list subsets of groups according to, well, anything | |
27004 | (@pxref{Listing Groups}). | |
27005 | ||
27006 | @item | |
27007 | You can browse foreign servers and subscribe to groups from those | |
27008 | servers (@pxref{Browse Foreign Server}). | |
27009 | ||
27010 | @item | |
27011 | Gnus can fetch articles, asynchronously, on a second connection to the | |
27012 | server (@pxref{Asynchronous Fetching}). | |
27013 | ||
27014 | @item | |
27015 | You can cache articles locally (@pxref{Article Caching}). | |
27016 | ||
27017 | @item | |
27018 | The uudecode functions have been expanded and generalized | |
27019 | (@pxref{Decoding Articles}). | |
27020 | ||
27021 | @item | |
27022 | You can still post uuencoded articles, which was a little-known feature | |
27023 | of @sc{gnus}' past (@pxref{Uuencoding and Posting}). | |
27024 | ||
27025 | @item | |
27026 | Fetching parents (and other articles) now actually works without | |
27027 | glitches (@pxref{Finding the Parent}). | |
27028 | ||
27029 | @item | |
27030 | Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}). | |
27031 | ||
27032 | @item | |
27033 | Digests (and other files) can be used as the basis for groups | |
27034 | (@pxref{Document Groups}). | |
27035 | ||
27036 | @item | |
27037 | Articles can be highlighted and customized (@pxref{Customizing | |
27038 | Articles}). | |
27039 | ||
27040 | @item | |
27041 | URLs and other external references can be buttonized (@pxref{Article | |
27042 | Buttons}). | |
27043 | ||
27044 | @item | |
27045 | You can do lots of strange stuff with the Gnus window & frame | |
27046 | configuration (@pxref{Window Layout}). | |
27047 | ||
4009494e GM |
27048 | @end itemize |
27049 | ||
27050 | ||
27051 | @node September Gnus | |
27052 | @subsubsection September Gnus | |
27053 | ||
27054 | @iftex | |
27055 | @iflatex | |
27056 | \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}} | |
27057 | @end iflatex | |
27058 | @end iftex | |
27059 | ||
27060 | New features in Gnus 5.2/5.3: | |
27061 | ||
27062 | @itemize @bullet | |
27063 | ||
27064 | @item | |
27065 | A new message composition mode is used. All old customization variables | |
27066 | for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are | |
27067 | now obsolete. | |
27068 | ||
27069 | @item | |
27070 | Gnus is now able to generate @dfn{sparse} threads---threads where | |
27071 | missing articles are represented by empty nodes (@pxref{Customizing | |
27072 | Threading}). | |
27073 | ||
27074 | @lisp | |
27075 | (setq gnus-build-sparse-threads 'some) | |
27076 | @end lisp | |
27077 | ||
27078 | @item | |
27079 | Outgoing articles are stored on a special archive server | |
27080 | (@pxref{Archived Messages}). | |
27081 | ||
27082 | @item | |
27083 | Partial thread regeneration now happens when articles are | |
27084 | referred. | |
27085 | ||
27086 | @item | |
01c52d31 | 27087 | Gnus can make use of GroupLens predictions. |
4009494e GM |
27088 | |
27089 | @item | |
27090 | Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). | |
27091 | ||
27092 | @item | |
27093 | A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}). | |
27094 | ||
27095 | @lisp | |
27096 | (setq gnus-use-trees t) | |
27097 | @end lisp | |
27098 | ||
27099 | @item | |
27100 | An @code{nn}-like pick-and-read minor mode is available for the summary | |
27101 | buffers (@pxref{Pick and Read}). | |
27102 | ||
27103 | @lisp | |
27104 | (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode) | |
27105 | @end lisp | |
27106 | ||
27107 | @item | |
27108 | In binary groups you can use a special binary minor mode (@pxref{Binary | |
27109 | Groups}). | |
27110 | ||
27111 | @item | |
27112 | Groups can be grouped in a folding topic hierarchy (@pxref{Group | |
27113 | Topics}). | |
27114 | ||
27115 | @lisp | |
27116 | (add-hook 'gnus-group-mode-hook 'gnus-topic-mode) | |
27117 | @end lisp | |
27118 | ||
27119 | @item | |
27120 | Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}). | |
27121 | ||
27122 | @item | |
27123 | Groups can now have a score, and bubbling based on entry frequency | |
27124 | is possible (@pxref{Group Score}). | |
27125 | ||
27126 | @lisp | |
27127 | (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group) | |
27128 | @end lisp | |
27129 | ||
27130 | @item | |
27131 | Groups can be process-marked, and commands can be performed on | |
27132 | groups of groups (@pxref{Marking Groups}). | |
27133 | ||
27134 | @item | |
27135 | Caching is possible in virtual groups. | |
27136 | ||
27137 | @item | |
27138 | @code{nndoc} now understands all kinds of digests, mail boxes, rnews | |
27139 | news batches, ClariNet briefs collections, and just about everything | |
27140 | else (@pxref{Document Groups}). | |
27141 | ||
27142 | @item | |
c4d82de8 | 27143 | Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets. |
4009494e GM |
27144 | |
27145 | @item | |
27146 | The Gnus cache is much faster. | |
27147 | ||
27148 | @item | |
27149 | Groups can be sorted according to many criteria (@pxref{Sorting | |
27150 | Groups}). | |
27151 | ||
27152 | @item | |
27153 | New group parameters have been introduced to set list-addresses and | |
27154 | expiry times (@pxref{Group Parameters}). | |
27155 | ||
27156 | @item | |
27157 | All formatting specs allow specifying faces to be used | |
27158 | (@pxref{Formatting Fonts}). | |
27159 | ||
27160 | @item | |
27161 | There are several more commands for setting/removing/acting on process | |
27162 | marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}). | |
27163 | ||
27164 | @item | |
27165 | The summary buffer can be limited to show parts of the available | |
27166 | articles based on a wide range of criteria. These commands have been | |
27167 | bound to keys on the @kbd{/} submap (@pxref{Limiting}). | |
27168 | ||
27169 | @item | |
27170 | Articles can be made persistent with the @kbd{*} command | |
27171 | (@pxref{Persistent Articles}). | |
27172 | ||
27173 | @item | |
27174 | All functions for hiding article elements are now toggles. | |
27175 | ||
27176 | @item | |
27177 | Article headers can be buttonized (@pxref{Article Washing}). | |
27178 | ||
27179 | @item | |
27180 | All mail back ends support fetching articles by @code{Message-ID}. | |
27181 | ||
27182 | @item | |
27183 | Duplicate mail can now be treated properly (@pxref{Duplicates}). | |
27184 | ||
27185 | @item | |
27186 | All summary mode commands are available directly from the article | |
27187 | buffer (@pxref{Article Keymap}). | |
27188 | ||
27189 | @item | |
27190 | Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window | |
27191 | Layout}). | |
27192 | ||
27193 | @item | |
27194 | Mail can be re-scanned by a daemonic process (@pxref{Daemons}). | |
27195 | @iftex | |
27196 | @iflatex | |
27197 | \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}} | |
27198 | @end iflatex | |
27199 | @end iftex | |
27200 | ||
4009494e GM |
27201 | @item |
27202 | Groups can be made permanently visible (@pxref{Listing Groups}). | |
27203 | ||
27204 | @lisp | |
27205 | (setq gnus-permanently-visible-groups "^nnml:") | |
27206 | @end lisp | |
27207 | ||
27208 | @item | |
27209 | Many new hooks have been introduced to make customizing easier. | |
27210 | ||
27211 | @item | |
27212 | Gnus respects the @code{Mail-Copies-To} header. | |
27213 | ||
27214 | @item | |
27215 | Threads can be gathered by looking at the @code{References} header | |
27216 | (@pxref{Customizing Threading}). | |
27217 | ||
27218 | @lisp | |
27219 | (setq gnus-summary-thread-gathering-function | |
27220 | 'gnus-gather-threads-by-references) | |
27221 | @end lisp | |
27222 | ||
27223 | @item | |
27224 | Read articles can be stored in a special backlog buffer to avoid | |
27225 | refetching (@pxref{Article Backlog}). | |
27226 | ||
27227 | @lisp | |
27228 | (setq gnus-keep-backlog 50) | |
27229 | @end lisp | |
27230 | ||
27231 | @item | |
27232 | A clean copy of the current article is always stored in a separate | |
27233 | buffer to allow easier treatment. | |
27234 | ||
27235 | @item | |
27236 | Gnus can suggest where to save articles (@pxref{Saving Articles}). | |
27237 | ||
27238 | @item | |
27239 | Gnus doesn't have to do as much prompting when saving (@pxref{Saving | |
27240 | Articles}). | |
27241 | ||
27242 | @lisp | |
27243 | (setq gnus-prompt-before-saving t) | |
27244 | @end lisp | |
27245 | ||
27246 | @item | |
27247 | @code{gnus-uu} can view decoded files asynchronously while fetching | |
27248 | articles (@pxref{Other Decode Variables}). | |
27249 | ||
27250 | @lisp | |
27251 | (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view) | |
27252 | @end lisp | |
27253 | ||
27254 | @item | |
27255 | Filling in the article buffer now works properly on cited text | |
27256 | (@pxref{Article Washing}). | |
27257 | ||
27258 | @item | |
27259 | Hiding cited text adds buttons to toggle hiding, and how much | |
27260 | cited text to hide is now customizable (@pxref{Article Hiding}). | |
27261 | ||
27262 | @lisp | |
27263 | (setq gnus-cited-lines-visible 2) | |
27264 | @end lisp | |
27265 | ||
27266 | @item | |
27267 | Boring headers can be hidden (@pxref{Article Hiding}). | |
27268 | ||
27269 | @item | |
27270 | Default scoring values can now be set from the menu bar. | |
27271 | ||
27272 | @item | |
27273 | Further syntax checking of outgoing articles have been added. | |
27274 | ||
27275 | @end itemize | |
27276 | ||
27277 | ||
27278 | @node Red Gnus | |
27279 | @subsubsection Red Gnus | |
27280 | ||
27281 | New features in Gnus 5.4/5.5: | |
27282 | ||
27283 | @iftex | |
27284 | @iflatex | |
27285 | \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}} | |
27286 | @end iflatex | |
27287 | @end iftex | |
27288 | ||
27289 | @itemize @bullet | |
27290 | ||
27291 | @item | |
27292 | @file{nntp.el} has been totally rewritten in an asynchronous fashion. | |
27293 | ||
27294 | @item | |
27295 | Article prefetching functionality has been moved up into | |
27296 | Gnus (@pxref{Asynchronous Fetching}). | |
27297 | ||
27298 | @item | |
27299 | Scoring can now be performed with logical operators like @code{and}, | |
27300 | @code{or}, @code{not}, and parent redirection (@pxref{Advanced | |
27301 | Scoring}). | |
27302 | ||
27303 | @item | |
27304 | Article washing status can be displayed in the | |
27305 | article mode line (@pxref{Misc Article}). | |
27306 | ||
27307 | @item | |
27308 | @file{gnus.el} has been split into many smaller files. | |
27309 | ||
27310 | @item | |
27311 | Suppression of duplicate articles based on Message-ID can be done | |
27312 | (@pxref{Duplicate Suppression}). | |
27313 | ||
27314 | @lisp | |
27315 | (setq gnus-suppress-duplicates t) | |
27316 | @end lisp | |
27317 | ||
27318 | @item | |
27319 | New variables for specifying what score and adapt files are to be | |
27320 | considered home score and adapt files (@pxref{Home Score File}) have | |
27321 | been added. | |
27322 | ||
27323 | @item | |
e4769531 | 27324 | @code{nndoc} was rewritten to be easily extensible (@pxref{Document |
4009494e GM |
27325 | Server Internals}). |
27326 | ||
27327 | @item | |
27328 | Groups can inherit group parameters from parent topics (@pxref{Topic | |
27329 | Parameters}). | |
27330 | ||
27331 | @item | |
27332 | Article editing has been revamped and is now actually usable. | |
27333 | ||
27334 | @item | |
27335 | Signatures can be recognized in more intelligent fashions | |
27336 | (@pxref{Article Signature}). | |
27337 | ||
27338 | @item | |
27339 | Summary pick mode has been made to look more @code{nn}-like. Line | |
27340 | numbers are displayed and the @kbd{.} command can be used to pick | |
27341 | articles (@code{Pick and Read}). | |
27342 | ||
27343 | @item | |
27344 | Commands for moving the @file{.newsrc.eld} from one server to | |
27345 | another have been added (@pxref{Changing Servers}). | |
27346 | ||
27347 | @item | |
27348 | There's a way now to specify that ``uninteresting'' fields be suppressed | |
27349 | when generating lines in buffers (@pxref{Advanced Formatting}). | |
27350 | ||
27351 | @item | |
27352 | Several commands in the group buffer can be undone with @kbd{C-M-_} | |
27353 | (@pxref{Undo}). | |
27354 | ||
27355 | @item | |
27356 | Scoring can be done on words using the new score type @code{w} | |
27357 | (@pxref{Score File Format}). | |
27358 | ||
27359 | @item | |
27360 | Adaptive scoring can be done on a Subject word-by-word basis | |
27361 | (@pxref{Adaptive Scoring}). | |
27362 | ||
27363 | @lisp | |
27364 | (setq gnus-use-adaptive-scoring '(word)) | |
27365 | @end lisp | |
27366 | ||
27367 | @item | |
27368 | Scores can be decayed (@pxref{Score Decays}). | |
27369 | ||
27370 | @lisp | |
27371 | (setq gnus-decay-scores t) | |
27372 | @end lisp | |
27373 | ||
27374 | @item | |
27375 | Scoring can be performed using a regexp on the Date header. The Date is | |
27376 | normalized to compact ISO 8601 format first (@pxref{Score File Format}). | |
27377 | ||
27378 | @item | |
27379 | A new command has been added to remove all data on articles from | |
27380 | the native server (@pxref{Changing Servers}). | |
27381 | ||
27382 | @item | |
27383 | A new command for reading collections of documents | |
27384 | (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d} | |
27385 | (@pxref{Really Various Summary Commands}). | |
27386 | ||
27387 | @item | |
27388 | Process mark sets can be pushed and popped (@pxref{Setting Process | |
27389 | Marks}). | |
27390 | ||
27391 | @item | |
27392 | A new mail-to-news back end makes it possible to post even when the @acronym{NNTP} | |
27393 | server doesn't allow posting (@pxref{Mail-To-News Gateways}). | |
27394 | ||
27395 | @item | |
27396 | A new back end for reading searches from Web search engines | |
27397 | (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added | |
27398 | (@pxref{Web Searches}). | |
27399 | ||
27400 | @item | |
27401 | Groups inside topics can now be sorted using the standard sorting | |
27402 | functions, and each topic can be sorted independently (@pxref{Topic | |
27403 | Sorting}). | |
27404 | ||
27405 | @item | |
27406 | Subsets of the groups can be sorted independently (@code{Sorting | |
27407 | Groups}). | |
27408 | ||
27409 | @item | |
27410 | Cached articles can be pulled into the groups (@pxref{Summary Generation | |
27411 | Commands}). | |
27412 | @iftex | |
27413 | @iflatex | |
27414 | \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}} | |
27415 | @end iflatex | |
27416 | @end iftex | |
27417 | ||
27418 | @item | |
27419 | Score files are now applied in a more reliable order (@pxref{Score | |
27420 | Variables}). | |
27421 | ||
27422 | @item | |
27423 | Reports on where mail messages end up can be generated (@pxref{Splitting | |
27424 | Mail}). | |
27425 | ||
27426 | @item | |
27427 | More hooks and functions have been added to remove junk from incoming | |
27428 | mail before saving the mail (@pxref{Washing Mail}). | |
27429 | ||
27430 | @item | |
27431 | Emphasized text can be properly fontisized: | |
27432 | ||
27433 | @end itemize | |
27434 | ||
27435 | ||
27436 | @node Quassia Gnus | |
27437 | @subsubsection Quassia Gnus | |
27438 | ||
27439 | New features in Gnus 5.6: | |
27440 | ||
27441 | @itemize @bullet | |
27442 | ||
27443 | @item | |
27444 | New functionality for using Gnus as an offline newsreader has been | |
27445 | added. A plethora of new commands and modes have been added. | |
27446 | @xref{Gnus Unplugged}, for the full story. | |
27447 | ||
27448 | @item | |
27449 | The @code{nndraft} back end has returned, but works differently than | |
27450 | before. All Message buffers are now also articles in the @code{nndraft} | |
27451 | group, which is created automatically. | |
27452 | ||
27453 | @item | |
27454 | @code{gnus-alter-header-function} can now be used to alter header | |
27455 | values. | |
27456 | ||
27457 | @item | |
1df7defd | 27458 | @code{gnus-summary-goto-article} now accept Message-IDs. |
4009494e GM |
27459 | |
27460 | @item | |
27461 | A new Message command for deleting text in the body of a message | |
27462 | outside the region: @kbd{C-c C-v}. | |
27463 | ||
27464 | @item | |
27465 | You can now post to component group in @code{nnvirtual} groups with | |
27466 | @kbd{C-u C-c C-c}. | |
27467 | ||
27468 | @item | |
27469 | @code{nntp-rlogin-program}---new variable to ease customization. | |
27470 | ||
27471 | @item | |
27472 | @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit | |
27473 | re-highlighting of the article buffer. | |
27474 | ||
27475 | @item | |
27476 | New element in @code{gnus-boring-article-headers}---@code{long-to}. | |
27477 | ||
27478 | @item | |
27479 | @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for | |
27480 | details. | |
27481 | ||
27482 | @item | |
27483 | @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix | |
27484 | @kbd{a} to add the score rule to the @file{all.SCORE} file. | |
27485 | ||
27486 | @item | |
27487 | @code{gnus-simplify-subject-functions} variable to allow greater | |
27488 | control over simplification. | |
27489 | ||
27490 | @item | |
27491 | @kbd{A T}---new command for fetching the current thread. | |
27492 | ||
27493 | @item | |
27494 | @kbd{/ T}---new command for including the current thread in the | |
27495 | limit. | |
27496 | ||
27497 | @item | |
27498 | @kbd{M-RET} is a new Message command for breaking cited text. | |
27499 | ||
27500 | @item | |
27501 | @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}. | |
27502 | ||
27503 | @item | |
27504 | The @code{custom-face-lookup} function has been removed. | |
27505 | If you used this function in your initialization files, you must | |
27506 | rewrite them to use @code{face-spec-set} instead. | |
27507 | ||
27508 | @item | |
27509 | Canceling now uses the current select method. Symbolic prefix | |
27510 | @kbd{a} forces normal posting method. | |
27511 | ||
27512 | @item | |
27513 | New command to translate M******** sm*rtq**t*s into proper | |
27514 | text---@kbd{W d}. | |
27515 | ||
27516 | @item | |
27517 | For easier debugging of @code{nntp}, you can set | |
27518 | @code{nntp-record-commands} to a non-@code{nil} value. | |
27519 | ||
27520 | @item | |
27521 | @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for | |
27522 | controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers. | |
27523 | ||
27524 | @item | |
27525 | A command for editing group parameters from the summary buffer | |
27526 | has been added. | |
27527 | ||
27528 | @item | |
27529 | A history of where mails have been split is available. | |
27530 | ||
27531 | @item | |
27532 | A new article date command has been added---@code{article-date-iso8601}. | |
27533 | ||
27534 | @item | |
27535 | Subjects can be simplified when threading by setting | |
27536 | @code{gnus-score-thread-simplify}. | |
27537 | ||
27538 | @item | |
27539 | A new function for citing in Message has been | |
27540 | added---@code{message-cite-original-without-signature}. | |
27541 | ||
27542 | @item | |
27543 | @code{article-strip-all-blank-lines}---new article command. | |
27544 | ||
27545 | @item | |
27546 | A new Message command to kill to the end of the article has | |
27547 | been added. | |
27548 | ||
27549 | @item | |
27550 | A minimum adaptive score can be specified by using the | |
27551 | @code{gnus-adaptive-word-minimum} variable. | |
27552 | ||
27553 | @item | |
27554 | The ``lapsed date'' article header can be kept continually | |
27555 | updated by the @code{gnus-start-date-timer} command. | |
27556 | ||
27557 | @item | |
27558 | Web listserv archives can be read with the @code{nnlistserv} back end. | |
27559 | ||
27560 | @item | |
27561 | Old dejanews archives can now be read by @code{nnweb}. | |
27562 | ||
27563 | @end itemize | |
27564 | ||
27565 | @node Pterodactyl Gnus | |
27566 | @subsubsection Pterodactyl Gnus | |
27567 | ||
27568 | New features in Gnus 5.8: | |
27569 | ||
27570 | @itemize @bullet | |
27571 | ||
27572 | @item | |
27573 | The mail-fetching functions have changed. See the manual for the | |
27574 | many details. In particular, all procmail fetching variables are gone. | |
27575 | ||
27576 | If you used procmail like in | |
27577 | ||
27578 | @lisp | |
27579 | (setq nnmail-use-procmail t) | |
27580 | (setq nnmail-spool-file 'procmail) | |
27581 | (setq nnmail-procmail-directory "~/mail/incoming/") | |
27582 | (setq nnmail-procmail-suffix "\\.in") | |
27583 | @end lisp | |
27584 | ||
27585 | this now has changed to | |
27586 | ||
27587 | @lisp | |
27588 | (setq mail-sources | |
27589 | '((directory :path "~/mail/incoming/" | |
27590 | :suffix ".in"))) | |
27591 | @end lisp | |
27592 | ||
27593 | @xref{Mail Source Specifiers}. | |
27594 | ||
27595 | @item | |
27596 | Gnus is now a @acronym{MIME}-capable reader. This affects many parts of | |
27597 | Gnus, and adds a slew of new commands. See the manual for details. | |
27598 | ||
27599 | @item | |
27600 | Gnus has also been multilingualized. This also affects too | |
27601 | many parts of Gnus to summarize here, and adds many new variables. | |
27602 | ||
27603 | @item | |
27604 | @code{gnus-auto-select-first} can now be a function to be | |
27605 | called to position point. | |
27606 | ||
27607 | @item | |
27608 | The user can now decide which extra headers should be included in | |
27609 | summary buffers and @acronym{NOV} files. | |
27610 | ||
27611 | @item | |
27612 | @code{gnus-article-display-hook} has been removed. Instead, a number | |
27613 | of variables starting with @code{gnus-treat-} have been added. | |
27614 | ||
27615 | @item | |
27616 | The Gnus posting styles have been redone again and now works in a | |
27617 | subtly different manner. | |
27618 | ||
27619 | @item | |
27620 | New web-based back ends have been added: @code{nnslashdot}, | |
27621 | @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped, | |
27622 | again, to keep up with ever-changing layouts. | |
27623 | ||
27624 | @item | |
27625 | Gnus can now read @acronym{IMAP} mail via @code{nnimap}. | |
27626 | ||
27627 | @end itemize | |
27628 | ||
27629 | @node Oort Gnus | |
27630 | @subsubsection Oort Gnus | |
27631 | @cindex Oort Gnus | |
27632 | ||
27633 | New features in Gnus 5.10: | |
27634 | ||
27635 | @itemize @bullet | |
27636 | ||
27637 | @item Installation changes | |
27638 | @c *********************** | |
27639 | ||
27640 | @itemize @bullet | |
27641 | @item | |
27642 | Upgrading from previous (stable) version if you have used Oort. | |
27643 | ||
27644 | If you have tried Oort (the unstable Gnus branch leading to this | |
27645 | release) but went back to a stable version, be careful when upgrading to | |
27646 | this version. In particular, you will probably want to remove all | |
27647 | @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are | |
27648 | read from your @file{.newsrc.eld} instead of from the | |
27649 | @file{.marks}/@file{.mrk} file where this release store flags. See a | |
27650 | later entry for more information about marks. Note that downgrading | |
27651 | isn't save in general. | |
27652 | ||
27653 | @item | |
27654 | Lisp files are now installed in @file{.../site-lisp/gnus/} by default. | |
27655 | It defaulted to @file{.../site-lisp/} formerly. In addition to this, | |
27656 | the new installer issues a warning if other Gnus installations which | |
27657 | will shadow the latest one are detected. You can then remove those | |
27658 | shadows manually or remove them using @code{make | |
27659 | remove-installed-shadows}. | |
27660 | ||
27661 | @item | |
27662 | New @file{make.bat} for compiling and installing Gnus under MS Windows | |
27663 | ||
27664 | Use @file{make.bat} if you want to install Gnus under MS Windows, the | |
27665 | first argument to the batch-program should be the directory where | |
27666 | @file{xemacs.exe} respectively @file{emacs.exe} is located, if you want | |
27667 | to install Gnus after compiling it, give @file{make.bat} @code{/copy} as | |
27668 | the second parameter. | |
27669 | ||
27670 | @file{make.bat} has been rewritten from scratch, it now features | |
47301027 | 27671 | automatic recognition of XEmacs and Emacs, generates |
4009494e GM |
27672 | @file{gnus-load.el}, checks if errors occur while compilation and |
27673 | generation of info files and reports them at the end of the build | |
27674 | process. It now uses @code{makeinfo} if it is available and falls | |
27675 | back to @file{infohack.el} otherwise. @file{make.bat} should now | |
27676 | install all files which are necessary to run Gnus and be generally a | |
27677 | complete replacement for the @code{configure; make; make install} | |
27678 | cycle used under Unix systems. | |
27679 | ||
27680 | The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak} | |
27681 | superfluous, so they have been removed. | |
27682 | ||
27683 | @item | |
27684 | @file{~/News/overview/} not used. | |
27685 | ||
27686 | As a result of the following change, the @file{~/News/overview/} | |
27687 | directory is not used any more. You can safely delete the entire | |
27688 | hierarchy. | |
27689 | ||
27690 | @c FIXME: `gnus-load' is mentioned in README, which is not included in | |
bff3818b | 27691 | @c the repository. We should find a better place for this item. |
4009494e GM |
27692 | @item |
27693 | @code{(require 'gnus-load)} | |
27694 | ||
27695 | If you use a stand-alone Gnus distribution, you'd better add | |
27696 | @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus | |
27697 | lisp directory into load-path. | |
27698 | ||
27699 | File @file{gnus-load.el} contains autoload commands, functions and variables, | |
27700 | some of which may not be included in distributions of Emacsen. | |
27701 | ||
27702 | @end itemize | |
27703 | ||
27704 | @item New packages and libraries within Gnus | |
27705 | @c ***************************************** | |
27706 | ||
27707 | @itemize @bullet | |
27708 | ||
27709 | @item | |
27710 | The revised Gnus @acronym{FAQ} is included in the manual, | |
27711 | @xref{Frequently Asked Questions}. | |
27712 | ||
27713 | @item | |
27714 | @acronym{TLS} wrapper shipped with Gnus | |
27715 | ||
27716 | @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and | |
321decc8 | 27717 | @acronym{NNTP} via @file{tls.el} and GnuTLS. |
4009494e GM |
27718 | |
27719 | @item | |
27720 | Improved anti-spam features. | |
27721 | ||
27722 | Gnus is now able to take out spam from your mail and news streams | |
27723 | using a wide variety of programs and filter rules. Among the supported | |
27724 | methods are RBL blocklists, bogofilter and white/blacklists. Hooks | |
27725 | for easy use of external packages such as SpamAssassin and Hashcash | |
01c52d31 | 27726 | are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}. |
4009494e GM |
27727 | @c FIXME: @xref{Spam Package}?. Should this be under Misc? |
27728 | ||
27729 | @item | |
27730 | Gnus supports server-side mail filtering using Sieve. | |
27731 | ||
27732 | Sieve rules can be added as Group Parameters for groups, and the | |
27733 | complete Sieve script is generated using @kbd{D g} from the Group | |
27734 | buffer, and then uploaded to the server using @kbd{C-c C-l} in the | |
27735 | generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve | |
27736 | manual @ref{Top, , Top, sieve, Emacs Sieve}. | |
27737 | ||
27738 | @end itemize | |
27739 | ||
27740 | @item Changes in group mode | |
27741 | @c ************************ | |
27742 | ||
27743 | @itemize @bullet | |
27744 | ||
27745 | @item | |
27746 | @code{gnus-group-read-ephemeral-group} can be called interactively, | |
27747 | using @kbd{G M}. | |
27748 | ||
27749 | @item | |
27750 | Retrieval of charters and control messages | |
27751 | ||
27752 | There are new commands for fetching newsgroup charters (@kbd{H c}) and | |
27753 | control messages (@kbd{H C}). | |
27754 | ||
27755 | @item | |
27756 | The new variable @code{gnus-parameters} can be used to set group parameters. | |
27757 | ||
27758 | Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored | |
27759 | the parameters in @file{~/.newsrc.eld}, but via this variable you can | |
27760 | enjoy the powers of customize, and simplified backups since you set the | |
27761 | variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The | |
27762 | variable maps regular expressions matching group names to group | |
27763 | parameters, a'la: | |
27764 | @lisp | |
27765 | (setq gnus-parameters | |
27766 | '(("mail\\..*" | |
27767 | (gnus-show-threads nil) | |
27768 | (gnus-use-scoring nil)) | |
27769 | ("^nnimap:\\(foo.bar\\)$" | |
27770 | (to-group . "\\1")))) | |
27771 | @end lisp | |
27772 | ||
27773 | @item | |
27774 | Unread count correct in nnimap groups. | |
27775 | ||
27776 | The estimated number of unread articles in the group buffer should now | |
27777 | be correct for nnimap groups. This is achieved by calling | |
27778 | @code{nnimap-fixup-unread-after-getting-new-news} from the | |
27779 | @code{gnus-setup-news-hook} (called on startup) and | |
27780 | @code{gnus-after-getting-new-news-hook}. (called after getting new | |
27781 | mail). If you have modified those variables from the default, you may | |
27782 | want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If | |
27783 | you were happy with the estimate and want to save some (minimal) time | |
27784 | when getting new mail, remove the function. | |
27785 | ||
27786 | @item | |
27787 | Group names are treated as UTF-8 by default. | |
27788 | ||
27789 | This is supposedly what USEFOR wanted to migrate to. See | |
27790 | @code{gnus-group-name-charset-group-alist} and | |
27791 | @code{gnus-group-name-charset-method-alist} for customization. | |
27792 | ||
27793 | @item | |
27794 | @code{gnus-group-charset-alist} and | |
27795 | @code{gnus-group-ignored-charsets-alist}. | |
27796 | ||
27797 | The regexps in these variables are compared with full group names | |
27798 | instead of real group names in 5.8. Users who customize these | |
27799 | variables should change those regexps accordingly. For example: | |
27800 | @lisp | |
27801 | ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr) | |
27802 | @end lisp | |
27803 | ||
37a68866 MB |
27804 | @item |
27805 | Old intermediate incoming mail files (@file{Incoming*}) are deleted | |
27806 | after a couple of days, not immediately. @xref{Mail Source | |
9b3ebcb6 | 27807 | Customization}. (New in Gnus 5.10.10 / Emacs 22.2) |
37a68866 | 27808 | |
4009494e GM |
27809 | @end itemize |
27810 | ||
27811 | @item Changes in summary and article mode | |
27812 | @c ************************************** | |
27813 | ||
27814 | @itemize @bullet | |
27815 | ||
27816 | @item | |
27817 | @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R} | |
27818 | (@code{gnus-article-reply-with-original}) only yank the text in the | |
27819 | region if the region is active. | |
27820 | ||
27821 | @item | |
27822 | In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}. | |
27823 | Use @kbd{B w} for @code{gnus-summary-edit-article} instead. | |
27824 | ||
27825 | @item | |
27826 | Article Buttons | |
27827 | ||
27828 | More buttons for URLs, mail addresses, Message-IDs, Info links, man | |
27829 | pages and Emacs or Gnus related references. @xref{Article Buttons}. The | |
27830 | variables @code{gnus-button-@var{*}-level} can be used to control the | |
27831 | appearance of all article buttons. @xref{Article Button Levels}. | |
27832 | ||
27833 | @item | |
27834 | Single-part yenc encoded attachments can be decoded. | |
27835 | ||
27836 | @item | |
27837 | Picons | |
27838 | ||
27839 | The picons code has been reimplemented to work in GNU Emacs---some of | |
27840 | the previous options have been removed or renamed. | |
27841 | ||
27842 | Picons are small ``personal icons'' representing users, domain and | |
27843 | newsgroups, which can be displayed in the Article buffer. | |
27844 | @xref{Picons}. | |
27845 | ||
27846 | @item | |
27847 | If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a | |
27848 | boundary line is drawn at the end of the headers. | |
27849 | ||
27850 | @item | |
27851 | Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}. | |
27852 | ||
27853 | @item | |
27854 | The Summary Buffer uses an arrow in the fringe to indicate the current | |
27855 | article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it. | |
27856 | ||
27857 | @item | |
27858 | Warn about email replies to news | |
27859 | ||
27860 | Do you often find yourself replying to news by email by mistake? Then | |
27861 | the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for | |
27862 | you. | |
27863 | ||
27864 | @item | |
27865 | If the new option @code{gnus-summary-display-while-building} is | |
27866 | non-@code{nil}, the summary buffer is shown and updated as it's being | |
27867 | built. | |
27868 | ||
4009494e GM |
27869 | @item |
27870 | Gnus supports RFC 2369 mailing list headers, and adds a number of | |
27871 | related commands in mailing list groups. @xref{Mailing List}. | |
27872 | ||
27873 | @item | |
27874 | The Date header can be displayed in a format that can be read aloud | |
27875 | in English. @xref{Article Date}. | |
27876 | ||
27877 | @item | |
27878 | diffs are automatically highlighted in groups matching | |
27879 | @code{mm-uu-diff-groups-regexp} | |
27880 | ||
27881 | @item | |
27882 | Better handling of Microsoft citation styles | |
27883 | ||
27884 | Gnus now tries to recognize the mangled header block that some Microsoft | |
27885 | mailers use to indicate that the rest of the message is a citation, even | |
27886 | though it is not quoted in any way. The variable | |
27887 | @code{gnus-cite-unsightly-citation-regexp} matches the start of these | |
27888 | citations. | |
27889 | ||
27890 | The new command @kbd{W Y f} | |
27891 | (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken | |
27892 | Outlook (Express) articles. | |
27893 | ||
27894 | @item | |
27895 | @code{gnus-article-skip-boring} | |
27896 | ||
27897 | If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will | |
27898 | not scroll down to show you a page that contains only boring text, | |
27899 | which by default means cited text and signature. You can customize | |
27900 | what is skippable using @code{gnus-article-boring-faces}. | |
27901 | ||
27902 | This feature is especially useful if you read many articles that | |
27903 | consist of a little new content at the top with a long, untrimmed | |
27904 | message cited below. | |
27905 | ||
27906 | @item | |
27907 | Smileys (@samp{:-)}, @samp{;-)} etc) are now displayed graphically in | |
27908 | Emacs too. | |
27909 | ||
27910 | Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to | |
27911 | disable it. | |
27912 | ||
27913 | @item | |
27914 | Face headers handling. @xref{Face}. | |
27915 | ||
27916 | @item | |
27917 | In the summary buffer, the new command @kbd{/ N} inserts new messages | |
27918 | and @kbd{/ o} inserts old messages. | |
27919 | ||
27920 | @item | |
27921 | Gnus decodes morse encoded messages if you press @kbd{W m}. | |
27922 | ||
27923 | @item | |
27924 | @code{gnus-summary-line-format} | |
27925 | ||
27926 | The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) | |
27927 | %s\n}. Moreover @code{gnus-extra-headers}, | |
27928 | @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses} | |
27929 | changed their default so that the users name will be replaced by the | |
27930 | recipient's name or the group name posting to for @acronym{NNTP} | |
27931 | groups. | |
27932 | ||
27933 | @item | |
27934 | Deleting of attachments. | |
27935 | ||
27936 | The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o} | |
27937 | on @acronym{MIME} buttons) saves a part and replaces the part with an | |
27938 | external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on | |
27939 | @acronym{MIME} buttons) removes a part. It works only on back ends | |
27940 | that support editing. | |
27941 | ||
27942 | @item | |
27943 | @code{gnus-default-charset} | |
27944 | ||
27945 | The default value is determined from the | |
27946 | @code{current-language-environment} variable, instead of | |
27947 | @code{iso-8859-1}. Also the @samp{.*} item in | |
27948 | @code{gnus-group-charset-alist} is removed. | |
27949 | ||
27950 | @item | |
27951 | Printing capabilities are enhanced. | |
27952 | ||
27953 | Gnus supports Muttprint natively with @kbd{O P} from the Summary and | |
27954 | Article buffers. Also, each individual @acronym{MIME} part can be | |
27955 | printed using @kbd{p} on the @acronym{MIME} button. | |
27956 | ||
27957 | @item | |
27958 | Extended format specs. | |
27959 | ||
27960 | Format spec @samp{%&user-date;} is added into | |
27961 | @code{gnus-summary-line-format-alist}. Also, user defined extended | |
27962 | format specs are supported. The extended format specs look like | |
27963 | @samp{%u&foo;}, which invokes function | |
27964 | @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the | |
27965 | escape character, old user defined format @samp{%u&} is no longer supported. | |
27966 | ||
27967 | @item | |
27968 | @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten. | |
27969 | @c FIXME: Was this a user-visible change? | |
27970 | ||
27971 | It was aliased to @kbd{Y c} | |
27972 | (@code{gnus-summary-insert-cached-articles}). The new function filters | |
27973 | out other articles. | |
27974 | ||
27975 | @item | |
27976 | Some limiting commands accept a @kbd{C-u} prefix to negate the match. | |
27977 | ||
27978 | If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/ | |
27979 | s}, @kbd{/ a}, and @kbd{/ x} | |
27980 | (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the | |
27981 | result will be to display all articles that do not match the expression. | |
27982 | ||
27983 | @item | |
27984 | Gnus inlines external parts (message/external). | |
27985 | ||
27986 | @end itemize | |
27987 | ||
27988 | @item Changes in Message mode and related Gnus features | |
27989 | @c **************************************************** | |
27990 | ||
27991 | @itemize @bullet | |
27992 | ||
27993 | @item | |
27994 | Delayed articles | |
27995 | ||
27996 | You can delay the sending of a message with @kbd{C-c C-j} in the Message | |
27997 | buffer. The messages are delivered at specified time. This is useful | |
27998 | for sending yourself reminders. @xref{Delayed Articles}. | |
27999 | ||
28000 | @item | |
28001 | If the new option @code{nnml-use-compressed-files} is non-@code{nil}, | |
28002 | the nnml back end allows compressed message files. | |
28003 | ||
28004 | @item | |
28005 | The new option @code{gnus-gcc-mark-as-read} automatically marks | |
28006 | Gcc articles as read. | |
28007 | ||
28008 | @item | |
28009 | Externalizing of attachments | |
28010 | ||
28011 | If @code{gnus-gcc-externalize-attachments} or | |
28012 | @code{message-fcc-externalize-attachments} is non-@code{nil}, attach | |
28013 | local files as external parts. | |
28014 | ||
28015 | @item | |
28016 | The envelope sender address can be customized when using Sendmail. | |
28017 | @xref{Mail Variables, Mail Variables,, message, Message Manual}. | |
28018 | ||
28019 | @item | |
28020 | Gnus no longer generate the Sender: header automatically. | |
28021 | ||
28022 | Earlier it was generated when the user configurable email address was | |
28023 | different from the Gnus guessed default user address. As the guessing | |
28024 | algorithm is rarely correct these days, and (more controversially) the | |
28025 | only use of the Sender: header was to check if you are entitled to | |
28026 | cancel/supersede news (which is now solved by Cancel Locks instead, | |
28027 | see another entry), generation of the header has been disabled by | |
28028 | default. See the variables @code{message-required-headers}, | |
28029 | @code{message-required-news-headers}, and | |
28030 | @code{message-required-mail-headers}. | |
28031 | ||
28032 | @item | |
28033 | Features from third party @file{message-utils.el} added to @file{message.el}. | |
28034 | ||
28035 | Message now asks if you wish to remove @samp{(was: <old subject>)} from | |
28036 | subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c | |
28037 | M-m} and @kbd{C-c M-f} inserts markers indicating included text. | |
28038 | @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts | |
28039 | appropriate headers and a note in the body for cross-postings and | |
28040 | followups (see the variables @code{message-cross-post-@var{*}}). | |
28041 | ||
28042 | @item | |
28043 | References and X-Draft-From headers are no longer generated when you | |
28044 | start composing messages and @code{message-generate-headers-first} is | |
28045 | @code{nil}. | |
28046 | ||
28047 | @item | |
28048 | Easy inclusion of X-Faces headers. @xref{X-Face}. | |
28049 | ||
28050 | @item | |
28051 | Group Carbon Copy (GCC) quoting | |
28052 | ||
28053 | To support groups that contains SPC and other weird characters, groups | |
28054 | are quoted before they are placed in the Gcc: header. This means | |
28055 | variables such as @code{gnus-message-archive-group} should no longer | |
28056 | contain quote characters to make groups containing SPC work. Also, if | |
28057 | you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc | |
28058 | into two groups) you must change it to return the list | |
28059 | @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted | |
28060 | incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar} | |
28061 | was incorrect earlier, it just didn't generate any problems since it | |
28062 | was inserted directly. | |
28063 | ||
28064 | @item | |
28065 | @code{message-insinuate-rmail} | |
28066 | ||
bc79f9ab | 28067 | @c FIXME should that not be 'message-user-agent? |
4009494e GM |
28068 | Adding @code{(message-insinuate-rmail)} and @code{(setq |
28069 | mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to | |
28070 | compose, reply and forward messages in message-mode, where you can | |
28071 | enjoy the power of @acronym{MML}. | |
28072 | ||
28073 | @item | |
28074 | @code{message-minibuffer-local-map} | |
28075 | ||
28076 | The line below enables BBDB in resending a message: | |
28077 | @lisp | |
28078 | (define-key message-minibuffer-local-map [(tab)] | |
28079 | 'bbdb-complete-name) | |
28080 | @end lisp | |
28081 | ||
28082 | @item | |
28083 | @code{gnus-posting-styles} | |
28084 | ||
28085 | Add a new format of match like | |
28086 | @lisp | |
28087 | ((header "to" "larsi.*org") | |
28088 | (Organization "Somewhere, Inc.")) | |
28089 | @end lisp | |
28090 | The old format like the lines below is obsolete, but still accepted. | |
28091 | @lisp | |
28092 | (header "to" "larsi.*org" | |
28093 | (Organization "Somewhere, Inc.")) | |
28094 | @end lisp | |
28095 | ||
28096 | @item | |
28097 | @code{message-ignored-news-headers} and @code{message-ignored-mail-headers} | |
28098 | ||
28099 | @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been | |
28100 | added into these two variables. If you customized those, perhaps you | |
28101 | need add those two headers too. | |
28102 | ||
28103 | @item | |
28104 | Gnus supports the ``format=flowed'' (RFC 2646) parameter. On | |
28105 | composing messages, it is enabled by @code{use-hard-newlines}. | |
28106 | Decoding format=flowed was present but not documented in earlier | |
28107 | versions. | |
28108 | ||
28109 | @item | |
28110 | The option @code{mm-fill-flowed} can be used to disable treatment of | |
28111 | ``format=flowed'' messages. Also, flowed text is disabled when sending | |
28112 | inline PGP signed messages. @xref{Flowed text, , Flowed text, | |
28113 | emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7) | |
28114 | @c This entry is also present in the node "No Gnus". | |
28115 | ||
28116 | @item | |
28117 | Gnus supports the generation of RFC 2298 Disposition Notification requests. | |
28118 | ||
28119 | This is invoked with the @kbd{C-c M-n} key binding from message mode. | |
28120 | ||
28121 | @item | |
28122 | Message supports the Importance: (RFC 2156) header. | |
28123 | ||
28124 | In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through | |
28125 | the valid values. | |
28126 | ||
28127 | @item | |
28128 | Gnus supports Cancel Locks in News. | |
28129 | ||
28130 | This means a header @samp{Cancel-Lock} is inserted in news posting. It is | |
28131 | used to determine if you wrote an article or not (for canceling and | |
28132 | superseding). Gnus generates a random password string the first time | |
28133 | you post a message, and saves it in your @file{~/.emacs} using the Custom | |
28134 | system. While the variable is called @code{canlock-password}, it is not | |
28135 | security sensitive data. Publishing your canlock string on the web | |
28136 | will not allow anyone to be able to anything she could not already do. | |
28137 | The behavior can be changed by customizing @code{message-insert-canlock}. | |
28138 | ||
28139 | @item | |
28140 | Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC | |
28141 | 2015/3156) and @acronym{S/MIME} (RFC 2630-2633). | |
28142 | ||
28143 | It needs an external @acronym{S/MIME} and OpenPGP implementation, but no | |
28144 | additional Lisp libraries. This add several menu items to the | |
28145 | Attachments menu, and @kbd{C-c RET} key bindings, when composing | |
28146 | messages. This also obsoletes @code{gnus-article-hide-pgp-hook}. | |
28147 | ||
28148 | @item | |
28149 | @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c | |
28150 | C-m}. | |
28151 | ||
28152 | This change was made to avoid conflict with the standard binding of | |
28153 | @code{back-to-indentation}, which is also useful in message mode. | |
28154 | ||
28155 | @item | |
28156 | The default for @code{message-forward-show-mml} changed to the symbol | |
28157 | @code{best}. | |
28158 | ||
28159 | The behavior for the @code{best} value is to show @acronym{MML} (i.e., | |
28160 | convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be | |
28161 | used when forwarding signed or encrypted messages, as the conversion | |
28162 | invalidate the digital signature. | |
28163 | ||
28164 | @item | |
28165 | If @code{auto-compression-mode} is enabled, attachments are automatically | |
28166 | decompressed when activated. | |
28167 | @c FIXME: Does this affect article or message mode? | |
28168 | ||
28169 | @item | |
28170 | Support for non-@acronym{ASCII} domain names | |
28171 | ||
28172 | Message supports non-@acronym{ASCII} domain names in From:, To: and | |
28173 | Cc: and will query you whether to perform encoding when you try to | |
28174 | send a message. The variable @code{message-use-idna} controls this. | |
28175 | Gnus will also decode non-@acronym{ASCII} domain names in From:, To: | |
28176 | and Cc: when you view a message. The variable @code{gnus-use-idna} | |
28177 | controls this. | |
28178 | ||
28179 | @item You can now drag and drop attachments to the Message buffer. | |
28180 | See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}. | |
28181 | @xref{MIME, ,MIME, message, Message Manual}. | |
2b968687 | 28182 | @c New in 5.10.9 / 5.11 (Emacs 22.1) |
d55fe5bb MB |
28183 | |
28184 | @item @code{auto-fill-mode} is enabled by default in Message mode. | |
28185 | See @code{message-fill-column}. @xref{Various Message Variables, , | |
28186 | Message Headers, message, Message Manual}. | |
28187 | @c New in Gnus 5.10.12 / 5.11 (Emacs 22.3) | |
4009494e GM |
28188 | |
28189 | @end itemize | |
28190 | ||
28191 | @item Changes in back ends | |
28192 | @c *********************** | |
28193 | ||
28194 | @itemize @bullet | |
28195 | @item | |
28196 | Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}. | |
28197 | ||
28198 | @item | |
28199 | The nndoc back end now supports mailman digests and exim bounces. | |
28200 | ||
28201 | @item | |
28202 | Gnus supports Maildir groups. | |
28203 | ||
28204 | Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}. | |
28205 | ||
28206 | @item | |
28207 | The nnml and nnfolder back ends store marks for each groups. | |
28208 | ||
28209 | This makes it possible to take backup of nnml/nnfolder servers/groups | |
28210 | separately of @file{~/.newsrc.eld}, while preserving marks. It also | |
28211 | makes it possible to share articles and marks between users (without | |
1df7defd | 28212 | sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It |
4009494e GM |
28213 | works by storing the marks stored in @file{~/.newsrc.eld} in a per-group |
28214 | file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for | |
28215 | nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to | |
28216 | another machine, Gnus will automatically use the @file{.marks} or | |
28217 | @file{.mrk} file instead of the information in @file{~/.newsrc.eld}. | |
28218 | The new server variables @code{nnml-marks-is-evil} and | |
28219 | @code{nnfolder-marks-is-evil} can be used to disable this feature. | |
28220 | ||
28221 | @end itemize | |
28222 | ||
28223 | @item Appearance | |
28224 | @c ************* | |
28225 | ||
28226 | @itemize @bullet | |
28227 | ||
28228 | @item | |
28229 | The menu bar item (in Group and Summary buffer) named ``Misc'' has | |
28230 | been renamed to ``Gnus''. | |
28231 | ||
28232 | @item | |
28233 | The menu bar item (in Message mode) named ``@acronym{MML}'' has been | |
28234 | renamed to ``Attachments''. Note that this menu also contains security | |
28235 | related stuff, like signing and encryption (@pxref{Security, Security,, | |
28236 | message, Message Manual}). | |
28237 | ||
28238 | @item | |
28239 | The tool bars have been updated to use GNOME icons in Group, Summary and | |
d55fe5bb MB |
28240 | Message mode. You can also customize the tool bars: @kbd{M-x |
28241 | customize-apropos RET -tool-bar$} should get you started. This is a new | |
28242 | feature in Gnus 5.10.10. (Only for Emacs, not in XEmacs.) | |
4009494e GM |
28243 | |
28244 | @item The tool bar icons are now (de)activated correctly | |
28245 | in the group buffer, see the variable @code{gnus-group-update-tool-bar}. | |
28246 | Its default value depends on your Emacs version. This is a new feature | |
28247 | in Gnus 5.10.9. | |
28248 | @end itemize | |
28249 | ||
28250 | ||
28251 | @item Miscellaneous changes | |
28252 | @c ************************ | |
28253 | ||
28254 | @itemize @bullet | |
28255 | ||
28256 | @item | |
28257 | @code{gnus-agent} | |
28258 | ||
28259 | The Gnus Agent has seen a major updated and is now enabled by default, | |
28260 | and all nntp and nnimap servers from @code{gnus-select-method} and | |
28261 | @code{gnus-secondary-select-method} are agentized by default. Earlier | |
28262 | only the server in @code{gnus-select-method} was agentized by the | |
28263 | default, and the agent was disabled by default. When the agent is | |
28264 | enabled, headers are now also retrieved from the Agent cache instead | |
28265 | of the back ends when possible. Earlier this only happened in the | |
28266 | unplugged state. You can enroll or remove servers with @kbd{J a} and | |
28267 | @kbd{J r} in the server buffer. Gnus will not download articles into | |
28268 | the Agent cache, unless you instruct it to do so, though, by using | |
28269 | @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old | |
28270 | behavior of having the Agent disabled with @code{(setq gnus-agent | |
28271 | nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el} | |
28272 | is not needed any more. | |
28273 | ||
28274 | @item | |
28275 | Gnus reads the @acronym{NOV} and articles in the Agent if plugged. | |
28276 | ||
28277 | If one reads an article while plugged, and the article already exists | |
28278 | in the Agent, it won't get downloaded once more. @code{(setq | |
28279 | gnus-agent-cache nil)} reverts to the old behavior. | |
28280 | ||
28281 | @item | |
28282 | Dired integration | |
28283 | ||
28284 | @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key | |
28285 | bindings in dired buffers to send a file as an attachment, open a file | |
28286 | using the appropriate mailcap entry, and print a file using the mailcap | |
28287 | entry. | |
28288 | ||
28289 | @item | |
28290 | The format spec @code{%C} for positioning point has changed to @code{%*}. | |
28291 | ||
28292 | @item | |
28293 | @code{gnus-slave-unplugged} | |
28294 | ||
28295 | A new command which starts Gnus offline in slave mode. | |
28296 | ||
28297 | @end itemize | |
28298 | ||
28299 | @end itemize | |
28300 | ||
01c52d31 MB |
28301 | @node No Gnus |
28302 | @subsubsection No Gnus | |
28303 | @cindex No Gnus | |
28304 | ||
28305 | New features in No Gnus: | |
28306 | @c FIXME: Gnus 5.12? | |
28307 | ||
28308 | @include gnus-news.texi | |
28309 | ||
89b163db G |
28310 | @node Ma Gnus |
28311 | @subsubsection Ma Gnus | |
28312 | @cindex Ma Gnus | |
28313 | ||
28314 | I'm sure there will be lots of text here. It's really spelled 真 | |
28315 | Gnus. | |
28316 | ||
28317 | New features in Ma Gnus: | |
28318 | ||
28319 | @itemize @bullet | |
28320 | ||
28321 | @item Changes in Message mode and related Gnus features | |
28322 | @c **************************************************** | |
28323 | ||
28324 | @itemize @bullet | |
28325 | ||
28326 | @item | |
28327 | The new hooks @code{gnus-gcc-pre-body-encode-hook} and | |
28328 | @code{gnus-gcc-post-body-encode-hook} are run before/after encoding | |
28329 | the message body of the Gcc copy of a sent message. See | |
28330 | @xref{Archived Messages}. | |
28331 | ||
28332 | @end itemize | |
28333 | ||
28334 | @end itemize | |
28335 | ||
4009494e GM |
28336 | @iftex |
28337 | ||
28338 | @page | |
28339 | @node The Manual | |
28340 | @section The Manual | |
28341 | @cindex colophon | |
28342 | @cindex manual | |
28343 | ||
28344 | This manual was generated from a TeXinfo file and then run through | |
28345 | either @code{texi2dvi} | |
28346 | @iflatex | |
28347 | or my own home-brewed TeXinfo to \LaTeX\ transformer, | |
28348 | and then run through @code{latex} and @code{dvips} | |
28349 | @end iflatex | |
28350 | to get what you hold in your hands now. | |
28351 | ||
28352 | The following conventions have been used: | |
28353 | ||
28354 | @enumerate | |
28355 | ||
28356 | @item | |
28357 | This is a @samp{string} | |
28358 | ||
28359 | @item | |
28360 | This is a @kbd{keystroke} | |
28361 | ||
28362 | @item | |
28363 | This is a @file{file} | |
28364 | ||
28365 | @item | |
28366 | This is a @code{symbol} | |
28367 | ||
28368 | @end enumerate | |
28369 | ||
28370 | So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would | |
28371 | mean: | |
28372 | ||
28373 | @lisp | |
28374 | (setq flargnoze "yes") | |
28375 | @end lisp | |
28376 | ||
28377 | If I say ``set @code{flumphel} to @code{yes}'', that would mean: | |
28378 | ||
28379 | @lisp | |
28380 | (setq flumphel 'yes) | |
28381 | @end lisp | |
28382 | ||
28383 | @samp{yes} and @code{yes} are two @emph{very} different things---don't | |
28384 | ever get them confused. | |
28385 | ||
28386 | @iflatex | |
28387 | @c @head | |
28388 | Of course, everything in this manual is of vital interest, so you should | |
28389 | read it all. Several times. However, if you feel like skimming the | |
28390 | manual, look for that gnu head you should see in the margin over | |
28391 | there---it means that what's being discussed is of more importance than | |
28392 | the rest of the stuff. (On the other hand, if everything is infinitely | |
28393 | important, how can anything be more important than that? Just one more | |
28394 | of the mysteries of this world, I guess.) | |
28395 | @end iflatex | |
28396 | ||
28397 | @end iftex | |
28398 | ||
28399 | ||
28400 | @node On Writing Manuals | |
28401 | @section On Writing Manuals | |
28402 | ||
28403 | I guess most manuals are written after-the-fact; documenting a program | |
28404 | that's already there. This is not how this manual is written. When | |
28405 | implementing something, I write the manual entry for that something | |
28406 | straight away. I then see that it's difficult to explain the | |
28407 | functionality, so I write how it's supposed to be, and then I change the | |
4b70e299 MB |
28408 | implementation. Writing the documentation and writing the code go hand |
28409 | in hand. | |
4009494e GM |
28410 | |
28411 | This, of course, means that this manual has no, or little, flow. It | |
28412 | documents absolutely everything in Gnus, but often not where you're | |
28413 | looking for it. It is a reference manual, and not a guide to how to get | |
28414 | started with Gnus. | |
28415 | ||
28416 | That would be a totally different book, that should be written using the | |
4b70e299 | 28417 | reference manual as source material. It would look quite different. |
4009494e GM |
28418 | |
28419 | ||
28420 | @page | |
28421 | @node Terminology | |
28422 | @section Terminology | |
28423 | ||
28424 | @cindex terminology | |
28425 | @table @dfn | |
28426 | ||
28427 | @item news | |
28428 | @cindex news | |
28429 | This is what you are supposed to use this thing for---reading news. | |
28430 | News is generally fetched from a nearby @acronym{NNTP} server, and is | |
28431 | generally publicly available to everybody. If you post news, the entire | |
28432 | world is likely to read just what you have written, and they'll all | |
28433 | snigger mischievously. Behind your back. | |
28434 | ||
28435 | @item mail | |
28436 | @cindex mail | |
28437 | Everything that's delivered to you personally is mail. Some news/mail | |
28438 | readers (like Gnus) blur the distinction between mail and news, but | |
28439 | there is a difference. Mail is private. News is public. Mailing is | |
28440 | not posting, and replying is not following up. | |
28441 | ||
28442 | @item reply | |
28443 | @cindex reply | |
28444 | Send a mail to the person who has written what you are reading. | |
28445 | ||
28446 | @item follow up | |
28447 | @cindex follow up | |
28448 | Post an article to the current newsgroup responding to the article you | |
28449 | are reading. | |
28450 | ||
28451 | @item back end | |
28452 | @cindex back end | |
28453 | Gnus considers mail and news to be mostly the same, really. The only | |
28454 | difference is how to access the actual articles. News articles are | |
28455 | commonly fetched via the protocol @acronym{NNTP}, whereas mail | |
28456 | messages could be read from a file on the local disk. The internal | |
28457 | architecture of Gnus thus comprises a ``front end'' and a number of | |
28458 | ``back ends''. Internally, when you enter a group (by hitting | |
28459 | @key{RET}, say), you thereby invoke a function in the front end in | |
28460 | Gnus. The front end then ``talks'' to a back end and says things like | |
28461 | ``Give me the list of articles in the foo group'' or ``Show me article | |
28462 | number 4711''. | |
28463 | ||
28464 | So a back end mainly defines either a protocol (the @code{nntp} back | |
28465 | end accesses news via @acronym{NNTP}, the @code{nnimap} back end | |
28466 | accesses mail via @acronym{IMAP}) or a file format and directory | |
28467 | layout (the @code{nnspool} back end accesses news via the common | |
28468 | ``spool directory'' format, the @code{nnml} back end access mail via a | |
28469 | file format and directory layout that's quite similar). | |
28470 | ||
28471 | Gnus does not handle the underlying media, so to speak---this is all | |
28472 | done by the back ends. A back end is a collection of functions to | |
28473 | access the articles. | |
28474 | ||
28475 | However, sometimes the term ``back end'' is also used where ``server'' | |
28476 | would have been more appropriate. And then there is the term ``select | |
28477 | method'' which can mean either. The Gnus terminology can be quite | |
28478 | confusing. | |
28479 | ||
28480 | @item native | |
28481 | @cindex native | |
28482 | Gnus will always use one method (and back end) as the @dfn{native}, or | |
0afb49a1 LMI |
28483 | default, way of getting news. Groups from the native select method |
28484 | have names like @samp{gnu.emacs.gnus}. | |
4009494e GM |
28485 | |
28486 | @item foreign | |
28487 | @cindex foreign | |
0afb49a1 LMI |
28488 | You can also have any number of foreign groups active at the same |
28489 | time. These are groups that use non-native non-secondary back ends | |
28490 | for getting news. Foreign groups have names like | |
28491 | @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}. | |
4009494e GM |
28492 | |
28493 | @item secondary | |
28494 | @cindex secondary | |
0afb49a1 LMI |
28495 | Secondary back ends are somewhere half-way between being native and |
28496 | being foreign, but they mostly act like they are native, but they, too | |
28497 | have names like @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}. | |
4009494e GM |
28498 | |
28499 | @item article | |
28500 | @cindex article | |
28501 | A message that has been posted as news. | |
28502 | ||
28503 | @item mail message | |
28504 | @cindex mail message | |
28505 | A message that has been mailed. | |
28506 | ||
28507 | @item message | |
28508 | @cindex message | |
28509 | A mail message or news article | |
28510 | ||
28511 | @item head | |
28512 | @cindex head | |
28513 | The top part of a message, where administrative information (etc.) is | |
28514 | put. | |
28515 | ||
28516 | @item body | |
28517 | @cindex body | |
28518 | The rest of an article. Everything not in the head is in the | |
28519 | body. | |
28520 | ||
28521 | @item header | |
28522 | @cindex header | |
28523 | A line from the head of an article. | |
28524 | ||
28525 | @item headers | |
28526 | @cindex headers | |
28527 | A collection of such lines, or a collection of heads. Or even a | |
28528 | collection of @acronym{NOV} lines. | |
28529 | ||
28530 | @item @acronym{NOV} | |
28531 | @cindex @acronym{NOV} | |
4b70e299 MB |
28532 | @acronym{NOV} stands for News OverView, which is a type of news server |
28533 | header which provide datas containing the condensed header information | |
28534 | of articles. They are produced by the server itself; in the @code{nntp} | |
28535 | back end Gnus uses the ones that the @acronym{NNTP} server makes, but | |
28536 | Gnus makes them by itself for some backends (in particular, @code{nnml}). | |
28537 | ||
4009494e GM |
28538 | When Gnus enters a group, it asks the back end for the headers of all |
28539 | unread articles in the group. Most servers support the News OverView | |
28540 | format, which is more compact and much faster to read and parse than the | |
28541 | normal @sc{head} format. | |
28542 | ||
4b70e299 MB |
28543 | The @acronym{NOV} data consist of one or more text lines (@pxref{Text |
28544 | Lines, ,Motion by Text Lines, elisp, The Emacs Lisp Reference Manual}) | |
28545 | where each line has the header information of one article. The header | |
28546 | information is a tab-separated series of the header's contents including | |
28547 | an article number, a subject, an author, a date, a message-id, | |
28548 | references, etc. | |
28549 | ||
28550 | Those data enable Gnus to generate summary lines quickly. However, if | |
28551 | the server does not support @acronym{NOV} or you disable it purposely or | |
28552 | for some reason, Gnus will try to generate the header information by | |
28553 | parsing each article's headers one by one. It will take time. | |
28554 | Therefore, it is not usually a good idea to set nn*-nov-is-evil | |
28555 | (@pxref{Slow/Expensive Connection}) to a non-@code{nil} value unless you | |
28556 | know that the server makes wrong @acronym{NOV} data. | |
28557 | ||
4009494e GM |
28558 | @item level |
28559 | @cindex levels | |
28560 | Each group is subscribed at some @dfn{level} or other (1-9). The ones | |
28561 | that have a lower level are ``more'' subscribed than the groups with a | |
28562 | higher level. In fact, groups on levels 1-5 are considered | |
28563 | @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9 | |
28564 | are @dfn{killed}. Commands for listing groups and scanning for new | |
28565 | articles will all use the numeric prefix as @dfn{working level}. | |
28566 | ||
28567 | @item killed groups | |
28568 | @cindex killed groups | |
28569 | No information on killed groups is stored or updated, which makes killed | |
28570 | groups much easier to handle than subscribed groups. | |
28571 | ||
28572 | @item zombie groups | |
28573 | @cindex zombie groups | |
28574 | Just like killed groups, only slightly less dead. | |
28575 | ||
28576 | @item active file | |
28577 | @cindex active file | |
28578 | The news server has to keep track of what articles it carries, and what | |
28579 | groups exist. All this information in stored in the active file, which | |
28580 | is rather large, as you might surmise. | |
28581 | ||
28582 | @item bogus groups | |
28583 | @cindex bogus groups | |
28584 | A group that exists in the @file{.newsrc} file, but isn't known to the | |
28585 | server (i.e., it isn't in the active file), is a @emph{bogus group}. | |
28586 | This means that the group probably doesn't exist (any more). | |
28587 | ||
28588 | @item activating | |
28589 | @cindex activating groups | |
28590 | The act of asking the server for info on a group and computing the | |
28591 | number of unread articles is called @dfn{activating the group}. | |
28592 | Un-activated groups are listed with @samp{*} in the group buffer. | |
28593 | ||
28594 | @item spool | |
28595 | @cindex spool | |
28596 | News servers store their articles locally in one fashion or other. | |
28597 | One old-fashioned storage method is to have just one file per | |
28598 | article. That's called a ``traditional spool''. | |
28599 | ||
28600 | @item server | |
28601 | @cindex server | |
28602 | A machine one can connect to and get news (or mail) from. | |
28603 | ||
28604 | @item select method | |
28605 | @cindex select method | |
28606 | A structure that specifies the back end, the server and the virtual | |
28607 | server settings. | |
28608 | ||
28609 | @item virtual server | |
28610 | @cindex virtual server | |
28611 | A named select method. Since a select method defines all there is to | |
28612 | know about connecting to a (physical) server, taking the thing as a | |
28613 | whole is a virtual server. | |
28614 | ||
28615 | @item washing | |
28616 | @cindex washing | |
28617 | Taking a buffer and running it through a filter of some sort. The | |
28618 | result will (more often than not) be cleaner and more pleasing than the | |
28619 | original. | |
28620 | ||
28621 | @item ephemeral groups | |
28622 | @cindex ephemeral groups | |
28623 | @cindex temporary groups | |
28624 | Most groups store data on what articles you have read. @dfn{Ephemeral} | |
28625 | groups are groups that will have no data stored---when you exit the | |
28626 | group, it'll disappear into the aether. | |
28627 | ||
28628 | @item solid groups | |
28629 | @cindex solid groups | |
28630 | This is the opposite of ephemeral groups. All groups listed in the | |
28631 | group buffer are solid groups. | |
28632 | ||
28633 | @item sparse articles | |
28634 | @cindex sparse articles | |
28635 | These are article placeholders shown in the summary buffer when | |
28636 | @code{gnus-build-sparse-threads} has been switched on. | |
28637 | ||
28638 | @item threading | |
28639 | @cindex threading | |
28640 | To put responses to articles directly after the articles they respond | |
28641 | to---in a hierarchical fashion. | |
28642 | ||
28643 | @item root | |
28644 | @cindex root | |
28645 | @cindex thread root | |
28646 | The first article in a thread is the root. It is the ancestor of all | |
28647 | articles in the thread. | |
28648 | ||
28649 | @item parent | |
28650 | @cindex parent | |
28651 | An article that has responses. | |
28652 | ||
28653 | @item child | |
28654 | @cindex child | |
28655 | An article that responds to a different article---its parent. | |
28656 | ||
28657 | @item digest | |
28658 | @cindex digest | |
28659 | A collection of messages in one file. The most common digest format is | |
28660 | specified by RFC 1153. | |
28661 | ||
28662 | @item splitting | |
28663 | @cindex splitting, terminology | |
28664 | @cindex mail sorting | |
28665 | @cindex mail filtering (splitting) | |
28666 | The action of sorting your emails according to certain rules. Sometimes | |
28667 | incorrectly called mail filtering. | |
28668 | ||
28669 | @end table | |
28670 | ||
28671 | ||
28672 | @page | |
28673 | @node Customization | |
28674 | @section Customization | |
28675 | @cindex general customization | |
28676 | ||
28677 | All variables are properly documented elsewhere in this manual. This | |
28678 | section is designed to give general pointers on how to customize Gnus | |
28679 | for some quite common situations. | |
28680 | ||
28681 | @menu | |
28682 | * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere. | |
28683 | * Slow Terminal Connection:: You run a remote Emacs. | |
28684 | * Little Disk Space:: You feel that having large setup files is icky. | |
28685 | * Slow Machine:: You feel like buying a faster machine. | |
28686 | @end menu | |
28687 | ||
28688 | ||
28689 | @node Slow/Expensive Connection | |
4b70e299 | 28690 | @subsection Slow/Expensive Connection |
4009494e GM |
28691 | |
28692 | If you run Emacs on a machine locally, and get your news from a machine | |
28693 | over some very thin strings, you want to cut down on the amount of data | |
4b70e299 | 28694 | Gnus has to get from the server. |
4009494e GM |
28695 | |
28696 | @table @code | |
28697 | ||
28698 | @item gnus-read-active-file | |
28699 | Set this to @code{nil}, which will inhibit Gnus from requesting the | |
28700 | entire active file from the server. This file is often very large. You | |
28701 | also have to set @code{gnus-check-new-newsgroups} and | |
28702 | @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus | |
28703 | doesn't suddenly decide to fetch the active file anyway. | |
28704 | ||
28705 | @item gnus-nov-is-evil | |
4b70e299 MB |
28706 | @vindex gnus-nov-is-evil |
28707 | Usually this one must @emph{always} be @code{nil} (which is the | |
28708 | default). If, for example, you wish to not use @acronym{NOV} | |
28709 | (@pxref{Terminology}) with the @code{nntp} back end (@pxref{Crosspost | |
28710 | Handling}), set @code{nntp-nov-is-evil} to a non-@code{nil} value | |
28711 | instead of setting this. But you normally do not need to set | |
28712 | @code{nntp-nov-is-evil} since Gnus by itself will detect whether the | |
28713 | @acronym{NNTP} server supports @acronym{NOV}. Anyway, grabbing article | |
28714 | headers from the @acronym{NNTP} server will not be very fast if you tell | |
28715 | Gnus not to use @acronym{NOV}. | |
28716 | ||
28717 | As the variables for the other back ends, there are | |
28718 | @code{nndiary-nov-is-evil}, @code{nndir-nov-is-evil}, | |
28719 | @code{nnfolder-nov-is-evil}, @code{nnimap-nov-is-evil}, | |
3c08d668 KY |
28720 | @code{nnml-nov-is-evil}, and @code{nnspool-nov-is-evil}. Note that a |
28721 | non-@code{nil} value for @code{gnus-nov-is-evil} overrides all those | |
261ff377 | 28722 | variables. |
4009494e GM |
28723 | @end table |
28724 | ||
28725 | ||
28726 | @node Slow Terminal Connection | |
28727 | @subsection Slow Terminal Connection | |
28728 | ||
28729 | Let's say you use your home computer for dialing up the system that runs | |
28730 | Emacs and Gnus. If your modem is slow, you want to reduce (as much as | |
28731 | possible) the amount of data sent over the wires. | |
28732 | ||
28733 | @table @code | |
28734 | ||
28735 | @item gnus-auto-center-summary | |
28736 | Set this to @code{nil} to inhibit Gnus from re-centering the summary | |
28737 | buffer all the time. If it is @code{vertical}, do only vertical | |
28738 | re-centering. If it is neither @code{nil} nor @code{vertical}, do both | |
28739 | horizontal and vertical recentering. | |
28740 | ||
28741 | @item gnus-visible-headers | |
28742 | Cut down on the headers included in the articles to the | |
28743 | minimum. You can, in fact, make do without them altogether---most of the | |
28744 | useful data is in the summary buffer, anyway. Set this variable to | |
28745 | @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need. | |
28746 | ||
28747 | Use the following to enable all the available hiding features: | |
28748 | @lisp | |
28749 | (setq gnus-treat-hide-headers 'head | |
28750 | gnus-treat-hide-signature t | |
28751 | gnus-treat-hide-citation t) | |
28752 | @end lisp | |
28753 | ||
28754 | @item gnus-use-full-window | |
28755 | By setting this to @code{nil}, you can make all the windows smaller. | |
28756 | While this doesn't really cut down much generally, it means that you | |
28757 | have to see smaller portions of articles before deciding that you didn't | |
28758 | want to read them anyway. | |
28759 | ||
28760 | @item gnus-thread-hide-subtree | |
28761 | If this is non-@code{nil}, all threads in the summary buffer will be | |
28762 | hidden initially. | |
28763 | ||
28764 | ||
28765 | @item gnus-updated-mode-lines | |
28766 | If this is @code{nil}, Gnus will not put information in the buffer mode | |
28767 | lines, which might save some time. | |
28768 | @end table | |
28769 | ||
28770 | ||
28771 | @node Little Disk Space | |
28772 | @subsection Little Disk Space | |
28773 | @cindex disk space | |
28774 | ||
28775 | The startup files can get rather large, so you may want to cut their | |
28776 | sizes a bit if you are running out of space. | |
28777 | ||
28778 | @table @code | |
28779 | ||
28780 | @item gnus-save-newsrc-file | |
28781 | If this is @code{nil}, Gnus will never save @file{.newsrc}---it will | |
28782 | only save @file{.newsrc.eld}. This means that you will not be able to | |
28783 | use any other newsreaders than Gnus. This variable is @code{t} by | |
28784 | default. | |
28785 | ||
28786 | @item gnus-read-newsrc-file | |
28787 | If this is @code{nil}, Gnus will never read @file{.newsrc}---it will | |
28788 | only read @file{.newsrc.eld}. This means that you will not be able to | |
28789 | use any other newsreaders than Gnus. This variable is @code{t} by | |
28790 | default. | |
28791 | ||
28792 | @item gnus-save-killed-list | |
28793 | If this is @code{nil}, Gnus will not save the list of dead groups. You | |
28794 | should also set @code{gnus-check-new-newsgroups} to @code{ask-server} | |
28795 | and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this | |
28796 | variable to @code{nil}. This variable is @code{t} by default. | |
28797 | ||
28798 | @end table | |
28799 | ||
28800 | ||
28801 | @node Slow Machine | |
28802 | @subsection Slow Machine | |
28803 | @cindex slow machine | |
28804 | ||
28805 | If you have a slow machine, or are just really impatient, there are a | |
28806 | few things you can do to make Gnus run faster. | |
28807 | ||
28808 | Set @code{gnus-check-new-newsgroups} and | |
28809 | @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster. | |
28810 | ||
28811 | Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and | |
28812 | @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the | |
4b70e299 | 28813 | summary buffer faster. Also @pxref{Slow/Expensive Connection}. |
4009494e GM |
28814 | |
28815 | ||
28816 | @page | |
28817 | @node Troubleshooting | |
28818 | @section Troubleshooting | |
28819 | @cindex troubleshooting | |
28820 | ||
28821 | Gnus works @emph{so} well straight out of the box---I can't imagine any | |
28822 | problems, really. | |
28823 | ||
28824 | Ahem. | |
28825 | ||
28826 | @enumerate | |
28827 | ||
28828 | @item | |
28829 | Make sure your computer is switched on. | |
28830 | ||
28831 | @item | |
28832 | Make sure that you really load the current Gnus version. If you have | |
28833 | been running @sc{gnus}, you need to exit Emacs and start it up again before | |
28834 | Gnus will work. | |
28835 | ||
28836 | @item | |
28837 | Try doing an @kbd{M-x gnus-version}. If you get something that looks | |
5c3a9e4c | 28838 | like @c |
437ce4be | 28839 | @samp{Gnus v5.13} @c Adjust ../Makefile.in if you change this line! |
5c3a9e4c MB |
28840 | @c |
28841 | you have the right files loaded. Otherwise you have some old @file{.el} | |
28842 | files lying around. Delete these. | |
4009494e GM |
28843 | |
28844 | @item | |
28845 | Read the help group (@kbd{G h} in the group buffer) for a | |
28846 | @acronym{FAQ} and a how-to. | |
28847 | ||
28848 | @item | |
28849 | @vindex max-lisp-eval-depth | |
28850 | Gnus works on many recursive structures, and in some extreme (and very | |
28851 | rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at | |
28852 | you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or | |
28853 | something like that. | |
28854 | @end enumerate | |
28855 | ||
28856 | If all else fails, report the problem as a bug. | |
28857 | ||
28858 | @cindex bugs | |
28859 | @cindex reporting bugs | |
28860 | ||
28861 | @kindex M-x gnus-bug | |
28862 | @findex gnus-bug | |
28863 | If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug} | |
28864 | command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send | |
28865 | me the backtrace. I will fix bugs, but I can only fix them if you send | |
28866 | me a precise description as to how to reproduce the bug. | |
28867 | ||
28868 | You really can never be too detailed in a bug report. Always use the | |
28869 | @kbd{M-x gnus-bug} command when you make bug reports, even if it creates | |
28870 | a 10Kb mail each time you use it, and even if you have sent me your | |
28871 | environment 500 times before. I don't care. I want the full info each | |
28872 | time. | |
28873 | ||
28874 | It is also important to remember that I have no memory whatsoever. If | |
28875 | you send a bug report, and I send you a reply, and then you just send | |
28876 | back ``No, it's not! Moron!'', I will have no idea what you are | |
28877 | insulting me about. Always over-explain everything. It's much easier | |
28878 | for all of us---if I don't have all the information I need, I will just | |
28879 | mail you and ask for more info, and everything takes more time. | |
28880 | ||
28881 | If the problem you're seeing is very visual, and you can't quite explain | |
28882 | it, copy the Emacs window to a file (with @code{xwd}, for instance), put | |
28883 | it somewhere it can be reached, and include the URL of the picture in | |
28884 | the bug report. | |
28885 | ||
28886 | @cindex patches | |
28887 | If you would like to contribute a patch to fix bugs or make | |
28888 | improvements, please produce the patch using @samp{diff -u}. | |
28889 | ||
28890 | @cindex edebug | |
28891 | If you want to debug your problem further before reporting, possibly | |
28892 | in order to solve the problem yourself and send a patch, you can use | |
28893 | edebug. Debugging Lisp code is documented in the Elisp manual | |
28894 | (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs | |
28895 | Lisp Reference Manual}). To get you started with edebug, consider if | |
28896 | you discover some weird behavior when pressing @kbd{c}, the first | |
28897 | step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in | |
28898 | the documentation buffer that leads you to the function definition, | |
28899 | then press @kbd{M-x edebug-defun RET} with point inside that function, | |
28900 | return to Gnus and press @kbd{c} to invoke the code. You will be | |
28901 | placed in the lisp buffer and can single step using @kbd{SPC} and | |
28902 | evaluate expressions using @kbd{M-:} or inspect variables using | |
28903 | @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with | |
28904 | @kbd{c} or @kbd{g}. | |
28905 | ||
28906 | @cindex elp | |
28907 | @cindex profile | |
28908 | @cindex slow | |
28909 | Sometimes, a problem do not directly generate an elisp error but | |
28910 | manifests itself by causing Gnus to be very slow. In these cases, you | |
28911 | can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are | |
28912 | slow, and then try to analyze the backtrace (repeating the procedure | |
28913 | helps isolating the real problem areas). | |
28914 | ||
1df7defd | 28915 | A fancier approach is to use the elisp profiler, ELP@. The profiler is |
4009494e GM |
28916 | (or should be) fully documented elsewhere, but to get you started |
28917 | there are a few steps that need to be followed. First, instrument the | |
1df7defd | 28918 | part of Gnus you are interested in for profiling, e.g., @kbd{M-x |
4009494e GM |
28919 | elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package |
28920 | RET message}. Then perform the operation that is slow and press | |
28921 | @kbd{M-x elp-results}. You will then see which operations that takes | |
28922 | time, and can debug them further. If the entire operation takes much | |
28923 | longer than the time spent in the slowest function in the profiler | |
28924 | output, you probably profiled the wrong part of Gnus. To reset | |
28925 | profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x | |
28926 | elp-restore-all} is supposed to remove profiling, but given the | |
28927 | complexities and dynamic code generation in Gnus, it might not always | |
28928 | work perfectly. | |
28929 | ||
28930 | @cindex gnu.emacs.gnus | |
28931 | @cindex ding mailing list | |
28932 | If you just need help, you are better off asking on | |
28933 | @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on | |
28934 | @email{ding@@gnus.org, the ding mailing list}. Write to | |
28935 | @email{ding-request@@gnus.org} to subscribe. | |
28936 | ||
28937 | ||
28938 | @page | |
28939 | @node Gnus Reference Guide | |
28940 | @section Gnus Reference Guide | |
28941 | ||
28942 | It is my hope that other people will figure out smart stuff that Gnus | |
28943 | can do, and that other people will write those smart things as well. To | |
28944 | facilitate that I thought it would be a good idea to describe the inner | |
28945 | workings of Gnus. And some of the not-so-inner workings, while I'm at | |
28946 | it. | |
28947 | ||
28948 | You can never expect the internals of a program not to change, but I | |
28949 | will be defining (in some details) the interface between Gnus and its | |
28950 | back ends (this is written in stone), the format of the score files | |
28951 | (ditto), data structures (some are less likely to change than others) | |
28952 | and general methods of operation. | |
28953 | ||
28954 | @menu | |
28955 | * Gnus Utility Functions:: Common functions and variable to use. | |
28956 | * Back End Interface:: How Gnus communicates with the servers. | |
28957 | * Score File Syntax:: A BNF definition of the score file standard. | |
28958 | * Headers:: How Gnus stores headers internally. | |
28959 | * Ranges:: A handy format for storing mucho numbers. | |
28960 | * Group Info:: The group info format. | |
28961 | * Extended Interactive:: Symbolic prefixes and stuff. | |
28962 | * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen. | |
28963 | * Various File Formats:: Formats of files that Gnus use. | |
28964 | @end menu | |
28965 | ||
28966 | ||
28967 | @node Gnus Utility Functions | |
28968 | @subsection Gnus Utility Functions | |
28969 | @cindex Gnus utility functions | |
28970 | @cindex utility functions | |
28971 | @cindex functions | |
28972 | @cindex internal variables | |
28973 | ||
28974 | When writing small functions to be run from hooks (and stuff), it's | |
28975 | vital to have access to the Gnus internal functions and variables. | |
28976 | Below is a list of the most common ones. | |
28977 | ||
28978 | @table @code | |
28979 | ||
28980 | @item gnus-newsgroup-name | |
28981 | @vindex gnus-newsgroup-name | |
28982 | This variable holds the name of the current newsgroup. | |
28983 | ||
28984 | @item gnus-find-method-for-group | |
28985 | @findex gnus-find-method-for-group | |
28986 | A function that returns the select method for @var{group}. | |
28987 | ||
28988 | @item gnus-group-real-name | |
28989 | @findex gnus-group-real-name | |
28990 | Takes a full (prefixed) Gnus group name, and returns the unprefixed | |
28991 | name. | |
28992 | ||
28993 | @item gnus-group-prefixed-name | |
28994 | @findex gnus-group-prefixed-name | |
28995 | Takes an unprefixed group name and a select method, and returns the full | |
28996 | (prefixed) Gnus group name. | |
28997 | ||
28998 | @item gnus-get-info | |
28999 | @findex gnus-get-info | |
465d0300 | 29000 | Returns the group info list for @var{group} (@pxref{Group Info}). |
4009494e GM |
29001 | |
29002 | @item gnus-group-unread | |
29003 | @findex gnus-group-unread | |
29004 | The number of unread articles in @var{group}, or @code{t} if that is | |
29005 | unknown. | |
29006 | ||
29007 | @item gnus-active | |
29008 | @findex gnus-active | |
465d0300 G |
29009 | The active entry (i.e., a cons cell containing the lowest and highest |
29010 | article numbers) for @var{group}. | |
4009494e GM |
29011 | |
29012 | @item gnus-set-active | |
29013 | @findex gnus-set-active | |
29014 | Set the active entry for @var{group}. | |
29015 | ||
29016 | @item gnus-add-current-to-buffer-list | |
29017 | @findex gnus-add-current-to-buffer-list | |
29018 | Adds the current buffer to the list of buffers to be killed on Gnus | |
29019 | exit. | |
29020 | ||
29021 | @item gnus-continuum-version | |
29022 | @findex gnus-continuum-version | |
29023 | Takes a Gnus version string as a parameter and returns a floating point | |
29024 | number. Earlier versions will always get a lower number than later | |
29025 | versions. | |
29026 | ||
29027 | @item gnus-group-read-only-p | |
29028 | @findex gnus-group-read-only-p | |
29029 | Says whether @var{group} is read-only or not. | |
29030 | ||
29031 | @item gnus-news-group-p | |
29032 | @findex gnus-news-group-p | |
29033 | Says whether @var{group} came from a news back end. | |
29034 | ||
29035 | @item gnus-ephemeral-group-p | |
29036 | @findex gnus-ephemeral-group-p | |
29037 | Says whether @var{group} is ephemeral or not. | |
29038 | ||
29039 | @item gnus-server-to-method | |
29040 | @findex gnus-server-to-method | |
29041 | Returns the select method corresponding to @var{server}. | |
29042 | ||
29043 | @item gnus-server-equal | |
29044 | @findex gnus-server-equal | |
465d0300 G |
29045 | Says whether two virtual servers are essentially equal. For instance, |
29046 | two virtual servers may have server parameters in different order, but | |
29047 | this function will consider them equal. | |
4009494e GM |
29048 | |
29049 | @item gnus-group-native-p | |
29050 | @findex gnus-group-native-p | |
29051 | Says whether @var{group} is native or not. | |
29052 | ||
29053 | @item gnus-group-secondary-p | |
29054 | @findex gnus-group-secondary-p | |
29055 | Says whether @var{group} is secondary or not. | |
29056 | ||
29057 | @item gnus-group-foreign-p | |
29058 | @findex gnus-group-foreign-p | |
29059 | Says whether @var{group} is foreign or not. | |
29060 | ||
29061 | @item gnus-group-find-parameter | |
29062 | @findex gnus-group-find-parameter | |
465d0300 G |
29063 | Returns the parameter list of @var{group} (@pxref{Group Parameters}). |
29064 | If given a second parameter, returns the value of that parameter for | |
29065 | @var{group}. | |
4009494e GM |
29066 | |
29067 | @item gnus-group-set-parameter | |
29068 | @findex gnus-group-set-parameter | |
29069 | Takes three parameters; @var{group}, @var{parameter} and @var{value}. | |
29070 | ||
29071 | @item gnus-narrow-to-body | |
29072 | @findex gnus-narrow-to-body | |
29073 | Narrows the current buffer to the body of the article. | |
29074 | ||
29075 | @item gnus-check-backend-function | |
29076 | @findex gnus-check-backend-function | |
29077 | Takes two parameters, @var{function} and @var{group}. If the back end | |
29078 | @var{group} comes from supports @var{function}, return non-@code{nil}. | |
29079 | ||
29080 | @lisp | |
29081 | (gnus-check-backend-function "request-scan" "nnml:misc") | |
29082 | @result{} t | |
29083 | @end lisp | |
29084 | ||
29085 | @item gnus-read-method | |
29086 | @findex gnus-read-method | |
29087 | Prompts the user for a select method. | |
29088 | ||
29089 | @end table | |
29090 | ||
29091 | ||
29092 | @node Back End Interface | |
29093 | @subsection Back End Interface | |
29094 | ||
29095 | Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual | |
29096 | groups. It only knows how to talk to @dfn{virtual servers}. A virtual | |
29097 | server is a @dfn{back end} and some @dfn{back end variables}. As examples | |
29098 | of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As | |
29099 | examples of the latter we have @code{nntp-port-number} and | |
29100 | @code{nnmbox-directory}. | |
29101 | ||
29102 | When Gnus asks for information from a back end---say @code{nntp}---on | |
29103 | something, it will normally include a virtual server name in the | |
29104 | function parameters. (If not, the back end should use the ``current'' | |
29105 | virtual server.) For instance, @code{nntp-request-list} takes a virtual | |
29106 | server as its only (optional) parameter. If this virtual server hasn't | |
29107 | been opened, the function should fail. | |
29108 | ||
29109 | Note that a virtual server name has no relation to some physical server | |
29110 | name. Take this example: | |
29111 | ||
29112 | @lisp | |
29113 | (nntp "odd-one" | |
29114 | (nntp-address "ifi.uio.no") | |
29115 | (nntp-port-number 4324)) | |
29116 | @end lisp | |
29117 | ||
29118 | Here the virtual server name is @samp{odd-one} while the name of | |
29119 | the physical server is @samp{ifi.uio.no}. | |
29120 | ||
29121 | The back ends should be able to switch between several virtual servers. | |
29122 | The standard back ends implement this by keeping an alist of virtual | |
29123 | server environments that they pull down/push up when needed. | |
29124 | ||
29125 | There are two groups of interface functions: @dfn{required functions}, | |
29126 | which must be present, and @dfn{optional functions}, which Gnus will | |
29127 | always check for presence before attempting to call 'em. | |
29128 | ||
29129 | All these functions are expected to return data in the buffer | |
29130 | @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat | |
29131 | unfortunately named, but we'll have to live with it. When I talk about | |
29132 | @dfn{resulting data}, I always refer to the data in that buffer. When I | |
29133 | talk about @dfn{return value}, I talk about the function value returned by | |
29134 | the function call. Functions that fail should return @code{nil} as the | |
29135 | return value. | |
29136 | ||
29137 | Some back ends could be said to be @dfn{server-forming} back ends, and | |
29138 | some might be said not to be. The latter are back ends that generally | |
29139 | only operate on one group at a time, and have no concept of ``server'' | |
29140 | ---they have a group, and they deliver info on that group and nothing | |
29141 | more. | |
29142 | ||
29143 | Gnus identifies each message by way of group name and article number. A | |
29144 | few remarks about these article numbers might be useful. First of all, | |
29145 | the numbers are positive integers. Secondly, it is normally not | |
29146 | possible for later articles to ``re-use'' older article numbers without | |
29147 | confusing Gnus. That is, if a group has ever contained a message | |
29148 | numbered 42, then no other message may get that number, or Gnus will get | |
29149 | mightily confused.@footnote{See the function | |
29150 | @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.} | |
29151 | Third, article numbers must be assigned in order of arrival in the | |
29152 | group; this is not necessarily the same as the date of the message. | |
29153 | ||
29154 | The previous paragraph already mentions all the ``hard'' restrictions that | |
29155 | article numbers must fulfill. But it seems that it might be useful to | |
29156 | assign @emph{consecutive} article numbers, for Gnus gets quite confused | |
29157 | if there are holes in the article numbering sequence. However, due to | |
29158 | the ``no-reuse'' restriction, holes cannot be avoided altogether. It's | |
29159 | also useful for the article numbers to start at 1 to avoid running out | |
29160 | of numbers as long as possible. | |
29161 | ||
29162 | Note that by convention, back ends are named @code{nnsomething}, but | |
29163 | Gnus also comes with some @code{nnnotbackends}, such as | |
29164 | @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}. | |
29165 | ||
29166 | In the examples and definitions I will refer to the imaginary back end | |
29167 | @code{nnchoke}. | |
29168 | ||
29169 | @cindex @code{nnchoke} | |
29170 | ||
29171 | @menu | |
29172 | * Required Back End Functions:: Functions that must be implemented. | |
29173 | * Optional Back End Functions:: Functions that need not be implemented. | |
29174 | * Error Messaging:: How to get messages and report errors. | |
29175 | * Writing New Back Ends:: Extending old back ends. | |
29176 | * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end. | |
29177 | * Mail-like Back Ends:: Some tips on mail back ends. | |
29178 | @end menu | |
29179 | ||
29180 | ||
29181 | @node Required Back End Functions | |
29182 | @subsubsection Required Back End Functions | |
29183 | ||
29184 | @table @code | |
29185 | ||
29186 | @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD) | |
29187 | ||
29188 | @var{articles} is either a range of article numbers or a list of | |
29189 | @code{Message-ID}s. Current back ends do not fully support either---only | |
29190 | sequences (lists) of article numbers, and most back ends do not support | |
29191 | retrieval of @code{Message-ID}s. But they should try for both. | |
29192 | ||
29193 | The result data should either be HEADs or @acronym{NOV} lines, and the result | |
29194 | value should either be @code{headers} or @code{nov} to reflect this. | |
29195 | This might later be expanded to @code{various}, which will be a mixture | |
29196 | of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus. | |
29197 | ||
29198 | If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra | |
29199 | headers'', in some meaning of the word. This is generally done by | |
29200 | fetching (at most) @var{fetch-old} extra headers less than the smallest | |
29201 | article number in @code{articles}, and filling the gaps as well. The | |
29202 | presence of this parameter can be ignored if the back end finds it | |
29203 | cumbersome to follow the request. If this is non-@code{nil} and not a | |
29204 | number, do maximum fetches. | |
29205 | ||
29206 | Here's an example HEAD: | |
29207 | ||
29208 | @example | |
29209 | 221 1056 Article retrieved. | |
29210 | Path: ifi.uio.no!sturles | |
29211 | From: sturles@@ifi.uio.no (Sturle Sunde) | |
29212 | Newsgroups: ifi.discussion | |
29213 | Subject: Re: Something very droll | |
29214 | Date: 27 Oct 1994 14:02:57 +0100 | |
29215 | Organization: Dept. of Informatics, University of Oslo, Norway | |
29216 | Lines: 26 | |
29217 | Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no> | |
29218 | References: <38jdmq$4qu@@visbur.ifi.uio.no> | |
29219 | NNTP-Posting-Host: holmenkollen.ifi.uio.no | |
29220 | . | |
29221 | @end example | |
29222 | ||
29223 | So a @code{headers} return value would imply that there's a number of | |
29224 | these in the data buffer. | |
29225 | ||
29226 | Here's a BNF definition of such a buffer: | |
29227 | ||
29228 | @example | |
29229 | headers = *head | |
29230 | head = error / valid-head | |
29231 | error-message = [ "4" / "5" ] 2number " " <error message> eol | |
29232 | valid-head = valid-message *header "." eol | |
29233 | valid-message = "221 " <number> " Article retrieved." eol | |
29234 | header = <text> eol | |
29235 | @end example | |
29236 | ||
29237 | @cindex BNF | |
29238 | (The version of BNF used here is the one used in RFC822.) | |
29239 | ||
29240 | If the return value is @code{nov}, the data buffer should contain | |
29241 | @dfn{network overview database} lines. These are basically fields | |
29242 | separated by tabs. | |
29243 | ||
29244 | @example | |
29245 | nov-buffer = *nov-line | |
29246 | nov-line = field 7*8[ <TAB> field ] eol | |
29247 | field = <text except TAB> | |
29248 | @end example | |
29249 | ||
29250 | For a closer look at what should be in those fields, | |
29251 | @pxref{Headers}. | |
29252 | ||
29253 | ||
29254 | @item (nnchoke-open-server SERVER &optional DEFINITIONS) | |
29255 | ||
29256 | @var{server} is here the virtual server name. @var{definitions} is a | |
29257 | list of @code{(VARIABLE VALUE)} pairs that define this virtual server. | |
29258 | ||
29259 | If the server can't be opened, no error should be signaled. The back end | |
29260 | may then choose to refuse further attempts at connecting to this | |
29261 | server. In fact, it should do so. | |
29262 | ||
29263 | If the server is opened already, this function should return a | |
29264 | non-@code{nil} value. There should be no data returned. | |
29265 | ||
29266 | ||
29267 | @item (nnchoke-close-server &optional SERVER) | |
29268 | ||
29269 | Close connection to @var{server} and free all resources connected | |
29270 | to it. Return @code{nil} if the server couldn't be closed for some | |
29271 | reason. | |
29272 | ||
29273 | There should be no data returned. | |
29274 | ||
29275 | ||
29276 | @item (nnchoke-request-close) | |
29277 | ||
29278 | Close connection to all servers and free all resources that the back end | |
29279 | have reserved. All buffers that have been created by that back end | |
29280 | should be killed. (Not the @code{nntp-server-buffer}, though.) This | |
29281 | function is generally only called when Gnus is shutting down. | |
29282 | ||
29283 | There should be no data returned. | |
29284 | ||
29285 | ||
29286 | @item (nnchoke-server-opened &optional SERVER) | |
29287 | ||
29288 | If @var{server} is the current virtual server, and the connection to the | |
29289 | physical server is alive, then this function should return a | |
29290 | non-@code{nil} value. This function should under no circumstances | |
29291 | attempt to reconnect to a server we have lost connection to. | |
29292 | ||
29293 | There should be no data returned. | |
29294 | ||
29295 | ||
29296 | @item (nnchoke-status-message &optional SERVER) | |
29297 | ||
29298 | This function should return the last error message from @var{server}. | |
29299 | ||
29300 | There should be no data returned. | |
29301 | ||
29302 | ||
29303 | @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER) | |
29304 | ||
29305 | The result data from this function should be the article specified by | |
29306 | @var{article}. This might either be a @code{Message-ID} or a number. | |
29307 | It is optional whether to implement retrieval by @code{Message-ID}, but | |
29308 | it would be nice if that were possible. | |
29309 | ||
29310 | If @var{to-buffer} is non-@code{nil}, the result data should be returned | |
29311 | in this buffer instead of the normal data buffer. This is to make it | |
29312 | possible to avoid copying large amounts of data from one buffer to | |
29313 | another, while Gnus mainly requests articles to be inserted directly | |
29314 | into its article buffer. | |
29315 | ||
29316 | If it is at all possible, this function should return a cons cell where | |
29317 | the @code{car} is the group name the article was fetched from, and the @code{cdr} is | |
29318 | the article number. This will enable Gnus to find out what the real | |
29319 | group and article numbers are when fetching articles by | |
29320 | @code{Message-ID}. If this isn't possible, @code{t} should be returned | |
29321 | on successful article retrieval. | |
29322 | ||
29323 | ||
bdaa75c7 | 29324 | @item (nnchoke-request-group GROUP &optional SERVER FAST INFO) |
4009494e GM |
29325 | |
29326 | Get data on @var{group}. This function also has the side effect of | |
29327 | making @var{group} the current group. | |
29328 | ||
29329 | If @var{fast}, don't bother to return useful data, just make @var{group} | |
29330 | the current group. | |
29331 | ||
bdaa75c7 LMI |
29332 | If @var{info}, it allows the backend to update the group info |
29333 | structure. | |
29334 | ||
4009494e GM |
29335 | Here's an example of some result data and a definition of the same: |
29336 | ||
29337 | @example | |
29338 | 211 56 1000 1059 ifi.discussion | |
29339 | @end example | |
29340 | ||
29341 | The first number is the status, which should be 211. Next is the | |
29342 | total number of articles in the group, the lowest article number, the | |
29343 | highest article number, and finally the group name. Note that the total | |
29344 | number of articles may be less than one might think while just | |
29345 | considering the highest and lowest article numbers, but some articles | |
29346 | may have been canceled. Gnus just discards the total-number, so | |
29347 | whether one should take the bother to generate it properly (if that is a | |
29348 | problem) is left as an exercise to the reader. If the group contains no | |
29349 | articles, the lowest article number should be reported as 1 and the | |
29350 | highest as 0. | |
29351 | ||
29352 | @example | |
29353 | group-status = [ error / info ] eol | |
29354 | error = [ "4" / "5" ] 2<number> " " <Error message> | |
29355 | info = "211 " 3* [ <number> " " ] <string> | |
29356 | @end example | |
29357 | ||
29358 | ||
29359 | @item (nnchoke-close-group GROUP &optional SERVER) | |
29360 | ||
29361 | Close @var{group} and free any resources connected to it. This will be | |
29362 | a no-op on most back ends. | |
29363 | ||
29364 | There should be no data returned. | |
29365 | ||
29366 | ||
29367 | @item (nnchoke-request-list &optional SERVER) | |
29368 | ||
29369 | Return a list of all groups available on @var{server}. And that means | |
29370 | @emph{all}. | |
29371 | ||
29372 | Here's an example from a server that only carries two groups: | |
29373 | ||
29374 | @example | |
29375 | ifi.test 0000002200 0000002000 y | |
29376 | ifi.discussion 3324 3300 n | |
29377 | @end example | |
29378 | ||
29379 | On each line we have a group name, then the highest article number in | |
29380 | that group, the lowest article number, and finally a flag. If the group | |
29381 | contains no articles, the lowest article number should be reported as 1 | |
29382 | and the highest as 0. | |
29383 | ||
29384 | @example | |
29385 | active-file = *active-line | |
29386 | active-line = name " " <number> " " <number> " " flags eol | |
29387 | name = <string> | |
29388 | flags = "n" / "y" / "m" / "x" / "j" / "=" name | |
29389 | @end example | |
29390 | ||
29391 | The flag says whether the group is read-only (@samp{n}), is moderated | |
29392 | (@samp{m}), is dead (@samp{x}), is aliased to some other group | |
29393 | (@samp{=other-group}) or none of the above (@samp{y}). | |
29394 | ||
29395 | ||
29396 | @item (nnchoke-request-post &optional SERVER) | |
29397 | ||
29398 | This function should post the current buffer. It might return whether | |
29399 | the posting was successful or not, but that's not required. If, for | |
29400 | instance, the posting is done asynchronously, it has generally not been | |
29401 | completed by the time this function concludes. In that case, this | |
29402 | function should set up some kind of sentinel to beep the user loud and | |
29403 | clear if the posting could not be completed. | |
29404 | ||
29405 | There should be no result data from this function. | |
29406 | ||
29407 | @end table | |
29408 | ||
29409 | ||
29410 | @node Optional Back End Functions | |
29411 | @subsubsection Optional Back End Functions | |
29412 | ||
29413 | @table @code | |
29414 | ||
29415 | @item (nnchoke-retrieve-groups GROUPS &optional SERVER) | |
29416 | ||
29417 | @var{groups} is a list of groups, and this function should request data | |
29418 | on all those groups. How it does it is of no concern to Gnus, but it | |
29419 | should attempt to do this in a speedy fashion. | |
29420 | ||
29421 | The return value of this function can be either @code{active} or | |
29422 | @code{group}, which says what the format of the result data is. The | |
29423 | former is in the same format as the data from | |
29424 | @code{nnchoke-request-list}, while the latter is a buffer full of lines | |
29425 | in the same format as @code{nnchoke-request-group} gives. | |
29426 | ||
29427 | @example | |
29428 | group-buffer = *active-line / *group-status | |
29429 | @end example | |
29430 | ||
29431 | ||
29432 | @item (nnchoke-request-update-info GROUP INFO &optional SERVER) | |
29433 | ||
29434 | A Gnus group info (@pxref{Group Info}) is handed to the back end for | |
29435 | alterations. This comes in handy if the back end really carries all | |
29436 | the information (as is the case with virtual and imap groups). This | |
29437 | function should destructively alter the info to suit its needs, and | |
01c52d31 MB |
29438 | should return a non-@code{nil} value (exceptionally, |
29439 | @code{nntp-request-update-info} always returns @code{nil} not to waste | |
29440 | the network resources). | |
4009494e GM |
29441 | |
29442 | There should be no result data from this function. | |
29443 | ||
29444 | ||
29445 | @item (nnchoke-request-type GROUP &optional ARTICLE) | |
29446 | ||
29447 | When the user issues commands for ``sending news'' (@kbd{F} in the | |
29448 | summary buffer, for instance), Gnus has to know whether the article the | |
29449 | user is following up on is news or mail. This function should return | |
29450 | @code{news} if @var{article} in @var{group} is news, @code{mail} if it | |
29451 | is mail and @code{unknown} if the type can't be decided. (The | |
29452 | @var{article} parameter is necessary in @code{nnvirtual} groups which | |
29453 | might very well combine mail groups and news groups.) Both @var{group} | |
29454 | and @var{article} may be @code{nil}. | |
29455 | ||
29456 | There should be no result data from this function. | |
29457 | ||
29458 | ||
29459 | @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER) | |
29460 | ||
29461 | Set/remove/add marks on articles. Normally Gnus handles the article | |
29462 | marks (such as read, ticked, expired etc) internally, and store them in | |
29463 | @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry | |
29464 | all information about the articles on the server, so Gnus need to | |
29465 | propagate the mark information to the server. | |
29466 | ||
29467 | @var{action} is a list of mark setting requests, having this format: | |
29468 | ||
29469 | @example | |
29470 | (RANGE ACTION MARK) | |
29471 | @end example | |
29472 | ||
29473 | @var{range} is a range of articles you wish to update marks on. | |
29474 | @var{action} is @code{add} or @code{del}, used to add marks or remove | |
29475 | marks (preserving all marks not mentioned). @var{mark} is a list of | |
29476 | marks; where each mark is a symbol. Currently used marks are | |
29477 | @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed}, | |
e21bac42 G |
29478 | @code{dormant}, @code{save}, @code{download}, @code{unsend}, and |
29479 | @code{forward}, but your back end should, if possible, not limit | |
29480 | itself to these. | |
4009494e GM |
29481 | |
29482 | Given contradictory actions, the last action in the list should be the | |
29483 | effective one. That is, if your action contains a request to add the | |
29484 | @code{tick} mark on article 1 and, later in the list, a request to | |
29485 | remove the mark on the same article, the mark should in fact be removed. | |
29486 | ||
29487 | An example action list: | |
29488 | ||
29489 | @example | |
29490 | (((5 12 30) 'del '(tick)) | |
29491 | ((10 . 90) 'add '(read expire)) | |
29492 | ((92 94) 'del '(read))) | |
29493 | @end example | |
29494 | ||
29495 | The function should return a range of articles it wasn't able to set the | |
29496 | mark on (currently not used for anything). | |
29497 | ||
29498 | There should be no result data from this function. | |
29499 | ||
29500 | @item (nnchoke-request-update-mark GROUP ARTICLE MARK) | |
29501 | ||
29502 | If the user tries to set a mark that the back end doesn't like, this | |
29503 | function may change the mark. Gnus will use whatever this function | |
29504 | returns as the mark for @var{article} instead of the original | |
29505 | @var{mark}. If the back end doesn't care, it must return the original | |
29506 | @var{mark}, and not @code{nil} or any other type of garbage. | |
29507 | ||
29508 | The only use for this I can see is what @code{nnvirtual} does with | |
29509 | it---if a component group is auto-expirable, marking an article as read | |
29510 | in the virtual group should result in the article being marked as | |
29511 | expirable. | |
29512 | ||
29513 | There should be no result data from this function. | |
29514 | ||
29515 | ||
29516 | @item (nnchoke-request-scan &optional GROUP SERVER) | |
29517 | ||
29518 | This function may be called at any time (by Gnus or anything else) to | |
29519 | request that the back end check for incoming articles, in one way or | |
29520 | another. A mail back end will typically read the spool file or query | |
29521 | the @acronym{POP} server when this function is invoked. The | |
29522 | @var{group} doesn't have to be heeded---if the back end decides that | |
29523 | it is too much work just scanning for a single group, it may do a | |
29524 | total scan of all groups. It would be nice, however, to keep things | |
29525 | local if that's practical. | |
29526 | ||
29527 | There should be no result data from this function. | |
29528 | ||
29529 | ||
29530 | @item (nnchoke-request-group-description GROUP &optional SERVER) | |
29531 | ||
29532 | The result data from this function should be a description of | |
29533 | @var{group}. | |
29534 | ||
29535 | @example | |
29536 | description-line = name <TAB> description eol | |
29537 | name = <string> | |
29538 | description = <text> | |
29539 | @end example | |
29540 | ||
29541 | @item (nnchoke-request-list-newsgroups &optional SERVER) | |
29542 | ||
29543 | The result data from this function should be the description of all | |
29544 | groups available on the server. | |
29545 | ||
29546 | @example | |
29547 | description-buffer = *description-line | |
29548 | @end example | |
29549 | ||
29550 | ||
29551 | @item (nnchoke-request-newgroups DATE &optional SERVER) | |
29552 | ||
29553 | The result data from this function should be all groups that were | |
29554 | created after @samp{date}, which is in normal human-readable date format | |
29555 | (i.e., the date format used in mail and news headers, and returned by | |
29556 | the function @code{message-make-date} by default). The data should be | |
29557 | in the active buffer format. | |
29558 | ||
29559 | It is okay for this function to return ``too many'' groups; some back ends | |
29560 | might find it cheaper to return the full list of groups, rather than | |
29561 | just the new groups. But don't do this for back ends with many groups. | |
29562 | Normally, if the user creates the groups herself, there won't be too | |
29563 | many groups, so @code{nnml} and the like are probably safe. But for | |
29564 | back ends like @code{nntp}, where the groups have been created by the | |
29565 | server, it is quite likely that there can be many groups. | |
29566 | ||
29567 | ||
29568 | @item (nnchoke-request-create-group GROUP &optional SERVER) | |
29569 | ||
29570 | This function should create an empty group with name @var{group}. | |
29571 | ||
29572 | There should be no return data. | |
29573 | ||
29574 | ||
29575 | @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE) | |
29576 | ||
29577 | This function should run the expiry process on all articles in the | |
29578 | @var{articles} range (which is currently a simple list of article | |
29579 | numbers.) It is left up to the back end to decide how old articles | |
29580 | should be before they are removed by this function. If @var{force} is | |
29581 | non-@code{nil}, all @var{articles} should be deleted, no matter how new | |
29582 | they are. | |
29583 | ||
29584 | This function should return a list of articles that it did not/was not | |
29585 | able to delete. | |
29586 | ||
29587 | There should be no result data returned. | |
29588 | ||
29589 | ||
29590 | @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST) | |
29591 | ||
29592 | This function should move @var{article} (which is a number) from | |
29593 | @var{group} by calling @var{accept-form}. | |
29594 | ||
29595 | This function should ready the article in question for moving by | |
29596 | removing any header lines it has added to the article, and generally | |
29597 | should ``tidy up'' the article. Then it should @code{eval} | |
29598 | @var{accept-form} in the buffer where the ``tidy'' article is. This | |
29599 | will do the actual copying. If this @code{eval} returns a | |
29600 | non-@code{nil} value, the article should be removed. | |
29601 | ||
29602 | If @var{last} is @code{nil}, that means that there is a high likelihood | |
29603 | that there will be more requests issued shortly, so that allows some | |
29604 | optimizations. | |
29605 | ||
29606 | The function should return a cons where the @code{car} is the group name and | |
29607 | the @code{cdr} is the article number that the article was entered as. | |
29608 | ||
29609 | There should be no data returned. | |
29610 | ||
29611 | ||
29612 | @item (nnchoke-request-accept-article GROUP &optional SERVER LAST) | |
29613 | ||
29614 | This function takes the current buffer and inserts it into @var{group}. | |
29615 | If @var{last} in @code{nil}, that means that there will be more calls to | |
29616 | this function in short order. | |
29617 | ||
29618 | The function should return a cons where the @code{car} is the group name and | |
29619 | the @code{cdr} is the article number that the article was entered as. | |
29620 | ||
29621 | The group should exist before the back end is asked to accept the | |
29622 | article for that group. | |
29623 | ||
29624 | There should be no data returned. | |
29625 | ||
29626 | ||
29627 | @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER) | |
29628 | ||
29629 | This function should remove @var{article} (which is a number) from | |
29630 | @var{group} and insert @var{buffer} there instead. | |
29631 | ||
29632 | There should be no data returned. | |
29633 | ||
29634 | ||
29635 | @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER) | |
29636 | ||
29637 | This function should delete @var{group}. If @var{force}, it should | |
29638 | really delete all the articles in the group, and then delete the group | |
29639 | itself. (If there is such a thing as ``the group itself''.) | |
29640 | ||
29641 | There should be no data returned. | |
29642 | ||
29643 | ||
29644 | @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER) | |
29645 | ||
29646 | This function should rename @var{group} into @var{new-name}. All | |
29647 | articles in @var{group} should move to @var{new-name}. | |
29648 | ||
29649 | There should be no data returned. | |
29650 | ||
29651 | @end table | |
29652 | ||
29653 | ||
29654 | @node Error Messaging | |
29655 | @subsubsection Error Messaging | |
29656 | ||
29657 | @findex nnheader-report | |
29658 | @findex nnheader-get-report | |
29659 | The back ends should use the function @code{nnheader-report} to report | |
29660 | error conditions---they should not raise errors when they aren't able to | |
29661 | perform a request. The first argument to this function is the back end | |
29662 | symbol, and the rest are interpreted as arguments to @code{format} if | |
29663 | there are multiple of them, or just a string if there is one of them. | |
29664 | This function must always returns @code{nil}. | |
29665 | ||
29666 | @lisp | |
29667 | (nnheader-report 'nnchoke "You did something totally bogus") | |
29668 | ||
29669 | (nnheader-report 'nnchoke "Could not request group %s" group) | |
29670 | @end lisp | |
29671 | ||
29672 | Gnus, in turn, will call @code{nnheader-get-report} when it gets a | |
29673 | @code{nil} back from a server, and this function returns the most | |
29674 | recently reported message for the back end in question. This function | |
29675 | takes one argument---the server symbol. | |
29676 | ||
29677 | Internally, these functions access @var{back-end}@code{-status-string}, | |
29678 | so the @code{nnchoke} back end will have its error message stored in | |
29679 | @code{nnchoke-status-string}. | |
29680 | ||
29681 | ||
29682 | @node Writing New Back Ends | |
29683 | @subsubsection Writing New Back Ends | |
29684 | ||
29685 | Many back ends are quite similar. @code{nnml} is just like | |
29686 | @code{nnspool}, but it allows you to edit the articles on the server. | |
29687 | @code{nnmh} is just like @code{nnml}, but it doesn't use an active file, | |
29688 | and it doesn't maintain overview databases. @code{nndir} is just like | |
29689 | @code{nnml}, but it has no concept of ``groups'', and it doesn't allow | |
29690 | editing articles. | |
29691 | ||
29692 | It would make sense if it were possible to ``inherit'' functions from | |
29693 | back ends when writing new back ends. And, indeed, you can do that if you | |
29694 | want to. (You don't have to if you don't want to, of course.) | |
29695 | ||
29696 | All the back ends declare their public variables and functions by using a | |
29697 | package called @code{nnoo}. | |
29698 | ||
29699 | To inherit functions from other back ends (and allow other back ends to | |
29700 | inherit functions from the current back end), you should use the | |
29701 | following macros: | |
29702 | ||
29703 | @table @code | |
29704 | ||
29705 | @item nnoo-declare | |
29706 | This macro declares the first parameter to be a child of the subsequent | |
29707 | parameters. For instance: | |
29708 | ||
29709 | @lisp | |
29710 | (nnoo-declare nndir | |
29711 | nnml nnmh) | |
29712 | @end lisp | |
29713 | ||
29714 | @code{nndir} has declared here that it intends to inherit functions from | |
29715 | both @code{nnml} and @code{nnmh}. | |
29716 | ||
29717 | @item defvoo | |
29718 | This macro is equivalent to @code{defvar}, but registers the variable as | |
29719 | a public server variable. Most state-oriented variables should be | |
29720 | declared with @code{defvoo} instead of @code{defvar}. | |
29721 | ||
29722 | In addition to the normal @code{defvar} parameters, it takes a list of | |
29723 | variables in the parent back ends to map the variable to when executing | |
29724 | a function in those back ends. | |
29725 | ||
29726 | @lisp | |
29727 | (defvoo nndir-directory nil | |
29728 | "Where nndir will look for groups." | |
29729 | nnml-current-directory nnmh-current-directory) | |
29730 | @end lisp | |
29731 | ||
29732 | This means that @code{nnml-current-directory} will be set to | |
29733 | @code{nndir-directory} when an @code{nnml} function is called on behalf | |
29734 | of @code{nndir}. (The same with @code{nnmh}.) | |
29735 | ||
29736 | @item nnoo-define-basics | |
29737 | This macro defines some common functions that almost all back ends should | |
29738 | have. | |
29739 | ||
29740 | @lisp | |
29741 | (nnoo-define-basics nndir) | |
29742 | @end lisp | |
29743 | ||
29744 | @item deffoo | |
29745 | This macro is just like @code{defun} and takes the same parameters. In | |
29746 | addition to doing the normal @code{defun} things, it registers the | |
29747 | function as being public so that other back ends can inherit it. | |
29748 | ||
29749 | @item nnoo-map-functions | |
29750 | This macro allows mapping of functions from the current back end to | |
29751 | functions from the parent back ends. | |
29752 | ||
29753 | @lisp | |
29754 | (nnoo-map-functions nndir | |
29755 | (nnml-retrieve-headers 0 nndir-current-group 0 0) | |
29756 | (nnmh-request-article 0 nndir-current-group 0 0)) | |
29757 | @end lisp | |
29758 | ||
29759 | This means that when @code{nndir-retrieve-headers} is called, the first, | |
29760 | third, and fourth parameters will be passed on to | |
29761 | @code{nnml-retrieve-headers}, while the second parameter is set to the | |
29762 | value of @code{nndir-current-group}. | |
29763 | ||
29764 | @item nnoo-import | |
29765 | This macro allows importing functions from back ends. It should be the | |
29766 | last thing in the source file, since it will only define functions that | |
29767 | haven't already been defined. | |
29768 | ||
29769 | @lisp | |
29770 | (nnoo-import nndir | |
29771 | (nnmh | |
29772 | nnmh-request-list | |
29773 | nnmh-request-newgroups) | |
29774 | (nnml)) | |
29775 | @end lisp | |
29776 | ||
29777 | This means that calls to @code{nndir-request-list} should just be passed | |
29778 | on to @code{nnmh-request-list}, while all public functions from | |
29779 | @code{nnml} that haven't been defined in @code{nndir} yet should be | |
29780 | defined now. | |
29781 | ||
29782 | @end table | |
29783 | ||
29784 | Below is a slightly shortened version of the @code{nndir} back end. | |
29785 | ||
29786 | @lisp | |
29787 | ;;; @r{nndir.el --- single directory newsgroup access for Gnus} | |
5dc584b5 | 29788 | ;; @r{Copyright (C) 1995,1996 Free Software Foundation, Inc.} |
4009494e GM |
29789 | |
29790 | ;;; @r{Code:} | |
29791 | ||
29792 | (require 'nnheader) | |
29793 | (require 'nnmh) | |
29794 | (require 'nnml) | |
29795 | (require 'nnoo) | |
29796 | (eval-when-compile (require 'cl)) | |
29797 | ||
29798 | (nnoo-declare nndir | |
29799 | nnml nnmh) | |
29800 | ||
29801 | (defvoo nndir-directory nil | |
29802 | "Where nndir will look for groups." | |
29803 | nnml-current-directory nnmh-current-directory) | |
29804 | ||
29805 | (defvoo nndir-nov-is-evil nil | |
29806 | "*Non-nil means that nndir will never retrieve NOV headers." | |
29807 | nnml-nov-is-evil) | |
29808 | ||
29809 | (defvoo nndir-current-group "" | |
29810 | nil | |
29811 | nnml-current-group nnmh-current-group) | |
29812 | (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory) | |
29813 | (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail) | |
29814 | ||
29815 | (defvoo nndir-status-string "" nil nnmh-status-string) | |
29816 | (defconst nndir-version "nndir 1.0") | |
29817 | ||
29818 | ;;; @r{Interface functions.} | |
29819 | ||
29820 | (nnoo-define-basics nndir) | |
29821 | ||
29822 | (deffoo nndir-open-server (server &optional defs) | |
29823 | (setq nndir-directory | |
29824 | (or (cadr (assq 'nndir-directory defs)) | |
29825 | server)) | |
29826 | (unless (assq 'nndir-directory defs) | |
29827 | (push `(nndir-directory ,server) defs)) | |
29828 | (push `(nndir-current-group | |
29829 | ,(file-name-nondirectory | |
29830 | (directory-file-name nndir-directory))) | |
29831 | defs) | |
29832 | (push `(nndir-top-directory | |
29833 | ,(file-name-directory (directory-file-name nndir-directory))) | |
29834 | defs) | |
29835 | (nnoo-change-server 'nndir server defs)) | |
29836 | ||
29837 | (nnoo-map-functions nndir | |
29838 | (nnml-retrieve-headers 0 nndir-current-group 0 0) | |
29839 | (nnmh-request-article 0 nndir-current-group 0 0) | |
29840 | (nnmh-request-group nndir-current-group 0 0) | |
29841 | (nnmh-close-group nndir-current-group 0)) | |
29842 | ||
29843 | (nnoo-import nndir | |
29844 | (nnmh | |
29845 | nnmh-status-message | |
29846 | nnmh-request-list | |
29847 | nnmh-request-newgroups)) | |
29848 | ||
29849 | (provide 'nndir) | |
29850 | @end lisp | |
29851 | ||
29852 | ||
29853 | @node Hooking New Back Ends Into Gnus | |
29854 | @subsubsection Hooking New Back Ends Into Gnus | |
29855 | ||
29856 | @vindex gnus-valid-select-methods | |
29857 | @findex gnus-declare-backend | |
29858 | Having Gnus start using your new back end is rather easy---you just | |
29859 | declare it with the @code{gnus-declare-backend} functions. This will | |
29860 | enter the back end into the @code{gnus-valid-select-methods} variable. | |
29861 | ||
29862 | @code{gnus-declare-backend} takes two parameters---the back end name and | |
29863 | an arbitrary number of @dfn{abilities}. | |
29864 | ||
29865 | Here's an example: | |
29866 | ||
29867 | @lisp | |
29868 | (gnus-declare-backend "nnchoke" 'mail 'respool 'address) | |
29869 | @end lisp | |
29870 | ||
29871 | The above line would then go in the @file{nnchoke.el} file. | |
29872 | ||
29873 | The abilities can be: | |
29874 | ||
29875 | @table @code | |
29876 | @item mail | |
29877 | This is a mailish back end---followups should (probably) go via mail. | |
29878 | @item post | |
29879 | This is a newsish back end---followups should (probably) go via news. | |
29880 | @item post-mail | |
29881 | This back end supports both mail and news. | |
29882 | @item none | |
29883 | This is neither a post nor mail back end---it's something completely | |
29884 | different. | |
29885 | @item respool | |
29886 | It supports respooling---or rather, it is able to modify its source | |
29887 | articles and groups. | |
29888 | @item address | |
29889 | The name of the server should be in the virtual server name. This is | |
29890 | true for almost all back ends. | |
29891 | @item prompt-address | |
29892 | The user should be prompted for an address when doing commands like | |
29893 | @kbd{B} in the group buffer. This is true for back ends like | |
29894 | @code{nntp}, but not @code{nnmbox}, for instance. | |
29895 | @end table | |
29896 | ||
29897 | ||
29898 | @node Mail-like Back Ends | |
29899 | @subsubsection Mail-like Back Ends | |
29900 | ||
29901 | One of the things that separate the mail back ends from the rest of the | |
29902 | back ends is the heavy dependence by most of the mail back ends on | |
29903 | common functions in @file{nnmail.el}. For instance, here's the | |
29904 | definition of @code{nnml-request-scan}: | |
29905 | ||
29906 | @lisp | |
29907 | (deffoo nnml-request-scan (&optional group server) | |
29908 | (setq nnml-article-file-alist nil) | |
29909 | (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group)) | |
29910 | @end lisp | |
29911 | ||
29912 | It simply calls @code{nnmail-get-new-mail} with a few parameters, | |
29913 | and @code{nnmail} takes care of all the moving and splitting of the | |
29914 | mail. | |
29915 | ||
29916 | This function takes four parameters. | |
29917 | ||
29918 | @table @var | |
29919 | @item method | |
29920 | This should be a symbol to designate which back end is responsible for | |
29921 | the call. | |
29922 | ||
29923 | @item exit-function | |
29924 | This function should be called after the splitting has been performed. | |
29925 | ||
29926 | @item temp-directory | |
29927 | Where the temporary files should be stored. | |
29928 | ||
29929 | @item group | |
29930 | This optional argument should be a group name if the splitting is to be | |
29931 | performed for one group only. | |
29932 | @end table | |
29933 | ||
29934 | @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to | |
29935 | save each article. @var{back-end}@code{-active-number} will be called to | |
29936 | find the article number assigned to this article. | |
29937 | ||
29938 | The function also uses the following variables: | |
29939 | @var{back-end}@code{-get-new-mail} (to see whether to get new mail for | |
29940 | this back end); and @var{back-end}@code{-group-alist} and | |
29941 | @var{back-end}@code{-active-file} to generate the new active file. | |
29942 | @var{back-end}@code{-group-alist} should be a group-active alist, like | |
29943 | this: | |
29944 | ||
29945 | @example | |
29946 | (("a-group" (1 . 10)) | |
29947 | ("some-group" (34 . 39))) | |
29948 | @end example | |
29949 | ||
29950 | ||
29951 | @node Score File Syntax | |
29952 | @subsection Score File Syntax | |
29953 | ||
fac916bf | 29954 | Score files are meant to be easily parsable, but yet extremely |
53964682 | 29955 | malleable. It was decided that something that had the same read syntax |
4009494e GM |
29956 | as an Emacs Lisp list would fit that spec. |
29957 | ||
29958 | Here's a typical score file: | |
29959 | ||
29960 | @lisp | |
29961 | (("summary" | |
b46a6a83 | 29962 | ("Windows 95" -10000 nil s) |
4009494e GM |
29963 | ("Gnus")) |
29964 | ("from" | |
29965 | ("Lars" -1000)) | |
29966 | (mark -100)) | |
29967 | @end lisp | |
29968 | ||
29969 | BNF definition of a score file: | |
29970 | ||
29971 | @example | |
29972 | score-file = "" / "(" *element ")" | |
29973 | element = rule / atom | |
29974 | rule = string-rule / number-rule / date-rule | |
29975 | string-rule = "(" quote string-header quote space *string-match ")" | |
29976 | number-rule = "(" quote number-header quote space *number-match ")" | |
29977 | date-rule = "(" quote date-header quote space *date-match ")" | |
29978 | quote = <ascii 34> | |
29979 | string-header = "subject" / "from" / "references" / "message-id" / | |
29980 | "xref" / "body" / "head" / "all" / "followup" | |
29981 | number-header = "lines" / "chars" | |
29982 | date-header = "date" | |
29983 | string-match = "(" quote <string> quote [ "" / [ space score [ "" / | |
29984 | space date [ "" / [ space string-match-t ] ] ] ] ] ")" | |
29985 | score = "nil" / <integer> | |
29986 | date = "nil" / <natural number> | |
29987 | string-match-t = "nil" / "s" / "substring" / "S" / "Substring" / | |
29988 | "r" / "regex" / "R" / "Regex" / | |
29989 | "e" / "exact" / "E" / "Exact" / | |
29990 | "f" / "fuzzy" / "F" / "Fuzzy" | |
29991 | number-match = "(" <integer> [ "" / [ space score [ "" / | |
29992 | space date [ "" / [ space number-match-t ] ] ] ] ] ")" | |
29993 | number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<=" | |
29994 | date-match = "(" quote <string> quote [ "" / [ space score [ "" / | |
29995 | space date [ "" / [ space date-match-t ] ] ] ] ")" | |
29996 | date-match-t = "nil" / "at" / "before" / "after" | |
29997 | atom = "(" [ required-atom / optional-atom ] ")" | |
29998 | required-atom = mark / expunge / mark-and-expunge / files / | |
29999 | exclude-files / read-only / touched | |
30000 | optional-atom = adapt / local / eval | |
30001 | mark = "mark" space nil-or-number | |
30002 | nil-or-number = "nil" / <integer> | |
30003 | expunge = "expunge" space nil-or-number | |
30004 | mark-and-expunge = "mark-and-expunge" space nil-or-number | |
30005 | files = "files" *[ space <string> ] | |
30006 | exclude-files = "exclude-files" *[ space <string> ] | |
30007 | read-only = "read-only" [ space "nil" / space "t" ] | |
30008 | adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ] | |
30009 | adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")" | |
30010 | local = "local" *[ space "(" <string> space <form> ")" ] | |
30011 | eval = "eval" space <form> | |
30012 | space = *[ " " / <TAB> / <NEWLINE> ] | |
30013 | @end example | |
30014 | ||
30015 | Any unrecognized elements in a score file should be ignored, but not | |
30016 | discarded. | |
30017 | ||
30018 | As you can see, white space is needed, but the type and amount of white | |
30019 | space is irrelevant. This means that formatting of the score file is | |
30020 | left up to the programmer---if it's simpler to just spew it all out on | |
30021 | one looong line, then that's ok. | |
30022 | ||
30023 | The meaning of the various atoms are explained elsewhere in this | |
30024 | manual (@pxref{Score File Format}). | |
30025 | ||
30026 | ||
30027 | @node Headers | |
30028 | @subsection Headers | |
30029 | ||
30030 | Internally Gnus uses a format for storing article headers that | |
30031 | corresponds to the @acronym{NOV} format in a mysterious fashion. One could | |
30032 | almost suspect that the author looked at the @acronym{NOV} specification and | |
30033 | just shamelessly @emph{stole} the entire thing, and one would be right. | |
30034 | ||
30035 | @dfn{Header} is a severely overloaded term. ``Header'' is used in | |
30036 | RFC 1036 to talk about lines in the head of an article (e.g., | |
30037 | @code{From}). It is used by many people as a synonym for | |
30038 | ``head''---``the header and the body''. (That should be avoided, in my | |
30039 | opinion.) And Gnus uses a format internally that it calls ``header'', | |
30040 | which is what I'm talking about here. This is a 9-element vector, | |
30041 | basically, with each header (ouch) having one slot. | |
30042 | ||
30043 | These slots are, in order: @code{number}, @code{subject}, @code{from}, | |
30044 | @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines}, | |
30045 | @code{xref}, and @code{extra}. There are macros for accessing and | |
30046 | setting these slots---they all have predictable names beginning with | |
30047 | @code{mail-header-} and @code{mail-header-set-}, respectively. | |
30048 | ||
30049 | All these slots contain strings, except the @code{extra} slot, which | |
30050 | contains an alist of header/value pairs (@pxref{To From Newsgroups}). | |
30051 | ||
30052 | ||
30053 | @node Ranges | |
30054 | @subsection Ranges | |
30055 | ||
30056 | @sc{gnus} introduced a concept that I found so useful that I've started | |
30057 | using it a lot and have elaborated on it greatly. | |
30058 | ||
30059 | The question is simple: If you have a large amount of objects that are | |
30060 | identified by numbers (say, articles, to take a @emph{wild} example) | |
30061 | that you want to qualify as being ``included'', a normal sequence isn't | |
30062 | very useful. (A 200,000 length sequence is a bit long-winded.) | |
30063 | ||
30064 | The solution is as simple as the question: You just collapse the | |
30065 | sequence. | |
30066 | ||
30067 | @example | |
30068 | (1 2 3 4 5 6 10 11 12) | |
30069 | @end example | |
30070 | ||
30071 | is transformed into | |
30072 | ||
30073 | @example | |
30074 | ((1 . 6) (10 . 12)) | |
30075 | @end example | |
30076 | ||
30077 | To avoid having those nasty @samp{(13 . 13)} elements to denote a | |
30078 | lonesome object, a @samp{13} is a valid element: | |
30079 | ||
30080 | @example | |
30081 | ((1 . 6) 7 (10 . 12)) | |
30082 | @end example | |
30083 | ||
30084 | This means that comparing two ranges to find out whether they are equal | |
30085 | is slightly tricky: | |
30086 | ||
30087 | @example | |
30088 | ((1 . 5) 7 8 (10 . 12)) | |
30089 | @end example | |
30090 | ||
30091 | and | |
30092 | ||
30093 | @example | |
30094 | ((1 . 5) (7 . 8) (10 . 12)) | |
30095 | @end example | |
30096 | ||
30097 | are equal. In fact, any non-descending list is a range: | |
30098 | ||
30099 | @example | |
30100 | (1 2 3 4 5) | |
30101 | @end example | |
30102 | ||
30103 | is a perfectly valid range, although a pretty long-winded one. This is | |
30104 | also valid: | |
30105 | ||
30106 | @example | |
30107 | (1 . 5) | |
30108 | @end example | |
30109 | ||
30110 | and is equal to the previous range. | |
30111 | ||
30112 | Here's a BNF definition of ranges. Of course, one must remember the | |
30113 | semantic requirement that the numbers are non-descending. (Any number | |
30114 | of repetition of the same number is allowed, but apt to disappear in | |
30115 | range handling.) | |
30116 | ||
30117 | @example | |
30118 | range = simple-range / normal-range | |
30119 | simple-range = "(" number " . " number ")" | |
30120 | normal-range = "(" start-contents ")" | |
30121 | contents = "" / simple-range *[ " " contents ] / | |
30122 | number *[ " " contents ] | |
30123 | @end example | |
30124 | ||
30125 | Gnus currently uses ranges to keep track of read articles and article | |
30126 | marks. I plan on implementing a number of range operators in C if The | |
30127 | Powers That Be are willing to let me. (I haven't asked yet, because I | |
30128 | need to do some more thinking on what operators I need to make life | |
30129 | totally range-based without ever having to convert back to normal | |
30130 | sequences.) | |
30131 | ||
30132 | ||
30133 | @node Group Info | |
30134 | @subsection Group Info | |
30135 | ||
30136 | Gnus stores all permanent info on groups in a @dfn{group info} list. | |
30137 | This list is from three to six elements (or more) long and exhaustively | |
30138 | describes the group. | |
30139 | ||
30140 | Here are two example group infos; one is a very simple group while the | |
30141 | second is a more complex one: | |
30142 | ||
30143 | @example | |
30144 | ("no.group" 5 ((1 . 54324))) | |
30145 | ||
30146 | ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55)) | |
30147 | ((tick (15 . 19)) (replied 3 6 (19 . 3))) | |
30148 | (nnml "") | |
30149 | ((auto-expire . t) (to-address . "ding@@gnus.org"))) | |
30150 | @end example | |
30151 | ||
30152 | The first element is the @dfn{group name}---as Gnus knows the group, | |
30153 | anyway. The second element is the @dfn{subscription level}, which | |
30154 | normally is a small integer. (It can also be the @dfn{rank}, which is a | |
30155 | cons cell where the @code{car} is the level and the @code{cdr} is the | |
30156 | score.) The third element is a list of ranges of read articles. The | |
30157 | fourth element is a list of lists of article marks of various kinds. | |
30158 | The fifth element is the select method (or virtual server, if you like). | |
30159 | The sixth element is a list of @dfn{group parameters}, which is what | |
30160 | this section is about. | |
30161 | ||
30162 | Any of the last three elements may be missing if they are not required. | |
30163 | In fact, the vast majority of groups will normally only have the first | |
30164 | three elements, which saves quite a lot of cons cells. | |
30165 | ||
30166 | Here's a BNF definition of the group info format: | |
30167 | ||
30168 | @example | |
30169 | info = "(" group space ralevel space read | |
30170 | [ "" / [ space marks-list [ "" / [ space method [ "" / | |
30171 | space parameters ] ] ] ] ] ")" | |
30172 | group = quote <string> quote | |
30173 | ralevel = rank / level | |
30174 | level = <integer in the range of 1 to inf> | |
30175 | rank = "(" level "." score ")" | |
30176 | score = <integer in the range of 1 to inf> | |
30177 | read = range | |
30178 | marks-lists = nil / "(" *marks ")" | |
30179 | marks = "(" <string> range ")" | |
30180 | method = "(" <string> *elisp-forms ")" | |
30181 | parameters = "(" *elisp-forms ")" | |
30182 | @end example | |
30183 | ||
30184 | Actually that @samp{marks} rule is a fib. A @samp{marks} is a | |
30185 | @samp{<string>} consed on to a @samp{range}, but that's a bitch to say | |
30186 | in pseudo-BNF. | |
30187 | ||
30188 | If you have a Gnus info and want to access the elements, Gnus offers a | |
30189 | series of macros for getting/setting these elements. | |
30190 | ||
30191 | @table @code | |
30192 | @item gnus-info-group | |
30193 | @itemx gnus-info-set-group | |
30194 | @findex gnus-info-group | |
30195 | @findex gnus-info-set-group | |
30196 | Get/set the group name. | |
30197 | ||
30198 | @item gnus-info-rank | |
30199 | @itemx gnus-info-set-rank | |
30200 | @findex gnus-info-rank | |
30201 | @findex gnus-info-set-rank | |
30202 | Get/set the group rank (@pxref{Group Score}). | |
30203 | ||
30204 | @item gnus-info-level | |
30205 | @itemx gnus-info-set-level | |
30206 | @findex gnus-info-level | |
30207 | @findex gnus-info-set-level | |
30208 | Get/set the group level. | |
30209 | ||
30210 | @item gnus-info-score | |
30211 | @itemx gnus-info-set-score | |
30212 | @findex gnus-info-score | |
30213 | @findex gnus-info-set-score | |
30214 | Get/set the group score (@pxref{Group Score}). | |
30215 | ||
30216 | @item gnus-info-read | |
30217 | @itemx gnus-info-set-read | |
30218 | @findex gnus-info-read | |
30219 | @findex gnus-info-set-read | |
30220 | Get/set the ranges of read articles. | |
30221 | ||
30222 | @item gnus-info-marks | |
30223 | @itemx gnus-info-set-marks | |
30224 | @findex gnus-info-marks | |
30225 | @findex gnus-info-set-marks | |
30226 | Get/set the lists of ranges of marked articles. | |
30227 | ||
30228 | @item gnus-info-method | |
30229 | @itemx gnus-info-set-method | |
30230 | @findex gnus-info-method | |
30231 | @findex gnus-info-set-method | |
30232 | Get/set the group select method. | |
30233 | ||
30234 | @item gnus-info-params | |
30235 | @itemx gnus-info-set-params | |
30236 | @findex gnus-info-params | |
30237 | @findex gnus-info-set-params | |
30238 | Get/set the group parameters. | |
30239 | @end table | |
30240 | ||
30241 | All the getter functions take one parameter---the info list. The setter | |
30242 | functions take two parameters---the info list and the new value. | |
30243 | ||
30244 | The last three elements in the group info aren't mandatory, so it may be | |
30245 | necessary to extend the group info before setting the element. If this | |
30246 | is necessary, you can just pass on a non-@code{nil} third parameter to | |
30247 | the three final setter functions to have this happen automatically. | |
30248 | ||
30249 | ||
30250 | @node Extended Interactive | |
30251 | @subsection Extended Interactive | |
30252 | @cindex interactive | |
30253 | @findex gnus-interactive | |
30254 | ||
30255 | Gnus extends the standard Emacs @code{interactive} specification | |
30256 | slightly to allow easy use of the symbolic prefix (@pxref{Symbolic | |
30257 | Prefixes}). Here's an example of how this is used: | |
30258 | ||
30259 | @lisp | |
30260 | (defun gnus-summary-increase-score (&optional score symp) | |
30261 | (interactive (gnus-interactive "P\ny")) | |
30262 | ... | |
30263 | ) | |
30264 | @end lisp | |
30265 | ||
30266 | The best thing to do would have been to implement | |
30267 | @code{gnus-interactive} as a macro which would have returned an | |
30268 | @code{interactive} form, but this isn't possible since Emacs checks | |
30269 | whether a function is interactive or not by simply doing an @code{assq} | |
30270 | on the lambda form. So, instead we have @code{gnus-interactive} | |
30271 | function that takes a string and returns values that are usable to | |
30272 | @code{interactive}. | |
30273 | ||
30274 | This function accepts (almost) all normal @code{interactive} specs, but | |
30275 | adds a few more. | |
30276 | ||
30277 | @table @samp | |
30278 | @item y | |
30279 | @vindex gnus-current-prefix-symbol | |
30280 | The current symbolic prefix---the @code{gnus-current-prefix-symbol} | |
30281 | variable. | |
30282 | ||
30283 | @item Y | |
30284 | @vindex gnus-current-prefix-symbols | |
30285 | A list of the current symbolic prefixes---the | |
30286 | @code{gnus-current-prefix-symbol} variable. | |
30287 | ||
30288 | @item A | |
30289 | The current article number---the @code{gnus-summary-article-number} | |
30290 | function. | |
30291 | ||
30292 | @item H | |
30293 | The current article header---the @code{gnus-summary-article-header} | |
30294 | function. | |
30295 | ||
30296 | @item g | |
30297 | The current group name---the @code{gnus-group-group-name} | |
30298 | function. | |
30299 | ||
30300 | @end table | |
30301 | ||
30302 | ||
30303 | @node Emacs/XEmacs Code | |
30304 | @subsection Emacs/XEmacs Code | |
30305 | @cindex XEmacs | |
30306 | @cindex Emacsen | |
30307 | ||
30308 | While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the | |
30309 | platforms must be the primary one. I chose Emacs. Not because I don't | |
30310 | like XEmacs or Mule, but because it comes first alphabetically. | |
30311 | ||
30312 | This means that Gnus will byte-compile under Emacs with nary a warning, | |
30313 | while XEmacs will pump out gigabytes of warnings while byte-compiling. | |
30314 | As I use byte-compilation warnings to help me root out trivial errors in | |
30315 | Gnus, that's very useful. | |
30316 | ||
30317 | I've also consistently used Emacs function interfaces, but have used | |
30318 | Gnusey aliases for the functions. To take an example: Emacs defines a | |
30319 | @code{run-at-time} function while XEmacs defines a @code{start-itimer} | |
30320 | function. I then define a function called @code{gnus-run-at-time} that | |
30321 | takes the same parameters as the Emacs @code{run-at-time}. When running | |
30322 | Gnus under Emacs, the former function is just an alias for the latter. | |
30323 | However, when running under XEmacs, the former is an alias for the | |
30324 | following function: | |
30325 | ||
30326 | @lisp | |
30327 | (defun gnus-xmas-run-at-time (time repeat function &rest args) | |
30328 | (start-itimer | |
30329 | "gnus-run-at-time" | |
30330 | `(lambda () | |
30331 | (,function ,@@args)) | |
30332 | time repeat)) | |
30333 | @end lisp | |
30334 | ||
30335 | This sort of thing has been done for bunches of functions. Gnus does | |
30336 | not redefine any native Emacs functions while running under XEmacs---it | |
30337 | does this @code{defalias} thing with Gnus equivalents instead. Cleaner | |
30338 | all over. | |
30339 | ||
30340 | In the cases where the XEmacs function interface was obviously cleaner, | |
30341 | I used it instead. For example @code{gnus-region-active-p} is an alias | |
30342 | for @code{region-active-p} in XEmacs, whereas in Emacs it is a function. | |
30343 | ||
30344 | Of course, I could have chosen XEmacs as my native platform and done | |
30345 | mapping functions the other way around. But I didn't. The performance | |
30346 | hit these indirections impose on Gnus under XEmacs should be slight. | |
30347 | ||
30348 | ||
30349 | @node Various File Formats | |
30350 | @subsection Various File Formats | |
30351 | ||
30352 | @menu | |
30353 | * Active File Format:: Information on articles and groups available. | |
30354 | * Newsgroups File Format:: Group descriptions. | |
30355 | @end menu | |
30356 | ||
30357 | ||
30358 | @node Active File Format | |
30359 | @subsubsection Active File Format | |
30360 | ||
30361 | The active file lists all groups available on the server in | |
30362 | question. It also lists the highest and lowest current article numbers | |
30363 | in each group. | |
30364 | ||
30365 | Here's an excerpt from a typical active file: | |
30366 | ||
30367 | @example | |
30368 | soc.motss 296030 293865 y | |
30369 | alt.binaries.pictures.fractals 3922 3913 n | |
30370 | comp.sources.unix 1605 1593 m | |
30371 | comp.binaries.ibm.pc 5097 5089 y | |
30372 | no.general 1000 900 y | |
30373 | @end example | |
30374 | ||
30375 | Here's a pseudo-BNF definition of this file: | |
30376 | ||
30377 | @example | |
30378 | active = *group-line | |
30379 | group-line = group spc high-number spc low-number spc flag <NEWLINE> | |
30380 | group = <non-white-space string> | |
30381 | spc = " " | |
30382 | high-number = <non-negative integer> | |
30383 | low-number = <positive integer> | |
30384 | flag = "y" / "n" / "m" / "j" / "x" / "=" group | |
30385 | @end example | |
30386 | ||
30387 | For a full description of this file, see the manual pages for | |
30388 | @samp{innd}, in particular @samp{active(5)}. | |
30389 | ||
30390 | ||
30391 | @node Newsgroups File Format | |
30392 | @subsubsection Newsgroups File Format | |
30393 | ||
30394 | The newsgroups file lists groups along with their descriptions. Not all | |
30395 | groups on the server have to be listed, and not all groups in the file | |
30396 | have to exist on the server. The file is meant purely as information to | |
30397 | the user. | |
30398 | ||
30399 | The format is quite simple; a group name, a tab, and the description. | |
30400 | Here's the definition: | |
30401 | ||
30402 | @example | |
30403 | newsgroups = *line | |
30404 | line = group tab description <NEWLINE> | |
30405 | group = <non-white-space string> | |
30406 | tab = <TAB> | |
30407 | description = <string> | |
30408 | @end example | |
30409 | ||
30410 | ||
30411 | @page | |
30412 | @node Emacs for Heathens | |
30413 | @section Emacs for Heathens | |
30414 | ||
30415 | Believe it or not, but some people who use Gnus haven't really used | |
30416 | Emacs much before they embarked on their journey on the Gnus Love Boat. | |
30417 | If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the | |
30418 | region'', and ``set @code{gnus-flargblossen} to an alist where the key | |
30419 | is a regexp that is used for matching on the group name'' are magical | |
30420 | phrases with little or no meaning, then this appendix is for you. If | |
30421 | you are already familiar with Emacs, just ignore this and go fondle your | |
30422 | cat instead. | |
30423 | ||
30424 | @menu | |
30425 | * Keystrokes:: Entering text and executing commands. | |
30426 | * Emacs Lisp:: The built-in Emacs programming language. | |
30427 | @end menu | |
30428 | ||
30429 | ||
30430 | @node Keystrokes | |
30431 | @subsection Keystrokes | |
30432 | ||
30433 | @itemize @bullet | |
30434 | @item | |
30435 | Q: What is an experienced Emacs user? | |
30436 | ||
30437 | @item | |
30438 | A: A person who wishes that the terminal had pedals. | |
30439 | @end itemize | |
30440 | ||
30441 | Yes, when you use Emacs, you are apt to use the control key, the shift | |
30442 | key and the meta key a lot. This is very annoying to some people | |
30443 | (notably @code{vi}le users), and the rest of us just love the hell out | |
30444 | of it. Just give up and submit. Emacs really does stand for | |
30445 | ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you | |
30446 | may have heard from other disreputable sources (like the Emacs author). | |
30447 | ||
30448 | The shift keys are normally located near your pinky fingers, and are | |
30449 | normally used to get capital letters and stuff. You probably use it all | |
30450 | the time. The control key is normally marked ``CTRL'' or something like | |
30451 | that. The meta key is, funnily enough, never marked as such on any | |
30452 | keyboard. The one I'm currently at has a key that's marked ``Alt'', | |
30453 | which is the meta key on this keyboard. It's usually located somewhere | |
30454 | to the left hand side of the keyboard, usually on the bottom row. | |
30455 | ||
30456 | Now, us Emacs people don't say ``press the meta-control-m key'', | |
30457 | because that's just too inconvenient. We say ``press the @kbd{C-M-m} | |
30458 | key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the | |
30459 | prefix that means ``control''. So ``press @kbd{C-k}'' means ``press | |
30460 | down the control key, and hold it down while you press @kbd{k}''. | |
30461 | ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and | |
30462 | the control key and then press @kbd{k}''. Simple, ay? | |
30463 | ||
30464 | This is somewhat complicated by the fact that not all keyboards have a | |
30465 | meta key. In that case you can use the ``escape'' key. Then @kbd{M-k} | |
30466 | means ``press escape, release escape, press @kbd{k}''. That's much more | |
30467 | work than if you have a meta key, so if that's the case, I respectfully | |
30468 | suggest you get a real keyboard with a meta key. You can't live without | |
30469 | it. | |
30470 | ||
30471 | ||
30472 | ||
30473 | @node Emacs Lisp | |
30474 | @subsection Emacs Lisp | |
30475 | ||
30476 | Emacs is the King of Editors because it's really a Lisp interpreter. | |
30477 | Each and every key you tap runs some Emacs Lisp code snippet, and since | |
30478 | Emacs Lisp is an interpreted language, that means that you can configure | |
30479 | any key to run any arbitrary code. You just, like, do it. | |
30480 | ||
30481 | Gnus is written in Emacs Lisp, and is run as a bunch of interpreted | |
30482 | functions. (These are byte-compiled for speed, but it's still | |
30483 | interpreted.) If you decide that you don't like the way Gnus does | |
30484 | certain things, it's trivial to have it do something a different way. | |
30485 | (Well, at least if you know how to write Lisp code.) However, that's | |
30486 | beyond the scope of this manual, so we are simply going to talk about | |
30487 | some common constructs that you normally use in your @file{~/.gnus.el} | |
30488 | file to customize Gnus. (You can also use the @file{~/.emacs} file, but | |
30489 | in order to set things of Gnus up, it is much better to use the | |
30490 | @file{~/.gnus.el} file, @xref{Startup Files}.) | |
30491 | ||
30492 | If you want to set the variable @code{gnus-florgbnize} to four (4), you | |
30493 | write the following: | |
30494 | ||
30495 | @lisp | |
30496 | (setq gnus-florgbnize 4) | |
30497 | @end lisp | |
30498 | ||
30499 | This function (really ``special form'') @code{setq} is the one that can | |
30500 | set a variable to some value. This is really all you need to know. Now | |
30501 | you can go and fill your @file{~/.gnus.el} file with lots of these to | |
30502 | change how Gnus works. | |
30503 | ||
30504 | If you have put that thing in your @file{~/.gnus.el} file, it will be | |
30505 | read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you | |
30506 | start Gnus. If you want to change the variable right away, simply say | |
30507 | @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the | |
30508 | previous ``form'', which is a simple @code{setq} statement here. | |
30509 | ||
30510 | Go ahead---just try it, if you're located at your Emacs. After you | |
30511 | @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which | |
30512 | is the return value of the form you @code{eval}ed. | |
30513 | ||
30514 | Some pitfalls: | |
30515 | ||
30516 | If the manual says ``set @code{gnus-read-active-file} to @code{some}'', | |
30517 | that means: | |
30518 | ||
30519 | @lisp | |
30520 | (setq gnus-read-active-file 'some) | |
30521 | @end lisp | |
30522 | ||
99e65b2d G |
30523 | On the other hand, if the manual says ``set @code{gnus-nntp-server-file} to |
30524 | @samp{/etc/nntpserver}'', that means: | |
4009494e GM |
30525 | |
30526 | @lisp | |
99e65b2d | 30527 | (setq gnus-nntp-server-file "/etc/nntpserver") |
4009494e GM |
30528 | @end lisp |
30529 | ||
30530 | So be careful not to mix up strings (the latter) with symbols (the | |
30531 | former). The manual is unambiguous, but it can be confusing. | |
30532 | ||
30533 | @page | |
30534 | @include gnus-faq.texi | |
30535 | ||
30536 | @node GNU Free Documentation License | |
30537 | @chapter GNU Free Documentation License | |
30538 | @include doclicense.texi | |
30539 | ||
30540 | @node Index | |
30541 | @chapter Index | |
30542 | @printindex cp | |
30543 | ||
30544 | @node Key Index | |
30545 | @chapter Key Index | |
30546 | @printindex ky | |
30547 | ||
4009494e GM |
30548 | @bye |
30549 | ||
30550 | @iftex | |
30551 | @iflatex | |
30552 | \end{document} | |
30553 | @end iflatex | |
30554 | @end iftex | |
30555 | ||
30556 | @c Local Variables: | |
30557 | @c mode: texinfo | |
89b163db | 30558 | @c coding: utf-8 |
4009494e | 30559 | @c End: |