Merge from emacs-24; up to 2012-05-08T15:19:18Z!monnier@iro.umontreal.ca
[bpt/emacs.git] / lisp / gnus / gnus.el
CommitLineData
5e67c784 1;;; gnus.el --- a newsreader for GNU Emacs
23f87bed 2
9937bef4 3;; Copyright (C) 1987-1990, 1993-1998, 2000-2012
95df8112 4;; Free Software Foundation, Inc.
eec82323
LMI
5
6;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6748645f 7;; Lars Magne Ingebrigtsen <larsi@gnus.org>
eec82323 8;; Keywords: news, mail
aad4679e 9;; Version: 5.13
eec82323
LMI
10
11;; This file is part of GNU Emacs.
12
5e809f55 13;; GNU Emacs is free software: you can redistribute it and/or modify
eec82323 14;; it under the terms of the GNU General Public License as published by
5e809f55
GM
15;; the Free Software Foundation, either version 3 of the License, or
16;; (at your option) any later version.
eec82323
LMI
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
65a32076 20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
eec82323
LMI
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
5e809f55 24;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
eec82323
LMI
25
26;;; Commentary:
27
28;;; Code:
29
30(eval '(run-hooks 'gnus-load-hook))
31
f0b7f5a8 32;; For Emacs <22.2 and XEmacs.
c7e9cfaf
GM
33(eval-and-compile
34 (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
35
a36c8d02 36(eval-when-compile (require 'cl))
23f87bed 37(require 'wid-edit)
16409b0b 38(require 'mm-util)
23f87bed 39(require 'nnheader)
a36c8d02 40
0005c181
JB
41;; These are defined afterwards with gnus-define-group-parameter
42(defvar gnus-ham-process-destinations)
43(defvar gnus-parameter-ham-marks-alist)
44(defvar gnus-parameter-spam-marks-alist)
45(defvar gnus-spam-autodetect)
46(defvar gnus-spam-autodetect-methods)
47(defvar gnus-spam-newsgroup-contents)
48(defvar gnus-spam-process-destinations)
a9b833d3
GM
49(defvar gnus-spam-resend-to)
50(defvar gnus-ham-resend-to)
0005c181
JB
51(defvar gnus-spam-process-newsgroups)
52
53
eec82323
LMI
54(defgroup gnus nil
55 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
56 :group 'news
57 :group 'mail)
58
4573e0df
MB
59(defgroup gnus-start nil
60 "Starting your favorite newsreader."
61 :group 'gnus)
62
23f87bed
MB
63(defgroup gnus-format nil
64 "Dealing with formatting issues."
65 :group 'gnus)
66
16409b0b
GM
67(defgroup gnus-charset nil
68 "Group character set issues."
69 :link '(custom-manual "(gnus)Charsets")
70 :version "21.1"
71 :group 'gnus)
72
6748645f
LMI
73(defgroup gnus-cache nil
74 "Cache interface."
23f87bed
MB
75 :link '(custom-manual "(gnus)Article Caching")
76 :group 'gnus)
77
78(defgroup gnus-registry nil
79 "Article Registry."
6748645f
LMI
80 :group 'gnus)
81
eec82323
LMI
82(defgroup gnus-start-server nil
83 "Server options at startup."
84 :group 'gnus-start)
85
86;; These belong to gnus-group.el.
87(defgroup gnus-group nil
88 "Group buffers."
23f87bed 89 :link '(custom-manual "(gnus)Group Buffer")
eec82323
LMI
90 :group 'gnus)
91
92(defgroup gnus-group-foreign nil
93 "Foreign groups."
94 :link '(custom-manual "(gnus)Foreign Groups")
95 :group 'gnus-group)
96
97(defgroup gnus-group-new nil
98 "Automatic subscription of new groups."
99 :group 'gnus-group)
100
101(defgroup gnus-group-levels nil
102 "Group levels."
103 :link '(custom-manual "(gnus)Group Levels")
104 :group 'gnus-group)
105
106(defgroup gnus-group-select nil
107 "Selecting a Group."
108 :link '(custom-manual "(gnus)Selecting a Group")
109 :group 'gnus-group)
110
111(defgroup gnus-group-listing nil
112 "Showing slices of the group list."
113 :link '(custom-manual "(gnus)Listing Groups")
114 :group 'gnus-group)
115
116(defgroup gnus-group-visual nil
117 "Sorting the group buffer."
118 :link '(custom-manual "(gnus)Group Buffer Format")
119 :group 'gnus-group
120 :group 'gnus-visual)
121
122(defgroup gnus-group-various nil
123 "Various group options."
124 :link '(custom-manual "(gnus)Scanning New Messages")
125 :group 'gnus-group)
126
127;; These belong to gnus-sum.el.
128(defgroup gnus-summary nil
129 "Summary buffers."
23f87bed 130 :link '(custom-manual "(gnus)Summary Buffer")
eec82323
LMI
131 :group 'gnus)
132
133(defgroup gnus-summary-exit nil
134 "Leaving summary buffers."
135 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
136 :group 'gnus-summary)
137
138(defgroup gnus-summary-marks nil
139 "Marks used in summary buffers."
140 :link '(custom-manual "(gnus)Marking Articles")
141 :group 'gnus-summary)
142
143(defgroup gnus-thread nil
144 "Ordering articles according to replies."
145 :link '(custom-manual "(gnus)Threading")
146 :group 'gnus-summary)
147
148(defgroup gnus-summary-format nil
149 "Formatting of the summary buffer."
150 :link '(custom-manual "(gnus)Summary Buffer Format")
151 :group 'gnus-summary)
152
153(defgroup gnus-summary-choose nil
154 "Choosing Articles."
155 :link '(custom-manual "(gnus)Choosing Articles")
156 :group 'gnus-summary)
157
158(defgroup gnus-summary-maneuvering nil
159 "Summary movement commands."
160 :link '(custom-manual "(gnus)Summary Maneuvering")
161 :group 'gnus-summary)
162
23f87bed
MB
163(defgroup gnus-picon nil
164 "Show pictures of people, domains, and newsgroups."
165 :group 'gnus-visual)
166
eec82323
LMI
167(defgroup gnus-summary-mail nil
168 "Mail group commands."
169 :link '(custom-manual "(gnus)Mail Group Commands")
170 :group 'gnus-summary)
171
172(defgroup gnus-summary-sort nil
173 "Sorting the summary buffer."
23f87bed 174 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
eec82323
LMI
175 :group 'gnus-summary)
176
177(defgroup gnus-summary-visual nil
178 "Highlighting and menus in the summary buffer."
179 :link '(custom-manual "(gnus)Summary Highlighting")
180 :group 'gnus-visual
181 :group 'gnus-summary)
182
183(defgroup gnus-summary-various nil
184 "Various summary buffer options."
185 :link '(custom-manual "(gnus)Various Summary Stuff")
186 :group 'gnus-summary)
187
a8151ef7
LMI
188(defgroup gnus-summary-pick nil
189 "Pick mode in the summary buffer."
190 :link '(custom-manual "(gnus)Pick and Read")
191 :prefix "gnus-pick-"
192 :group 'gnus-summary)
193
194(defgroup gnus-summary-tree nil
195 "Tree display of threads in the summary buffer."
196 :link '(custom-manual "(gnus)Tree Display")
197 :prefix "gnus-tree-"
198 :group 'gnus-summary)
199
eec82323
LMI
200;; Belongs to gnus-uu.el
201(defgroup gnus-extract-view nil
202 "Viewing extracted files."
203 :link '(custom-manual "(gnus)Viewing Files")
204 :group 'gnus-extract)
205
206;; Belongs to gnus-score.el
207(defgroup gnus-score nil
208 "Score and kill file handling."
209 :group 'gnus)
210
211(defgroup gnus-score-kill nil
212 "Kill files."
213 :group 'gnus-score)
214
215(defgroup gnus-score-adapt nil
216 "Adaptive score files."
217 :group 'gnus-score)
218
219(defgroup gnus-score-default nil
220 "Default values for score files."
221 :group 'gnus-score)
222
223(defgroup gnus-score-expire nil
224 "Expiring score rules."
225 :group 'gnus-score)
226
227(defgroup gnus-score-decay nil
228 "Decaying score rules."
229 :group 'gnus-score)
230
231(defgroup gnus-score-files nil
232 "Score and kill file names."
233 :group 'gnus-score
234 :group 'gnus-files)
235
236(defgroup gnus-score-various nil
237 "Various scoring and killing options."
238 :group 'gnus-score)
239
240;; Other
241(defgroup gnus-visual nil
23f87bed 242 "Options controlling the visual fluff."
eec82323
LMI
243 :group 'gnus
244 :group 'faces)
245
6748645f
LMI
246(defgroup gnus-agent nil
247 "Offline support for Gnus."
248 :group 'gnus)
249
eec82323
LMI
250(defgroup gnus-files nil
251 "Files used by Gnus."
252 :group 'gnus)
253
254(defgroup gnus-dribble-file nil
255 "Auto save file."
256 :link '(custom-manual "(gnus)Auto Save")
257 :group 'gnus-files)
258
259(defgroup gnus-newsrc nil
260 "Storing Gnus state."
261 :group 'gnus-files)
262
263(defgroup gnus-server nil
264 "Options related to newsservers and other servers used by Gnus."
265 :group 'gnus)
266
23f87bed
MB
267(defgroup gnus-server-visual nil
268 "Highlighting and menus in the server buffer."
269 :group 'gnus-visual
270 :group 'gnus-server)
271
eec82323
LMI
272(defgroup gnus-message '((message custom-group))
273 "Composing replies and followups in Gnus."
274 :group 'gnus)
275
276(defgroup gnus-meta nil
23f87bed 277 "Meta variables controlling major portions of Gnus.
85ee3c75 278In general, modifying these variables does not take effect until Gnus
eec82323
LMI
279is restarted, and sometimes reloaded."
280 :group 'gnus)
281
282(defgroup gnus-various nil
283 "Other Gnus options."
284 :link '(custom-manual "(gnus)Various Various")
285 :group 'gnus)
286
287(defgroup gnus-exit nil
873f3c50 288 "Exiting Gnus."
eec82323
LMI
289 :link '(custom-manual "(gnus)Exiting Gnus")
290 :group 'gnus)
291
23f87bed
MB
292(defgroup gnus-fun nil
293 "Frivolous Gnus extensions."
294 :link '(custom-manual "(gnus)Exiting Gnus")
295 :group 'gnus)
296
c7ff939a 297(defconst gnus-version-number "5.13"
eec82323
LMI
298 "Version number for this version of Gnus.")
299
c7ff939a 300(defconst gnus-version (format "Gnus v%s" gnus-version-number)
eec82323
LMI
301 "Version string for this version of Gnus.")
302
303(defcustom gnus-inhibit-startup-message nil
304 "If non-nil, the startup message will not be displayed.
305This variable is used before `.gnus.el' is loaded, so it should
306be set in `.emacs' instead."
307 :group 'gnus-start
308 :type 'boolean)
309
eec82323
LMI
310(unless (featurep 'gnus-xmas)
311 (defalias 'gnus-make-overlay 'make-overlay)
6748645f 312 (defalias 'gnus-delete-overlay 'delete-overlay)
9bfd9a76 313 (defalias 'gnus-overlay-get 'overlay-get)
eec82323
LMI
314 (defalias 'gnus-overlay-put 'overlay-put)
315 (defalias 'gnus-move-overlay 'move-overlay)
48df946a
DL
316 (defalias 'gnus-overlay-buffer 'overlay-buffer)
317 (defalias 'gnus-overlay-start 'overlay-start)
eec82323 318 (defalias 'gnus-overlay-end 'overlay-end)
9bfd9a76 319 (defalias 'gnus-overlays-in 'overlays-in)
eec82323
LMI
320 (defalias 'gnus-extent-detached-p 'ignore)
321 (defalias 'gnus-extent-start-open 'ignore)
eec82323
LMI
322 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
323 (defalias 'gnus-character-to-event 'identity)
23f87bed 324 (defalias 'gnus-assq-delete-all 'assq-delete-all)
eec82323
LMI
325 (defalias 'gnus-add-text-properties 'add-text-properties)
326 (defalias 'gnus-put-text-property 'put-text-property)
16409b0b
GM
327 (defvar gnus-mode-line-image-cache t)
328 (if (fboundp 'find-image)
329 (defun gnus-mode-line-buffer-identification (line)
d31fa104
MB
330 (let ((str (car-safe line))
331 (load-path (mm-image-load-path)))
16409b0b
GM
332 (if (and (stringp str)
333 (string-match "^Gnus:" str))
334 (progn (add-text-properties
335 0 5
336 (list 'display
337 (if (eq t gnus-mode-line-image-cache)
338 (setq gnus-mode-line-image-cache
339 (find-image
340 '((:type xpm :file "gnus-pointer.xpm"
e03eed51 341 :ascent center)
16409b0b 342 (:type xbm :file "gnus-pointer.xbm"
e03eed51 343 :ascent center))))
16409b0b 344 gnus-mode-line-image-cache)
23f87bed
MB
345 'help-echo (format
346 "This is %s, %s."
347 gnus-version (gnus-emacs-version)))
16409b0b
GM
348 str)
349 (list str))
350 line)))
351 (defalias 'gnus-mode-line-buffer-identification 'identity))
6748645f
LMI
352 (defalias 'gnus-deactivate-mark 'deactivate-mark)
353 (defalias 'gnus-window-edges 'window-edges)
16409b0b 354 (defalias 'gnus-key-press-event-p 'numberp)
23f87bed
MB
355 ;;(defalias 'gnus-decode-rfc1522 'ignore)
356 )
eec82323 357
eec82323
LMI
358;; We define these group faces here to avoid the display
359;; update forced when creating new faces.
360
0f49874b 361(defface gnus-group-news-1
eec82323
LMI
362 '((((class color)
363 (background dark))
23f87bed 364 (:foreground "PaleTurquoise" :bold t))
eec82323
LMI
365 (((class color)
366 (background light))
23f87bed 367 (:foreground "ForestGreen" :bold t))
eec82323
LMI
368 (t
369 ()))
d0859c9a
MB
370 "Level 1 newsgroup face."
371 :group 'gnus-group)
0f49874b
MB
372;; backward-compatibility alias
373(put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
3d493bef 374(put 'gnus-group-news-1-face 'obsolete-face "22.1")
eec82323 375
0f49874b 376(defface gnus-group-news-1-empty
eec82323
LMI
377 '((((class color)
378 (background dark))
379 (:foreground "PaleTurquoise"))
380 (((class color)
381 (background light))
382 (:foreground "ForestGreen"))
383 (t
384 ()))
d0859c9a
MB
385 "Level 1 empty newsgroup face."
386 :group 'gnus-group)
0f49874b
MB
387;; backward-compatibility alias
388(put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
3d493bef 389(put 'gnus-group-news-1-empty-face 'obsolete-face "22.1")
eec82323 390
0f49874b 391(defface gnus-group-news-2
eec82323
LMI
392 '((((class color)
393 (background dark))
23f87bed 394 (:foreground "turquoise" :bold t))
eec82323
LMI
395 (((class color)
396 (background light))
23f87bed 397 (:foreground "CadetBlue4" :bold t))
eec82323
LMI
398 (t
399 ()))
d0859c9a
MB
400 "Level 2 newsgroup face."
401 :group 'gnus-group)
0f49874b
MB
402;; backward-compatibility alias
403(put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
3d493bef 404(put 'gnus-group-news-2-face 'obsolete-face "22.1")
eec82323 405
0f49874b 406(defface gnus-group-news-2-empty
eec82323
LMI
407 '((((class color)
408 (background dark))
409 (:foreground "turquoise"))
410 (((class color)
411 (background light))
412 (:foreground "CadetBlue4"))
413 (t
414 ()))
d0859c9a
MB
415 "Level 2 empty newsgroup face."
416 :group 'gnus-group)
0f49874b
MB
417;; backward-compatibility alias
418(put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
3d493bef 419(put 'gnus-group-news-2-empty-face 'obsolete-face "22.1")
eec82323 420
0f49874b 421(defface gnus-group-news-3
eec82323
LMI
422 '((((class color)
423 (background dark))
23f87bed 424 (:bold t))
eec82323
LMI
425 (((class color)
426 (background light))
23f87bed 427 (:bold t))
eec82323
LMI
428 (t
429 ()))
d0859c9a
MB
430 "Level 3 newsgroup face."
431 :group 'gnus-group)
0f49874b
MB
432;; backward-compatibility alias
433(put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
3d493bef 434(put 'gnus-group-news-3-face 'obsolete-face "22.1")
eec82323 435
0f49874b 436(defface gnus-group-news-3-empty
eec82323
LMI
437 '((((class color)
438 (background dark))
439 ())
440 (((class color)
441 (background light))
442 ())
443 (t
444 ()))
d0859c9a
MB
445 "Level 3 empty newsgroup face."
446 :group 'gnus-group)
0f49874b
MB
447;; backward-compatibility alias
448(put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
3d493bef 449(put 'gnus-group-news-3-empty-face 'obsolete-face "22.1")
eec82323 450
0f49874b 451(defface gnus-group-news-4
16409b0b
GM
452 '((((class color)
453 (background dark))
23f87bed 454 (:bold t))
16409b0b
GM
455 (((class color)
456 (background light))
23f87bed 457 (:bold t))
16409b0b
GM
458 (t
459 ()))
d0859c9a
MB
460 "Level 4 newsgroup face."
461 :group 'gnus-group)
0f49874b
MB
462;; backward-compatibility alias
463(put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
3d493bef 464(put 'gnus-group-news-4-face 'obsolete-face "22.1")
16409b0b 465
0f49874b 466(defface gnus-group-news-4-empty
16409b0b
GM
467 '((((class color)
468 (background dark))
469 ())
470 (((class color)
471 (background light))
472 ())
473 (t
474 ()))
d0859c9a
MB
475 "Level 4 empty newsgroup face."
476 :group 'gnus-group)
0f49874b
MB
477;; backward-compatibility alias
478(put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
3d493bef 479(put 'gnus-group-news-4-empty-face 'obsolete-face "22.1")
16409b0b 480
0f49874b 481(defface gnus-group-news-5
16409b0b
GM
482 '((((class color)
483 (background dark))
23f87bed 484 (:bold t))
16409b0b
GM
485 (((class color)
486 (background light))
23f87bed 487 (:bold t))
16409b0b
GM
488 (t
489 ()))
d0859c9a
MB
490 "Level 5 newsgroup face."
491 :group 'gnus-group)
0f49874b
MB
492;; backward-compatibility alias
493(put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
3d493bef 494(put 'gnus-group-news-5-face 'obsolete-face "22.1")
16409b0b 495
0f49874b 496(defface gnus-group-news-5-empty
16409b0b
GM
497 '((((class color)
498 (background dark))
499 ())
500 (((class color)
501 (background light))
502 ())
503 (t
504 ()))
d0859c9a
MB
505 "Level 5 empty newsgroup face."
506 :group 'gnus-group)
0f49874b
MB
507;; backward-compatibility alias
508(put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
3d493bef 509(put 'gnus-group-news-5-empty-face 'obsolete-face "22.1")
16409b0b 510
0f49874b 511(defface gnus-group-news-6
16409b0b
GM
512 '((((class color)
513 (background dark))
23f87bed 514 (:bold t))
16409b0b
GM
515 (((class color)
516 (background light))
23f87bed 517 (:bold t))
16409b0b
GM
518 (t
519 ()))
d0859c9a
MB
520 "Level 6 newsgroup face."
521 :group 'gnus-group)
0f49874b
MB
522;; backward-compatibility alias
523(put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
3d493bef 524(put 'gnus-group-news-6-face 'obsolete-face "22.1")
16409b0b 525
0f49874b 526(defface gnus-group-news-6-empty
16409b0b
GM
527 '((((class color)
528 (background dark))
529 ())
530 (((class color)
531 (background light))
532 ())
533 (t
534 ()))
d0859c9a
MB
535 "Level 6 empty newsgroup face."
536 :group 'gnus-group)
0f49874b
MB
537;; backward-compatibility alias
538(put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
3d493bef 539(put 'gnus-group-news-6-empty-face 'obsolete-face "22.1")
16409b0b 540
0f49874b 541(defface gnus-group-news-low
eec82323
LMI
542 '((((class color)
543 (background dark))
23f87bed 544 (:foreground "DarkTurquoise" :bold t))
eec82323
LMI
545 (((class color)
546 (background light))
23f87bed 547 (:foreground "DarkGreen" :bold t))
eec82323
LMI
548 (t
549 ()))
d0859c9a
MB
550 "Low level newsgroup face."
551 :group 'gnus-group)
0f49874b
MB
552;; backward-compatibility alias
553(put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
3d493bef 554(put 'gnus-group-news-low-face 'obsolete-face "22.1")
eec82323 555
0f49874b 556(defface gnus-group-news-low-empty
eec82323
LMI
557 '((((class color)
558 (background dark))
559 (:foreground "DarkTurquoise"))
560 (((class color)
561 (background light))
562 (:foreground "DarkGreen"))
563 (t
564 ()))
d0859c9a
MB
565 "Low level empty newsgroup face."
566 :group 'gnus-group)
0f49874b
MB
567;; backward-compatibility alias
568(put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
3d493bef 569(put 'gnus-group-news-low-empty-face 'obsolete-face "22.1")
eec82323 570
0f49874b 571(defface gnus-group-mail-1
eec82323
LMI
572 '((((class color)
573 (background dark))
01c52d31 574 (:foreground "#e1ffe1" :bold t))
eec82323
LMI
575 (((class color)
576 (background light))
23f87bed 577 (:foreground "DeepPink3" :bold t))
eec82323 578 (t
23f87bed 579 (:bold t)))
d0859c9a
MB
580 "Level 1 mailgroup face."
581 :group 'gnus-group)
0f49874b
MB
582;; backward-compatibility alias
583(put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
3d493bef 584(put 'gnus-group-mail-1-face 'obsolete-face "22.1")
eec82323 585
0f49874b 586(defface gnus-group-mail-1-empty
eec82323
LMI
587 '((((class color)
588 (background dark))
01c52d31 589 (:foreground "#e1ffe1"))
eec82323
LMI
590 (((class color)
591 (background light))
592 (:foreground "DeepPink3"))
593 (t
23f87bed 594 (:italic t :bold t)))
d0859c9a
MB
595 "Level 1 empty mailgroup face."
596 :group 'gnus-group)
0f49874b
MB
597;; backward-compatibility alias
598(put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
3d493bef 599(put 'gnus-group-mail-1-empty-face 'obsolete-face "22.1")
eec82323 600
0f49874b 601(defface gnus-group-mail-2
eec82323
LMI
602 '((((class color)
603 (background dark))
01c52d31 604 (:foreground "DarkSeaGreen1" :bold t))
eec82323
LMI
605 (((class color)
606 (background light))
23f87bed 607 (:foreground "HotPink3" :bold t))
eec82323 608 (t
23f87bed 609 (:bold t)))
d0859c9a
MB
610 "Level 2 mailgroup face."
611 :group 'gnus-group)
0f49874b
MB
612;; backward-compatibility alias
613(put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
3d493bef 614(put 'gnus-group-mail-2-face 'obsolete-face "22.1")
eec82323 615
0f49874b 616(defface gnus-group-mail-2-empty
eec82323
LMI
617 '((((class color)
618 (background dark))
01c52d31 619 (:foreground "DarkSeaGreen1"))
eec82323
LMI
620 (((class color)
621 (background light))
622 (:foreground "HotPink3"))
623 (t
23f87bed 624 (:bold t)))
d0859c9a
MB
625 "Level 2 empty mailgroup face."
626 :group 'gnus-group)
0f49874b
MB
627;; backward-compatibility alias
628(put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
3d493bef 629(put 'gnus-group-mail-2-empty-face 'obsolete-face "22.1")
eec82323 630
0f49874b 631(defface gnus-group-mail-3
eec82323
LMI
632 '((((class color)
633 (background dark))
01c52d31 634 (:foreground "aquamarine1" :bold t))
eec82323
LMI
635 (((class color)
636 (background light))
23f87bed 637 (:foreground "magenta4" :bold t))
eec82323 638 (t
23f87bed 639 (:bold t)))
d0859c9a
MB
640 "Level 3 mailgroup face."
641 :group 'gnus-group)
0f49874b
MB
642;; backward-compatibility alias
643(put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
3d493bef 644(put 'gnus-group-mail-3-face 'obsolete-face "22.1")
eec82323 645
0f49874b 646(defface gnus-group-mail-3-empty
eec82323
LMI
647 '((((class color)
648 (background dark))
01c52d31 649 (:foreground "aquamarine1"))
eec82323
LMI
650 (((class color)
651 (background light))
652 (:foreground "magenta4"))
653 (t
654 ()))
d0859c9a
MB
655 "Level 3 empty mailgroup face."
656 :group 'gnus-group)
0f49874b
MB
657;; backward-compatibility alias
658(put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
3d493bef 659(put 'gnus-group-mail-3-empty-face 'obsolete-face "22.1")
eec82323 660
0f49874b 661(defface gnus-group-mail-low
eec82323
LMI
662 '((((class color)
663 (background dark))
01c52d31 664 (:foreground "aquamarine2" :bold t))
eec82323
LMI
665 (((class color)
666 (background light))
23f87bed 667 (:foreground "DeepPink4" :bold t))
eec82323 668 (t
23f87bed 669 (:bold t)))
d0859c9a
MB
670 "Low level mailgroup face."
671 :group 'gnus-group)
0f49874b
MB
672;; backward-compatibility alias
673(put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
3d493bef 674(put 'gnus-group-mail-low-face 'obsolete-face "22.1")
eec82323 675
0f49874b 676(defface gnus-group-mail-low-empty
eec82323
LMI
677 '((((class color)
678 (background dark))
01c52d31 679 (:foreground "aquamarine2"))
eec82323
LMI
680 (((class color)
681 (background light))
682 (:foreground "DeepPink4"))
683 (t
23f87bed 684 (:bold t)))
d0859c9a
MB
685 "Low level empty mailgroup face."
686 :group 'gnus-group)
0f49874b
MB
687;; backward-compatibility alias
688(put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
3d493bef 689(put 'gnus-group-mail-low-empty-face 'obsolete-face "22.1")
eec82323
LMI
690
691;; Summary mode faces.
692
0f49874b 693(defface gnus-summary-selected '((t (:underline t)))
d0859c9a
MB
694 "Face used for selected articles."
695 :group 'gnus-summary)
0f49874b
MB
696;; backward-compatibility alias
697(put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
3d493bef 698(put 'gnus-summary-selected-face 'obsolete-face "22.1")
eec82323 699
0f49874b 700(defface gnus-summary-cancelled
eec82323
LMI
701 '((((class color))
702 (:foreground "yellow" :background "black")))
c80e3b4a 703 "Face used for canceled articles."
d0859c9a 704 :group 'gnus-summary)
0f49874b
MB
705;; backward-compatibility alias
706(put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
3d493bef 707(put 'gnus-summary-cancelled-face 'obsolete-face "22.1")
eec82323 708
0f49874b 709(defface gnus-summary-high-ticked
eec82323
LMI
710 '((((class color)
711 (background dark))
23f87bed 712 (:foreground "pink" :bold t))
eec82323
LMI
713 (((class color)
714 (background light))
23f87bed 715 (:foreground "firebrick" :bold t))
eec82323 716 (t
23f87bed 717 (:bold t)))
d0859c9a
MB
718 "Face used for high interest ticked articles."
719 :group 'gnus-summary)
0f49874b
MB
720;; backward-compatibility alias
721(put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
3d493bef 722(put 'gnus-summary-high-ticked-face 'obsolete-face "22.1")
eec82323 723
0f49874b 724(defface gnus-summary-low-ticked
eec82323
LMI
725 '((((class color)
726 (background dark))
23f87bed 727 (:foreground "pink" :italic t))
eec82323
LMI
728 (((class color)
729 (background light))
23f87bed 730 (:foreground "firebrick" :italic t))
eec82323 731 (t
23f87bed 732 (:italic t)))
d0859c9a
MB
733 "Face used for low interest ticked articles."
734 :group 'gnus-summary)
0f49874b
MB
735;; backward-compatibility alias
736(put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
3d493bef 737(put 'gnus-summary-low-ticked-face 'obsolete-face "22.1")
eec82323 738
0f49874b 739(defface gnus-summary-normal-ticked
eec82323
LMI
740 '((((class color)
741 (background dark))
742 (:foreground "pink"))
743 (((class color)
744 (background light))
745 (:foreground "firebrick"))
746 (t
747 ()))
d0859c9a
MB
748 "Face used for normal interest ticked articles."
749 :group 'gnus-summary)
0f49874b
MB
750;; backward-compatibility alias
751(put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
3d493bef 752(put 'gnus-summary-normal-ticked-face 'obsolete-face "22.1")
eec82323 753
0f49874b 754(defface gnus-summary-high-ancient
eec82323
LMI
755 '((((class color)
756 (background dark))
23f87bed 757 (:foreground "SkyBlue" :bold t))
eec82323
LMI
758 (((class color)
759 (background light))
23f87bed 760 (:foreground "RoyalBlue" :bold t))
eec82323 761 (t
23f87bed 762 (:bold t)))
d0859c9a
MB
763 "Face used for high interest ancient articles."
764 :group 'gnus-summary)
0f49874b
MB
765;; backward-compatibility alias
766(put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
3d493bef 767(put 'gnus-summary-high-ancient-face 'obsolete-face "22.1")
eec82323 768
0f49874b 769(defface gnus-summary-low-ancient
eec82323
LMI
770 '((((class color)
771 (background dark))
23f87bed 772 (:foreground "SkyBlue" :italic t))
eec82323
LMI
773 (((class color)
774 (background light))
23f87bed 775 (:foreground "RoyalBlue" :italic t))
eec82323 776 (t
23f87bed 777 (:italic t)))
d0859c9a
MB
778 "Face used for low interest ancient articles."
779 :group 'gnus-summary)
0f49874b
MB
780;; backward-compatibility alias
781(put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
3d493bef 782(put 'gnus-summary-low-ancient-face 'obsolete-face "22.1")
eec82323 783
0f49874b 784(defface gnus-summary-normal-ancient
eec82323
LMI
785 '((((class color)
786 (background dark))
787 (:foreground "SkyBlue"))
788 (((class color)
789 (background light))
790 (:foreground "RoyalBlue"))
791 (t
792 ()))
d0859c9a
MB
793 "Face used for normal interest ancient articles."
794 :group 'gnus-summary)
0f49874b
MB
795;; backward-compatibility alias
796(put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
3d493bef 797(put 'gnus-summary-normal-ancient-face 'obsolete-face "22.1")
eec82323 798
0f49874b 799(defface gnus-summary-high-undownloaded
23f87bed
MB
800 '((((class color)
801 (background light))
802 (:bold t :foreground "cyan4"))
803 (((class color) (background dark))
804 (:bold t :foreground "LightGray"))
805 (t (:inverse-video t :bold t)))
d0859c9a
MB
806 "Face used for high interest uncached articles."
807 :group 'gnus-summary)
0f49874b
MB
808;; backward-compatibility alias
809(put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
3d493bef 810(put 'gnus-summary-high-undownloaded-face 'obsolete-face "22.1")
23f87bed 811
0f49874b 812(defface gnus-summary-low-undownloaded
23f87bed
MB
813 '((((class color)
814 (background light))
815 (:italic t :foreground "cyan4" :bold nil))
816 (((class color) (background dark))
817 (:italic t :foreground "LightGray" :bold nil))
818 (t (:inverse-video t :italic t)))
d0859c9a
MB
819 "Face used for low interest uncached articles."
820 :group 'gnus-summary)
0f49874b
MB
821;; backward-compatibility alias
822(put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
3d493bef 823(put 'gnus-summary-low-undownloaded-face 'obsolete-face "22.1")
23f87bed 824
0f49874b 825(defface gnus-summary-normal-undownloaded
23f87bed
MB
826 '((((class color)
827 (background light))
828 (:foreground "cyan4" :bold nil))
829 (((class color) (background dark))
830 (:foreground "LightGray" :bold nil))
831 (t (:inverse-video t)))
d0859c9a
MB
832 "Face used for normal interest uncached articles."
833 :group 'gnus-summary)
0f49874b
MB
834;; backward-compatibility alias
835(put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
3d493bef 836(put 'gnus-summary-normal-undownloaded-face 'obsolete-face "22.1")
23f87bed 837
0f49874b 838(defface gnus-summary-high-unread
eec82323 839 '((t
23f87bed 840 (:bold t)))
d0859c9a
MB
841 "Face used for high interest unread articles."
842 :group 'gnus-summary)
0f49874b
MB
843;; backward-compatibility alias
844(put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
3d493bef 845(put 'gnus-summary-high-unread-face 'obsolete-face "22.1")
eec82323 846
0f49874b 847(defface gnus-summary-low-unread
eec82323 848 '((t
23f87bed 849 (:italic t)))
d0859c9a
MB
850 "Face used for low interest unread articles."
851 :group 'gnus-summary)
0f49874b
MB
852;; backward-compatibility alias
853(put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
3d493bef 854(put 'gnus-summary-low-unread-face 'obsolete-face "22.1")
eec82323 855
0f49874b 856(defface gnus-summary-normal-unread
eec82323
LMI
857 '((t
858 ()))
d0859c9a
MB
859 "Face used for normal interest unread articles."
860 :group 'gnus-summary)
0f49874b
MB
861;; backward-compatibility alias
862(put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
3d493bef 863(put 'gnus-summary-normal-unread-face 'obsolete-face "22.1")
eec82323 864
0f49874b 865(defface gnus-summary-high-read
eec82323
LMI
866 '((((class color)
867 (background dark))
868 (:foreground "PaleGreen"
23f87bed 869 :bold t))
eec82323
LMI
870 (((class color)
871 (background light))
872 (:foreground "DarkGreen"
23f87bed 873 :bold t))
eec82323 874 (t
23f87bed 875 (:bold t)))
d0859c9a
MB
876 "Face used for high interest read articles."
877 :group 'gnus-summary)
0f49874b
MB
878;; backward-compatibility alias
879(put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
3d493bef 880(put 'gnus-summary-high-read-face 'obsolete-face "22.1")
eec82323 881
0f49874b 882(defface gnus-summary-low-read
eec82323
LMI
883 '((((class color)
884 (background dark))
885 (:foreground "PaleGreen"
23f87bed 886 :italic t))
eec82323
LMI
887 (((class color)
888 (background light))
889 (:foreground "DarkGreen"
23f87bed 890 :italic t))
eec82323 891 (t
23f87bed 892 (:italic t)))
d0859c9a
MB
893 "Face used for low interest read articles."
894 :group 'gnus-summary)
0f49874b
MB
895;; backward-compatibility alias
896(put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
3d493bef 897(put 'gnus-summary-low-read-face 'obsolete-face "22.1")
eec82323 898
0f49874b 899(defface gnus-summary-normal-read
eec82323
LMI
900 '((((class color)
901 (background dark))
902 (:foreground "PaleGreen"))
903 (((class color)
904 (background light))
905 (:foreground "DarkGreen"))
906 (t
907 ()))
d0859c9a
MB
908 "Face used for normal interest read articles."
909 :group 'gnus-summary)
0f49874b
MB
910;; backward-compatibility alias
911(put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
3d493bef 912(put 'gnus-summary-normal-read-face 'obsolete-face "22.1")
eec82323
LMI
913
914
6748645f
LMI
915;;;
916;;; Gnus buffers
917;;;
918
2ec4c966
JD
919(defvar gnus-buffers nil
920 "List of buffers handled by Gnus.")
6748645f
LMI
921
922(defun gnus-get-buffer-create (name)
923 "Do the same as `get-buffer-create', but store the created buffer."
924 (or (get-buffer name)
925 (car (push (get-buffer-create name) gnus-buffers))))
926
927(defun gnus-add-buffer ()
928 "Add the current buffer to the list of Gnus buffers."
929 (push (current-buffer) gnus-buffers))
930
23f87bed
MB
931(defmacro gnus-kill-buffer (buffer)
932 "Kill BUFFER and remove from the list of Gnus buffers."
933 `(let ((buf ,buffer))
934 (when (gnus-buffer-exists-p buf)
935 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
936 (kill-buffer buf))))
937
6748645f
LMI
938(defun gnus-buffers ()
939 "Return a list of live Gnus buffers."
940 (while (and gnus-buffers
941 (not (buffer-name (car gnus-buffers))))
942 (pop gnus-buffers))
943 (let ((buffers gnus-buffers))
944 (while (cdr buffers)
945 (if (buffer-name (cadr buffers))
946 (pop buffers)
947 (setcdr buffers (cddr buffers)))))
948 gnus-buffers)
949
eec82323
LMI
950;;; Splash screen.
951
2ec4c966
JD
952(defvar gnus-group-buffer "*Group*"
953 "Name of the Gnus group buffer.")
eec82323 954
0f49874b 955(defface gnus-splash
eec82323
LMI
956 '((((class color)
957 (background dark))
01c52d31 958 (:foreground "#cccccc"))
eec82323
LMI
959 (((class color)
960 (background light))
23f87bed 961 (:foreground "#888888"))
eec82323
LMI
962 (t
963 ()))
d0859c9a 964 "Face for the splash screen."
3031d8b0 965 :group 'gnus-start)
0f49874b
MB
966;; backward-compatibility alias
967(put 'gnus-splash-face 'face-alias 'gnus-splash)
3d493bef 968(put 'gnus-splash-face 'obsolete-face "22.1")
eec82323
LMI
969
970(defun gnus-splash ()
971 (save-excursion
6748645f 972 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
eec82323
LMI
973 (let ((buffer-read-only nil))
974 (erase-buffer)
975 (unless gnus-inhibit-startup-message
976 (gnus-group-startup-message)
8ccbef23 977 (sit-for 0)))))
eec82323
LMI
978
979(defun gnus-indent-rigidly (start end arg)
980 "Indent rigidly using only spaces and no tabs."
981 (save-excursion
982 (save-restriction
983 (narrow-to-region start end)
a8151ef7
LMI
984 (let ((tab-width 8))
985 (indent-rigidly start end arg)
986 ;; We translate tabs into spaces -- not everybody uses
987 ;; an 8-character tab.
988 (goto-char (point-min))
989 (while (search-forward "\t" nil t)
990 (replace-match " " t t))))))
eec82323 991
23f87bed
MB
992;;(format "%02x%02x%02x" 114 66 20) "724214"
993
994(defvar gnus-logo-color-alist
995 '((flame "#cc3300" "#ff2200")
996 (pine "#c0cc93" "#f8ffb8")
997 (moss "#a1cc93" "#d2ffb8")
998 (irish "#04cc90" "#05ff97")
999 (sky "#049acc" "#05deff")
1000 (tin "#6886cc" "#82b6ff")
1001 (velvet "#7c68cc" "#8c82ff")
1002 (grape "#b264cc" "#cf7df")
1003 (labia "#cc64c2" "#fd7dff")
1004 (berry "#cc6485" "#ff7db5")
1005 (dino "#724214" "#1e3f03")
1006 (oort "#cccccc" "#888888")
1007 (storm "#666699" "#99ccff")
1008 (pdino "#9999cc" "#99ccff")
1009 (purp "#9999cc" "#666699")
01c52d31 1010 (no "#ff0000" "#ffff00")
23f87bed 1011 (neutral "#b4b4b4" "#878787")
89b163db 1012 (ma "#2020e0" "#8080ff")
23f87bed
MB
1013 (september "#bf9900" "#ffcc00"))
1014 "Color alist used for the Gnus logo.")
1015
89b163db 1016(defcustom gnus-logo-color-style 'ma
23f87bed
MB
1017 "*Color styles used for the Gnus logo."
1018 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
1019 gnus-logo-color-alist))
1020 :group 'gnus-xmas)
1021
1022(defvar gnus-logo-colors
1023 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
1024 "Colors used for the Gnus logo.")
1025
12c9fab6
GM
1026(declare-function image-size "image.c" (spec &optional pixels frame))
1027
eec82323
LMI
1028(defun gnus-group-startup-message (&optional x y)
1029 "Insert startup message in current buffer."
1030 ;; Insert the message.
1031 (erase-buffer)
2ec4c966
JD
1032 (unless (and
1033 (fboundp 'find-image)
1034 (display-graphic-p)
389b76fa
G
1035 ;; Make sure the library defining `image-load-path' is
1036 ;; loaded (`find-image' is autoloaded) (and discard the
1037 ;; result). Else, we may get "defvar ignored because
1038 ;; image-load-path is let-bound" when calling `find-image'
1039 ;; below.
2ec4c966
JD
1040 (or (find-image '(nil (:type xpm :file "gnus.xpm"))) t)
1041 (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
1042 (image-load-path (cond (data-directory
1043 (list data-directory))
1044 ((boundp 'image-load-path)
1045 (symbol-value 'image-load-path))
1046 (t load-path)))
a5954fa5
G
1047 (image (gnus-splash-svg-color-symbols (find-image
1048 `((:type svg :file "gnus.svg"
1049 :color-symbols
1050 (("#bf9900" . ,(car gnus-logo-colors))
1051 ("#ffcc00" . ,(cadr gnus-logo-colors))))
1052 (:type xpm :file "gnus.xpm"
2ec4c966
JD
1053 :color-symbols
1054 (("thing" . ,(car gnus-logo-colors))
1055 ("shadow" . ,(cadr gnus-logo-colors))))
2ec4c966
JD
1056 (:type png :file "gnus.png")
1057 (:type pbm :file "gnus.pbm"
1058 ;; Account for the pbm's background.
1059 :background ,(face-foreground 'gnus-splash)
1060 :foreground ,(face-background 'default))
1061 (:type xbm :file "gnus.xbm"
1062 ;; Account for the xbm's background.
1063 :background ,(face-foreground 'gnus-splash)
a5954fa5 1064 :foreground ,(face-background 'default)))))))
2ec4c966
JD
1065 (when image
1066 (let ((size (image-size image)))
1067 (insert-char ?\n (max 0 (round (- (window-height)
1068 (or y (cdr size)) 1) 2)))
1069 (insert-char ?\ (max 0 (round (- (window-width)
1070 (or x (car size))) 2)))
1071 (insert-image image))
389b76fa 1072 (goto-char (point-min))
2ec4c966 1073 t)))
16409b0b 1074 (insert
389b76fa 1075 (format "
01c52d31
MB
1076 _ ___ _ _
1077 _ ___ __ ___ __ _ ___
1078 __ _ ___ __ ___
1079 _ ___ _
1080 _ _ __ _
1081 ___ __ _
1082 __ _
1083 _ _ _
1084 _ _ _
1085 _ _ _
1086 __ ___
1087 _ _ _ _
1088 _ _
1089 _ _
1090 _ _
1091 _
1092 __
eec82323 1093
2ec4c966 1094"))
16409b0b
GM
1095 ;; And then hack it.
1096 (gnus-indent-rigidly (point-min) (point-max)
1097 (/ (max (- (window-width) (or x 46)) 0) 2))
1098 (goto-char (point-min))
1099 (forward-line 1)
1100 (let* ((pheight (count-lines (point-min) (point-max)))
1101 (wheight (window-height))
1102 (rest (- wheight pheight)))
1103 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1104 ;; Fontify some.
0f49874b 1105 (put-text-property (point-min) (point-max) 'face 'gnus-splash)
2ec4c966
JD
1106 (goto-char (point-min))
1107 (setq mode-line-buffer-identification (concat " " gnus-version))
1108 (set-buffer-modified-p t)))
eec82323 1109
a5954fa5 1110(defun gnus-splash-svg-color-symbols (list)
70f6144d 1111 "Do color-symbol search-and-replace in svg file."
a5954fa5
G
1112 (let ((type (plist-get (cdr list) :type))
1113 (file (plist-get (cdr list) :file))
1114 (color-symbols (plist-get (cdr list) :color-symbols)))
1115 (if (string= type "svg")
70f6144d
SM
1116 (let ((data (with-temp-buffer (insert-file-contents file)
1117 (buffer-string))))
a5954fa5
G
1118 (mapc (lambda (rule)
1119 (setq data (replace-regexp-in-string
1120 (concat "fill:" (car rule))
70f6144d
SM
1121 (concat "fill:" (cdr rule)) data)))
1122 color-symbols)
a5954fa5
G
1123 (cons (car list) (list :type type :data data)))
1124 list)))
1125
eec82323
LMI
1126(eval-when (load)
1127 (let ((command (format "%s" this-command)))
23f87bed
MB
1128 (when (string-match "gnus" command)
1129 (if (string-match "gnus-other-frame" command)
1130 (gnus-get-buffer-create gnus-group-buffer)
1131 (gnus-splash)))))
eec82323
LMI
1132
1133;;; Do the rest.
1134
eec82323
LMI
1135(require 'gnus-util)
1136(require 'nnheader)
1137
23f87bed
MB
1138(defcustom gnus-parameters nil
1139 "Alist of group parameters.
1140
1141For example:
1142 ((\"mail\\\\..*\" (gnus-show-threads nil)
1143 (gnus-use-scoring nil)
1144 (gnus-summary-line-format
1145 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1146 (gcc-self . t)
1147 (display . all))
1148 (\"mail\\\\.me\" (gnus-use-scoring t))
1149 (\"list\\\\..*\" (total-expire . t)
e7719ea1 1150 (broken-reply-to . t)))"
bf247b6e 1151 :version "22.1"
23f87bed
MB
1152 :group 'gnus-group-various
1153 :type '(repeat (cons regexp
1154 (repeat sexp))))
1155
e8beac8a
MB
1156(defcustom gnus-parameters-case-fold-search 'default
1157 "If it is t, ignore case of group names specified in `gnus-parameters'.
1158If it is nil, don't ignore case. If it is `default', which is for the
1159backward compatibility, use the value of `case-fold-search'."
1160 :version "22.1"
1161 :group 'gnus-group-various
1162 :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
1163 (const :tag "Use `case-fold-search'" default)
1164 (const nil)
1165 (const t)))
1166
23f87bed
MB
1167(defvar gnus-group-parameters-more nil)
1168
1169(defmacro gnus-define-group-parameter (param &rest rest)
1170 "Define a group parameter PARAM.
1171REST is a plist of following:
1172:type One of `bool', `list' or nil.
1173:function The name of the function.
1174:function-document The documentation of the function.
1175:parameter-type The type for customizing the parameter.
1176:parameter-document The documentation for the parameter.
1177:variable The name of the variable.
1178:variable-document The documentation for the variable.
1179:variable-group The group for customizing the variable.
1180:variable-type The type for customizing the variable.
1181:variable-default The default value of the variable."
1182 (let* ((type (plist-get rest :type))
1183 (parameter-type (plist-get rest :parameter-type))
1184 (parameter-document (plist-get rest :parameter-document))
1185 (function (or (plist-get rest :function)
1186 (intern (format "gnus-parameter-%s" param))))
1187 (function-document (or (plist-get rest :function-document) ""))
1188 (variable (or (plist-get rest :variable)
1189 (intern (format "gnus-parameter-%s-alist" param))))
1190 (variable-document (or (plist-get rest :variable-document) ""))
1191 (variable-group (plist-get rest :variable-group))
1192 (variable-type (or (plist-get rest :variable-type)
1193 `(quote (repeat
1194 (list (regexp :tag "Group")
1195 ,(car (cdr parameter-type)))))))
1196 (variable-default (plist-get rest :variable-default)))
1197 (list
1198 'progn
1199 `(defcustom ,variable ,variable-default
1200 ,variable-document
1201 :group 'gnus-group-parameter
1202 :group ',variable-group
1203 :type ,variable-type)
1204 `(setq gnus-group-parameters-more
1205 (delq (assq ',param gnus-group-parameters-more)
1206 gnus-group-parameters-more))
1207 `(add-to-list 'gnus-group-parameters-more
1208 (list ',param
1209 ,parameter-type
1210 ,parameter-document))
1211 (if (eq type 'bool)
1212 `(defun ,function (name)
1213 ,function-document
1214 (let ((params (gnus-group-find-parameter name))
1215 val)
1216 (cond
1217 ((memq ',param params)
1218 t)
1219 ((setq val (assq ',param params))
1220 (cdr val))
1221 ((stringp ,variable)
1222 (string-match ,variable name))
1223 (,variable
1224 (let ((alist ,variable)
1225 elem value)
1226 (while (setq elem (pop alist))
1227 (when (and name
1228 (string-match (car elem) name))
1229 (setq alist nil
1230 value (cdr elem))))
1231 (if (consp value) (car value) value))))))
1232 `(defun ,function (name)
1233 ,function-document
1234 (and name
1235 (or (gnus-group-find-parameter name ',param ,(and type t))
1236 (let ((alist ,variable)
1237 elem value)
1238 (while (setq elem (pop alist))
1239 (when (and name
1240 (string-match (car elem) name))
1241 (setq alist nil
1242 value (cdr elem))))
1243 ,(if type
1244 'value
1245 '(if (consp value) (car value) value))))))))))
1246
eec82323
LMI
1247(defcustom gnus-home-directory "~/"
1248 "Directory variable that specifies the \"home\" directory.
052bd38a
LMI
1249All other Gnus file and directory variables are initialized from this variable.
1250
1251Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1252This means that other directory variables that are initialized
1253from this variable won't be set properly if you set this variable
1254in `.gnus.el'. Set this variable in `.emacs' instead."
eec82323
LMI
1255 :group 'gnus-files
1256 :type 'directory)
1257
1258(defcustom gnus-directory (or (getenv "SAVEDIR")
1259 (nnheader-concat gnus-home-directory "News/"))
6748645f
LMI
1260 "*Directory variable from which all other Gnus file variables are derived.
1261
1262Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1263This means that other directory variables that are initialized from
1264this variable won't be set properly if you set this variable in `.gnus.el'.
1265Set this variable in `.emacs' instead."
eec82323
LMI
1266 :group 'gnus-files
1267 :type 'directory)
1268
1269(defcustom gnus-default-directory nil
1270 "*Default directory for all Gnus buffers."
1271 :group 'gnus-files
1272 :type '(choice (const :tag "current" nil)
1273 directory))
1274
f8815e4c 1275;; Site dependent variables.
eec82323 1276
f8815e4c
GM
1277;; Should this be obsolete?
1278(defcustom gnus-default-nntp-server nil
1279 "The hostname of the default NNTP server.
1280The empty string, or nil, means to use the local host.
1281You may wish to set this on a site-wide basis.
1282
1283If you want to change servers, you should use `gnus-select-method'."
1284 :group 'gnus-server
1285 :type '(choice (const :tag "local host" nil)
1286 (string :tag "host name")))
eec82323 1287
eec82323
LMI
1288(defcustom gnus-nntpserver-file "/etc/nntpserver"
1289 "A file with only the name of the nntp server in it."
1290 :group 'gnus-files
1291 :group 'gnus-server
1292 :type 'file)
1293
eec82323 1294(defun gnus-getenv-nntpserver ()
23f87bed
MB
1295 "Find default nntp server.
1296Check the NNTPSERVER environment variable and the
1297`gnus-nntpserver-file' file."
eec82323
LMI
1298 (or (getenv "NNTPSERVER")
1299 (and (file-readable-p gnus-nntpserver-file)
23f87bed 1300 (with-temp-buffer
eec82323 1301 (insert-file-contents gnus-nntpserver-file)
f4dd4ae8
MB
1302 (when (re-search-forward "[^ \t\n\r]+" nil t)
1303 (match-string 0))))))
eec82323 1304
4573e0df
MB
1305;; `M-x customize-variable RET gnus-select-method RET' should work without
1306;; starting or even loading Gnus.
1307;;;###autoload(when (fboundp 'custom-autoload)
1308;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1309
eec82323 1310(defcustom gnus-select-method
99e65b2d
G
1311 (list 'nntp (or (gnus-getenv-nntpserver)
1312 (when (and gnus-default-nntp-server
1313 (not (string= gnus-default-nntp-server "")))
1314 gnus-default-nntp-server)
1315 "news"))
16409b0b 1316 "Default method for selecting a newsgroup.
eec82323
LMI
1317This variable should be a list, where the first element is how the
1318news is to be fetched, the second is the address.
1319
23f87bed
MB
1320For instance, if you want to get your news via \"flab.flab.edu\" using
1321NNTP, you could say:
eec82323
LMI
1322
1323\(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1324
1325If you want to use your local spool, say:
1326
1327\(setq gnus-select-method (list 'nnspool (system-name)))
1328
1329If you use this variable, you must set `gnus-nntp-server' to nil.
1330
1331There is a lot more to know about select methods and virtual servers -
1332see the manual for details."
f8815e4c
GM
1333 ;; Emacs has set-after since 22.1.
1334 ;set-after '(gnus-default-nntp-server)
eec82323 1335 :group 'gnus-server
4573e0df
MB
1336 :group 'gnus-start
1337 :initialize 'custom-initialize-default
eec82323
LMI
1338 :type 'gnus-select-method)
1339
23f87bed 1340(defcustom gnus-message-archive-method "archive"
6748645f 1341 "*Method used for archiving messages you've sent.
01c52d31
MB
1342This should be a mail method.
1343
1344See also `gnus-update-message-archive-method'."
eec82323
LMI
1345 :group 'gnus-server
1346 :group 'gnus-message
23f87bed
MB
1347 :type '(choice (const :tag "Default archive method" "archive")
1348 gnus-select-method))
eec82323 1349
01c52d31
MB
1350(defcustom gnus-update-message-archive-method nil
1351 "Non-nil means always update the saved \"archive\" method.
1352
1353The archive method is initially set according to the value of
1354`gnus-message-archive-method' and is saved in the \"~/.newsrc.eld\" file
1355so that it may be used as a real method of the server which is named
1356\"archive\" ever since. If it once has been saved, it will never be
1357updated if the value of this variable is nil, even if you change the
1358value of `gnus-message-archive-method' afterward. If you want the
1359saved \"archive\" method to be updated whenever you change the value of
1360`gnus-message-archive-method', set this variable to a non-nil value."
d99bf2d8 1361 :version "23.1"
01c52d31
MB
1362 :group 'gnus-server
1363 :group 'gnus-message
1364 :type 'boolean)
1365
d99bf2d8 1366(defcustom gnus-message-archive-group '((format-time-string "sent.%Y-%m"))
eec82323
LMI
1367 "*Name of the group in which to save the messages you've written.
1368This can either be a string; a list of strings; or an alist
1369of regexps/functions/forms to be evaluated to return a string (or a list
1370of strings). The functions are called with the name of the current
1371group (or nil) as a parameter.
1372
1373If you want to save your mail in one group and the news articles you
1374write in another group, you could say something like:
1375
1376 \(setq gnus-message-archive-group
23f87bed
MB
1377 '((if (message-news-p)
1378 \"misc-news\"
1379 \"misc-mail\")))
eec82323
LMI
1380
1381Normally the group names returned by this variable should be
1382unprefixed -- which implicitly means \"store on the archive server\".
1383However, you may wish to store the message on some other server. In
1384that case, just return a fully prefixed name of the group --
1385\"nnml+private:mail.misc\", for instance."
d99bf2d8 1386 :version "24.1"
eec82323
LMI
1387 :group 'gnus-message
1388 :type '(choice (const :tag "none" nil)
514d9128
LMI
1389 (const :tag "Weekly" ((format-time-string "sent.%Yw%U")))
1390 (const :tag "Monthly" ((format-time-string "sent.%Y-%m")))
1391 (const :tag "Yearly" ((format-time-string "sent.%Y")))
16409b0b 1392 function
6748645f 1393 sexp
eec82323
LMI
1394 string))
1395
1396(defcustom gnus-secondary-servers nil
1397 "List of NNTP servers that the user can choose between interactively.
1398To make Gnus query you for a server, you have to give `gnus' a
1399non-numeric prefix - `C-u M-x gnus', in short."
1400 :group 'gnus-server
1401 :type '(repeat string))
99e65b2d 1402(make-obsolete-variable 'gnus-secondary-servers 'gnus-select-method "24.1")
eec82323 1403
eec82323
LMI
1404(defcustom gnus-secondary-select-methods nil
1405 "A list of secondary methods that will be used for reading news.
1406This is a list where each element is a complete select method (see
1407`gnus-select-method').
1408
23f87bed 1409If, for instance, you want to read your mail with the nnml back end,
eec82323
LMI
1410you could set this variable:
1411
1412\(setq gnus-secondary-select-methods '((nnml \"\")))"
16409b0b
GM
1413 :group 'gnus-server
1414 :type '(repeat gnus-select-method))
eec82323 1415
6f33b4d7
LMI
1416(defcustom gnus-local-domain nil
1417 "Local domain name without a host name.
1418The DOMAINNAME environment variable is used instead if it is defined.
1419If the function `system-name' returns the full Internet name, there is
1420no need to set this variable."
1421 :group 'gnus-message
1422 :type '(choice (const :tag "default" nil)
1423 string))
6b958814 1424(make-obsolete-variable 'gnus-local-domain nil "Emacs 24.1")
6f33b4d7 1425
eec82323
LMI
1426;; Customization variables
1427
a1347097 1428(defcustom gnus-refer-article-method 'current
eec82323 1429 "Preferred method for fetching an article by Message-ID.
eec82323 1430The value of this variable must be a valid select method as discussed
16409b0b
GM
1431in the documentation of `gnus-select-method'.
1432
1433It can also be a list of select methods, as well as the special symbol
1434`current', which means to use the current select method. If it is a
1435list, Gnus will try all the methods in the list until it finds a match."
a1347097 1436 :version "24.1"
eec82323
LMI
1437 :group 'gnus-server
1438 :type '(choice (const :tag "default" nil)
23f87bed
MB
1439 (const current)
1440 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
16409b0b 1441 gnus-select-method
ae97e645 1442 sexp
16409b0b
GM
1443 (repeat :menu-tag "Try multiple"
1444 :tag "Multiple"
23f87bed 1445 :value (current (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1446 (choice :tag "Method"
1447 (const current)
23f87bed
MB
1448 (const :tag "Google"
1449 (nnweb "refer" (nnweb-type google)))
16409b0b 1450 gnus-select-method))))
eec82323 1451
eec82323
LMI
1452(defcustom gnus-use-cross-reference t
1453 "*Non-nil means that cross referenced articles will be marked as read.
1454If nil, ignore cross references. If t, mark articles as read in
65a32076 1455subscribed newsgroups. If neither t nor nil, mark as read in all
eec82323
LMI
1456newsgroups."
1457 :group 'gnus-server
1458 :type '(choice (const :tag "off" nil)
1459 (const :tag "subscribed" t)
1460 (sexp :format "all"
1461 :value always)))
1462
1463(defcustom gnus-process-mark ?#
1464 "*Process mark."
1465 :group 'gnus-group-visual
1466 :group 'gnus-summary-marks
1467 :type 'character)
1468
eec82323
LMI
1469(defcustom gnus-large-newsgroup 200
1470 "*The number of articles which indicates a large newsgroup.
1471If the number of articles in a newsgroup is greater than this value,
23f87bed 1472confirmation is required for selecting the newsgroup.
a3f57c41
G
1473If it is nil, no confirmation is required.
1474
1475Also see `gnus-large-ephemeral-newsgroup'."
eec82323 1476 :group 'gnus-group-select
23f87bed
MB
1477 :type '(choice (const :tag "No limit" nil)
1478 integer))
eec82323 1479
f3041af1 1480(defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v)))
99e65b2d 1481 "Non-nil means that the default name of a file to save articles in is the group name.
eec82323
LMI
1482If it's nil, the directory form of the group name is used instead.
1483
1484If this variable is a list, and the list contains the element
1485`not-score', long file names will not be used for score files; if it
1486contains the element `not-save', long file names will not be used for
1487saving; and if it contains the element `not-kill', long file names
1488will not be used for kill files.
1489
1490Note that the default for this variable varies according to what system
99e65b2d
G
1491type you're using. On `usg-unix-v' this variable defaults to nil while
1492on all other systems it defaults to t."
eec82323 1493 :group 'gnus-start
23f87bed
MB
1494 :type '(radio (sexp :format "Non-nil\n"
1495 :match (lambda (widget value)
1496 (and value (not (listp value))))
1497 :value t)
1498 (const nil)
1499 (checklist (const :format "%v " not-score)
1500 (const :format "%v " not-save)
1501 (const not-kill))))
eec82323
LMI
1502
1503(defcustom gnus-kill-files-directory gnus-directory
1504 "*Name of the directory where kill files will be stored (default \"~/News\")."
1505 :group 'gnus-score-files
1506 :group 'gnus-score-kill
1507 :type 'directory)
1508
1509(defcustom gnus-save-score nil
1510 "*If non-nil, save group scoring info."
1511 :group 'gnus-score-various
1512 :group 'gnus-start
1513 :type 'boolean)
1514
1515(defcustom gnus-use-undo t
1516 "*If non-nil, allow undoing in Gnus group mode buffers."
1517 :group 'gnus-meta
1518 :type 'boolean)
1519
1520(defcustom gnus-use-adaptive-scoring nil
1521 "*If non-nil, use some adaptive scoring scheme.
1522If a list, then the values `word' and `line' are meaningful. The
1523former will perform adaption on individual words in the subject
1524header while `line' will perform adaption on several headers."
1525 :group 'gnus-meta
1526 :group 'gnus-score-adapt
1527 :type '(set (const word) (const line)))
1528
1529(defcustom gnus-use-cache 'passive
1530 "*If nil, Gnus will ignore the article cache.
1531If `passive', it will allow entering (and reading) articles
1532explicitly entered into the cache. If anything else, use the
1533cache to the full extent of the law."
1534 :group 'gnus-meta
1535 :group 'gnus-cache
1536 :type '(choice (const :tag "off" nil)
1537 (const :tag "passive" passive)
1538 (const :tag "active" t)))
1539
1540(defcustom gnus-use-trees nil
1541 "*If non-nil, display a thread tree buffer."
1542 :group 'gnus-meta
1543 :type 'boolean)
1544
23f87bed 1545(defcustom gnus-keep-backlog 20
eec82323
LMI
1546 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1547If it is a number N, then Gnus will only keep the last N articles
1548read. If it is neither nil nor a number, Gnus will keep all read
1549articles. This is not a good idea."
1550 :group 'gnus-meta
1551 :type '(choice (const :tag "off" nil)
1552 integer
1553 (sexp :format "all"
1554 :value t)))
1555
eec82323
LMI
1556(defcustom gnus-suppress-duplicates nil
1557 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1558 :group 'gnus-meta
1559 :type 'boolean)
1560
eec82323
LMI
1561(defcustom gnus-use-scoring t
1562 "*If non-nil, enable scoring."
1563 :group 'gnus-meta
1564 :type 'boolean)
1565
eec82323
LMI
1566(defcustom gnus-summary-prepare-exit-hook
1567 '(gnus-summary-expire-articles)
6748645f 1568 "*A hook called when preparing to exit from the summary buffer.
eec82323
LMI
1569It calls `gnus-summary-expire-articles' by default."
1570 :group 'gnus-summary-exit
1571 :type 'hook)
1572
1573(defcustom gnus-novice-user t
23f87bed 1574 "*Non-nil means that you are a Usenet novice.
eec82323
LMI
1575If non-nil, verbose messages may be displayed and confirmations may be
1576required."
1577 :group 'gnus-meta
1578 :type 'boolean)
1579
1580(defcustom gnus-expert-user nil
1581 "*Non-nil means that you will never be asked for confirmation about anything.
6748645f
LMI
1582That doesn't mean *anything* anything; particularly destructive
1583commands will still require prompting."
eec82323
LMI
1584 :group 'gnus-meta
1585 :type 'boolean)
1586
1587(defcustom gnus-interactive-catchup t
1588 "*If non-nil, require your confirmation when catching up a group."
1589 :group 'gnus-group-select
1590 :type 'boolean)
1591
1592(defcustom gnus-interactive-exit t
e21bac42
G
1593 "*If non-nil, require your confirmation when exiting Gnus.
1594If `quiet', update any active summary buffers automatically
1595first before exiting."
eec82323 1596 :group 'gnus-exit
2af70b94
LMI
1597 :type '(choice boolean
1598 (const quiet)))
eec82323
LMI
1599
1600(defcustom gnus-extract-address-components 'gnus-extract-address-components
1601 "*Function for extracting address components from a From header.
1602Two pre-defined function exist: `gnus-extract-address-components',
1603which is the default, quite fast, and too simplistic solution, and
1604`mail-extract-address-components', which works much better, but is
1605slower."
1606 :group 'gnus-summary-format
1607 :type '(radio (function-item gnus-extract-address-components)
1608 (function-item mail-extract-address-components)
1609 (function :tag "Other")))
1610
eec82323 1611(defcustom gnus-shell-command-separator ";"
23f87bed 1612 "String used to separate shell commands."
eec82323
LMI
1613 :group 'gnus-files
1614 :type 'string)
1615
1616(defcustom gnus-valid-select-methods
1617 '(("nntp" post address prompt-address physical-address)
1618 ("nnspool" post address)
1619 ("nnvirtual" post-mail virtual prompt-address)
1620 ("nnmbox" mail respool address)
23f87bed 1621 ("nnml" post-mail respool address)
eec82323
LMI
1622 ("nnmh" mail respool address)
1623 ("nndir" post-mail prompt-address physical-address)
1624 ("nneething" none address prompt-address physical-address)
1625 ("nndoc" none address prompt-address)
1626 ("nnbabyl" mail address respool)
eec82323
LMI
1627 ("nndraft" post-mail)
1628 ("nnfolder" mail respool address)
6748645f
LMI
1629 ("nngateway" post-mail address prompt-address physical-address)
1630 ("nnweb" none)
23f87bed 1631 ("nnrss" none)
16409b0b 1632 ("nnagent" post-mail)
706b5974
G
1633 ("nnimap" post-mail address prompt-address physical-address respool
1634 server-marks)
efc708ec 1635 ("nnmaildir" mail respool address server-marks)
23f87bed 1636 ("nnnil" none))
6748645f 1637 "*An alist of valid select methods.
eec82323
LMI
1638The first element of each list lists should be a string with the name
1639of the select method. The other elements may be the category of
1640this method (i. e., `post', `mail', `none' or whatever) or other
1641properties that this method has (like being respoolable).
1642If you implement a new select method, all you should have to change is
65a32076 1643this variable. I think."
eec82323
LMI
1644 :group 'gnus-server
1645 :type '(repeat (group (string :tag "Name")
1646 (radio-button-choice (const :format "%v " post)
1647 (const :format "%v " mail)
1648 (const :format "%v " none)
1649 (const post-mail))
4650d5fa 1650 (checklist :inline t :greedy t
eec82323
LMI
1651 (const :format "%v " address)
1652 (const :format "%v " prompt-address)
c06fc524 1653 (const :format "%v " physical-address)
4650d5fa
KY
1654 (const virtual)
1655 (const :format "%v " respool)
1656 (const server-marks))))
1a10d421 1657 :version "24.1")
eec82323 1658
16409b0b
GM
1659(defun gnus-redefine-select-method-widget ()
1660 "Recomputes the select-method widget based on the value of
1661`gnus-valid-select-methods'."
1662 (define-widget 'gnus-select-method 'list
1663 "Widget for entering a select method."
1664 :value '(nntp "")
1665 :tag "Select Method"
1666 :args `((choice :tag "Method"
1667 ,@(mapcar (lambda (entry)
1668 (list 'const :format "%v\n"
1669 (intern (car entry))))
1670 gnus-valid-select-methods)
1671 (symbol :tag "other"))
1672 (string :tag "Address")
1673 (repeat :tag "Options"
1674 :inline t
1675 (list :format "%v"
1676 variable
23f87bed 1677 (sexp :tag "Value"))))))
16409b0b
GM
1678
1679(gnus-redefine-select-method-widget)
eec82323
LMI
1680
1681(defcustom gnus-updated-mode-lines '(group article summary tree)
1682 "List of buffers that should update their mode lines.
1683The list may contain the symbols `group', `article', `tree' and
1684`summary'. If the corresponding symbol is present, Gnus will keep
1685that mode line updated with information that may be pertinent.
1686If this variable is nil, screen refresh may be quicker."
1687 :group 'gnus-various
1688 :type '(set (const group)
1689 (const article)
1690 (const summary)
1691 (const tree)))
1692
a1347097 1693(defcustom gnus-mode-non-string-length 30
eec82323
LMI
1694 "*Max length of mode-line non-string contents.
1695If this is nil, Gnus will take space as is needed, leaving the rest
a1347097
LMI
1696of the mode line intact."
1697 :version "24.1"
eec82323
LMI
1698 :group 'gnus-various
1699 :type '(choice (const nil)
1700 integer))
1701
23f87bed
MB
1702;; There should be special validation for this.
1703(define-widget 'gnus-email-address 'string
1704 "An email address.")
1705
1706(gnus-define-group-parameter
1707 to-address
1708 :function-document
1709 "Return GROUP's to-address."
1710 :variable-document
1711 "*Alist of group regexps and correspondent to-addresses."
e79f14a4 1712 :variable-group gnus-group-parameter
23f87bed
MB
1713 :parameter-type '(gnus-email-address :tag "To Address")
1714 :parameter-document "\
1715This will be used when doing followups and posts.
1716
1717This is primarily useful in mail groups that represent closed
1718mailing lists--mailing lists where it's expected that everybody that
1719writes to the mailing list is subscribed to it. Since using this
1720parameter ensures that the mail only goes to the mailing list itself,
1721it means that members won't receive two copies of your followups.
1722
1723Using `to-address' will actually work whether the group is foreign or
1724not. Let's say there's a group on the server that is called
1725`fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1726articles from a mail-to-news gateway. Posting directly to this group
1727is therefore impossible--you have to send mail to the mailing list
1728address instead.
1729
1730The gnus-group-split mail splitting mechanism will behave as if this
1731address was listed in gnus-group-split Addresses (see below).")
1732
1733(gnus-define-group-parameter
1734 to-list
1735 :function-document
1736 "Return GROUP's to-list."
1737 :variable-document
1738 "*Alist of group regexps and correspondent to-lists."
e79f14a4 1739 :variable-group gnus-group-parameter
23f87bed
MB
1740 :parameter-type '(gnus-email-address :tag "To List")
1741 :parameter-document "\
1742This address will be used when doing a `a' in the group.
1743
1744It is totally ignored when doing a followup--except that if it is
1745present in a news group, you'll get mail group semantics when doing
1746`f'.
1747
1748The gnus-group-split mail splitting mechanism will behave as if this
1749address was listed in gnus-group-split Addresses (see below).")
1750
1751(gnus-define-group-parameter
1752 subscribed
1753 :type bool
1754 :function-document
1755 "Return GROUP's subscription status."
1756 :variable-document
1757 "*Groups which are automatically considered subscribed."
e79f14a4 1758 :variable-group gnus-group-parameter
23f87bed
MB
1759 :parameter-type '(const :tag "Subscribed" t)
1760 :parameter-document "\
1761Gnus assumed that you are subscribed to the To/List address.
1762
1763When constructing a list of subscribed groups using
1764`gnus-find-subscribed-addresses', Gnus includes the To address given
1765above, or the list address (if the To address has not been set).")
1766
1767(gnus-define-group-parameter
1768 auto-expire
1769 :type bool
1770 :function gnus-group-auto-expirable-p
1771 :function-document
1772 "Check whether GROUP is auto-expirable or not."
1773 :variable gnus-auto-expirable-newsgroups
1774 :variable-default nil
1775 :variable-document
1776 "*Groups in which to automatically mark read articles as expirable.
eec82323
LMI
1777If non-nil, this should be a regexp that should match all groups in
1778which to perform auto-expiry. This only makes sense for mail groups."
23f87bed
MB
1779 :variable-group nnmail-expire
1780 :variable-type '(choice (const nil)
1781 regexp)
1782 :parameter-type '(const :tag "Automatic Expire" t)
1783 :parameter-document
1784 "All articles that are read will be marked as expirable.")
1785
1786(gnus-define-group-parameter
1787 total-expire
1788 :type bool
1789 :function gnus-group-total-expirable-p
1790 :function-document
1791 "Check whether GROUP is total-expirable or not."
1792 :variable gnus-total-expirable-newsgroups
1793 :variable-default nil
1794 :variable-document
1795 "*Groups in which to perform expiry of all read articles.
eec82323
LMI
1796Use with extreme caution. All groups that match this regexp will be
1797expiring - which means that all read articles will be deleted after
65a32076 1798\(say) one week. (This only goes for mail groups and the like, of
eec82323 1799course.)"
23f87bed
MB
1800 :variable-group nnmail-expire
1801 :variable-type '(choice (const nil)
1802 regexp)
1803 :parameter-type '(const :tag "Total Expire" t)
1804 :parameter-document
1805 "All read articles will be put through the expiry process
1806
1807This happens even if they are not marked as expirable.
1808Use with caution.")
1809
1810(gnus-define-group-parameter
1811 charset
1812 :function-document
1813 "Return the default charset of GROUP."
1814 :variable gnus-group-charset-alist
1815 :variable-default
1816 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1817 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1818 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1819 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1820 ("\\(^\\|:\\)relcom\\>" koi8-r)
1821 ("\\(^\\|:\\)fido7\\>" koi8-r)
1822 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1823 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1824 ("\\(^\\|:\\)han\\>" euc-kr)
1825 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1826 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1827 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1828 :variable-document
1829 "Alist of regexps (to match group names) and default charsets to be used when reading."
1830 :variable-group gnus-charset
1831 :variable-type '(repeat (list (regexp :tag "Group")
1832 (symbol :tag "Charset")))
1833 :parameter-type '(symbol :tag "Charset")
1834 :parameter-document "\
1835The default charset to use in the group.")
1836
1837(gnus-define-group-parameter
1838 post-method
1839 :type list
1840 :function-document
1841 "Return a posting method for GROUP."
1842 :variable gnus-post-method-alist
1843 :variable-document
1844 "Alist of regexps (to match group names) and method to be used when
1845posting an article."
1846 :variable-group gnus-group-foreign
1847 :parameter-type
1848 '(choice :tag "Posting Method"
1849 (const :tag "Use native server" native)
1850 (const :tag "Use current server" current)
1851 (list :convert-widget
1852 (lambda (widget)
1853 (list 'sexp :tag "Methods"
1854 :value gnus-select-method))))
1855 :parameter-document
1856 "Posting method for this group.")
1857
1858(gnus-define-group-parameter
1859 large-newsgroup-initial
1860 :type integer
1861 :function-document
1862 "Return GROUP's initial input of the number of articles."
1863 :variable-document
1864 "*Alist of group regexps and its initial input of the number of articles."
e79f14a4 1865 :variable-group gnus-group-parameter
23f87bed
MB
1866 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1867 (const :tag "All" nil)
1868 (integer))
1869 :parameter-document "\
1870
1871This number will be prompted as the initial value of the number of
1872articles to list when the group is a large newsgroup (see
1873`gnus-large-newsgroup'). If it is nil, the default value is the
1874total number of articles in the group.")
1875
1876;; The Gnus registry's ignored groups
1877(gnus-define-group-parameter
1878 registry-ignore
1879 :type list
1880 :function-document
1881 "Whether this group should be ignored by the registry."
1882 :variable gnus-registry-ignored-groups
c024b021
TZ
1883 :variable-default (mapcar
1884 (lambda (g) (list g t))
1885 '("delayed$" "drafts$" "queue$" "INBOX$"
e504613c 1886 "^nnmairix:" "^nnir:" "archive"))
23f87bed
MB
1887 :variable-document
1888 "*Groups in which the registry should be turned off."
1889 :variable-group gnus-registry
1890 :variable-type '(repeat
1891 (list
1892 (regexp :tag "Group Name Regular Expression")
1893 (boolean :tag "Ignored")))
bf247b6e 1894
23f87bed
MB
1895 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1896 :parameter-document
1897 "Whether the Gnus Registry should ignore this group.")
1898
1899;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1900(defcustom gnus-install-group-spam-parameters t
1901 "*Disable the group parameters for spam detection.
1902Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
bf247b6e 1903 :version "22.1"
23f87bed
MB
1904 :type 'boolean
1905 :group 'gnus-start)
1906
1907(when gnus-install-group-spam-parameters
1908 (defvar gnus-group-spam-classification-spam t
1909 "Spam group classification (requires spam.el).
1910This group contains spam messages. On summary entry, unread messages
1911will be marked as spam. On summary exit, the specified spam
1912processors will be invoked on spam-marked messages, then those
1913messages will be expired, so the spam processor will only see a
1914spam-marked message once.")
1915
1916 (defvar gnus-group-spam-classification-ham 'ask
1917 "The ham value for the spam group parameter (requires spam.el).
1918On summary exit, the specified ham processors will be invoked on
1919ham-marked messages. Exercise caution, since the ham processor will
1920see the same message more than once because there is no ham message
1921registry.")
1922
1923 (gnus-define-group-parameter
1924 spam-contents
1925 :type list
1926 :function-document
1927 "The spam type (spam, ham, or neither) of the group."
1928 :variable gnus-spam-newsgroup-contents
1929 :variable-default nil
1930 :variable-document
270a576a
MB
1931 "*Group classification (spam, ham, or neither). Only
1932meaningful when spam.el is loaded. If non-nil, this should be a
1933list of group name regexps associated with a classification for
1934each one. In spam groups, new articles are marked as spam on
1935summary entry. There is other behavior associated with ham and
1936no classification when spam.el is loaded - see the manual."
23f87bed
MB
1937 :variable-group spam
1938 :variable-type '(repeat
1939 (list :tag "Group contents spam/ham classification"
1940 (regexp :tag "Group")
1941 (choice
1942 (variable-item gnus-group-spam-classification-spam)
1943 (variable-item gnus-group-spam-classification-ham)
1944 (const :tag "Unclassified" nil))))
1945
1946 :parameter-type '(list :tag "Group contents spam/ham classification"
1947 (choice :tag "Group contents classification for spam sorting"
1948 (variable-item gnus-group-spam-classification-spam)
1949 (variable-item gnus-group-spam-classification-ham)
1950 (const :tag "Unclassified" nil)))
1951 :parameter-document
1952 "The spam classification (spam, ham, or neither) of this group.
270a576a
MB
1953When a spam group is entered, all unread articles are marked as
1954spam. There is other behavior associated with ham and no
1955classification when spam.el is loaded - see the manual.")
23f87bed 1956
01c52d31
MB
1957 (gnus-define-group-parameter
1958 spam-resend-to
1959 :type list
1960 :function-document
1961 "The address to get spam resent (through spam-report-resend)."
1962 :variable gnus-spam-resend-to
1963 :variable-default nil
1964 :variable-document
1965 "The address to get spam resent (through spam-report-resend)."
1966 :variable-group spam
1967 :variable-type '(repeat
1968 (list :tag "Group address for resending spam"
1969 (regexp :tag "Group")
1970 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1971 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1972 :parameter-document
1973 "The address to get spam resent (through spam-report-resend).")
1974
1975 (gnus-define-group-parameter
1976 ham-resend-to
1977 :type list
1978 :function-document
1979 "The address to get ham resent (through spam-report-resend)."
1980 :variable gnus-ham-resend-to
1981 :variable-default nil
1982 :variable-document
1983 "The address to get ham resent (through spam-report-resend)."
1984 :variable-group spam
1985 :variable-type '(repeat
1986 (list :tag "Group address for resending ham"
1987 (regexp :tag "Group")
1988 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1989 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1990 :parameter-document
1991 "The address to get ham resent (through spam-report-resend).")
1992
23f87bed
MB
1993 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1994 "OBSOLETE: The ifile summary exit spam processor.")
1995
1996 (defvar gnus-group-spam-exit-processor-stat "stat"
1997 "OBSOLETE: The spam-stat summary exit spam processor.")
1998
1999 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
2000 "OBSOLETE: The Bogofilter summary exit spam processor.")
2001
2002 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
2003 "OBSOLETE: The Blacklist summary exit spam processor.")
2004
2005 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2006 "OBSOLETE: The Gmane reporting summary exit spam processor.
2007Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
2008
2009 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2010 "OBSOLETE: The spamoracle summary exit spam processor.")
2011
2012 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2013 "OBSOLETE: The ifile summary exit ham processor.
2014Only applicable to non-spam (unclassified and ham) groups.")
2015
2016 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2017 "OBSOLETE: The Bogofilter summary exit ham processor.
2018Only applicable to non-spam (unclassified and ham) groups.")
2019
2020 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2021 "OBSOLETE: The spam-stat summary exit ham processor.
2022Only applicable to non-spam (unclassified and ham) groups.")
2023
2024 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2025 "OBSOLETE: The whitelist summary exit ham processor.
2026Only applicable to non-spam (unclassified and ham) groups.")
2027
2028 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2029 "OBSOLETE: The BBDB summary exit ham processor.
2030Only applicable to non-spam (unclassified and ham) groups.")
2031
2032 (defvar gnus-group-ham-exit-processor-copy "copy"
2033 "OBSOLETE: The ham copy exit ham processor.
2034Only applicable to non-spam (unclassified and ham) groups.")
2035
2036 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2037 "OBSOLETE: The spamoracle summary exit ham processor.
2038Only applicable to non-spam (unclassified and ham) groups.")
2039
2040 (gnus-define-group-parameter
2041 spam-process
2042 :type list
bf247b6e
KS
2043 :parameter-type
2044 '(choice
23f87bed
MB
2045 :tag "Spam Summary Exit Processor"
2046 :value nil
2047 (list :tag "Spam Summary Exit Processor Choices"
2048 (set
01c52d31
MB
2049 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2050 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2051 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2052 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2053 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2054 (const :tag "Spam: ifile" (spam spam-use-ifile))
2055 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2056 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2057 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2058 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2059 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2060 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2061 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2062 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2063 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2064 (const :tag "Ham: ifile" (ham spam-use-ifile))
2065 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2066 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2067 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2068 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2069 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2070 (variable-item gnus-group-spam-exit-processor-ifile)
2071 (variable-item gnus-group-spam-exit-processor-stat)
2072 (variable-item gnus-group-spam-exit-processor-bogofilter)
2073 (variable-item gnus-group-spam-exit-processor-blacklist)
2074 (variable-item gnus-group-spam-exit-processor-spamoracle)
2075 (variable-item gnus-group-spam-exit-processor-report-gmane)
2076 (variable-item gnus-group-ham-exit-processor-bogofilter)
2077 (variable-item gnus-group-ham-exit-processor-ifile)
2078 (variable-item gnus-group-ham-exit-processor-stat)
2079 (variable-item gnus-group-ham-exit-processor-whitelist)
2080 (variable-item gnus-group-ham-exit-processor-BBDB)
2081 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2082 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2083 :function-document
2084 "Which spam or ham processors will be applied when the summary is exited."
2085 :variable gnus-spam-process-newsgroups
2086 :variable-default nil
2087 :variable-document
2088 "*Groups in which to automatically process spam or ham articles with
2089a backend on summary exit. If non-nil, this should be a list of group
2090name regexps that should match all groups in which to do automatic
2091spam processing, associated with the appropriate processor."
2092 :variable-group spam
bf247b6e 2093 :variable-type
23f87bed
MB
2094 '(repeat :tag "Spam/Ham Processors"
2095 (list :tag "Spam Summary Exit Processor Choices"
2096 (regexp :tag "Group Regexp")
bf247b6e 2097 (set
23f87bed 2098 :tag "Spam/Ham Summary Exit Processor"
01c52d31
MB
2099 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2100 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2101 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2102 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2103 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2104 (const :tag "Spam: ifile" (spam spam-use-ifile))
2105 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2106 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2107 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2108 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2109 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2110 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2111 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2112 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2113 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2114 (const :tag "Ham: ifile" (ham spam-use-ifile))
2115 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2116 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2117 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2118 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2119 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2120 (variable-item gnus-group-spam-exit-processor-ifile)
2121 (variable-item gnus-group-spam-exit-processor-stat)
2122 (variable-item gnus-group-spam-exit-processor-bogofilter)
2123 (variable-item gnus-group-spam-exit-processor-blacklist)
2124 (variable-item gnus-group-spam-exit-processor-spamoracle)
2125 (variable-item gnus-group-spam-exit-processor-report-gmane)
2126 (variable-item gnus-group-ham-exit-processor-bogofilter)
2127 (variable-item gnus-group-ham-exit-processor-ifile)
2128 (variable-item gnus-group-ham-exit-processor-stat)
2129 (variable-item gnus-group-ham-exit-processor-whitelist)
2130 (variable-item gnus-group-ham-exit-processor-BBDB)
2131 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2132 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2133
2134 :parameter-document
2135 "Which spam or ham processors will be applied when the summary is exited.")
2136
2137 (gnus-define-group-parameter
2138 spam-autodetect
2139 :type list
bf247b6e 2140 :parameter-type
23f87bed
MB
2141 '(boolean :tag "Spam autodetection")
2142 :function-document
2143 "Should spam be autodetected (with spam-split) in this group?"
2144 :variable gnus-spam-autodetect
2145 :variable-default nil
2146 :variable-document
2147 "*Groups in which spam should be autodetected when they are entered.
2148 Only unseen articles will be examined, unless
2149 spam-autodetect-recheck-messages is set."
2150 :variable-group spam
bf247b6e 2151 :variable-type
23f87bed
MB
2152 '(repeat
2153 :tag "Autodetection setting"
2154 (list
2155 (regexp :tag "Group Regexp")
2156 boolean))
2157 :parameter-document
2158 "Spam autodetection.
2159Only unseen articles will be examined, unless
2160spam-autodetect-recheck-messages is set.")
2161
2162 (gnus-define-group-parameter
2163 spam-autodetect-methods
2164 :type list
bf247b6e 2165 :parameter-type
23f87bed
MB
2166 '(choice :tag "Spam autodetection-specific methods"
2167 (const none)
2168 (const default)
2169 (set :tag "Use specific methods"
2170 (variable-item spam-use-blacklist)
01c52d31 2171 (variable-item spam-use-gmane-xref)
23f87bed
MB
2172 (variable-item spam-use-regex-headers)
2173 (variable-item spam-use-regex-body)
2174 (variable-item spam-use-whitelist)
2175 (variable-item spam-use-BBDB)
2176 (variable-item spam-use-ifile)
2177 (variable-item spam-use-spamoracle)
01c52d31
MB
2178 (variable-item spam-use-crm114)
2179 (variable-item spam-use-spamassassin)
2180 (variable-item spam-use-spamassassin-headers)
2181 (variable-item spam-use-bsfilter)
2182 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2183 (variable-item spam-use-stat)
2184 (variable-item spam-use-blackholes)
2185 (variable-item spam-use-hashcash)
2186 (variable-item spam-use-bogofilter-headers)
2187 (variable-item spam-use-bogofilter)))
2188 :function-document
2189 "Methods to be used for autodetection in each group"
2190 :variable gnus-spam-autodetect-methods
2191 :variable-default nil
2192 :variable-document
2193 "*Methods for autodetecting spam per group.
2194Requires the spam-autodetect parameter. Only unseen articles
2195will be examined, unless spam-autodetect-recheck-messages is
2196set."
2197 :variable-group spam
bf247b6e 2198 :variable-type
23f87bed
MB
2199 '(repeat
2200 :tag "Autodetection methods"
2201 (list
2202 (regexp :tag "Group Regexp")
2203 (choice
2204 (const none)
2205 (const default)
2206 (set :tag "Use specific methods"
2207 (variable-item spam-use-blacklist)
01c52d31 2208 (variable-item spam-use-gmane-xref)
23f87bed
MB
2209 (variable-item spam-use-regex-headers)
2210 (variable-item spam-use-regex-body)
2211 (variable-item spam-use-whitelist)
2212 (variable-item spam-use-BBDB)
2213 (variable-item spam-use-ifile)
2214 (variable-item spam-use-spamoracle)
01c52d31 2215 (variable-item spam-use-crm114)
23f87bed
MB
2216 (variable-item spam-use-stat)
2217 (variable-item spam-use-blackholes)
2218 (variable-item spam-use-hashcash)
01c52d31
MB
2219 (variable-item spam-use-spamassassin)
2220 (variable-item spam-use-spamassassin-headers)
2221 (variable-item spam-use-bsfilter)
2222 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2223 (variable-item spam-use-bogofilter-headers)
2224 (variable-item spam-use-bogofilter)))))
2225 :parameter-document
bf247b6e 2226 "Spam autodetection methods.
23f87bed
MB
2227Requires the spam-autodetect parameter. Only unseen articles
2228will be examined, unless spam-autodetect-recheck-messages is
2229set.")
2230
2231 (gnus-define-group-parameter
2232 spam-process-destination
2233 :type list
bf247b6e 2234 :parameter-type
23f87bed
MB
2235 '(choice :tag "Destination for spam-processed articles at summary exit"
2236 (string :tag "Move to a group")
2237 (repeat :tag "Move to multiple groups"
2238 (string :tag "Destination group"))
2239 (const :tag "Expire" nil))
2240 :function-document
2241 "Where spam-processed articles will go at summary exit."
2242 :variable gnus-spam-process-destinations
2243 :variable-default nil
2244 :variable-document
2245 "*Groups in which to explicitly send spam-processed articles to
2246another group, or expire them (the default). If non-nil, this should
2247be a list of group name regexps that should match all groups in which
2248to do spam-processed article moving, associated with the destination
2249group or nil for explicit expiration. This only makes sense for
2250mail groups."
2251 :variable-group spam
bf247b6e 2252 :variable-type
23f87bed
MB
2253 '(repeat
2254 :tag "Spam-processed articles destination"
2255 (list
2256 (regexp :tag "Group Regexp")
2257 (choice
2258 :tag "Destination for spam-processed articles at summary exit"
2259 (string :tag "Move to a group")
2260 (repeat :tag "Move to multiple groups"
2261 (string :tag "Destination group"))
2262 (const :tag "Expire" nil))))
2263 :parameter-document
2264 "Where spam-processed articles will go at summary exit.")
bf247b6e 2265
23f87bed
MB
2266 (gnus-define-group-parameter
2267 ham-process-destination
2268 :type list
bf247b6e 2269 :parameter-type
23f87bed
MB
2270 '(choice
2271 :tag "Destination for ham articles at summary exit from a spam group"
2272 (string :tag "Move to a group")
2273 (repeat :tag "Move to multiple groups"
2274 (string :tag "Destination group"))
2275 (const :tag "Respool" respool)
2276 (const :tag "Do nothing" nil))
2277 :function-document
2278 "Where ham articles will go at summary exit from a spam group."
2279 :variable gnus-ham-process-destinations
2280 :variable-default nil
2281 :variable-document
2282 "*Groups in which to explicitly send ham articles to
2283another group, or do nothing (the default). If non-nil, this should
2284be a list of group name regexps that should match all groups in which
2285to do ham article moving, associated with the destination
2286group or nil for explicit ignoring. This only makes sense for
2287mail groups, and only works in spam groups."
2288 :variable-group spam
bf247b6e 2289 :variable-type
23f87bed
MB
2290 '(repeat
2291 :tag "Ham articles destination"
2292 (list
2293 (regexp :tag "Group Regexp")
2294 (choice
2295 :tag "Destination for ham articles at summary exit from spam group"
2296 (string :tag "Move to a group")
2297 (repeat :tag "Move to multiple groups"
2298 (string :tag "Destination group"))
2299 (const :tag "Respool" respool)
2300 (const :tag "Expire" nil))))
2301 :parameter-document
2302 "Where ham articles will go at summary exit from a spam group.")
2303
2304 (gnus-define-group-parameter
2305 ham-marks
2306 :type 'list
2307 :parameter-type '(list :tag "Ham mark choices"
2308 (set
2309 (variable-item gnus-del-mark)
2310 (variable-item gnus-read-mark)
2311 (variable-item gnus-ticked-mark)
2312 (variable-item gnus-killed-mark)
2313 (variable-item gnus-kill-file-mark)
2314 (variable-item gnus-low-score-mark)))
2315
2316 :parameter-document
2317 "Marks considered ham (positively not spam). Such articles will be
2318processed as ham (non-spam) on group exit. When nil, the global
2319spam-ham-marks variable takes precedence."
2320 :variable-default '((".*" ((gnus-del-mark
2321 gnus-read-mark
2322 gnus-killed-mark
2323 gnus-kill-file-mark
2324 gnus-low-score-mark))))
2325 :variable-group spam
2326 :variable-document
2327 "*Groups in which to explicitly set the ham marks to some value.")
2328
2329 (gnus-define-group-parameter
2330 spam-marks
2331 :type 'list
2332 :parameter-type '(list :tag "Spam mark choices"
2333 (set
2334 (variable-item gnus-spam-mark)
2335 (variable-item gnus-killed-mark)
2336 (variable-item gnus-kill-file-mark)
2337 (variable-item gnus-low-score-mark)))
2338
2339 :parameter-document
2340 "Marks considered spam.
2341Such articles will be processed as spam on group exit. When nil, the global
2342spam-spam-marks variable takes precedence."
2343 :variable-default '((".*" ((gnus-spam-mark))))
2344 :variable-group spam
2345 :variable-document
2346 "*Groups in which to explicitly set the spam marks to some value."))
eec82323
LMI
2347
2348(defcustom gnus-group-uncollapsed-levels 1
2349 "Number of group name elements to leave alone when making a short group name."
2350 :group 'gnus-group-visual
2351 :type 'integer)
2352
2353(defcustom gnus-group-use-permanent-levels nil
2354 "*If non-nil, once you set a level, Gnus will use this level."
2355 :group 'gnus-group-levels
2356 :type 'boolean)
2357
2358;; Hooks.
2359
2360(defcustom gnus-load-hook nil
2361 "A hook run while Gnus is loaded."
2362 :group 'gnus-start
2363 :type 'hook)
2364
2365(defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2366 "A hook called to apply kill files to a group.
2367This hook is intended to apply a kill file to the selected newsgroup.
2368The function `gnus-apply-kill-file' is called by default.
2369
2370Since a general kill file is too heavy to use only for a few
2371newsgroups, I recommend you to use a lighter hook function. For
2372example, if you'd like to apply a kill file to articles which contains
2373a string `rmgroup' in subject in newsgroup `control', you can use the
2374following hook:
2375
2376 (setq gnus-apply-kill-hook
2377 (list
2378 (lambda ()
2379 (cond ((string-match \"control\" gnus-newsgroup-name)
2380 (gnus-kill \"Subject\" \"rmgroup\")
2381 (gnus-expunge \"X\"))))))"
2382 :group 'gnus-score-kill
2383 :options '(gnus-apply-kill-file)
2384 :type 'hook)
2385
2386(defcustom gnus-group-change-level-function nil
2387 "Function run when a group level is changed.
2388It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
16409b0b 2389 :group 'gnus-group-levels
4a2358e9
MB
2390 :type '(choice (const nil)
2391 function))
eec82323
LMI
2392
2393;;; Face thingies.
2394
2395(defcustom gnus-visual
2396 '(summary-highlight group-highlight article-highlight
2397 mouse-face
2398 summary-menu group-menu article-menu
2399 tree-highlight menu highlight
2400 browse-menu server-menu
01c52d31 2401 page-marker tree-menu binary-menu pick-menu)
6748645f 2402 "*Enable visual features.
eec82323
LMI
2403If `visual' is disabled, there will be no menus and few faces. Most of
2404the visual customization options below will be ignored. Gnus will use
2405less space and be faster as a result.
2406
2407This variable can also be a list of visual elements to switch on. For
2408instance, to switch off all visual things except menus, you can say:
2409
2410 (setq gnus-visual '(menu))
2411
2412Valid elements include `summary-highlight', `group-highlight',
2413`article-highlight', `mouse-face', `summary-menu', `group-menu',
2414`article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
01c52d31 2415`server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
eec82323
LMI
2416 :group 'gnus-meta
2417 :group 'gnus-visual
2418 :type '(set (const summary-highlight)
2419 (const group-highlight)
2420 (const article-highlight)
2421 (const mouse-face)
2422 (const summary-menu)
2423 (const group-menu)
2424 (const article-menu)
2425 (const tree-highlight)
2426 (const menu)
2427 (const highlight)
2428 (const browse-menu)
2429 (const server-menu)
2430 (const page-marker)
2431 (const tree-menu)
2432 (const binary-menu)
01c52d31 2433 (const pick-menu)))
eec82323 2434
23f87bed
MB
2435;; Byte-compiler warning.
2436(defvar gnus-visual)
2437;; Find out whether the gnus-visual TYPE is wanted.
2438(defun gnus-visual-p (&optional type class)
2439 (and gnus-visual ; Has to be non-nil, at least.
2440 (if (not type) ; We don't care about type.
2441 gnus-visual
2442 (if (listp gnus-visual) ; It's a list, so we check it.
2443 (or (memq type gnus-visual)
2444 (memq class gnus-visual))
2445 t))))
2446
eec82323
LMI
2447(defcustom gnus-mouse-face
2448 (condition-case ()
2449 (if (gnus-visual-p 'mouse-face 'highlight)
2450 (if (boundp 'gnus-mouse-face)
2451 (or gnus-mouse-face 'highlight)
2452 'highlight)
2453 'default)
2454 (error 'highlight))
6748645f 2455 "*Face used for group or summary buffer mouse highlighting.
eec82323
LMI
2456The line beneath the mouse pointer will be highlighted with this
2457face."
2458 :group 'gnus-visual
2459 :type 'face)
2460
eec82323
LMI
2461(defcustom gnus-article-save-directory gnus-directory
2462 "*Name of the directory articles will be saved in (default \"~/News\")."
2463 :group 'gnus-article-saving
2464 :type 'directory)
2465
6748645f
LMI
2466(defvar gnus-plugged t
2467 "Whether Gnus is plugged or not.")
2468
23f87bed
MB
2469(defcustom gnus-agent-cache t
2470 "Controls use of the agent cache while plugged.
2471When set, Gnus will prefer using the locally stored content rather
2472than re-fetching it from the server. You also need to enable
2473`gnus-agent' for this to have any affect."
bf247b6e 2474 :version "22.1"
23f87bed
MB
2475 :group 'gnus-agent
2476 :type 'boolean)
2477
2478(defcustom gnus-default-charset 'undecided
16409b0b
GM
2479 "Default charset assumed to be used when viewing non-ASCII characters.
2480This variable is overridden on a group-to-group basis by the
23f87bed 2481`gnus-group-charset-alist' variable and is only used on groups not
16409b0b
GM
2482covered by that variable."
2483 :type 'symbol
2484 :group 'gnus-charset)
2485
23f87bed
MB
2486;; Fixme: Doc reference to agent.
2487(defcustom gnus-agent t
2488 "Whether we want to use the Gnus agent or not.
2489
2490You may customize gnus-agent to disable its use. However, some
2491back ends have started to use the agent as a client-side cache.
2492Disabling the agent may result in noticeable loss of performance."
bf247b6e 2493 :version "22.1"
23f87bed
MB
2494 :group 'gnus-agent
2495 :type 'boolean)
2496
2497(defcustom gnus-other-frame-function 'gnus
2498 "Function called by the command `gnus-other-frame'."
2499 :group 'gnus-start
2500 :type '(choice (function-item gnus)
2501 (function-item gnus-no-server)
2502 (function-item gnus-slave)
2503 (function-item gnus-slave-no-server)))
2504
2505(defcustom gnus-other-frame-parameters nil
2506 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2507This should be an alist for Emacs, or a plist for XEmacs."
2508 :group 'gnus-start
2509 :type (if (featurep 'xemacs)
2510 '(repeat (list :inline t :format "%v"
2511 (symbol :tag "Property")
2512 (sexp :tag "Value")))
2513 '(repeat (cons :format "%v"
2514 (symbol :tag "Parameter")
2515 (sexp :tag "Value")))))
2516
4a2358e9 2517(defcustom gnus-user-agent '(emacs gnus type)
23f87bed
MB
2518 "Which information should be exposed in the User-Agent header.
2519
4a2358e9
MB
2520Can be a list of symbols or a string. Valid symbols are `gnus'
2521\(show Gnus version\) and `emacs' \(show Emacs version\). In
2522addition to the Emacs version, you can add `codename' \(show
2523\(S\)XEmacs codename\) or either `config' \(show system
2524configuration\) or `type' \(show system type\). If you set it to
2525a string, be sure to use a valid format, see RFC 2616."
2526
bf247b6e 2527 :version "22.1"
23f87bed 2528 :group 'gnus-message
4a2358e9
MB
2529 :type '(choice (list (set :inline t
2530 (const gnus :tag "Gnus version")
2531 (const emacs :tag "Emacs version")
2532 (choice :tag "system"
2533 (const type :tag "system type")
2534 (const config :tag "system configuration"))
2535 (const codename :tag "Emacs codename")))
2536 (string)))
2537
01c52d31 2538;; Convert old (< 2005-01-10) symbol type values:
4a2358e9
MB
2539(when (symbolp gnus-user-agent)
2540 (setq gnus-user-agent
2541 (cond ((eq gnus-user-agent 'emacs-gnus-config)
2542 '(emacs gnus config))
2543 ((eq gnus-user-agent 'emacs-gnus-type)
2544 '(emacs gnus type))
2545 ((eq gnus-user-agent 'emacs-gnus)
2546 '(emacs gnus))
2547 ((eq gnus-user-agent 'gnus)
2548 '(gnus))
2549 (t gnus-user-agent)))
2550 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2551 (sit-for 1)
2552 (if (get 'gnus-user-agent 'saved-value)
2553 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2554 (gnus-message 1 "Edit your init file to make this change permanent.")
2555 (sit-for 2)))
16409b0b 2556
eec82323
LMI
2557\f
2558;;; Internal variables
2559
48df946a 2560(defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
16409b0b 2561(defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
23f87bed
MB
2562(defvar gnus-agent-method-p-cache nil
2563 ; Reset each time gnus-agent-covered-methods is changed else
2564 ; gnus-agent-method-p may mis-report a methods status.
2565 )
2566(defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2567(defvar gnus-draft-meta-information-header "X-Draft-From")
eec82323
LMI
2568(defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2569(defvar gnus-original-article-buffer " *Original Article*")
2570(defvar gnus-newsgroup-name nil)
6748645f 2571(defvar gnus-ephemeral-servers nil)
23f87bed 2572(defvar gnus-server-method-cache nil)
0617bb00 2573(defvar gnus-extended-servers nil)
6748645f 2574
3d319c8f 2575;; The carpal mode has been removed, but define the variable for
01c35094 2576;; backwards compatibility.
3d319c8f
LMI
2577(defvar gnus-carpal nil)
2578(make-obsolete-variable 'gnus-carpal nil "Emacs 24.1")
2579
48df946a
DL
2580(defvar gnus-agent-fetching nil
2581 "Whether Gnus agent is in fetching mode.")
2582
23f87bed
MB
2583(defvar gnus-agent-covered-methods nil
2584 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2585
6748645f 2586(defvar gnus-command-method nil
23f87bed 2587 "Dynamically bound variable that says what the current back end is.")
eec82323
LMI
2588
2589(defvar gnus-current-select-method nil
2590 "The current method for selecting a newsgroup.")
2591
2592(defvar gnus-tree-buffer "*Tree*"
2593 "Buffer where Gnus thread trees are displayed.")
2594
eec82323
LMI
2595;; Variable holding the user answers to all method prompts.
2596(defvar gnus-method-history nil)
eec82323
LMI
2597
2598;; Variable holding the user answers to all mail method prompts.
2599(defvar gnus-mail-method-history nil)
2600
2601;; Variable holding the user answers to all group prompts.
2602(defvar gnus-group-history nil)
2603
2604(defvar gnus-server-alist nil
2605 "List of available servers.")
2606
6748645f
LMI
2607(defcustom gnus-cache-directory
2608 (nnheader-concat gnus-directory "cache/")
2609 "*The directory where cached articles will be stored."
2610 :group 'gnus-cache
2611 :type 'directory)
2612
eec82323
LMI
2613(defvar gnus-predefined-server-alist
2614 `(("cache"
6748645f
LMI
2615 nnspool "cache"
2616 (nnspool-spool-directory ,gnus-cache-directory)
2617 (nnspool-nov-directory ,gnus-cache-directory)
2618 (nnspool-active-file
2619 ,(nnheader-concat gnus-cache-directory "active"))))
eec82323
LMI
2620 "List of predefined (convenience) servers.")
2621
eec82323
LMI
2622(defconst gnus-article-mark-lists
2623 '((marked . tick) (replied . reply)
2624 (expirable . expire) (killed . killed)
2625 (bookmarks . bookmark) (dormant . dormant)
2626 (scored . score) (saved . save)
6748645f 2627 (cached . cache) (downloadable . download)
23f87bed 2628 (unsendable . unsend) (forwarded . forward)
e21bac42 2629 (seen . seen)))
23f87bed
MB
2630
2631(defconst gnus-article-special-mark-lists
2632 '((seen range)
2633 (killed range)
2634 (bookmark tuple)
20a673b2
KY
2635 (uid tuple)
2636 (active tuple)
23f87bed
MB
2637 (score tuple)))
2638
2639;; Propagate flags to server, with the following exceptions:
2640;; `seen' is private to each gnus installation
2641;; `cache' is a internal gnus flag for each gnus installation
2642;; `download' is a agent flag private to each gnus installation
2643;; `unsend' are for nndraft groups only
2644;; `score' is not a proper mark
2645;; `bookmark': don't propagated it, or fix the bug in update-mark.
2646(defconst gnus-article-unpropagated-mark-lists
2647 '(seen cache download unsend score bookmark)
2648 "Marks that shouldn't be propagated to back ends.
2649Typical marks are those that make no sense in a standalone back end,
2650such as a mark that says whether an article is stored in the cache
2651\(which doesn't make sense in a standalone back end).")
eec82323
LMI
2652
2653(defvar gnus-headers-retrieved-by nil)
2654(defvar gnus-article-reply nil)
2655(defvar gnus-override-method nil)
eec82323
LMI
2656(defvar gnus-opened-servers nil)
2657
2658(defvar gnus-current-kill-article nil)
2659
2660(defvar gnus-have-read-active-file nil)
2661
2662(defconst gnus-maintainer
8b7fba43 2663 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
eec82323
LMI
2664 "The mail address of the Gnus maintainers.")
2665
8b7fba43
TZ
2666(defconst gnus-bug-package
2667 "gnus"
2668 "The package to use in the bug submission.")
2669
eec82323 2670(defvar gnus-info-nodes
23f87bed
MB
2671 '((gnus-group-mode "(gnus)Group Buffer")
2672 (gnus-summary-mode "(gnus)Summary Buffer")
2673 (gnus-article-mode "(gnus)Article Buffer")
2674 (gnus-server-mode "(gnus)Server Buffer")
eec82323
LMI
2675 (gnus-browse-mode "(gnus)Browse Foreign Server")
2676 (gnus-tree-mode "(gnus)Tree Display"))
2677 "Alist of major modes and related Info nodes.")
2678
2679(defvar gnus-group-buffer "*Group*")
2680(defvar gnus-summary-buffer "*Summary*")
2681(defvar gnus-article-buffer "*Article*")
2682(defvar gnus-server-buffer "*Server*")
2683
eec82323
LMI
2684(defvar gnus-slave nil
2685 "Whether this Gnus is a slave or not.")
2686
2687(defvar gnus-batch-mode nil
2688 "Whether this Gnus is running in batch mode or not.")
2689
2690(defvar gnus-variable-list
2691 '(gnus-newsrc-options gnus-newsrc-options-n
16409b0b
GM
2692 gnus-newsrc-last-checked-date
2693 gnus-newsrc-alist gnus-server-alist
2694 gnus-killed-list gnus-zombie-list
e21bac42 2695 gnus-topic-topology gnus-topic-alist)
eec82323
LMI
2696 "Gnus variables saved in the quick startup file.")
2697
2698(defvar gnus-newsrc-alist nil
2699 "Assoc list of read articles.
23f87bed
MB
2700`gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2701
2702(defvar gnus-registry-alist nil
2703 "Assoc list of registry data.
2704gnus-registry.el will populate this if it's loaded.")
eec82323
LMI
2705
2706(defvar gnus-newsrc-hashtb nil
23f87bed 2707 "Hashtable of `gnus-newsrc-alist'.")
eec82323
LMI
2708
2709(defvar gnus-killed-list nil
2710 "List of killed newsgroups.")
2711
2712(defvar gnus-killed-hashtb nil
23f87bed 2713 "Hash table equivalent of `gnus-killed-list'.")
eec82323
LMI
2714
2715(defvar gnus-zombie-list nil
2716 "List of almost dead newsgroups.")
2717
2718(defvar gnus-description-hashtb nil
2719 "Descriptions of newsgroups.")
2720
2721(defvar gnus-list-of-killed-groups nil
2722 "List of newsgroups that have recently been killed by the user.")
2723
2724(defvar gnus-active-hashtb nil
2725 "Hashtable of active articles.")
2726
2727(defvar gnus-moderated-hashtb nil
2728 "Hashtable of moderated newsgroups.")
2729
2730;; Save window configuration.
2731(defvar gnus-prev-winconf nil)
2732
2733(defvar gnus-reffed-article-number nil)
2734
eec82323
LMI
2735(defvar gnus-dead-summary nil)
2736
16409b0b
GM
2737(defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2738 "Regexp matching invalid groups.")
2739
23f87bed
MB
2740(defvar gnus-other-frame-object nil
2741 "A frame object which will be created by `gnus-other-frame'.")
2742
eec82323
LMI
2743;;; End of variables.
2744
2745;; Define some autoload functions Gnus might use.
2746(eval-and-compile
2747
2748 ;; This little mapcar goes through the list below and marks the
2749 ;; symbols in question as autoloaded functions.
01c52d31 2750 (mapc
eec82323
LMI
2751 (lambda (package)
2752 (let ((interactive (nth 1 (memq ':interactive package))))
2753 (mapcar
2754 (lambda (function)
2755 (let (keymap)
2756 (when (consp function)
2757 (setq keymap (car (memq 'keymap function)))
2758 (setq function (car function)))
16409b0b
GM
2759 (unless (fboundp function)
2760 (autoload function (car package) nil interactive keymap))))
eec82323 2761 (if (eq (nth 1 package) ':interactive)
16409b0b 2762 (nthcdr 3 package)
eec82323 2763 (cdr package)))))
16409b0b 2764 '(("info" :interactive t Info-goto-node)
ceaed79b 2765 ("pp" pp-to-string)
16409b0b 2766 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
eec82323 2767 ("ps-print" ps-print-preprint)
eec82323
LMI
2768 ("message" :interactive t
2769 message-send-and-exit message-yank-original)
16409b0b
GM
2770 ("babel" babel-as-string)
2771 ("nnmail" nnmail-split-fancy nnmail-article-group)
eec82323 2772 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
fe1f089f
GM
2773 ;; This is only used in message.el, which has an autoload.
2774 ("rmailout" rmail-output)
2775 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2776 ("rmail" rmail-count-new-messages rmail-show-message
2777 ;; Next two only used in gnus-util.
2778 rmail-summary-exists rmail-select-summary)
2779 ;; Only used in gnus-util, which has an autoload.
2780 ("rmailsum" rmail-update-summary)
eec82323 2781 ("gnus-xmas" gnus-xmas-splash)
eec82323
LMI
2782 ("score-mode" :interactive t gnus-score-mode)
2783 ("gnus-mh" gnus-summary-save-article-folder
2784 gnus-Folder-save-name gnus-folder-save-name)
2785 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
8ccbef23 2786 ("gnus-demon" gnus-demon-add-scanmail
eec82323
LMI
2787 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2788 gnus-demon-add-disconnection gnus-demon-add-handler
2789 gnus-demon-remove-handler)
2790 ("gnus-demon" :interactive t
2791 gnus-demon-init gnus-demon-cancel)
23f87bed
MB
2792 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2793 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2794 gnus-face-from-file)
eec82323 2795 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
71e691a5 2796 gnus-tree-open gnus-tree-close)
6748645f
LMI
2797 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2798 gnus-server-server-name)
eec82323
LMI
2799 ("gnus-srvr" gnus-browse-foreign-server)
2800 ("gnus-cite" :interactive t
2801 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2802 gnus-article-hide-citation gnus-article-fill-cited-article
389b76fa
G
2803 gnus-article-hide-citation-in-followups
2804 gnus-article-fill-cited-long-lines)
eec82323
LMI
2805 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2806 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
16409b0b 2807 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
89b163db
G
2808 ("gnus-registry" gnus-try-warping-via-registry
2809 gnus-registry-handle-action)
eec82323
LMI
2810 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2811 gnus-cache-possibly-remove-articles gnus-cache-request-article
2812 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2813 gnus-cache-enter-remove-article gnus-cached-article-p
16409b0b
GM
2814 gnus-cache-open gnus-cache-close gnus-cache-update-article
2815 gnus-cache-articles-in-group)
2816 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2817 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2818 ("gnus-score" :interactive t
2819 gnus-summary-increase-score gnus-summary-set-score
2820 gnus-summary-raise-thread gnus-summary-raise-same-subject
2821 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2822 gnus-summary-lower-thread gnus-summary-lower-same-subject
2823 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2824 gnus-summary-current-score gnus-score-delta-default
2825 gnus-score-flush-cache gnus-score-close
2826 gnus-possibly-score-headers gnus-score-followup-article
2827 gnus-score-followup-thread)
2828 ("gnus-score"
2829 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
eec82323
LMI
2830 gnus-current-score-file-nondirectory gnus-score-adaptive
2831 gnus-score-find-trace gnus-score-file-name)
2832 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2833 ("gnus-topic" :interactive t gnus-topic-mode)
16409b0b
GM
2834 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2835 gnus-subscribe-topics)
eec82323
LMI
2836 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2837 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2838 ("gnus-uu" :interactive t
2839 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2840 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2841 gnus-uu-mark-by-regexp gnus-uu-mark-all
2842 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2843 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2844 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2845 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2846 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2847 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
6748645f 2848 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
01c52d31 2849 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
16409b0b 2850 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
eec82323
LMI
2851 ("gnus-msg" (gnus-summary-send-map keymap)
2852 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2853 ("gnus-msg" :interactive t
23f87bed
MB
2854 gnus-group-post-news gnus-group-mail gnus-group-news
2855 gnus-summary-post-news gnus-summary-news-other-window
eec82323
LMI
2856 gnus-summary-followup gnus-summary-followup-with-original
2857 gnus-summary-cancel-article gnus-summary-supersede-article
2858 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2859 gnus-summary-mail-forward gnus-summary-mail-other-window
2860 gnus-summary-resend-message gnus-summary-resend-bounced-mail
6748645f
LMI
2861 gnus-summary-wide-reply gnus-summary-followup-to-mail
2862 gnus-summary-followup-to-mail-with-original gnus-bug
2863 gnus-summary-wide-reply-with-original
2864 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2865 gnus-summary-post-forward)
23f87bed 2866 ("gnus-picon" :interactive t gnus-treat-from-picon)
23f87bed 2867 ("smiley" :interactive t smiley-region)
eec82323
LMI
2868 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2869 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2870 gnus-list-of-unread-articles gnus-list-of-read-articles
2871 gnus-offer-save-summaries gnus-make-thread-indent-array
6748645f
LMI
2872 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2873 gnus-summary-skip-intangible gnus-summary-article-number
2874 gnus-data-header gnus-data-find)
eec82323
LMI
2875 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2876 gnus-group-list-groups gnus-group-first-unread-group
2877 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2878 gnus-group-setup-buffer gnus-group-get-new-news
6748645f 2879 gnus-group-make-help-group gnus-group-update-group
16409b0b 2880 gnus-group-iterate gnus-group-group-name)
eec82323
LMI
2881 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2882 gnus-backlog-remove-article)
2883 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2884 gnus-article-prepare gnus-article-set-window-start
2885 gnus-article-next-page gnus-article-prev-page
2886 gnus-request-article-this-buffer gnus-article-mode
2887 gnus-article-setup-buffer gnus-narrow-to-page
16409b0b 2888 gnus-article-delete-invisible-text gnus-treat-article)
eec82323
LMI
2889 ("gnus-art" :interactive t
2890 gnus-article-hide-headers gnus-article-hide-boring-headers
16409b0b 2891 gnus-article-treat-overstrike
eec82323
LMI
2892 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2893 gnus-article-display-x-face gnus-article-de-quoted-unreadable
16409b0b
GM
2894 gnus-article-de-base64-unreadable
2895 gnus-article-decode-HZ
2896 gnus-article-wash-html
23f87bed 2897 gnus-article-unsplit-urls
eec82323
LMI
2898 gnus-article-hide-pem gnus-article-hide-signature
2899 gnus-article-strip-leading-blank-lines gnus-article-date-local
2900 gnus-article-date-original gnus-article-date-lapsed
01c52d31 2901 ;;gnus-article-show-all-headers
eec82323 2902 gnus-article-edit-mode gnus-article-edit-article
16409b0b
GM
2903 gnus-article-edit-done gnus-article-decode-encoded-words
2904 gnus-start-date-timer gnus-stop-date-timer
2905 gnus-mime-view-all-parts)
eec82323
LMI
2906 ("gnus-int" gnus-request-type)
2907 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
01c52d31
MB
2908 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2909 gnus-check-reasonable-setup)
eec82323
LMI
2910 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2911 gnus-dup-enter-articles)
2912 ("gnus-range" gnus-copy-sequence)
2913 ("gnus-eform" gnus-edit-form)
eec82323
LMI
2914 ("gnus-logic" gnus-score-advanced)
2915 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2916 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2917 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2918 gnus-async-halt-prefetch)
6748645f 2919 ("gnus-agent" gnus-open-agent gnus-agent-get-function
fa9a04e1 2920 gnus-agent-save-active gnus-agent-method-p
6748645f 2921 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
23f87bed 2922 gnus-summary-set-agent-mark gnus-agent-save-group-info
f3b146e9
LMI
2923 gnus-agent-request-article gnus-agent-retrieve-headers
2924 gnus-agent-store-article gnus-agent-group-covered-p)
6748645f
LMI
2925 ("gnus-agent" :interactive t
2926 gnus-unplugged gnus-agentize gnus-agent-batch)
eec82323 2927 ("gnus-vm" :interactive t gnus-summary-save-in-vm
6748645f 2928 gnus-summary-save-article-vm)
23f87bed
MB
2929 ("compface" uncompface)
2930 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
16409b0b
GM
2931 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2932 ("gnus-mlspl" :interactive t gnus-group-split-setup
23f87bed
MB
2933 gnus-group-split-update)
2934 ("gnus-delay" gnus-delay-initialize))))
eec82323
LMI
2935
2936;;; gnus-sum.el thingies
2937
2938
23f87bed 2939(defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323
LMI
2940 "*The format specification of the lines in the summary buffer.
2941
2942It works along the same lines as a normal formatting string,
2943with some simple extensions.
2944
0d1c2cc8
G
2945%N Article number, left padded with spaces (string)
2946%S Subject (string)
2947%s Subject if it is at the root of a thread, and \"\"
2948 otherwise (string)
2949%n Name of the poster (string)
2950%a Extracted name of the poster (string)
2951%A Extracted address of the poster (string)
2952%F Contents of the From: header (string)
2953%f Contents of the From: or To: headers (string)
2954%x Contents of the Xref: header (string)
2955%D Date of the article (string)
2956%d Date of the article (string) in DD-MMM format
2957%o Date of the article (string) in YYYYMMDD`T'HHMMSS
2958 format
2959%M Message-id of the article (string)
2960%r References of the article (string)
2961%c Number of characters in the article (integer)
2962%k Pretty-printed version of the above (string)
2963 For example, \"1.2k\" or \"0.4M\".
2964%L Number of lines in the article (integer)
2965%I Indentation based on thread level (a string of
2966 spaces)
2967%B A complex trn-style thread tree (string)
2968 The variables `gnus-sum-thread-*' can be used for
2969 customization.
2970%T A string with two possible values: 80 spaces if the
2971 article is on thread level two or larger and 0 spaces
2972 on level one
2973%R \"A\" if this article has been replied to, \" \"
2974 otherwise (character)
cd865a33 2975%U \"Read\" status of this article.
509542f3 2976 See Info node `(gnus)Marking Articles'
0d1c2cc8
G
2977%[ Opening bracket (character, \"[\" or \"<\")
2978%] Closing bracket (character, \"]\" or \">\")
2979%> Spaces of length thread-level (string)
2980%< Spaces of length (- 20 thread-level) (string)
2981%i Article score (number)
2982%z Article zcore (character)
2983%t Number of articles under the current thread (number).
2984%e Whether the thread is empty or not (character).
2985%V Total thread score (number).
2986%P The line number (number).
2987%O Download mark (character).
2988%* If present, indicates desired cursor position
2989 (instead of after first colon).
2990%u User defined specifier. The next character in the
2991 format string should be a letter. Gnus will call the
2992 function gnus-user-format-function-X, where X is the
2993 letter following %u. The function will be passed the
2994 current header as argument. The function should
2995 return a string, which will be inserted into the
2996 summary just like information from any other summary
2997 specifier.
2998&user-date; Age sensitive date format. Various date format is
2999 defined in `gnus-summary-user-date-format-alist'.
3000
eec82323 3001
eec82323
LMI
3002The %U (status), %R (replied) and %z (zcore) specs have to be handled
3003with care. For reasons of efficiency, Gnus will compute what column
3004these characters will end up in, and \"hard-code\" that. This means that
65a32076 3005it is invalid to have these specs after a variable-length spec. Well,
eec82323
LMI
3006you might not be arrested, but your summary buffer will look strange,
3007which is bad enough.
3008
23f87bed 3009The smart choice is to have these specs as far to the left as
eec82323
LMI
3010possible.
3011
23f87bed
MB
3012This restriction may disappear in later versions of Gnus.
3013
3014General format specifiers can also be used.
3015See Info node `(gnus)Formatting Variables'."
3016 :link '(custom-manual "(gnus)Formatting Variables")
eec82323
LMI
3017 :type 'string
3018 :group 'gnus-summary-format)
3019
3020;;;
3021;;; Skeleton keymaps
3022;;;
3023
3024(defun gnus-suppress-keymap (keymap)
3025 (suppress-keymap keymap)
6748645f 3026 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
eec82323
LMI
3027 (while keys
3028 (define-key keymap (pop keys) 'undefined))))
3029
3030(defvar gnus-article-mode-map
16409b0b 3031 (let ((keymap (make-sparse-keymap)))
eec82323
LMI
3032 (gnus-suppress-keymap keymap)
3033 keymap))
3034(defvar gnus-summary-mode-map
3035 (let ((keymap (make-keymap)))
3036 (gnus-suppress-keymap keymap)
3037 keymap))
3038(defvar gnus-group-mode-map
3039 (let ((keymap (make-keymap)))
3040 (gnus-suppress-keymap keymap)
3041 keymap))
3042
3043\f
3044
3045;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3046;; If you want the cursor to go somewhere else, set these two
3047;; functions in some startup hook to whatever you want.
3048(defalias 'gnus-summary-position-point 'gnus-goto-colon)
3049(defalias 'gnus-group-position-point 'gnus-goto-colon)
3050
3051;;; Various macros and substs.
3052
3053(defun gnus-header-from (header)
3054 (mail-header-from header))
3055
3056(defmacro gnus-gethash (string hashtable)
3057 "Get hash value of STRING in HASHTABLE."
3058 `(symbol-value (intern-soft ,string ,hashtable)))
3059
23f87bed
MB
3060(defmacro gnus-gethash-safe (string hashtable)
3061 "Get hash value of STRING in HASHTABLE.
3062Return nil if not defined."
3063 `(let ((sym (intern-soft ,string ,hashtable)))
3064 (and (boundp sym) (symbol-value sym))))
3065
eec82323
LMI
3066(defmacro gnus-sethash (string value hashtable)
3067 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3068 `(set (intern ,string ,hashtable) ,value))
3069(put 'gnus-sethash 'edebug-form-spec '(form form form))
3070
3071(defmacro gnus-group-unread (group)
3072 "Get the currently computed number of unread articles in GROUP."
3073 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3074
3075(defmacro gnus-group-entry (group)
3076 "Get the newsrc entry for GROUP."
3077 `(gnus-gethash ,group gnus-newsrc-hashtb))
3078
3079(defmacro gnus-active (group)
3080 "Get active info on GROUP."
3081 `(gnus-gethash ,group gnus-active-hashtb))
3082
3083(defmacro gnus-set-active (group active)
3084 "Set GROUP's active info."
3085 `(gnus-sethash ,group ,active gnus-active-hashtb))
3086
eec82323
LMI
3087;; Info access macros.
3088
3089(defmacro gnus-info-group (info)
3090 `(nth 0 ,info))
3091(defmacro gnus-info-rank (info)
3092 `(nth 1 ,info))
3093(defmacro gnus-info-read (info)
3094 `(nth 2 ,info))
3095(defmacro gnus-info-marks (info)
3096 `(nth 3 ,info))
3097(defmacro gnus-info-method (info)
3098 `(nth 4 ,info))
3099(defmacro gnus-info-params (info)
3100 `(nth 5 ,info))
3101
3102(defmacro gnus-info-level (info)
3103 `(let ((rank (gnus-info-rank ,info)))
3104 (if (consp rank)
3105 (car rank)
3106 rank)))
3107(defmacro gnus-info-score (info)
3108 `(let ((rank (gnus-info-rank ,info)))
3109 (or (and (consp rank) (cdr rank)) 0)))
3110
3111(defmacro gnus-info-set-group (info group)
3112 `(setcar ,info ,group))
3113(defmacro gnus-info-set-rank (info rank)
3114 `(setcar (nthcdr 1 ,info) ,rank))
3115(defmacro gnus-info-set-read (info read)
3116 `(setcar (nthcdr 2 ,info) ,read))
3117(defmacro gnus-info-set-marks (info marks &optional extend)
3118 (if extend
3119 `(gnus-info-set-entry ,info ,marks 3)
3120 `(setcar (nthcdr 3 ,info) ,marks)))
3121(defmacro gnus-info-set-method (info method &optional extend)
3122 (if extend
3123 `(gnus-info-set-entry ,info ,method 4)
3124 `(setcar (nthcdr 4 ,info) ,method)))
3125(defmacro gnus-info-set-params (info params &optional extend)
3126 (if extend
3127 `(gnus-info-set-entry ,info ,params 5)
3128 `(setcar (nthcdr 5 ,info) ,params)))
3129
3130(defun gnus-info-set-entry (info entry number)
3131 ;; Extend the info until we have enough elements.
3132 (while (<= (length info) number)
3133 (nconc info (list nil)))
3134 ;; Set the entry.
3135 (setcar (nthcdr number info) entry))
3136
3137(defmacro gnus-info-set-level (info level)
3138 `(let ((rank (cdr ,info)))
3139 (if (consp (car rank))
3140 (setcar (car rank) ,level)
3141 (setcar rank ,level))))
3142(defmacro gnus-info-set-score (info score)
3143 `(let ((rank (cdr ,info)))
3144 (if (consp (car rank))
3145 (setcdr (car rank) ,score)
3146 (setcar rank (cons (car rank) ,score)))))
3147
3148(defmacro gnus-get-info (group)
3149 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3150
85e75ded
LI
3151(defun gnus-set-info (group info)
3152 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3153 info))
3154
8f688cb0 3155;;; Load the compatibility functions.
eec82323
LMI
3156
3157(require 'gnus-ems)
3158
3159\f
3160;;;
3161;;; Shutdown
3162;;;
3163
3164(defvar gnus-shutdown-alist nil)
3165
3166(defun gnus-add-shutdown (function &rest symbols)
3167 "Run FUNCTION whenever one of SYMBOLS is shut down."
3168 (push (cons function symbols) gnus-shutdown-alist))
3169
3170(defun gnus-shutdown (symbol)
3171 "Shut down everything that waits for SYMBOL."
01c52d31
MB
3172 (dolist (entry gnus-shutdown-alist)
3173 (when (memq symbol (cdr entry))
3174 (funcall (car entry)))))
eec82323
LMI
3175
3176\f
3177;;;
3178;;; Gnus Utility Functions
3179;;;
3180
23f87bed
MB
3181(defun gnus-find-subscribed-addresses ()
3182 "Return a regexp matching the addresses of all subscribed mail groups.
3183It consists of the `to-address' or `to-list' parameter of all groups
3184with a `subscribed' parameter."
3185 (let (group address addresses)
3186 (dolist (entry (cdr gnus-newsrc-alist))
3187 (setq group (car entry))
3188 (when (gnus-parameter-subscribed group)
3189 (setq address (mail-strip-quoted-names
3190 (or (gnus-group-fast-parameter group 'to-address)
3191 (gnus-group-fast-parameter group 'to-list))))
3192 (when address
3193 (add-to-list 'addresses address))))
3194 (when addresses
3195 (list (mapconcat 'regexp-quote addresses "\\|")))))
6748645f 3196
a8151ef7
LMI
3197(defmacro gnus-string-or (&rest strings)
3198 "Return the first element of STRINGS that is a non-blank string.
3199STRINGS will be evaluated in normal `or' order."
075843d3 3200 `(gnus-string-or-1 (list ,@strings)))
a8151ef7
LMI
3201
3202(defun gnus-string-or-1 (strings)
3203 (let (string)
3204 (while strings
075843d3 3205 (setq string (pop strings))
a8151ef7
LMI
3206 (if (string-match "^[ \t]*$" string)
3207 (setq string nil)
3208 (setq strings nil)))
3209 string))
3210
eec82323
LMI
3211(defun gnus-version (&optional arg)
3212 "Version number of this version of Gnus.
3213If ARG, insert string at point."
3214 (interactive "P")
6748645f
LMI
3215 (if arg
3216 (insert (message gnus-version))
3217 (message gnus-version)))
eec82323 3218
23f87bed 3219(defun gnus-continuum-version (&optional version)
eec82323 3220 "Return VERSION as a floating point number."
23f87bed
MB
3221 (unless version
3222 (setq version gnus-version))
eec82323
LMI
3223 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3224 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
6748645f
LMI
3225 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3226 (number (match-string 2 version))
3227 major minor least)
3228 (unless (string-match
3229 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3230 (error "Invalid version string: %s" version))
3231 (setq major (string-to-number (match-string 1 number))
3232 minor (string-to-number (match-string 2 number))
3233 least (if (match-beginning 3)
eec82323
LMI
3234 (string-to-number (match-string 3 number))
3235 0))
3236 (string-to-number
3237 (if (zerop major)
23f87bed
MB
3238 (format "%s00%02d%02d"
3239 (if (member alpha '("(ding)" "d"))
3240 "4.99"
3241 (+ 5 (* 0.02
3242 (abs
3243 (- (mm-char-int (aref (downcase alpha) 0))
3244 (mm-char-int ?t))))
3245 -0.01))
3246 minor least)
eec82323
LMI
3247 (format "%d.%02d%02d" major minor least))))))
3248
23f87bed 3249(defun gnus-info-find-node (&optional nodename)
eec82323
LMI
3250 "Find Info documentation of Gnus."
3251 (interactive)
3252 ;; Enlarge info window if needed.
3253 (let (gnus-info-buffer)
23f87bed 3254 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
eec82323
LMI
3255 (setq gnus-info-buffer (current-buffer))
3256 (gnus-configure-windows 'info)))
3257
6748645f
LMI
3258;;;
3259;;; gnus-interactive
3260;;;
3261
3262(defvar gnus-current-prefix-symbol nil
3263 "Current prefix symbol.")
3264
3265(defvar gnus-current-prefix-symbols nil
3266 "List of current prefix symbols.")
3267
3268(defun gnus-interactive (string &optional params)
3269 "Return a list that can be fed to `interactive'.
3270See `interactive' for full documentation.
3271
3272Adds the following specs:
3273
3274y -- The current symbolic prefix.
3275Y -- A list of the current symbolic prefix(es).
3276A -- Article number.
3277H -- Article header.
3278g -- Group name."
3279 (let ((i 0)
3280 out c prompt)
3281 (while (< i (length string))
3282 (string-match ".\\([^\n]*\\)\n?" string i)
3283 (setq c (aref string i))
3284 (when (match-end 1)
3285 (setq prompt (match-string 1 string)))
3286 (setq i (match-end 0))
3287 ;; We basically emulate just about everything that
3288 ;; `interactive' does, but add the specs listed above.
3289 (push
3290 (cond
3291 ((= c ?a)
3292 (completing-read prompt obarray 'fboundp t))
3293 ((= c ?b)
3294 (read-buffer prompt (current-buffer) t))
3295 ((= c ?B)
3296 (read-buffer prompt (other-buffer (current-buffer))))
3297 ((= c ?c)
3298 (read-char))
3299 ((= c ?C)
3300 (completing-read prompt obarray 'commandp t))
3301 ((= c ?d)
3302 (point))
3303 ((= c ?D)
7e27ce9c 3304 (read-directory-name prompt nil default-directory 'lambda))
6748645f
LMI
3305 ((= c ?f)
3306 (read-file-name prompt nil nil 'lambda))
3307 ((= c ?F)
3308 (read-file-name prompt))
3309 ((= c ?k)
3310 (read-key-sequence prompt))
3311 ((= c ?K)
3312 (error "Not implemented spec"))
3313 ((= c ?e)
3314 (error "Not implemented spec"))
3315 ((= c ?m)
3316 (mark))
3317 ((= c ?N)
3318 (error "Not implemented spec"))
3319 ((= c ?n)
3320 (string-to-number (read-from-minibuffer prompt)))
3321 ((= c ?p)
3322 (prefix-numeric-value current-prefix-arg))
3323 ((= c ?P)
3324 current-prefix-arg)
3325 ((= c ?r)
3326 'gnus-prefix-nil)
3327 ((= c ?s)
3328 (read-string prompt))
3329 ((= c ?S)
3330 (intern (read-string prompt)))
3331 ((= c ?v)
3332 (read-variable prompt))
3333 ((= c ?x)
3334 (read-minibuffer prompt))
3335 ((= c ?x)
3336 (eval-minibuffer prompt))
3337 ;; And here the new specs come.
3338 ((= c ?y)
3339 gnus-current-prefix-symbol)
3340 ((= c ?Y)
3341 gnus-current-prefix-symbols)
3342 ((= c ?g)
3343 (gnus-group-group-name))
3344 ((= c ?A)
3345 (gnus-summary-skip-intangible)
3346 (or (get-text-property (point) 'gnus-number)
3347 (gnus-summary-last-subject)))
3348 ((= c ?H)
3349 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3350 (t
3351 (error "Non-implemented spec")))
3352 out)
3353 (cond
3354 ((= c ?r)
fa066d09
GM
3355 (push (if (< (point) (mark)) (point) (mark)) out)
3356 (push (if (> (point) (mark)) (point) (mark)) out))))
6748645f
LMI
3357 (setq out (delq 'gnus-prefix-nil out))
3358 (nreverse out)))
3359
3360(defun gnus-symbolic-argument (&optional arg)
3361 "Read a symbolic argument and a command, and then execute command."
3362 (interactive "P")
3363 (let* ((in-command (this-command-keys))
3364 (command in-command)
3365 gnus-current-prefix-symbols
3366 gnus-current-prefix-symbol
3367 syms)
3368 (while (equal in-command command)
3369 (message "%s-" (key-description (this-command-keys)))
3370 (push (intern (char-to-string (read-char))) syms)
3371 (setq command (read-key-sequence nil t)))
3372 (setq gnus-current-prefix-symbols (nreverse syms)
3373 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3374 (call-interactively (key-binding command t))))
3375
eec82323
LMI
3376;;; More various functions.
3377
a36c8d02
RS
3378(defsubst gnus-check-backend-function (func group)
3379 "Check whether GROUP supports function FUNC.
3380GROUP can either be a string (a group name) or a select method."
3381 (ignore-errors
3382 (let ((method (if (stringp group)
3383 (car (gnus-find-method-for-group group))
3384 group)))
3385 (unless (featurep method)
3386 (require method))
3387 (fboundp (intern (format "%s-%s" method func))))))
3388
eec82323
LMI
3389(defun gnus-group-read-only-p (&optional group)
3390 "Check whether GROUP supports editing or not.
65a32076 3391If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
eec82323
LMI
3392that that variable is buffer-local to the summary buffers."
3393 (let ((group (or group gnus-newsgroup-name)))
3394 (not (gnus-check-backend-function 'request-replace-article group))))
3395
eec82323
LMI
3396(defun gnus-virtual-group-p (group)
3397 "Say whether GROUP is virtual or not."
3398 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3399 gnus-valid-select-methods)))
3400
3401(defun gnus-news-group-p (group &optional article)
3402 "Return non-nil if GROUP (and ARTICLE) come from a news server."
23f87bed 3403 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
f7aa248a 3404 t) ;is news of course.
23f87bed
MB
3405 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3406 nil) ;must be mail then.
3407 ((vectorp article) ;Has header info.
3408 (eq (gnus-request-type group (mail-header-id article)) 'news))
f7aa248a 3409 ((null article) ;Hasn't header info
23f87bed 3410 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
f7aa248a 3411 ((< article 0) ;Virtual message
23f87bed
MB
3412 nil) ;we don't know, guess mail.
3413 (t ;Has positive number
3414 (eq (gnus-request-type group article) 'news)))) ;use it.
eec82323 3415
eec82323
LMI
3416;; Check whether to use long file names.
3417(defun gnus-use-long-file-name (symbol)
3418 ;; The variable has to be set...
3419 (and gnus-use-long-file-name
3420 ;; If it isn't a list, then we return t.
3421 (or (not (listp gnus-use-long-file-name))
3422 ;; If it is a list, and the list contains `symbol', we
3423 ;; return nil.
3424 (not (memq symbol gnus-use-long-file-name)))))
3425
3426;; Generate a unique new group name.
3427(defun gnus-generate-new-group-name (leaf)
3428 (let ((name leaf)
3429 (num 0))
01c52d31 3430 (while (gnus-group-entry name)
eec82323
LMI
3431 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3432 name))
3433
3434(defun gnus-ephemeral-group-p (group)
3435 "Say whether GROUP is ephemeral or not."
6748645f 3436 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3437
3438(defun gnus-group-quit-config (group)
3439 "Return the quit-config of GROUP."
6748645f 3440 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3441
3442(defun gnus-kill-ephemeral-group (group)
3443 "Remove ephemeral GROUP from relevant structures."
3444 (gnus-sethash group nil gnus-newsrc-hashtb))
3445
3446(defun gnus-simplify-mode-line ()
3447 "Make mode lines a bit simpler."
a8151ef7 3448 (setq mode-line-modified (cdr gnus-mode-line-modified))
eec82323
LMI
3449 (when (listp mode-line-format)
3450 (make-local-variable 'mode-line-format)
3451 (setq mode-line-format (copy-sequence mode-line-format))
3452 (when (equal (nth 3 mode-line-format) " ")
3453 (setcar (nthcdr 3 mode-line-format) " "))))
3454
3455;;; Servers and groups.
3456
3457(defsubst gnus-server-add-address (method)
3458 (let ((method-name (symbol-name (car method))))
3459 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3460 (not (assq (intern (concat method-name "-address")) method))
3461 (memq 'physical-address (assq (car method)
3462 gnus-valid-select-methods)))
3463 (append method (list (list (intern (concat method-name "-address"))
3464 (nth 1 method))))
3465 method)))
3466
b069e5a6 3467(defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
14e20e13
MB
3468 (catch 'server-name
3469 (setq method (or method gnus-select-method))
3470
3471 ;; Perhaps it is already in the cache.
b890d447
MB
3472 (unless nocache
3473 (mapc (lambda (name-method)
3474 (if (equal (cdr name-method) method)
3475 (throw 'server-name (car name-method))))
3476 gnus-server-method-cache))
14e20e13
MB
3477
3478 (mapc
3479 (lambda (server-alist)
3480 (mapc (lambda (name-method)
01c52d31
MB
3481 (when (gnus-methods-equal-p (cdr name-method) method)
3482 (unless (member name-method gnus-server-method-cache)
3483 (push name-method gnus-server-method-cache))
3484 (throw 'server-name (car name-method))))
3485 server-alist))
3486 (list gnus-server-alist
3487 gnus-predefined-server-alist))
14e20e13
MB
3488
3489 (let* ((name (if (member (cadr method) '(nil ""))
01c52d31
MB
3490 (format "%s" (car method))
3491 (format "%s:%s" (car method) (cadr method))))
3492 (name-method (cons name method)))
b069e5a6
G
3493 (when (and (not (member name-method gnus-server-method-cache))
3494 (not no-enter-cache)
3495 (not (assoc (car name-method) gnus-server-method-cache)))
01c52d31 3496 (push name-method gnus-server-method-cache))
14e20e13
MB
3497 name)))
3498
23f87bed
MB
3499(defsubst gnus-server-to-method (server)
3500 "Map virtual server names to select methods."
3501 (or (and server (listp server) server)
3502 (cdr (assoc server gnus-server-method-cache))
3503 (let ((result
3504 (or
3505 ;; Perhaps this is the native server?
3506 (and (equal server "native") gnus-select-method)
3507 ;; It should be in the server alist.
3508 (cdr (assoc server gnus-server-alist))
3509 ;; It could be in the predefined server alist.
3510 (cdr (assoc server gnus-predefined-server-alist))
3511 ;; If not, we look through all the opened server
3512 ;; to see whether we can find it there.
3513 (let ((opened gnus-opened-servers))
3514 (while (and opened
3515 (not (equal server (format "%s:%s" (caaar opened)
3516 (cadaar opened)))))
3517 (pop opened))
3518 (caar opened))
3519 ;; It could be a named method, search all servers
3520 (let ((servers gnus-secondary-select-methods))
3521 (while (and servers
3522 (not (equal server (format "%s:%s" (caar servers)
3523 (cadar servers)))))
3524 (pop servers))
3525 (car servers))
fdc90613
MB
3526 ;; This could be some sort of foreign server that I
3527 ;; simply haven't opened (yet). Do a brute-force scan
3528 ;; of the entire gnus-newsrc-alist for the server name
3529 ;; of every method. As a side-effect, loads the
3530 ;; gnus-server-method-cache so this only happens once,
3531 ;; if at all.
3532 (let ((alist (cdr gnus-newsrc-alist))
3533 method match)
3534 (while alist
3535 (setq method (gnus-info-method (pop alist)))
3536 (when (and (not (stringp method))
b069e5a6
G
3537 (equal server
3538 (gnus-method-to-server method nil t)))
fdc90613
MB
3539 (setq match method
3540 alist nil)))
3541 match))))
b069e5a6
G
3542 (when (and result
3543 (not (assoc server gnus-server-method-cache)))
fdc90613 3544 (push (cons server result) gnus-server-method-cache))
23f87bed
MB
3545 result)))
3546
eec82323
LMI
3547(defsubst gnus-server-get-method (group method)
3548 ;; Input either a server name, and extended server name, or a
3549 ;; select method, and return a select method.
3550 (cond ((stringp method)
3551 (gnus-server-to-method method))
3552 ((equal method gnus-select-method)
3553 gnus-select-method)
6748645f
LMI
3554 ((and (stringp (car method))
3555 group)
eec82323 3556 (gnus-server-extend-method group method))
6748645f
LMI
3557 ((and method
3558 (not group)
eec82323
LMI
3559 (equal (cadr method) ""))
3560 method)
3561 (t
3562 (gnus-server-add-address method))))
3563
eec82323
LMI
3564(defmacro gnus-method-equal (ss1 ss2)
3565 "Say whether two servers are equal."
3566 `(let ((s1 ,ss1)
3567 (s2 ,ss2))
3568 (or (equal s1 s2)
3569 (and (= (length s1) (length s2))
3570 (progn
3571 (while (and s1 (member (car s1) s2))
3572 (setq s1 (cdr s1)))
3573 (null s1))))))
3574
16409b0b
GM
3575(defun gnus-methods-equal-p (m1 m2)
3576 (let ((m1 (or m1 gnus-select-method))
3577 (m2 (or m2 gnus-select-method)))
3578 (or (equal m1 m2)
3579 (and (eq (car m1) (car m2))
3580 (or (not (memq 'address (assoc (symbol-name (car m1))
3581 gnus-valid-select-methods)))
3582 (equal (nth 1 m1) (nth 1 m2)))))))
3583
0617bb00 3584(defsubst gnus-sloppily-equal-method-parameters (m1 m2)
4c36be58 3585 ;; Check parameters for sloppy equality.
61b1af82
G
3586 (let ((p1 (copy-sequence (cddr m1)))
3587 (p2 (copy-sequence (cddr m2)))
0617bb00
LMI
3588 e1 e2)
3589 (block nil
3590 (while (setq e1 (pop p1))
3591 (unless (setq e2 (assq (car e1) p2))
3592 ;; The parameter doesn't exist in p2.
3593 (return nil))
3594 (setq p2 (delq e2 p2))
61b1af82 3595 (unless (equal e1 e2)
0617bb00
LMI
3596 (if (not (and (stringp (cadr e1))
3597 (stringp (cadr e2))))
3598 (return nil)
3599 ;; Special-case string parameter comparison so that we
3600 ;; can uniquify them.
3601 (let ((s1 (cadr e1))
3602 (s2 (cadr e2)))
3603 (when (string-match "/$" s1)
3604 (setq s1 (directory-file-name s1)))
3605 (when (string-match "/$" s2)
3606 (setq s2 (directory-file-name s2)))
3607 (unless (equal s1 s2)
3608 (return nil))))))
3609 ;; If p2 now is empty, they were equal.
3610 (null p2))))
bdaa75c7 3611
a427f84d
JB
3612(defun gnus-method-ephemeral-p (method)
3613 (let ((equal nil))
3614 (dolist (ephemeral gnus-ephemeral-servers)
3615 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3616 (setq equal t)))
3617 equal))
3618
f979f37e
GM
3619(defun gnus-methods-sloppily-equal (m1 m2)
3620 ;; Same method.
3621 (or
3622 (eq m1 m2)
3623 ;; Type and name are equal.
3624 (and
3625 (eq (car m1) (car m2))
3626 (equal (cadr m1) (cadr m2))
3627 (gnus-sloppily-equal-method-parameters m1 m2))))
3628
eec82323
LMI
3629(defun gnus-server-equal (m1 m2)
3630 "Say whether two methods are equal."
3631 (let ((m1 (cond ((null m1) gnus-select-method)
3632 ((stringp m1) (gnus-server-to-method m1))
3633 (t m1)))
3634 (m2 (cond ((null m2) gnus-select-method)
3635 ((stringp m2) (gnus-server-to-method m2))
3636 (t m2))))
3637 (gnus-method-equal m1 m2)))
3638
3639(defun gnus-servers-using-backend (backend)
3640 "Return a list of known servers using BACKEND."
3641 (let ((opened gnus-opened-servers)
3642 out)
3643 (while opened
3644 (when (eq backend (caaar opened))
3645 (push (caar opened) out))
3646 (pop opened))
3647 out))
3648
3649(defun gnus-archive-server-wanted-p ()
3650 "Say whether the user wants to use the archive server."
3651 (cond
3652 ((or (not gnus-message-archive-method)
3653 (not gnus-message-archive-group))
3654 nil)
3655 ((and gnus-message-archive-method gnus-message-archive-group)
3656 t)
3657 (t
3658 (let ((active (cadr (assq 'nnfolder-active-file
3659 gnus-message-archive-method))))
3660 (and active
3661 (file-exists-p active))))))
3662
23f87bed
MB
3663(defsubst gnus-method-to-server-name (method)
3664 (concat
3665 (format "%s" (car method))
3666 (when (and
3667 (or (assoc (format "%s" (car method))
3668 (gnus-methods-using 'address))
3669 (gnus-server-equal method gnus-message-archive-method))
3670 (nth 1 method)
3671 (not (string= (nth 1 method) "")))
3672 (concat "+" (nth 1 method)))))
3673
3674(defsubst gnus-method-to-full-server-name (method)
3675 (format "%s+%s" (car method) (nth 1 method)))
3676
3677(defun gnus-group-prefixed-name (group method &optional full)
3678 "Return the whole name from GROUP and METHOD.
3679Call with full set to get the fully qualified group name (even if the
3680server is native)."
3681 (when (stringp method)
3682 (setq method (gnus-server-to-method method)))
6748645f 3683 (if (or (not method)
23f87bed
MB
3684 (and (not full) (gnus-server-equal method "native"))
3685 ;;;!!! This might not be right. We'll see...
3686 ;(string-match ":" group)
3687 )
eec82323 3688 group
23f87bed
MB
3689 (concat (gnus-method-to-server-name method) ":" group)))
3690
23f87bed
MB
3691(defun gnus-group-full-name (group method)
3692 "Return the full name from GROUP and METHOD, even if the method is native."
3693 (gnus-group-prefixed-name group method t))
3694
23f87bed
MB
3695(defun gnus-group-guess-full-name-from-command-method (group)
3696 "Guess the full name from GROUP, even if the method is native."
3697 (if (gnus-group-prefixed-p group)
3698 group
3699 (gnus-group-full-name group gnus-command-method)))
eec82323
LMI
3700
3701(defun gnus-group-real-prefix (group)
3702 "Return the prefix of the current group name."
23f87bed
MB
3703 (if (stringp group)
3704 (if (string-match "^[^:]+:" group)
3705 (substring group 0 (match-end 0))
3706 "")
3707 nil))
3708
3709(defun gnus-group-short-name (group)
3710 "Return the short group name."
3711 (let ((prefix (gnus-group-real-prefix group)))
3712 (if (< 0 (length prefix))
3713 (substring group (length prefix) nil)
3714 group)))
3715
3716(defun gnus-group-prefixed-p (group)
3717 "Return the prefix of the current group name."
3718 (< 0 (length (gnus-group-real-prefix group))))
3719
c7e9cfaf
GM
3720(declare-function gnus-group-decoded-name "gnus-group" (string))
3721
23f87bed
MB
3722(defun gnus-summary-buffer-name (group)
3723 "Return the summary buffer name of GROUP."
3724 (concat "*Summary " (gnus-group-decoded-name group) "*"))
eec82323
LMI
3725
3726(defun gnus-group-method (group)
3727 "Return the server or method used for selecting GROUP.
3728You should probably use `gnus-find-method-for-group' instead."
3729 (let ((prefix (gnus-group-real-prefix group)))
3730 (if (equal prefix "")
3731 gnus-select-method
3732 (let ((servers gnus-opened-servers)
3733 (server "")
3734 backend possible found)
3735 (if (string-match "^[^\\+]+\\+" prefix)
3736 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3737 server (substring prefix (match-end 0) (1- (length prefix))))
3738 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3739 (while servers
3740 (when (eq (caaar servers) backend)
3741 (setq possible (caar servers))
3742 (when (equal (cadaar servers) server)
3743 (setq found (caar servers))))
3744 (pop servers))
3745 (or (car (rassoc found gnus-server-alist))
3746 found
3747 (car (rassoc possible gnus-server-alist))
3748 possible
3749 (list backend server))))))
3750
16409b0b
GM
3751(defsubst gnus-native-method-p (method)
3752 "Return whether METHOD is the native select method."
3753 (gnus-method-equal method gnus-select-method))
3754
eec82323
LMI
3755(defsubst gnus-secondary-method-p (method)
3756 "Return whether METHOD is a secondary select method."
3757 (let ((methods gnus-secondary-select-methods)
23f87bed 3758 (gmethod (inline (gnus-server-get-method nil method))))
eec82323 3759 (while (and methods
16409b0b 3760 (not (gnus-method-equal
23f87bed 3761 (inline (gnus-server-get-method nil (car methods)))
16409b0b 3762 gmethod)))
eec82323
LMI
3763 (setq methods (cdr methods)))
3764 methods))
3765
16409b0b
GM
3766(defun gnus-method-simplify (method)
3767 "Return the shortest uniquely identifying string or method for METHOD."
3768 (cond ((stringp method)
3769 method)
3770 ((gnus-native-method-p method)
3771 nil)
3772 ((gnus-secondary-method-p method)
3773 (format "%s:%s" (nth 0 method) (nth 1 method)))
3774 (t
3775 method)))
3776
6748645f
LMI
3777(defun gnus-groups-from-server (server)
3778 "Return a list of all groups that are fetched from SERVER."
3779 (let ((alist (cdr gnus-newsrc-alist))
3780 info groups)
3781 (while (setq info (pop alist))
3782 (when (gnus-server-equal (gnus-info-method info) server)
3783 (push (gnus-info-group info) groups)))
3784 (sort groups 'string<)))
3785
eec82323
LMI
3786(defun gnus-group-foreign-p (group)
3787 "Say whether a group is foreign or not."
3788 (and (not (gnus-group-native-p group))
3789 (not (gnus-group-secondary-p group))))
3790
3791(defun gnus-group-native-p (group)
3792 "Say whether the group is native or not."
3793 (not (string-match ":" group)))
3794
3795(defun gnus-group-secondary-p (group)
3796 "Say whether the group is secondary or not."
3797 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3798
23f87bed
MB
3799(defun gnus-parameters-get-parameter (group)
3800 "Return the group parameters for GROUP from `gnus-parameters'."
e8beac8a
MB
3801 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3802 case-fold-search
3803 gnus-parameters-case-fold-search))
3804 params-list)
23f87bed
MB
3805 (dolist (elem gnus-parameters)
3806 (when (string-match (car elem) group)
3807 (setq params-list
3808 (nconc (gnus-expand-group-parameters
3809 (car elem) (cdr elem) group)
3810 params-list))))
3811 params-list))
3812
3813(defun gnus-expand-group-parameter (match value group)
3814 "Use MATCH to expand VALUE in GROUP."
d2abc29a
JD
3815 (let ((start (string-match match group)))
3816 (if start
3817 (let ((matched-string (substring group start (match-end 0))))
3818 ;; Build match groups
3819 (string-match match matched-string)
3820 (replace-match value nil nil matched-string))
3821 group)))
23f87bed
MB
3822
3823(defun gnus-expand-group-parameters (match parameters group)
3824 "Go through PARAMETERS and expand them according to the match data."
3825 (let (new)
3826 (dolist (elem parameters)
350a1888
G
3827 (cond
3828 ((and (stringp (cdr elem))
3829 (string-match "\\\\[0-9&]" (cdr elem)))
3830 (push (cons (car elem)
3831 (gnus-expand-group-parameter match (cdr elem) group))
3832 new))
3833 ;; For `sieve' group parameters, perform substitutions for every
3834 ;; string within the match rule. This allows for parameters such
3835 ;; as:
3836 ;; ("list\\.\\(.*\\)"
3837 ;; (sieve header :is "list-id" "<\\1.domain.org>"))
3838 ((eq 'sieve (car elem))
3839 (push (mapcar (lambda (sieve-elem)
3840 (if (and (stringp sieve-elem)
3841 (string-match "\\\\[0-9&]" sieve-elem))
3842 (gnus-expand-group-parameter match sieve-elem
3843 group)
3844 sieve-elem))
3845 (cdr elem))
3846 new))
3847 (t
3848 (push elem new))))
23f87bed
MB
3849 new))
3850
3851(defun gnus-group-fast-parameter (group symbol &optional allow-list)
3852 "For GROUP, return the value of SYMBOL.
3853
3854You should call this in the `gnus-group-buffer' buffer.
3855The function `gnus-group-find-parameter' will do that for you."
3856 ;; The speed trick: No cons'ing and quit early.
3857 (let* ((params (funcall gnus-group-get-parameter-function group))
3858 ;; Start easy, check the "real" group parameters.
3859 (simple-results
3860 (gnus-group-parameter-value params symbol allow-list t)))
3861 (if simple-results
3862 ;; Found results; return them.
3863 (car simple-results)
01c52d31 3864 ;; We didn't find it there, try `gnus-parameters'.
23f87bed
MB
3865 (let ((result nil)
3866 (head nil)
3867 (tail gnus-parameters))
3868 ;; A good old-fashioned non-cl loop.
3869 (while tail
3870 (setq head (car tail)
3871 tail (cdr tail))
3872 ;; The car is regexp matching for matching the group name.
3873 (when (string-match (car head) group)
3874 ;; The cdr is the parameters.
e7719ea1
G
3875 (let ((this-result
3876 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3877 (when this-result
3878 (setq result (car this-result))
3879 ;; Expand if necessary.
350a1888
G
3880 (cond
3881 ((and (stringp result) (string-match "\\\\[0-9&]" result))
3882 (setq result (gnus-expand-group-parameter
3883 (car head) result group)))
3884 ;; For `sieve' group parameters, perform substitutions
3885 ;; for every string within the match rule (see above).
3886 ((eq symbol 'sieve)
3887 (setq result
3888 (mapcar (lambda (elem)
3889 (if (stringp elem)
3890 (gnus-expand-group-parameter (car head)
3891 elem group)
3892 elem))
3893 result))))))))
23f87bed
MB
3894 ;; Done.
3895 result))))
3896
6748645f 3897(defun gnus-group-find-parameter (group &optional symbol allow-list)
eec82323 3898 "Return the group parameters for GROUP.
23f87bed
MB
3899If SYMBOL, return the value of that symbol in the group parameters.
3900
3901If you call this function inside a loop, consider using the faster
3902`gnus-group-fast-parameter' instead."
f4887f8b 3903 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
e7719ea1
G
3904 gnus-group-buffer
3905 (current-buffer))
23f87bed
MB
3906 (if symbol
3907 (gnus-group-fast-parameter group symbol allow-list)
3908 (nconc
3909 (copy-sequence
3910 (funcall gnus-group-get-parameter-function group))
3911 (gnus-parameters-get-parameter group)))))
eec82323 3912
6748645f 3913(defun gnus-group-get-parameter (group &optional symbol allow-list)
eec82323 3914 "Return the group parameters for GROUP.
6748645f 3915If SYMBOL, return the value of that symbol in the group parameters.
3031d8b0 3916If ALLOW-LIST, also allow list as a result.
6748645f
LMI
3917Most functions should use `gnus-group-find-parameter', which
3918also examines the topic parameters."
eec82323
LMI
3919 (let ((params (gnus-info-params (gnus-get-info group))))
3920 (if symbol
6748645f 3921 (gnus-group-parameter-value params symbol allow-list)
eec82323
LMI
3922 params)))
3923
23f87bed
MB
3924(defun gnus-group-parameter-value (params symbol &optional
3925 allow-list present-p)
3031d8b0
MB
3926 "Return the value of SYMBOL in group PARAMS.
3927If ALLOW-LIST, also allow list as a result."
6748645f
LMI
3928 ;; We only wish to return group parameters (dotted lists) and
3929 ;; not local variables, which may have the same names.
3930 ;; But first we handle single elements...
3931 (or (car (memq symbol params))
3932 ;; Handle alist.
3933 (let (elem)
3934 (catch 'found
3935 (while (setq elem (pop params))
3936 (when (and (consp elem)
3937 (eq (car elem) symbol)
3938 (or allow-list
3939 (atom (cdr elem))))
23f87bed
MB
3940 (throw 'found (if present-p (list (cdr elem))
3941 (cdr elem)))))))))
eec82323
LMI
3942
3943(defun gnus-group-add-parameter (group param)
3944 "Add parameter PARAM to GROUP."
3945 (let ((info (gnus-get-info group)))
3946 (when info
3947 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3948 ;; Cons the new param to the old one and update.
3949 (gnus-group-set-info (cons param (gnus-info-params info))
3950 group 'params))))
3951
3952(defun gnus-group-set-parameter (group name value)
f7aa248a
G
3953 "Set parameter NAME to VALUE in GROUP.
3954GROUP can also be an INFO structure."
3955 (let ((info (if (listp group)
3956 group
3957 (gnus-get-info group))))
eec82323
LMI
3958 (when info
3959 (gnus-group-remove-parameter group name)
3960 (let ((old-params (gnus-info-params info))
3961 (new-params (list (cons name value))))
3962 (while old-params
3963 (when (or (not (listp (car old-params)))
3964 (not (eq (caar old-params) name)))
3965 (setq new-params (append new-params (list (car old-params)))))
3966 (setq old-params (cdr old-params)))
7cad71ad
G
3967 (if (listp group)
3968 (gnus-info-set-params info new-params t)
3969 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
eec82323
LMI
3970
3971(defun gnus-group-remove-parameter (group name)
f7aa248a
G
3972 "Remove parameter NAME from GROUP.
3973GROUP can also be an INFO structure."
3974 (let ((info (if (listp group)
3975 group
3976 (gnus-get-info group))))
eec82323
LMI
3977 (when info
3978 (let ((params (gnus-info-params info)))
3979 (when params
3980 (setq params (delq name params))
3981 (while (assq name params)
36d3245f 3982 (gnus-alist-pull name params))
eec82323
LMI
3983 (gnus-info-set-params info params))))))
3984
3985(defun gnus-group-add-score (group &optional score)
3986 "Add SCORE to the GROUP score.
3987If SCORE is nil, add 1 to the score of GROUP."
3988 (let ((info (gnus-get-info group)))
3989 (when info
3990 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3991
eec82323
LMI
3992(defun gnus-short-group-name (group &optional levels)
3993 "Collapse GROUP name LEVELS.
3994Select methods are stripped and any remote host name is stripped down to
3995just the host name."
6748645f
LMI
3996 (let* ((name "")
3997 (foreign "")
3998 (depth 0)
3999 (skip 1)
eec82323 4000 (levels (or levels
16409b0b 4001 gnus-group-uncollapsed-levels
eec82323
LMI
4002 (progn
4003 (while (string-match "\\." group skip)
4004 (setq skip (match-end 0)
4005 depth (+ depth 1)))
4006 depth))))
16409b0b 4007 ;; Separate foreign select method from group name and collapse.
23f87bed 4008 ;; If method contains a server, collapse to non-domain server name,
16409b0b
GM
4009 ;; otherwise collapse to select method.
4010 (let* ((colon (string-match ":" group))
4011 (server (and colon (substring group 0 colon)))
4012 (plus (and server (string-match "+" server))))
4013 (when server
4014 (if plus
4015 (setq foreign (substring server (+ 1 plus)
4016 (string-match "\\." server))
4017 group (substring group (+ 1 colon)))
4018 (setq foreign server
4019 group (substring group (+ 1 colon))))
4020 (setq foreign (concat foreign ":")))
4021 ;; Collapse group name leaving LEVELS uncollapsed elements
4022 (let* ((slist (split-string group "/"))
4023 (slen (length slist))
4024 (dlist (split-string group "\\."))
4025 (dlen (length dlist))
4026 glist
4027 glen
4028 gsep
4029 res)
4030 (if (> slen dlen)
4031 (setq glist slist
4032 glen slen
4033 gsep "/")
4034 (setq glist dlist
4035 glen dlen
4036 gsep "."))
4037 (setq levels (- glen levels))
4038 (dolist (g glist)
4039 (push (if (>= (decf levels) 0)
4040 (if (zerop (length g))
4041 ""
4042 (substring g 0 1))
4043 g)
4044 res))
4045 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
eec82323
LMI
4046
4047(defun gnus-narrow-to-body ()
4048 "Narrow to the body of an article."
4049 (narrow-to-region
4050 (progn
4051 (goto-char (point-min))
4052 (or (search-forward "\n\n" nil t)
4053 (point-max)))
4054 (point-max)))
4055
4056\f
4057;;;
4058;;; Kill file handling.
4059;;;
4060
4061(defun gnus-apply-kill-file ()
4062 "Apply a kill file to the current newsgroup.
4063Returns the number of articles marked as read."
4064 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4065 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4066 (gnus-apply-kill-file-internal)
4067 0))
4068
4069(defun gnus-kill-save-kill-buffer ()
4070 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4071 (when (get-file-buffer file)
765abcce 4072 (with-current-buffer (get-file-buffer file)
eec82323
LMI
4073 (when (buffer-modified-p)
4074 (save-buffer))
4075 (kill-buffer (current-buffer))))))
4076
4077(defcustom gnus-kill-file-name "KILL"
4078 "Suffix of the kill files."
4079 :group 'gnus-score-kill
4080 :group 'gnus-score-files
4081 :type 'string)
4082
4083(defun gnus-newsgroup-kill-file (newsgroup)
4084 "Return the name of a kill file name for NEWSGROUP.
4085If NEWSGROUP is nil, return the global kill file name instead."
4086 (cond
4087 ;; The global KILL file is placed at top of the directory.
4088 ((or (null newsgroup)
4089 (string-equal newsgroup ""))
4090 (expand-file-name gnus-kill-file-name
4091 gnus-kill-files-directory))
4092 ;; Append ".KILL" to newsgroup name.
4093 ((gnus-use-long-file-name 'not-kill)
4094 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4095 "." gnus-kill-file-name)
4096 gnus-kill-files-directory))
4097 ;; Place "KILL" under the hierarchical directory.
4098 (t
4099 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4100 "/" gnus-kill-file-name)
4101 gnus-kill-files-directory))))
4102
4103;;; Server things.
4104
4105(defun gnus-member-of-valid (symbol group)
4106 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4107 (memq symbol (assoc
4108 (symbol-name (car (gnus-find-method-for-group group)))
4109 gnus-valid-select-methods)))
4110
4111(defun gnus-method-option-p (method option)
4112 "Return non-nil if select METHOD has OPTION as a parameter."
4113 (when (stringp method)
4114 (setq method (gnus-server-to-method method)))
4115 (memq option (assoc (format "%s" (car method))
4116 gnus-valid-select-methods)))
4117
4118(defun gnus-similar-server-opened (method)
bdaa75c7
LMI
4119 "Return non-nil if we have a similar server opened.
4120This is defined as a server with the same name, but different
4121parameters."
4122 (let ((opened gnus-opened-servers)
4123 open)
eec82323 4124 (while (and method opened)
bdaa75c7
LMI
4125 (setq open (car (pop opened)))
4126 ;; Type and name are the same...
4127 (when (and (equal (car method) (car open))
4128 (equal (cadr method) (cadr open))
4129 ;; ... but the rest of the parameters differ.
4130 (not (gnus-methods-sloppily-equal method open)))
4131 (setq method nil)))
eec82323
LMI
4132 (not method)))
4133
4134(defun gnus-server-extend-method (group method)
65a32076 4135 ;; This function "extends" a virtual server. If the server is
eec82323
LMI
4136 ;; "hello", and the select method is ("hello" (my-var "something"))
4137 ;; in the group "alt.alt", this will result in a new virtual server
4138 ;; called "hello+alt.alt".
4139 (if (or (not (inline (gnus-similar-server-opened method)))
4140 (not (cddr method)))
4141 method
d25ceb52
LI
4142 (let ((address-slot
4143 (intern (format "%s-address" (car method)))))
4144 (setq method
4145 (if (assq address-slot (cddr method))
4146 `(,(car method) ,(concat (cadr method) "+" group)
4147 ,@(cddr method))
4148 `(,(car method) ,(concat (cadr method) "+" group)
4149 (,address-slot ,(cadr method))
4150 ,@(cddr method))))
4151 (push method gnus-extended-servers)
4152 method)))
eec82323
LMI
4153
4154(defun gnus-server-status (method)
4155 "Return the status of METHOD."
4156 (nth 1 (assoc method gnus-opened-servers)))
4157
4158(defun gnus-group-name-to-method (group)
4159 "Guess a select method based on GROUP."
4160 (if (string-match ":" group)
4161 (let ((server (substring group 0 (match-beginning 0))))
4162 (if (string-match "\\+" server)
4163 (list (intern (substring server 0 (match-beginning 0)))
4164 (substring server (match-end 0)))
4165 (list (intern server) "")))
4166 gnus-select-method))
4167
23f87bed
MB
4168(defun gnus-server-string (server)
4169 "Return a readable string that describes SERVER."
4170 (let* ((server (gnus-server-to-method server))
4171 (address (nth 1 server)))
4172 (if (and address
4173 (not (zerop (length address))))
4174 (format "%s using %s" address (car server))
4175 (format "%s" (car server)))))
4176
0617bb00
LMI
4177(defun gnus-same-method-different-name (method)
4178 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4179 (unless (assq slot (cddr method))
4180 (setq method
4181 (append method (list (list slot (nth 1 method)))))))
4182 (let ((methods gnus-extended-servers)
4183 open found)
4184 (while (and (not found)
4185 (setq open (pop methods)))
4186 (when (and (eq (car method) (car open))
4187 (gnus-sloppily-equal-method-parameters method open))
4188 (setq found open)))
4189 found))
4190
eec82323
LMI
4191(defun gnus-find-method-for-group (group &optional info)
4192 "Find the select method that GROUP uses."
4193 (or gnus-override-method
4194 (and (not group)
4195 gnus-select-method)
6c5d6b6c 4196 (and (not (gnus-group-entry group))
01c52d31
MB
4197 ;; Killed or otherwise unknown group.
4198 (or
4199 ;; If we know a virtual server by that name, return its method.
4200 (gnus-server-to-method (gnus-group-server group))
4201 ;; Guess a new method as last resort.
4202 (gnus-group-name-to-method group)))
eec82323
LMI
4203 (let ((info (or info (gnus-get-info group)))
4204 method)
4205 (if (or (not info)
4206 (not (setq method (gnus-info-method info)))
4207 (equal method "native"))
4208 gnus-select-method
4209 (setq method
4210 (cond ((stringp method)
4211 (inline (gnus-server-to-method method)))
4212 ((stringp (cadr method))
0617bb00
LMI
4213 (or
4214 (inline
4215 (gnus-same-method-different-name method))
4216 (inline (gnus-server-extend-method group method))))
eec82323
LMI
4217 (t
4218 method)))
4219 (cond ((equal (cadr method) "")
4220 method)
4221 ((null (cadr method))
4222 (list (car method) ""))
4223 (t
4224 (gnus-server-add-address method)))))))
4225
eec82323
LMI
4226(defun gnus-methods-using (feature)
4227 "Find all methods that have FEATURE."
4228 (let ((valids gnus-valid-select-methods)
4229 outs)
4230 (while valids
4231 (when (memq feature (car valids))
4232 (push (car valids) outs))
4233 (setq valids (cdr valids)))
4234 outs))
4235
8654e13a
MB
4236(eval-and-compile
4237 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4238
eec82323
LMI
4239(defun gnus-read-group (prompt &optional default)
4240 "Prompt the user for a group name.
16409b0b 4241Disallow invalid group names."
eec82323
LMI
4242 (let ((prefix "")
4243 group)
4244 (while (not group)
a1506d29 4245 (when (string-match
16409b0b 4246 gnus-invalid-group-regexp
eec82323
LMI
4247 (setq group (read-string (concat prefix prompt)
4248 (cons (or default "") 0)
4249 'gnus-group-history)))
23f87bed
MB
4250 (let ((match (match-string 0 group)))
4251 ;; Might be okay (e.g. for nnimap), so ask the user:
4252 (unless (and (not (string-match "^$\\|:" match))
4253 (message-y-or-n-p
4254 "Proceed and create group anyway? " t
4255"The group name \"" group "\" contains a forbidden character: \"" match "\".
4256
4257Usually, it's dangerous to create a group with this name, because it's not
4258supported by all back ends and servers. On IMAP servers it should work,
4259though. If you are really sure, you can proceed anyway and create the group.
4260
4261You may customize the variable `gnus-invalid-group-regexp', which currently is
4262set to \"" gnus-invalid-group-regexp
4263"\", if you want to get rid of this query permanently."))
4264 (setq prefix (format "Invalid group name: \"%s\". " group)
4265 group nil)))))
eec82323
LMI
4266 group))
4267
4268(defun gnus-read-method (prompt)
4269 "Prompt the user for a method.
4270Allow completion over sensible values."
23f87bed
MB
4271 (let* ((open-servers
4272 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4273 gnus-opened-servers))
4274 (valid-methods
4275 (let (methods)
4276 (dolist (method gnus-valid-select-methods)
4277 (if (or (memq 'prompt-address method)
4278 (not (assoc (format "%s:" (car method)) open-servers)))
4279 (push method methods)))
4280 methods))
4281 (servers
4282 (append valid-methods
4283 open-servers
6748645f
LMI
4284 gnus-predefined-server-alist
4285 gnus-server-alist))
4286 (method
229b59da
G
4287 (gnus-completing-read
4288 prompt (mapcar 'car servers)
4289 t nil 'gnus-method-history)))
eec82323
LMI
4290 (cond
4291 ((equal method "")
4292 (setq method gnus-select-method))
4293 ((assoc method gnus-valid-select-methods)
16409b0b
GM
4294 (let ((address (if (memq 'prompt-address
4295 (assoc method gnus-valid-select-methods))
4296 (read-string "Address: ")
4297 "")))
23f87bed 4298 (or (cadr (assoc (format "%s:%s" method address) open-servers))
16409b0b 4299 (list (intern method) address))))
6748645f 4300 ((assoc method servers)
eec82323
LMI
4301 method)
4302 (t
4303 (list (intern method) "")))))
4304
23f87bed
MB
4305;;; Agent functions
4306
b890d447 4307(defun gnus-agent-method-p (method-or-server)
23f87bed 4308 "Say whether METHOD is covered by the agent."
b890d447
MB
4309 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4310 (let* ((method (if (stringp method-or-server)
4311 (gnus-server-to-method method-or-server)
4312 method-or-server))
4313 (server (gnus-method-to-server method t)))
4314 (setq gnus-agent-method-p-cache
4315 (cons method-or-server
4316 (member server gnus-agent-covered-methods)))))
23f87bed
MB
4317 (cdr gnus-agent-method-p-cache))
4318
4319(defun gnus-online (method)
4320 (not
4321 (if gnus-plugged
4322 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4323 (gnus-agent-method-p method))))
4324
eec82323
LMI
4325;;; User-level commands.
4326
4327;;;###autoload
4328(defun gnus-slave-no-server (&optional arg)
23f87bed 4329 "Read network news as a slave, without connecting to the local server."
eec82323
LMI
4330 (interactive "P")
4331 (gnus-no-server arg t))
4332
4333;;;###autoload
4334(defun gnus-no-server (&optional arg slave)
4335 "Read network news.
23f87bed
MB
4336If ARG is a positive number, Gnus will use that as the startup
4337level. If ARG is nil, Gnus will be started at level 2. If ARG is
4338non-nil and not a positive number, Gnus will prompt the user for the
4339name of an NNTP server to use.
4340As opposed to `gnus', this command will not connect to the local
4341server."
eec82323
LMI
4342 (interactive "P")
4343 (gnus-no-server-1 arg slave))
4344
4345;;;###autoload
4346(defun gnus-slave (&optional arg)
4347 "Read news as a slave."
4348 (interactive "P")
4349 (gnus arg nil 'slave))
4350
4351;;;###autoload
23f87bed
MB
4352(defun gnus-other-frame (&optional arg display)
4353 "Pop up a frame to read news.
4354This will call one of the Gnus commands which is specified by the user
4355option `gnus-other-frame-function' (default `gnus') with the argument
4356ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4357optional second argument DISPLAY should be a standard display string
4358such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4359omitted or the function `make-frame-on-display' is not available, the
4360current display is used."
eec82323 4361 (interactive "P")
23f87bed
MB
4362 (if (fboundp 'make-frame-on-display)
4363 (unless display
4364 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4365 (setq display nil))
4366 (let ((alive (gnus-alive-p)))
4367 (unless (and alive
4368 (catch 'found
4369 (walk-windows
4370 (lambda (window)
4371 (when (and (or (not display)
4372 (equal display
4373 (gnus-frame-or-window-display-name
4374 window)))
4375 (with-current-buffer (window-buffer window)
4376 (string-match "\\`gnus-"
4377 (symbol-name major-mode))))
4378 (gnus-select-frame-set-input-focus
4379 (setq gnus-other-frame-object (window-frame window)))
4380 (select-window window)
4381 (throw 'found t)))
4382 'ignore t)))
4383 (gnus-select-frame-set-input-focus
4384 (setq gnus-other-frame-object
4385 (if display
4386 (make-frame-on-display display gnus-other-frame-parameters)
4387 (make-frame gnus-other-frame-parameters))))
4388 (if alive
4389 (switch-to-buffer gnus-group-buffer)
4390 (funcall gnus-other-frame-function arg)
4391 (add-hook 'gnus-exit-gnus-hook
4f91a816
SM
4392 (lambda nil
4393 (when (and (frame-live-p gnus-other-frame-object)
4394 (cdr (frame-list)))
4395 (delete-frame gnus-other-frame-object))
4396 (setq gnus-other-frame-object nil)))))))
eec82323
LMI
4397
4398;;;###autoload
4399(defun gnus (&optional arg dont-connect slave)
4400 "Read network news.
4401If ARG is non-nil and a positive number, Gnus will use that as the
23f87bed 4402startup level. If ARG is non-nil and not a positive number, Gnus will
eec82323
LMI
4403prompt the user for the name of an NNTP server to use."
4404 (interactive "P")
bdaa75c7
LMI
4405 ;; When using the development version of Gnus, load the gnus-load
4406 ;; file.
4407 (unless (string-match "^Gnus" gnus-version)
8ccbef23 4408 (load "gnus-load" nil t))
23f87bed
MB
4409 (unless (byte-code-function-p (symbol-function 'gnus))
4410 (message "You should byte-compile Gnus")
4411 (sit-for 2))
4478e074
G
4412 (let ((gnus-action-message-log (list nil)))
4413 (gnus-1 arg dont-connect slave)
4414 (gnus-final-warning)))
eec82323 4415
7b9946cf
AS
4416(eval-and-compile
4417 (unless (fboundp 'debbugs-gnu)
4418 (autoload 'debbugs-gnu "debbugs-gnu" "List all outstanding Emacs bugs." t)))
ecd283b9
LMI
4419(defun gnus-list-debbugs ()
4420 "List all open Gnus bug reports."
4421 (interactive)
c152c1d6 4422 (debbugs-gnu nil "gnus"))
ecd283b9 4423
eec82323
LMI
4424;; Allow redefinition of Gnus functions.
4425
4426(gnus-ems-redefine)
4427
4428(provide 'gnus)
4429
4430;;; gnus.el ends here