Merge changes made in Gnus master; Remove dead code
[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))
1650 (checklist :inline t
1651 (const :format "%v " address)
1652 (const :format "%v " prompt-address)
c06fc524 1653 (const :format "%v " physical-address)
eec82323 1654 (const :format "%v " virtual)
1a10d421
KY
1655 (const respool))))
1656 :version "24.1")
eec82323 1657
16409b0b
GM
1658(defun gnus-redefine-select-method-widget ()
1659 "Recomputes the select-method widget based on the value of
1660`gnus-valid-select-methods'."
1661 (define-widget 'gnus-select-method 'list
1662 "Widget for entering a select method."
1663 :value '(nntp "")
1664 :tag "Select Method"
1665 :args `((choice :tag "Method"
1666 ,@(mapcar (lambda (entry)
1667 (list 'const :format "%v\n"
1668 (intern (car entry))))
1669 gnus-valid-select-methods)
1670 (symbol :tag "other"))
1671 (string :tag "Address")
1672 (repeat :tag "Options"
1673 :inline t
1674 (list :format "%v"
1675 variable
23f87bed 1676 (sexp :tag "Value"))))))
16409b0b
GM
1677
1678(gnus-redefine-select-method-widget)
eec82323
LMI
1679
1680(defcustom gnus-updated-mode-lines '(group article summary tree)
1681 "List of buffers that should update their mode lines.
1682The list may contain the symbols `group', `article', `tree' and
1683`summary'. If the corresponding symbol is present, Gnus will keep
1684that mode line updated with information that may be pertinent.
1685If this variable is nil, screen refresh may be quicker."
1686 :group 'gnus-various
1687 :type '(set (const group)
1688 (const article)
1689 (const summary)
1690 (const tree)))
1691
a1347097 1692(defcustom gnus-mode-non-string-length 30
eec82323
LMI
1693 "*Max length of mode-line non-string contents.
1694If this is nil, Gnus will take space as is needed, leaving the rest
a1347097
LMI
1695of the mode line intact."
1696 :version "24.1"
eec82323
LMI
1697 :group 'gnus-various
1698 :type '(choice (const nil)
1699 integer))
1700
23f87bed
MB
1701;; There should be special validation for this.
1702(define-widget 'gnus-email-address 'string
1703 "An email address.")
1704
1705(gnus-define-group-parameter
1706 to-address
1707 :function-document
1708 "Return GROUP's to-address."
1709 :variable-document
1710 "*Alist of group regexps and correspondent to-addresses."
e79f14a4 1711 :variable-group gnus-group-parameter
23f87bed
MB
1712 :parameter-type '(gnus-email-address :tag "To Address")
1713 :parameter-document "\
1714This will be used when doing followups and posts.
1715
1716This is primarily useful in mail groups that represent closed
1717mailing lists--mailing lists where it's expected that everybody that
1718writes to the mailing list is subscribed to it. Since using this
1719parameter ensures that the mail only goes to the mailing list itself,
1720it means that members won't receive two copies of your followups.
1721
1722Using `to-address' will actually work whether the group is foreign or
1723not. Let's say there's a group on the server that is called
1724`fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1725articles from a mail-to-news gateway. Posting directly to this group
1726is therefore impossible--you have to send mail to the mailing list
1727address instead.
1728
1729The gnus-group-split mail splitting mechanism will behave as if this
1730address was listed in gnus-group-split Addresses (see below).")
1731
1732(gnus-define-group-parameter
1733 to-list
1734 :function-document
1735 "Return GROUP's to-list."
1736 :variable-document
1737 "*Alist of group regexps and correspondent to-lists."
e79f14a4 1738 :variable-group gnus-group-parameter
23f87bed
MB
1739 :parameter-type '(gnus-email-address :tag "To List")
1740 :parameter-document "\
1741This address will be used when doing a `a' in the group.
1742
1743It is totally ignored when doing a followup--except that if it is
1744present in a news group, you'll get mail group semantics when doing
1745`f'.
1746
1747The gnus-group-split mail splitting mechanism will behave as if this
1748address was listed in gnus-group-split Addresses (see below).")
1749
1750(gnus-define-group-parameter
1751 subscribed
1752 :type bool
1753 :function-document
1754 "Return GROUP's subscription status."
1755 :variable-document
1756 "*Groups which are automatically considered subscribed."
e79f14a4 1757 :variable-group gnus-group-parameter
23f87bed
MB
1758 :parameter-type '(const :tag "Subscribed" t)
1759 :parameter-document "\
1760Gnus assumed that you are subscribed to the To/List address.
1761
1762When constructing a list of subscribed groups using
1763`gnus-find-subscribed-addresses', Gnus includes the To address given
1764above, or the list address (if the To address has not been set).")
1765
1766(gnus-define-group-parameter
1767 auto-expire
1768 :type bool
1769 :function gnus-group-auto-expirable-p
1770 :function-document
1771 "Check whether GROUP is auto-expirable or not."
1772 :variable gnus-auto-expirable-newsgroups
1773 :variable-default nil
1774 :variable-document
1775 "*Groups in which to automatically mark read articles as expirable.
eec82323
LMI
1776If non-nil, this should be a regexp that should match all groups in
1777which to perform auto-expiry. This only makes sense for mail groups."
23f87bed
MB
1778 :variable-group nnmail-expire
1779 :variable-type '(choice (const nil)
1780 regexp)
1781 :parameter-type '(const :tag "Automatic Expire" t)
1782 :parameter-document
1783 "All articles that are read will be marked as expirable.")
1784
1785(gnus-define-group-parameter
1786 total-expire
1787 :type bool
1788 :function gnus-group-total-expirable-p
1789 :function-document
1790 "Check whether GROUP is total-expirable or not."
1791 :variable gnus-total-expirable-newsgroups
1792 :variable-default nil
1793 :variable-document
1794 "*Groups in which to perform expiry of all read articles.
eec82323
LMI
1795Use with extreme caution. All groups that match this regexp will be
1796expiring - which means that all read articles will be deleted after
65a32076 1797\(say) one week. (This only goes for mail groups and the like, of
eec82323 1798course.)"
23f87bed
MB
1799 :variable-group nnmail-expire
1800 :variable-type '(choice (const nil)
1801 regexp)
1802 :parameter-type '(const :tag "Total Expire" t)
1803 :parameter-document
1804 "All read articles will be put through the expiry process
1805
1806This happens even if they are not marked as expirable.
1807Use with caution.")
1808
1809(gnus-define-group-parameter
1810 charset
1811 :function-document
1812 "Return the default charset of GROUP."
1813 :variable gnus-group-charset-alist
1814 :variable-default
1815 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1816 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1817 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1818 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1819 ("\\(^\\|:\\)relcom\\>" koi8-r)
1820 ("\\(^\\|:\\)fido7\\>" koi8-r)
1821 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1822 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1823 ("\\(^\\|:\\)han\\>" euc-kr)
1824 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1825 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1826 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1827 :variable-document
1828 "Alist of regexps (to match group names) and default charsets to be used when reading."
1829 :variable-group gnus-charset
1830 :variable-type '(repeat (list (regexp :tag "Group")
1831 (symbol :tag "Charset")))
1832 :parameter-type '(symbol :tag "Charset")
1833 :parameter-document "\
1834The default charset to use in the group.")
1835
1836(gnus-define-group-parameter
1837 post-method
1838 :type list
1839 :function-document
1840 "Return a posting method for GROUP."
1841 :variable gnus-post-method-alist
1842 :variable-document
1843 "Alist of regexps (to match group names) and method to be used when
1844posting an article."
1845 :variable-group gnus-group-foreign
1846 :parameter-type
1847 '(choice :tag "Posting Method"
1848 (const :tag "Use native server" native)
1849 (const :tag "Use current server" current)
1850 (list :convert-widget
1851 (lambda (widget)
1852 (list 'sexp :tag "Methods"
1853 :value gnus-select-method))))
1854 :parameter-document
1855 "Posting method for this group.")
1856
1857(gnus-define-group-parameter
1858 large-newsgroup-initial
1859 :type integer
1860 :function-document
1861 "Return GROUP's initial input of the number of articles."
1862 :variable-document
1863 "*Alist of group regexps and its initial input of the number of articles."
e79f14a4 1864 :variable-group gnus-group-parameter
23f87bed
MB
1865 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1866 (const :tag "All" nil)
1867 (integer))
1868 :parameter-document "\
1869
1870This number will be prompted as the initial value of the number of
1871articles to list when the group is a large newsgroup (see
1872`gnus-large-newsgroup'). If it is nil, the default value is the
1873total number of articles in the group.")
1874
1875;; The Gnus registry's ignored groups
1876(gnus-define-group-parameter
1877 registry-ignore
1878 :type list
1879 :function-document
1880 "Whether this group should be ignored by the registry."
1881 :variable gnus-registry-ignored-groups
c024b021
TZ
1882 :variable-default (mapcar
1883 (lambda (g) (list g t))
1884 '("delayed$" "drafts$" "queue$" "INBOX$"
e504613c 1885 "^nnmairix:" "^nnir:" "archive"))
23f87bed
MB
1886 :variable-document
1887 "*Groups in which the registry should be turned off."
1888 :variable-group gnus-registry
1889 :variable-type '(repeat
1890 (list
1891 (regexp :tag "Group Name Regular Expression")
1892 (boolean :tag "Ignored")))
bf247b6e 1893
23f87bed
MB
1894 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1895 :parameter-document
1896 "Whether the Gnus Registry should ignore this group.")
1897
1898;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1899(defcustom gnus-install-group-spam-parameters t
1900 "*Disable the group parameters for spam detection.
1901Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
bf247b6e 1902 :version "22.1"
23f87bed
MB
1903 :type 'boolean
1904 :group 'gnus-start)
1905
1906(when gnus-install-group-spam-parameters
1907 (defvar gnus-group-spam-classification-spam t
1908 "Spam group classification (requires spam.el).
1909This group contains spam messages. On summary entry, unread messages
1910will be marked as spam. On summary exit, the specified spam
1911processors will be invoked on spam-marked messages, then those
1912messages will be expired, so the spam processor will only see a
1913spam-marked message once.")
1914
1915 (defvar gnus-group-spam-classification-ham 'ask
1916 "The ham value for the spam group parameter (requires spam.el).
1917On summary exit, the specified ham processors will be invoked on
1918ham-marked messages. Exercise caution, since the ham processor will
1919see the same message more than once because there is no ham message
1920registry.")
1921
1922 (gnus-define-group-parameter
1923 spam-contents
1924 :type list
1925 :function-document
1926 "The spam type (spam, ham, or neither) of the group."
1927 :variable gnus-spam-newsgroup-contents
1928 :variable-default nil
1929 :variable-document
270a576a
MB
1930 "*Group classification (spam, ham, or neither). Only
1931meaningful when spam.el is loaded. If non-nil, this should be a
1932list of group name regexps associated with a classification for
1933each one. In spam groups, new articles are marked as spam on
1934summary entry. There is other behavior associated with ham and
1935no classification when spam.el is loaded - see the manual."
23f87bed
MB
1936 :variable-group spam
1937 :variable-type '(repeat
1938 (list :tag "Group contents spam/ham classification"
1939 (regexp :tag "Group")
1940 (choice
1941 (variable-item gnus-group-spam-classification-spam)
1942 (variable-item gnus-group-spam-classification-ham)
1943 (const :tag "Unclassified" nil))))
1944
1945 :parameter-type '(list :tag "Group contents spam/ham classification"
1946 (choice :tag "Group contents classification for spam sorting"
1947 (variable-item gnus-group-spam-classification-spam)
1948 (variable-item gnus-group-spam-classification-ham)
1949 (const :tag "Unclassified" nil)))
1950 :parameter-document
1951 "The spam classification (spam, ham, or neither) of this group.
270a576a
MB
1952When a spam group is entered, all unread articles are marked as
1953spam. There is other behavior associated with ham and no
1954classification when spam.el is loaded - see the manual.")
23f87bed 1955
01c52d31
MB
1956 (gnus-define-group-parameter
1957 spam-resend-to
1958 :type list
1959 :function-document
1960 "The address to get spam resent (through spam-report-resend)."
1961 :variable gnus-spam-resend-to
1962 :variable-default nil
1963 :variable-document
1964 "The address to get spam resent (through spam-report-resend)."
1965 :variable-group spam
1966 :variable-type '(repeat
1967 (list :tag "Group address for resending spam"
1968 (regexp :tag "Group")
1969 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1970 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1971 :parameter-document
1972 "The address to get spam resent (through spam-report-resend).")
1973
1974 (gnus-define-group-parameter
1975 ham-resend-to
1976 :type list
1977 :function-document
1978 "The address to get ham resent (through spam-report-resend)."
1979 :variable gnus-ham-resend-to
1980 :variable-default nil
1981 :variable-document
1982 "The address to get ham resent (through spam-report-resend)."
1983 :variable-group spam
1984 :variable-type '(repeat
1985 (list :tag "Group address for resending ham"
1986 (regexp :tag "Group")
1987 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1988 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1989 :parameter-document
1990 "The address to get ham resent (through spam-report-resend).")
1991
23f87bed
MB
1992 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1993 "OBSOLETE: The ifile summary exit spam processor.")
1994
1995 (defvar gnus-group-spam-exit-processor-stat "stat"
1996 "OBSOLETE: The spam-stat summary exit spam processor.")
1997
1998 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1999 "OBSOLETE: The Bogofilter summary exit spam processor.")
2000
2001 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
2002 "OBSOLETE: The Blacklist summary exit spam processor.")
2003
2004 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2005 "OBSOLETE: The Gmane reporting summary exit spam processor.
2006Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
2007
2008 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2009 "OBSOLETE: The spamoracle summary exit spam processor.")
2010
2011 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2012 "OBSOLETE: The ifile summary exit ham processor.
2013Only applicable to non-spam (unclassified and ham) groups.")
2014
2015 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2016 "OBSOLETE: The Bogofilter summary exit ham processor.
2017Only applicable to non-spam (unclassified and ham) groups.")
2018
2019 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2020 "OBSOLETE: The spam-stat summary exit ham processor.
2021Only applicable to non-spam (unclassified and ham) groups.")
2022
2023 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2024 "OBSOLETE: The whitelist summary exit ham processor.
2025Only applicable to non-spam (unclassified and ham) groups.")
2026
2027 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2028 "OBSOLETE: The BBDB summary exit ham processor.
2029Only applicable to non-spam (unclassified and ham) groups.")
2030
2031 (defvar gnus-group-ham-exit-processor-copy "copy"
2032 "OBSOLETE: The ham copy exit ham processor.
2033Only applicable to non-spam (unclassified and ham) groups.")
2034
2035 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2036 "OBSOLETE: The spamoracle summary exit ham processor.
2037Only applicable to non-spam (unclassified and ham) groups.")
2038
2039 (gnus-define-group-parameter
2040 spam-process
2041 :type list
bf247b6e
KS
2042 :parameter-type
2043 '(choice
23f87bed
MB
2044 :tag "Spam Summary Exit Processor"
2045 :value nil
2046 (list :tag "Spam Summary Exit Processor Choices"
2047 (set
01c52d31
MB
2048 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2049 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2050 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2051 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2052 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2053 (const :tag "Spam: ifile" (spam spam-use-ifile))
2054 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2055 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2056 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2057 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2058 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2059 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2060 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2061 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2062 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2063 (const :tag "Ham: ifile" (ham spam-use-ifile))
2064 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2065 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2066 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2067 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2068 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2069 (variable-item gnus-group-spam-exit-processor-ifile)
2070 (variable-item gnus-group-spam-exit-processor-stat)
2071 (variable-item gnus-group-spam-exit-processor-bogofilter)
2072 (variable-item gnus-group-spam-exit-processor-blacklist)
2073 (variable-item gnus-group-spam-exit-processor-spamoracle)
2074 (variable-item gnus-group-spam-exit-processor-report-gmane)
2075 (variable-item gnus-group-ham-exit-processor-bogofilter)
2076 (variable-item gnus-group-ham-exit-processor-ifile)
2077 (variable-item gnus-group-ham-exit-processor-stat)
2078 (variable-item gnus-group-ham-exit-processor-whitelist)
2079 (variable-item gnus-group-ham-exit-processor-BBDB)
2080 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2081 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2082 :function-document
2083 "Which spam or ham processors will be applied when the summary is exited."
2084 :variable gnus-spam-process-newsgroups
2085 :variable-default nil
2086 :variable-document
2087 "*Groups in which to automatically process spam or ham articles with
2088a backend on summary exit. If non-nil, this should be a list of group
2089name regexps that should match all groups in which to do automatic
2090spam processing, associated with the appropriate processor."
2091 :variable-group spam
bf247b6e 2092 :variable-type
23f87bed
MB
2093 '(repeat :tag "Spam/Ham Processors"
2094 (list :tag "Spam Summary Exit Processor Choices"
2095 (regexp :tag "Group Regexp")
bf247b6e 2096 (set
23f87bed 2097 :tag "Spam/Ham Summary Exit Processor"
01c52d31
MB
2098 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2099 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2100 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2101 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2102 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2103 (const :tag "Spam: ifile" (spam spam-use-ifile))
2104 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2105 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2106 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2107 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2108 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2109 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2110 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2111 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2112 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2113 (const :tag "Ham: ifile" (ham spam-use-ifile))
2114 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2115 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2116 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2117 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2118 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2119 (variable-item gnus-group-spam-exit-processor-ifile)
2120 (variable-item gnus-group-spam-exit-processor-stat)
2121 (variable-item gnus-group-spam-exit-processor-bogofilter)
2122 (variable-item gnus-group-spam-exit-processor-blacklist)
2123 (variable-item gnus-group-spam-exit-processor-spamoracle)
2124 (variable-item gnus-group-spam-exit-processor-report-gmane)
2125 (variable-item gnus-group-ham-exit-processor-bogofilter)
2126 (variable-item gnus-group-ham-exit-processor-ifile)
2127 (variable-item gnus-group-ham-exit-processor-stat)
2128 (variable-item gnus-group-ham-exit-processor-whitelist)
2129 (variable-item gnus-group-ham-exit-processor-BBDB)
2130 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2131 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2132
2133 :parameter-document
2134 "Which spam or ham processors will be applied when the summary is exited.")
2135
2136 (gnus-define-group-parameter
2137 spam-autodetect
2138 :type list
bf247b6e 2139 :parameter-type
23f87bed
MB
2140 '(boolean :tag "Spam autodetection")
2141 :function-document
2142 "Should spam be autodetected (with spam-split) in this group?"
2143 :variable gnus-spam-autodetect
2144 :variable-default nil
2145 :variable-document
2146 "*Groups in which spam should be autodetected when they are entered.
2147 Only unseen articles will be examined, unless
2148 spam-autodetect-recheck-messages is set."
2149 :variable-group spam
bf247b6e 2150 :variable-type
23f87bed
MB
2151 '(repeat
2152 :tag "Autodetection setting"
2153 (list
2154 (regexp :tag "Group Regexp")
2155 boolean))
2156 :parameter-document
2157 "Spam autodetection.
2158Only unseen articles will be examined, unless
2159spam-autodetect-recheck-messages is set.")
2160
2161 (gnus-define-group-parameter
2162 spam-autodetect-methods
2163 :type list
bf247b6e 2164 :parameter-type
23f87bed
MB
2165 '(choice :tag "Spam autodetection-specific methods"
2166 (const none)
2167 (const default)
2168 (set :tag "Use specific methods"
2169 (variable-item spam-use-blacklist)
01c52d31 2170 (variable-item spam-use-gmane-xref)
23f87bed
MB
2171 (variable-item spam-use-regex-headers)
2172 (variable-item spam-use-regex-body)
2173 (variable-item spam-use-whitelist)
2174 (variable-item spam-use-BBDB)
2175 (variable-item spam-use-ifile)
2176 (variable-item spam-use-spamoracle)
01c52d31
MB
2177 (variable-item spam-use-crm114)
2178 (variable-item spam-use-spamassassin)
2179 (variable-item spam-use-spamassassin-headers)
2180 (variable-item spam-use-bsfilter)
2181 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2182 (variable-item spam-use-stat)
2183 (variable-item spam-use-blackholes)
2184 (variable-item spam-use-hashcash)
2185 (variable-item spam-use-bogofilter-headers)
2186 (variable-item spam-use-bogofilter)))
2187 :function-document
2188 "Methods to be used for autodetection in each group"
2189 :variable gnus-spam-autodetect-methods
2190 :variable-default nil
2191 :variable-document
2192 "*Methods for autodetecting spam per group.
2193Requires the spam-autodetect parameter. Only unseen articles
2194will be examined, unless spam-autodetect-recheck-messages is
2195set."
2196 :variable-group spam
bf247b6e 2197 :variable-type
23f87bed
MB
2198 '(repeat
2199 :tag "Autodetection methods"
2200 (list
2201 (regexp :tag "Group Regexp")
2202 (choice
2203 (const none)
2204 (const default)
2205 (set :tag "Use specific methods"
2206 (variable-item spam-use-blacklist)
01c52d31 2207 (variable-item spam-use-gmane-xref)
23f87bed
MB
2208 (variable-item spam-use-regex-headers)
2209 (variable-item spam-use-regex-body)
2210 (variable-item spam-use-whitelist)
2211 (variable-item spam-use-BBDB)
2212 (variable-item spam-use-ifile)
2213 (variable-item spam-use-spamoracle)
01c52d31 2214 (variable-item spam-use-crm114)
23f87bed
MB
2215 (variable-item spam-use-stat)
2216 (variable-item spam-use-blackholes)
2217 (variable-item spam-use-hashcash)
01c52d31
MB
2218 (variable-item spam-use-spamassassin)
2219 (variable-item spam-use-spamassassin-headers)
2220 (variable-item spam-use-bsfilter)
2221 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2222 (variable-item spam-use-bogofilter-headers)
2223 (variable-item spam-use-bogofilter)))))
2224 :parameter-document
bf247b6e 2225 "Spam autodetection methods.
23f87bed
MB
2226Requires the spam-autodetect parameter. Only unseen articles
2227will be examined, unless spam-autodetect-recheck-messages is
2228set.")
2229
2230 (gnus-define-group-parameter
2231 spam-process-destination
2232 :type list
bf247b6e 2233 :parameter-type
23f87bed
MB
2234 '(choice :tag "Destination for spam-processed articles at summary exit"
2235 (string :tag "Move to a group")
2236 (repeat :tag "Move to multiple groups"
2237 (string :tag "Destination group"))
2238 (const :tag "Expire" nil))
2239 :function-document
2240 "Where spam-processed articles will go at summary exit."
2241 :variable gnus-spam-process-destinations
2242 :variable-default nil
2243 :variable-document
2244 "*Groups in which to explicitly send spam-processed articles to
2245another group, or expire them (the default). If non-nil, this should
2246be a list of group name regexps that should match all groups in which
2247to do spam-processed article moving, associated with the destination
2248group or nil for explicit expiration. This only makes sense for
2249mail groups."
2250 :variable-group spam
bf247b6e 2251 :variable-type
23f87bed
MB
2252 '(repeat
2253 :tag "Spam-processed articles destination"
2254 (list
2255 (regexp :tag "Group Regexp")
2256 (choice
2257 :tag "Destination for spam-processed articles at summary exit"
2258 (string :tag "Move to a group")
2259 (repeat :tag "Move to multiple groups"
2260 (string :tag "Destination group"))
2261 (const :tag "Expire" nil))))
2262 :parameter-document
2263 "Where spam-processed articles will go at summary exit.")
bf247b6e 2264
23f87bed
MB
2265 (gnus-define-group-parameter
2266 ham-process-destination
2267 :type list
bf247b6e 2268 :parameter-type
23f87bed
MB
2269 '(choice
2270 :tag "Destination for ham articles at summary exit from a spam group"
2271 (string :tag "Move to a group")
2272 (repeat :tag "Move to multiple groups"
2273 (string :tag "Destination group"))
2274 (const :tag "Respool" respool)
2275 (const :tag "Do nothing" nil))
2276 :function-document
2277 "Where ham articles will go at summary exit from a spam group."
2278 :variable gnus-ham-process-destinations
2279 :variable-default nil
2280 :variable-document
2281 "*Groups in which to explicitly send ham articles to
2282another group, or do nothing (the default). If non-nil, this should
2283be a list of group name regexps that should match all groups in which
2284to do ham article moving, associated with the destination
2285group or nil for explicit ignoring. This only makes sense for
2286mail groups, and only works in spam groups."
2287 :variable-group spam
bf247b6e 2288 :variable-type
23f87bed
MB
2289 '(repeat
2290 :tag "Ham articles destination"
2291 (list
2292 (regexp :tag "Group Regexp")
2293 (choice
2294 :tag "Destination for ham articles at summary exit from spam group"
2295 (string :tag "Move to a group")
2296 (repeat :tag "Move to multiple groups"
2297 (string :tag "Destination group"))
2298 (const :tag "Respool" respool)
2299 (const :tag "Expire" nil))))
2300 :parameter-document
2301 "Where ham articles will go at summary exit from a spam group.")
2302
2303 (gnus-define-group-parameter
2304 ham-marks
2305 :type 'list
2306 :parameter-type '(list :tag "Ham mark choices"
2307 (set
2308 (variable-item gnus-del-mark)
2309 (variable-item gnus-read-mark)
2310 (variable-item gnus-ticked-mark)
2311 (variable-item gnus-killed-mark)
2312 (variable-item gnus-kill-file-mark)
2313 (variable-item gnus-low-score-mark)))
2314
2315 :parameter-document
2316 "Marks considered ham (positively not spam). Such articles will be
2317processed as ham (non-spam) on group exit. When nil, the global
2318spam-ham-marks variable takes precedence."
2319 :variable-default '((".*" ((gnus-del-mark
2320 gnus-read-mark
2321 gnus-killed-mark
2322 gnus-kill-file-mark
2323 gnus-low-score-mark))))
2324 :variable-group spam
2325 :variable-document
2326 "*Groups in which to explicitly set the ham marks to some value.")
2327
2328 (gnus-define-group-parameter
2329 spam-marks
2330 :type 'list
2331 :parameter-type '(list :tag "Spam mark choices"
2332 (set
2333 (variable-item gnus-spam-mark)
2334 (variable-item gnus-killed-mark)
2335 (variable-item gnus-kill-file-mark)
2336 (variable-item gnus-low-score-mark)))
2337
2338 :parameter-document
2339 "Marks considered spam.
2340Such articles will be processed as spam on group exit. When nil, the global
2341spam-spam-marks variable takes precedence."
2342 :variable-default '((".*" ((gnus-spam-mark))))
2343 :variable-group spam
2344 :variable-document
2345 "*Groups in which to explicitly set the spam marks to some value."))
eec82323
LMI
2346
2347(defcustom gnus-group-uncollapsed-levels 1
2348 "Number of group name elements to leave alone when making a short group name."
2349 :group 'gnus-group-visual
2350 :type 'integer)
2351
2352(defcustom gnus-group-use-permanent-levels nil
2353 "*If non-nil, once you set a level, Gnus will use this level."
2354 :group 'gnus-group-levels
2355 :type 'boolean)
2356
2357;; Hooks.
2358
2359(defcustom gnus-load-hook nil
2360 "A hook run while Gnus is loaded."
2361 :group 'gnus-start
2362 :type 'hook)
2363
2364(defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2365 "A hook called to apply kill files to a group.
2366This hook is intended to apply a kill file to the selected newsgroup.
2367The function `gnus-apply-kill-file' is called by default.
2368
2369Since a general kill file is too heavy to use only for a few
2370newsgroups, I recommend you to use a lighter hook function. For
2371example, if you'd like to apply a kill file to articles which contains
2372a string `rmgroup' in subject in newsgroup `control', you can use the
2373following hook:
2374
2375 (setq gnus-apply-kill-hook
2376 (list
2377 (lambda ()
2378 (cond ((string-match \"control\" gnus-newsgroup-name)
2379 (gnus-kill \"Subject\" \"rmgroup\")
2380 (gnus-expunge \"X\"))))))"
2381 :group 'gnus-score-kill
2382 :options '(gnus-apply-kill-file)
2383 :type 'hook)
2384
2385(defcustom gnus-group-change-level-function nil
2386 "Function run when a group level is changed.
2387It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
16409b0b 2388 :group 'gnus-group-levels
4a2358e9
MB
2389 :type '(choice (const nil)
2390 function))
eec82323
LMI
2391
2392;;; Face thingies.
2393
2394(defcustom gnus-visual
2395 '(summary-highlight group-highlight article-highlight
2396 mouse-face
2397 summary-menu group-menu article-menu
2398 tree-highlight menu highlight
2399 browse-menu server-menu
01c52d31 2400 page-marker tree-menu binary-menu pick-menu)
6748645f 2401 "*Enable visual features.
eec82323
LMI
2402If `visual' is disabled, there will be no menus and few faces. Most of
2403the visual customization options below will be ignored. Gnus will use
2404less space and be faster as a result.
2405
2406This variable can also be a list of visual elements to switch on. For
2407instance, to switch off all visual things except menus, you can say:
2408
2409 (setq gnus-visual '(menu))
2410
2411Valid elements include `summary-highlight', `group-highlight',
2412`article-highlight', `mouse-face', `summary-menu', `group-menu',
2413`article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
01c52d31 2414`server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
eec82323
LMI
2415 :group 'gnus-meta
2416 :group 'gnus-visual
2417 :type '(set (const summary-highlight)
2418 (const group-highlight)
2419 (const article-highlight)
2420 (const mouse-face)
2421 (const summary-menu)
2422 (const group-menu)
2423 (const article-menu)
2424 (const tree-highlight)
2425 (const menu)
2426 (const highlight)
2427 (const browse-menu)
2428 (const server-menu)
2429 (const page-marker)
2430 (const tree-menu)
2431 (const binary-menu)
01c52d31 2432 (const pick-menu)))
eec82323 2433
23f87bed
MB
2434;; Byte-compiler warning.
2435(defvar gnus-visual)
2436;; Find out whether the gnus-visual TYPE is wanted.
2437(defun gnus-visual-p (&optional type class)
2438 (and gnus-visual ; Has to be non-nil, at least.
2439 (if (not type) ; We don't care about type.
2440 gnus-visual
2441 (if (listp gnus-visual) ; It's a list, so we check it.
2442 (or (memq type gnus-visual)
2443 (memq class gnus-visual))
2444 t))))
2445
eec82323
LMI
2446(defcustom gnus-mouse-face
2447 (condition-case ()
2448 (if (gnus-visual-p 'mouse-face 'highlight)
2449 (if (boundp 'gnus-mouse-face)
2450 (or gnus-mouse-face 'highlight)
2451 'highlight)
2452 'default)
2453 (error 'highlight))
6748645f 2454 "*Face used for group or summary buffer mouse highlighting.
eec82323
LMI
2455The line beneath the mouse pointer will be highlighted with this
2456face."
2457 :group 'gnus-visual
2458 :type 'face)
2459
eec82323
LMI
2460(defcustom gnus-article-save-directory gnus-directory
2461 "*Name of the directory articles will be saved in (default \"~/News\")."
2462 :group 'gnus-article-saving
2463 :type 'directory)
2464
6748645f
LMI
2465(defvar gnus-plugged t
2466 "Whether Gnus is plugged or not.")
2467
23f87bed
MB
2468(defcustom gnus-agent-cache t
2469 "Controls use of the agent cache while plugged.
2470When set, Gnus will prefer using the locally stored content rather
2471than re-fetching it from the server. You also need to enable
2472`gnus-agent' for this to have any affect."
bf247b6e 2473 :version "22.1"
23f87bed
MB
2474 :group 'gnus-agent
2475 :type 'boolean)
2476
2477(defcustom gnus-default-charset 'undecided
16409b0b
GM
2478 "Default charset assumed to be used when viewing non-ASCII characters.
2479This variable is overridden on a group-to-group basis by the
23f87bed 2480`gnus-group-charset-alist' variable and is only used on groups not
16409b0b
GM
2481covered by that variable."
2482 :type 'symbol
2483 :group 'gnus-charset)
2484
23f87bed
MB
2485;; Fixme: Doc reference to agent.
2486(defcustom gnus-agent t
2487 "Whether we want to use the Gnus agent or not.
2488
2489You may customize gnus-agent to disable its use. However, some
2490back ends have started to use the agent as a client-side cache.
2491Disabling the agent may result in noticeable loss of performance."
bf247b6e 2492 :version "22.1"
23f87bed
MB
2493 :group 'gnus-agent
2494 :type 'boolean)
2495
2496(defcustom gnus-other-frame-function 'gnus
2497 "Function called by the command `gnus-other-frame'."
2498 :group 'gnus-start
2499 :type '(choice (function-item gnus)
2500 (function-item gnus-no-server)
2501 (function-item gnus-slave)
2502 (function-item gnus-slave-no-server)))
2503
2504(defcustom gnus-other-frame-parameters nil
2505 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2506This should be an alist for Emacs, or a plist for XEmacs."
2507 :group 'gnus-start
2508 :type (if (featurep 'xemacs)
2509 '(repeat (list :inline t :format "%v"
2510 (symbol :tag "Property")
2511 (sexp :tag "Value")))
2512 '(repeat (cons :format "%v"
2513 (symbol :tag "Parameter")
2514 (sexp :tag "Value")))))
2515
4a2358e9 2516(defcustom gnus-user-agent '(emacs gnus type)
23f87bed
MB
2517 "Which information should be exposed in the User-Agent header.
2518
4a2358e9
MB
2519Can be a list of symbols or a string. Valid symbols are `gnus'
2520\(show Gnus version\) and `emacs' \(show Emacs version\). In
2521addition to the Emacs version, you can add `codename' \(show
2522\(S\)XEmacs codename\) or either `config' \(show system
2523configuration\) or `type' \(show system type\). If you set it to
2524a string, be sure to use a valid format, see RFC 2616."
2525
bf247b6e 2526 :version "22.1"
23f87bed 2527 :group 'gnus-message
4a2358e9
MB
2528 :type '(choice (list (set :inline t
2529 (const gnus :tag "Gnus version")
2530 (const emacs :tag "Emacs version")
2531 (choice :tag "system"
2532 (const type :tag "system type")
2533 (const config :tag "system configuration"))
2534 (const codename :tag "Emacs codename")))
2535 (string)))
2536
01c52d31 2537;; Convert old (< 2005-01-10) symbol type values:
4a2358e9
MB
2538(when (symbolp gnus-user-agent)
2539 (setq gnus-user-agent
2540 (cond ((eq gnus-user-agent 'emacs-gnus-config)
2541 '(emacs gnus config))
2542 ((eq gnus-user-agent 'emacs-gnus-type)
2543 '(emacs gnus type))
2544 ((eq gnus-user-agent 'emacs-gnus)
2545 '(emacs gnus))
2546 ((eq gnus-user-agent 'gnus)
2547 '(gnus))
2548 (t gnus-user-agent)))
2549 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2550 (sit-for 1)
2551 (if (get 'gnus-user-agent 'saved-value)
2552 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2553 (gnus-message 1 "Edit your init file to make this change permanent.")
2554 (sit-for 2)))
16409b0b 2555
eec82323
LMI
2556\f
2557;;; Internal variables
2558
48df946a 2559(defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
16409b0b 2560(defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
23f87bed
MB
2561(defvar gnus-agent-method-p-cache nil
2562 ; Reset each time gnus-agent-covered-methods is changed else
2563 ; gnus-agent-method-p may mis-report a methods status.
2564 )
2565(defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2566(defvar gnus-draft-meta-information-header "X-Draft-From")
eec82323
LMI
2567(defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2568(defvar gnus-original-article-buffer " *Original Article*")
2569(defvar gnus-newsgroup-name nil)
6748645f 2570(defvar gnus-ephemeral-servers nil)
23f87bed 2571(defvar gnus-server-method-cache nil)
0617bb00 2572(defvar gnus-extended-servers nil)
6748645f 2573
3d319c8f 2574;; The carpal mode has been removed, but define the variable for
01c35094 2575;; backwards compatibility.
3d319c8f
LMI
2576(defvar gnus-carpal nil)
2577(make-obsolete-variable 'gnus-carpal nil "Emacs 24.1")
2578
48df946a
DL
2579(defvar gnus-agent-fetching nil
2580 "Whether Gnus agent is in fetching mode.")
2581
23f87bed
MB
2582(defvar gnus-agent-covered-methods nil
2583 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2584
6748645f 2585(defvar gnus-command-method nil
23f87bed 2586 "Dynamically bound variable that says what the current back end is.")
eec82323
LMI
2587
2588(defvar gnus-current-select-method nil
2589 "The current method for selecting a newsgroup.")
2590
2591(defvar gnus-tree-buffer "*Tree*"
2592 "Buffer where Gnus thread trees are displayed.")
2593
eec82323
LMI
2594;; Variable holding the user answers to all method prompts.
2595(defvar gnus-method-history nil)
eec82323
LMI
2596
2597;; Variable holding the user answers to all mail method prompts.
2598(defvar gnus-mail-method-history nil)
2599
2600;; Variable holding the user answers to all group prompts.
2601(defvar gnus-group-history nil)
2602
2603(defvar gnus-server-alist nil
2604 "List of available servers.")
2605
6748645f
LMI
2606(defcustom gnus-cache-directory
2607 (nnheader-concat gnus-directory "cache/")
2608 "*The directory where cached articles will be stored."
2609 :group 'gnus-cache
2610 :type 'directory)
2611
eec82323
LMI
2612(defvar gnus-predefined-server-alist
2613 `(("cache"
6748645f
LMI
2614 nnspool "cache"
2615 (nnspool-spool-directory ,gnus-cache-directory)
2616 (nnspool-nov-directory ,gnus-cache-directory)
2617 (nnspool-active-file
2618 ,(nnheader-concat gnus-cache-directory "active"))))
eec82323
LMI
2619 "List of predefined (convenience) servers.")
2620
eec82323
LMI
2621(defconst gnus-article-mark-lists
2622 '((marked . tick) (replied . reply)
2623 (expirable . expire) (killed . killed)
2624 (bookmarks . bookmark) (dormant . dormant)
2625 (scored . score) (saved . save)
6748645f 2626 (cached . cache) (downloadable . download)
23f87bed 2627 (unsendable . unsend) (forwarded . forward)
e21bac42 2628 (seen . seen)))
23f87bed
MB
2629
2630(defconst gnus-article-special-mark-lists
2631 '((seen range)
2632 (killed range)
2633 (bookmark tuple)
20a673b2
KY
2634 (uid tuple)
2635 (active tuple)
23f87bed
MB
2636 (score tuple)))
2637
2638;; Propagate flags to server, with the following exceptions:
2639;; `seen' is private to each gnus installation
2640;; `cache' is a internal gnus flag for each gnus installation
2641;; `download' is a agent flag private to each gnus installation
2642;; `unsend' are for nndraft groups only
2643;; `score' is not a proper mark
2644;; `bookmark': don't propagated it, or fix the bug in update-mark.
2645(defconst gnus-article-unpropagated-mark-lists
2646 '(seen cache download unsend score bookmark)
2647 "Marks that shouldn't be propagated to back ends.
2648Typical marks are those that make no sense in a standalone back end,
2649such as a mark that says whether an article is stored in the cache
2650\(which doesn't make sense in a standalone back end).")
eec82323
LMI
2651
2652(defvar gnus-headers-retrieved-by nil)
2653(defvar gnus-article-reply nil)
2654(defvar gnus-override-method nil)
eec82323
LMI
2655(defvar gnus-opened-servers nil)
2656
2657(defvar gnus-current-kill-article nil)
2658
2659(defvar gnus-have-read-active-file nil)
2660
2661(defconst gnus-maintainer
8b7fba43 2662 "submit@debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)"
eec82323
LMI
2663 "The mail address of the Gnus maintainers.")
2664
8b7fba43
TZ
2665(defconst gnus-bug-package
2666 "gnus"
2667 "The package to use in the bug submission.")
2668
eec82323 2669(defvar gnus-info-nodes
23f87bed
MB
2670 '((gnus-group-mode "(gnus)Group Buffer")
2671 (gnus-summary-mode "(gnus)Summary Buffer")
2672 (gnus-article-mode "(gnus)Article Buffer")
2673 (gnus-server-mode "(gnus)Server Buffer")
eec82323
LMI
2674 (gnus-browse-mode "(gnus)Browse Foreign Server")
2675 (gnus-tree-mode "(gnus)Tree Display"))
2676 "Alist of major modes and related Info nodes.")
2677
2678(defvar gnus-group-buffer "*Group*")
2679(defvar gnus-summary-buffer "*Summary*")
2680(defvar gnus-article-buffer "*Article*")
2681(defvar gnus-server-buffer "*Server*")
2682
eec82323
LMI
2683(defvar gnus-slave nil
2684 "Whether this Gnus is a slave or not.")
2685
2686(defvar gnus-batch-mode nil
2687 "Whether this Gnus is running in batch mode or not.")
2688
2689(defvar gnus-variable-list
2690 '(gnus-newsrc-options gnus-newsrc-options-n
16409b0b
GM
2691 gnus-newsrc-last-checked-date
2692 gnus-newsrc-alist gnus-server-alist
2693 gnus-killed-list gnus-zombie-list
e21bac42 2694 gnus-topic-topology gnus-topic-alist)
eec82323
LMI
2695 "Gnus variables saved in the quick startup file.")
2696
2697(defvar gnus-newsrc-alist nil
2698 "Assoc list of read articles.
23f87bed
MB
2699`gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2700
2701(defvar gnus-registry-alist nil
2702 "Assoc list of registry data.
2703gnus-registry.el will populate this if it's loaded.")
eec82323
LMI
2704
2705(defvar gnus-newsrc-hashtb nil
23f87bed 2706 "Hashtable of `gnus-newsrc-alist'.")
eec82323
LMI
2707
2708(defvar gnus-killed-list nil
2709 "List of killed newsgroups.")
2710
2711(defvar gnus-killed-hashtb nil
23f87bed 2712 "Hash table equivalent of `gnus-killed-list'.")
eec82323
LMI
2713
2714(defvar gnus-zombie-list nil
2715 "List of almost dead newsgroups.")
2716
2717(defvar gnus-description-hashtb nil
2718 "Descriptions of newsgroups.")
2719
2720(defvar gnus-list-of-killed-groups nil
2721 "List of newsgroups that have recently been killed by the user.")
2722
2723(defvar gnus-active-hashtb nil
2724 "Hashtable of active articles.")
2725
2726(defvar gnus-moderated-hashtb nil
2727 "Hashtable of moderated newsgroups.")
2728
2729;; Save window configuration.
2730(defvar gnus-prev-winconf nil)
2731
2732(defvar gnus-reffed-article-number nil)
2733
eec82323
LMI
2734(defvar gnus-dead-summary nil)
2735
16409b0b
GM
2736(defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2737 "Regexp matching invalid groups.")
2738
23f87bed
MB
2739(defvar gnus-other-frame-object nil
2740 "A frame object which will be created by `gnus-other-frame'.")
2741
eec82323
LMI
2742;;; End of variables.
2743
2744;; Define some autoload functions Gnus might use.
2745(eval-and-compile
2746
2747 ;; This little mapcar goes through the list below and marks the
2748 ;; symbols in question as autoloaded functions.
01c52d31 2749 (mapc
eec82323
LMI
2750 (lambda (package)
2751 (let ((interactive (nth 1 (memq ':interactive package))))
2752 (mapcar
2753 (lambda (function)
2754 (let (keymap)
2755 (when (consp function)
2756 (setq keymap (car (memq 'keymap function)))
2757 (setq function (car function)))
16409b0b
GM
2758 (unless (fboundp function)
2759 (autoload function (car package) nil interactive keymap))))
eec82323 2760 (if (eq (nth 1 package) ':interactive)
16409b0b 2761 (nthcdr 3 package)
eec82323 2762 (cdr package)))))
16409b0b 2763 '(("info" :interactive t Info-goto-node)
ceaed79b 2764 ("pp" pp-to-string)
16409b0b 2765 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
eec82323 2766 ("ps-print" ps-print-preprint)
eec82323
LMI
2767 ("message" :interactive t
2768 message-send-and-exit message-yank-original)
16409b0b
GM
2769 ("babel" babel-as-string)
2770 ("nnmail" nnmail-split-fancy nnmail-article-group)
eec82323 2771 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
fe1f089f
GM
2772 ;; This is only used in message.el, which has an autoload.
2773 ("rmailout" rmail-output)
2774 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2775 ("rmail" rmail-count-new-messages rmail-show-message
2776 ;; Next two only used in gnus-util.
2777 rmail-summary-exists rmail-select-summary)
2778 ;; Only used in gnus-util, which has an autoload.
2779 ("rmailsum" rmail-update-summary)
eec82323 2780 ("gnus-xmas" gnus-xmas-splash)
eec82323
LMI
2781 ("score-mode" :interactive t gnus-score-mode)
2782 ("gnus-mh" gnus-summary-save-article-folder
2783 gnus-Folder-save-name gnus-folder-save-name)
2784 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
8ccbef23 2785 ("gnus-demon" gnus-demon-add-scanmail
eec82323
LMI
2786 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2787 gnus-demon-add-disconnection gnus-demon-add-handler
2788 gnus-demon-remove-handler)
2789 ("gnus-demon" :interactive t
2790 gnus-demon-init gnus-demon-cancel)
23f87bed
MB
2791 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2792 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2793 gnus-face-from-file)
eec82323 2794 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
71e691a5 2795 gnus-tree-open gnus-tree-close)
6748645f
LMI
2796 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2797 gnus-server-server-name)
eec82323
LMI
2798 ("gnus-srvr" gnus-browse-foreign-server)
2799 ("gnus-cite" :interactive t
2800 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2801 gnus-article-hide-citation gnus-article-fill-cited-article
389b76fa
G
2802 gnus-article-hide-citation-in-followups
2803 gnus-article-fill-cited-long-lines)
eec82323
LMI
2804 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2805 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
16409b0b 2806 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
89b163db
G
2807 ("gnus-registry" gnus-try-warping-via-registry
2808 gnus-registry-handle-action)
eec82323
LMI
2809 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2810 gnus-cache-possibly-remove-articles gnus-cache-request-article
2811 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2812 gnus-cache-enter-remove-article gnus-cached-article-p
16409b0b
GM
2813 gnus-cache-open gnus-cache-close gnus-cache-update-article
2814 gnus-cache-articles-in-group)
2815 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2816 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2817 ("gnus-score" :interactive t
2818 gnus-summary-increase-score gnus-summary-set-score
2819 gnus-summary-raise-thread gnus-summary-raise-same-subject
2820 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2821 gnus-summary-lower-thread gnus-summary-lower-same-subject
2822 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2823 gnus-summary-current-score gnus-score-delta-default
2824 gnus-score-flush-cache gnus-score-close
2825 gnus-possibly-score-headers gnus-score-followup-article
2826 gnus-score-followup-thread)
2827 ("gnus-score"
2828 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
eec82323
LMI
2829 gnus-current-score-file-nondirectory gnus-score-adaptive
2830 gnus-score-find-trace gnus-score-file-name)
2831 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2832 ("gnus-topic" :interactive t gnus-topic-mode)
16409b0b
GM
2833 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2834 gnus-subscribe-topics)
eec82323
LMI
2835 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2836 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2837 ("gnus-uu" :interactive t
2838 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2839 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2840 gnus-uu-mark-by-regexp gnus-uu-mark-all
2841 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2842 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2843 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2844 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2845 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2846 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
6748645f 2847 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
01c52d31 2848 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
16409b0b 2849 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
eec82323
LMI
2850 ("gnus-msg" (gnus-summary-send-map keymap)
2851 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2852 ("gnus-msg" :interactive t
23f87bed
MB
2853 gnus-group-post-news gnus-group-mail gnus-group-news
2854 gnus-summary-post-news gnus-summary-news-other-window
eec82323
LMI
2855 gnus-summary-followup gnus-summary-followup-with-original
2856 gnus-summary-cancel-article gnus-summary-supersede-article
2857 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2858 gnus-summary-mail-forward gnus-summary-mail-other-window
2859 gnus-summary-resend-message gnus-summary-resend-bounced-mail
6748645f
LMI
2860 gnus-summary-wide-reply gnus-summary-followup-to-mail
2861 gnus-summary-followup-to-mail-with-original gnus-bug
2862 gnus-summary-wide-reply-with-original
2863 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2864 gnus-summary-post-forward)
23f87bed 2865 ("gnus-picon" :interactive t gnus-treat-from-picon)
23f87bed 2866 ("smiley" :interactive t smiley-region)
eec82323
LMI
2867 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2868 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2869 gnus-list-of-unread-articles gnus-list-of-read-articles
2870 gnus-offer-save-summaries gnus-make-thread-indent-array
6748645f
LMI
2871 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2872 gnus-summary-skip-intangible gnus-summary-article-number
2873 gnus-data-header gnus-data-find)
eec82323
LMI
2874 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2875 gnus-group-list-groups gnus-group-first-unread-group
2876 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2877 gnus-group-setup-buffer gnus-group-get-new-news
6748645f 2878 gnus-group-make-help-group gnus-group-update-group
16409b0b 2879 gnus-group-iterate gnus-group-group-name)
eec82323
LMI
2880 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2881 gnus-backlog-remove-article)
2882 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2883 gnus-article-prepare gnus-article-set-window-start
2884 gnus-article-next-page gnus-article-prev-page
2885 gnus-request-article-this-buffer gnus-article-mode
2886 gnus-article-setup-buffer gnus-narrow-to-page
16409b0b 2887 gnus-article-delete-invisible-text gnus-treat-article)
eec82323
LMI
2888 ("gnus-art" :interactive t
2889 gnus-article-hide-headers gnus-article-hide-boring-headers
16409b0b 2890 gnus-article-treat-overstrike
eec82323
LMI
2891 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2892 gnus-article-display-x-face gnus-article-de-quoted-unreadable
16409b0b
GM
2893 gnus-article-de-base64-unreadable
2894 gnus-article-decode-HZ
2895 gnus-article-wash-html
23f87bed 2896 gnus-article-unsplit-urls
eec82323
LMI
2897 gnus-article-hide-pem gnus-article-hide-signature
2898 gnus-article-strip-leading-blank-lines gnus-article-date-local
2899 gnus-article-date-original gnus-article-date-lapsed
01c52d31 2900 ;;gnus-article-show-all-headers
eec82323 2901 gnus-article-edit-mode gnus-article-edit-article
16409b0b
GM
2902 gnus-article-edit-done gnus-article-decode-encoded-words
2903 gnus-start-date-timer gnus-stop-date-timer
2904 gnus-mime-view-all-parts)
eec82323
LMI
2905 ("gnus-int" gnus-request-type)
2906 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
01c52d31
MB
2907 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2908 gnus-check-reasonable-setup)
eec82323
LMI
2909 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2910 gnus-dup-enter-articles)
2911 ("gnus-range" gnus-copy-sequence)
2912 ("gnus-eform" gnus-edit-form)
eec82323
LMI
2913 ("gnus-logic" gnus-score-advanced)
2914 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2915 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2916 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2917 gnus-async-halt-prefetch)
6748645f 2918 ("gnus-agent" gnus-open-agent gnus-agent-get-function
fa9a04e1 2919 gnus-agent-save-active gnus-agent-method-p
6748645f 2920 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
23f87bed 2921 gnus-summary-set-agent-mark gnus-agent-save-group-info
f3b146e9
LMI
2922 gnus-agent-request-article gnus-agent-retrieve-headers
2923 gnus-agent-store-article gnus-agent-group-covered-p)
6748645f
LMI
2924 ("gnus-agent" :interactive t
2925 gnus-unplugged gnus-agentize gnus-agent-batch)
eec82323 2926 ("gnus-vm" :interactive t gnus-summary-save-in-vm
6748645f 2927 gnus-summary-save-article-vm)
23f87bed
MB
2928 ("compface" uncompface)
2929 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
16409b0b
GM
2930 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2931 ("gnus-mlspl" :interactive t gnus-group-split-setup
23f87bed
MB
2932 gnus-group-split-update)
2933 ("gnus-delay" gnus-delay-initialize))))
eec82323
LMI
2934
2935;;; gnus-sum.el thingies
2936
2937
23f87bed 2938(defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323
LMI
2939 "*The format specification of the lines in the summary buffer.
2940
2941It works along the same lines as a normal formatting string,
2942with some simple extensions.
2943
0d1c2cc8
G
2944%N Article number, left padded with spaces (string)
2945%S Subject (string)
2946%s Subject if it is at the root of a thread, and \"\"
2947 otherwise (string)
2948%n Name of the poster (string)
2949%a Extracted name of the poster (string)
2950%A Extracted address of the poster (string)
2951%F Contents of the From: header (string)
2952%f Contents of the From: or To: headers (string)
2953%x Contents of the Xref: header (string)
2954%D Date of the article (string)
2955%d Date of the article (string) in DD-MMM format
2956%o Date of the article (string) in YYYYMMDD`T'HHMMSS
2957 format
2958%M Message-id of the article (string)
2959%r References of the article (string)
2960%c Number of characters in the article (integer)
2961%k Pretty-printed version of the above (string)
2962 For example, \"1.2k\" or \"0.4M\".
2963%L Number of lines in the article (integer)
2964%I Indentation based on thread level (a string of
2965 spaces)
2966%B A complex trn-style thread tree (string)
2967 The variables `gnus-sum-thread-*' can be used for
2968 customization.
2969%T A string with two possible values: 80 spaces if the
2970 article is on thread level two or larger and 0 spaces
2971 on level one
2972%R \"A\" if this article has been replied to, \" \"
2973 otherwise (character)
cd865a33 2974%U \"Read\" status of this article.
509542f3 2975 See Info node `(gnus)Marking Articles'
0d1c2cc8
G
2976%[ Opening bracket (character, \"[\" or \"<\")
2977%] Closing bracket (character, \"]\" or \">\")
2978%> Spaces of length thread-level (string)
2979%< Spaces of length (- 20 thread-level) (string)
2980%i Article score (number)
2981%z Article zcore (character)
2982%t Number of articles under the current thread (number).
2983%e Whether the thread is empty or not (character).
2984%V Total thread score (number).
2985%P The line number (number).
2986%O Download mark (character).
2987%* If present, indicates desired cursor position
2988 (instead of after first colon).
2989%u User defined specifier. The next character in the
2990 format string should be a letter. Gnus will call the
2991 function gnus-user-format-function-X, where X is the
2992 letter following %u. The function will be passed the
2993 current header as argument. The function should
2994 return a string, which will be inserted into the
2995 summary just like information from any other summary
2996 specifier.
2997&user-date; Age sensitive date format. Various date format is
2998 defined in `gnus-summary-user-date-format-alist'.
2999
eec82323 3000
eec82323
LMI
3001The %U (status), %R (replied) and %z (zcore) specs have to be handled
3002with care. For reasons of efficiency, Gnus will compute what column
3003these characters will end up in, and \"hard-code\" that. This means that
65a32076 3004it is invalid to have these specs after a variable-length spec. Well,
eec82323
LMI
3005you might not be arrested, but your summary buffer will look strange,
3006which is bad enough.
3007
23f87bed 3008The smart choice is to have these specs as far to the left as
eec82323
LMI
3009possible.
3010
23f87bed
MB
3011This restriction may disappear in later versions of Gnus.
3012
3013General format specifiers can also be used.
3014See Info node `(gnus)Formatting Variables'."
3015 :link '(custom-manual "(gnus)Formatting Variables")
eec82323
LMI
3016 :type 'string
3017 :group 'gnus-summary-format)
3018
3019;;;
3020;;; Skeleton keymaps
3021;;;
3022
3023(defun gnus-suppress-keymap (keymap)
3024 (suppress-keymap keymap)
6748645f 3025 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
eec82323
LMI
3026 (while keys
3027 (define-key keymap (pop keys) 'undefined))))
3028
3029(defvar gnus-article-mode-map
16409b0b 3030 (let ((keymap (make-sparse-keymap)))
eec82323
LMI
3031 (gnus-suppress-keymap keymap)
3032 keymap))
3033(defvar gnus-summary-mode-map
3034 (let ((keymap (make-keymap)))
3035 (gnus-suppress-keymap keymap)
3036 keymap))
3037(defvar gnus-group-mode-map
3038 (let ((keymap (make-keymap)))
3039 (gnus-suppress-keymap keymap)
3040 keymap))
3041
3042\f
3043
3044;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3045;; If you want the cursor to go somewhere else, set these two
3046;; functions in some startup hook to whatever you want.
3047(defalias 'gnus-summary-position-point 'gnus-goto-colon)
3048(defalias 'gnus-group-position-point 'gnus-goto-colon)
3049
3050;;; Various macros and substs.
3051
3052(defun gnus-header-from (header)
3053 (mail-header-from header))
3054
3055(defmacro gnus-gethash (string hashtable)
3056 "Get hash value of STRING in HASHTABLE."
3057 `(symbol-value (intern-soft ,string ,hashtable)))
3058
23f87bed
MB
3059(defmacro gnus-gethash-safe (string hashtable)
3060 "Get hash value of STRING in HASHTABLE.
3061Return nil if not defined."
3062 `(let ((sym (intern-soft ,string ,hashtable)))
3063 (and (boundp sym) (symbol-value sym))))
3064
eec82323
LMI
3065(defmacro gnus-sethash (string value hashtable)
3066 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3067 `(set (intern ,string ,hashtable) ,value))
3068(put 'gnus-sethash 'edebug-form-spec '(form form form))
3069
3070(defmacro gnus-group-unread (group)
3071 "Get the currently computed number of unread articles in GROUP."
3072 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3073
3074(defmacro gnus-group-entry (group)
3075 "Get the newsrc entry for GROUP."
3076 `(gnus-gethash ,group gnus-newsrc-hashtb))
3077
3078(defmacro gnus-active (group)
3079 "Get active info on GROUP."
3080 `(gnus-gethash ,group gnus-active-hashtb))
3081
3082(defmacro gnus-set-active (group active)
3083 "Set GROUP's active info."
3084 `(gnus-sethash ,group ,active gnus-active-hashtb))
3085
eec82323
LMI
3086;; Info access macros.
3087
3088(defmacro gnus-info-group (info)
3089 `(nth 0 ,info))
3090(defmacro gnus-info-rank (info)
3091 `(nth 1 ,info))
3092(defmacro gnus-info-read (info)
3093 `(nth 2 ,info))
3094(defmacro gnus-info-marks (info)
3095 `(nth 3 ,info))
3096(defmacro gnus-info-method (info)
3097 `(nth 4 ,info))
3098(defmacro gnus-info-params (info)
3099 `(nth 5 ,info))
3100
3101(defmacro gnus-info-level (info)
3102 `(let ((rank (gnus-info-rank ,info)))
3103 (if (consp rank)
3104 (car rank)
3105 rank)))
3106(defmacro gnus-info-score (info)
3107 `(let ((rank (gnus-info-rank ,info)))
3108 (or (and (consp rank) (cdr rank)) 0)))
3109
3110(defmacro gnus-info-set-group (info group)
3111 `(setcar ,info ,group))
3112(defmacro gnus-info-set-rank (info rank)
3113 `(setcar (nthcdr 1 ,info) ,rank))
3114(defmacro gnus-info-set-read (info read)
3115 `(setcar (nthcdr 2 ,info) ,read))
3116(defmacro gnus-info-set-marks (info marks &optional extend)
3117 (if extend
3118 `(gnus-info-set-entry ,info ,marks 3)
3119 `(setcar (nthcdr 3 ,info) ,marks)))
3120(defmacro gnus-info-set-method (info method &optional extend)
3121 (if extend
3122 `(gnus-info-set-entry ,info ,method 4)
3123 `(setcar (nthcdr 4 ,info) ,method)))
3124(defmacro gnus-info-set-params (info params &optional extend)
3125 (if extend
3126 `(gnus-info-set-entry ,info ,params 5)
3127 `(setcar (nthcdr 5 ,info) ,params)))
3128
3129(defun gnus-info-set-entry (info entry number)
3130 ;; Extend the info until we have enough elements.
3131 (while (<= (length info) number)
3132 (nconc info (list nil)))
3133 ;; Set the entry.
3134 (setcar (nthcdr number info) entry))
3135
3136(defmacro gnus-info-set-level (info level)
3137 `(let ((rank (cdr ,info)))
3138 (if (consp (car rank))
3139 (setcar (car rank) ,level)
3140 (setcar rank ,level))))
3141(defmacro gnus-info-set-score (info score)
3142 `(let ((rank (cdr ,info)))
3143 (if (consp (car rank))
3144 (setcdr (car rank) ,score)
3145 (setcar rank (cons (car rank) ,score)))))
3146
3147(defmacro gnus-get-info (group)
3148 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3149
85e75ded
LI
3150(defun gnus-set-info (group info)
3151 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3152 info))
3153
8f688cb0 3154;;; Load the compatibility functions.
eec82323
LMI
3155
3156(require 'gnus-ems)
3157
3158\f
3159;;;
3160;;; Shutdown
3161;;;
3162
3163(defvar gnus-shutdown-alist nil)
3164
3165(defun gnus-add-shutdown (function &rest symbols)
3166 "Run FUNCTION whenever one of SYMBOLS is shut down."
3167 (push (cons function symbols) gnus-shutdown-alist))
3168
3169(defun gnus-shutdown (symbol)
3170 "Shut down everything that waits for SYMBOL."
01c52d31
MB
3171 (dolist (entry gnus-shutdown-alist)
3172 (when (memq symbol (cdr entry))
3173 (funcall (car entry)))))
eec82323
LMI
3174
3175\f
3176;;;
3177;;; Gnus Utility Functions
3178;;;
3179
23f87bed
MB
3180(defun gnus-find-subscribed-addresses ()
3181 "Return a regexp matching the addresses of all subscribed mail groups.
3182It consists of the `to-address' or `to-list' parameter of all groups
3183with a `subscribed' parameter."
3184 (let (group address addresses)
3185 (dolist (entry (cdr gnus-newsrc-alist))
3186 (setq group (car entry))
3187 (when (gnus-parameter-subscribed group)
3188 (setq address (mail-strip-quoted-names
3189 (or (gnus-group-fast-parameter group 'to-address)
3190 (gnus-group-fast-parameter group 'to-list))))
3191 (when address
3192 (add-to-list 'addresses address))))
3193 (when addresses
3194 (list (mapconcat 'regexp-quote addresses "\\|")))))
6748645f 3195
a8151ef7
LMI
3196(defmacro gnus-string-or (&rest strings)
3197 "Return the first element of STRINGS that is a non-blank string.
3198STRINGS will be evaluated in normal `or' order."
075843d3 3199 `(gnus-string-or-1 (list ,@strings)))
a8151ef7
LMI
3200
3201(defun gnus-string-or-1 (strings)
3202 (let (string)
3203 (while strings
075843d3 3204 (setq string (pop strings))
a8151ef7
LMI
3205 (if (string-match "^[ \t]*$" string)
3206 (setq string nil)
3207 (setq strings nil)))
3208 string))
3209
eec82323
LMI
3210(defun gnus-version (&optional arg)
3211 "Version number of this version of Gnus.
3212If ARG, insert string at point."
3213 (interactive "P")
6748645f
LMI
3214 (if arg
3215 (insert (message gnus-version))
3216 (message gnus-version)))
eec82323 3217
23f87bed 3218(defun gnus-continuum-version (&optional version)
eec82323 3219 "Return VERSION as a floating point number."
23f87bed
MB
3220 (unless version
3221 (setq version gnus-version))
eec82323
LMI
3222 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3223 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
6748645f
LMI
3224 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3225 (number (match-string 2 version))
3226 major minor least)
3227 (unless (string-match
3228 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3229 (error "Invalid version string: %s" version))
3230 (setq major (string-to-number (match-string 1 number))
3231 minor (string-to-number (match-string 2 number))
3232 least (if (match-beginning 3)
eec82323
LMI
3233 (string-to-number (match-string 3 number))
3234 0))
3235 (string-to-number
3236 (if (zerop major)
23f87bed
MB
3237 (format "%s00%02d%02d"
3238 (if (member alpha '("(ding)" "d"))
3239 "4.99"
3240 (+ 5 (* 0.02
3241 (abs
3242 (- (mm-char-int (aref (downcase alpha) 0))
3243 (mm-char-int ?t))))
3244 -0.01))
3245 minor least)
eec82323
LMI
3246 (format "%d.%02d%02d" major minor least))))))
3247
23f87bed 3248(defun gnus-info-find-node (&optional nodename)
eec82323
LMI
3249 "Find Info documentation of Gnus."
3250 (interactive)
3251 ;; Enlarge info window if needed.
3252 (let (gnus-info-buffer)
23f87bed 3253 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
eec82323
LMI
3254 (setq gnus-info-buffer (current-buffer))
3255 (gnus-configure-windows 'info)))
3256
6748645f
LMI
3257;;;
3258;;; gnus-interactive
3259;;;
3260
3261(defvar gnus-current-prefix-symbol nil
3262 "Current prefix symbol.")
3263
3264(defvar gnus-current-prefix-symbols nil
3265 "List of current prefix symbols.")
3266
3267(defun gnus-interactive (string &optional params)
3268 "Return a list that can be fed to `interactive'.
3269See `interactive' for full documentation.
3270
3271Adds the following specs:
3272
3273y -- The current symbolic prefix.
3274Y -- A list of the current symbolic prefix(es).
3275A -- Article number.
3276H -- Article header.
3277g -- Group name."
3278 (let ((i 0)
3279 out c prompt)
3280 (while (< i (length string))
3281 (string-match ".\\([^\n]*\\)\n?" string i)
3282 (setq c (aref string i))
3283 (when (match-end 1)
3284 (setq prompt (match-string 1 string)))
3285 (setq i (match-end 0))
3286 ;; We basically emulate just about everything that
3287 ;; `interactive' does, but add the specs listed above.
3288 (push
3289 (cond
3290 ((= c ?a)
3291 (completing-read prompt obarray 'fboundp t))
3292 ((= c ?b)
3293 (read-buffer prompt (current-buffer) t))
3294 ((= c ?B)
3295 (read-buffer prompt (other-buffer (current-buffer))))
3296 ((= c ?c)
3297 (read-char))
3298 ((= c ?C)
3299 (completing-read prompt obarray 'commandp t))
3300 ((= c ?d)
3301 (point))
3302 ((= c ?D)
7e27ce9c 3303 (read-directory-name prompt nil default-directory 'lambda))
6748645f
LMI
3304 ((= c ?f)
3305 (read-file-name prompt nil nil 'lambda))
3306 ((= c ?F)
3307 (read-file-name prompt))
3308 ((= c ?k)
3309 (read-key-sequence prompt))
3310 ((= c ?K)
3311 (error "Not implemented spec"))
3312 ((= c ?e)
3313 (error "Not implemented spec"))
3314 ((= c ?m)
3315 (mark))
3316 ((= c ?N)
3317 (error "Not implemented spec"))
3318 ((= c ?n)
3319 (string-to-number (read-from-minibuffer prompt)))
3320 ((= c ?p)
3321 (prefix-numeric-value current-prefix-arg))
3322 ((= c ?P)
3323 current-prefix-arg)
3324 ((= c ?r)
3325 'gnus-prefix-nil)
3326 ((= c ?s)
3327 (read-string prompt))
3328 ((= c ?S)
3329 (intern (read-string prompt)))
3330 ((= c ?v)
3331 (read-variable prompt))
3332 ((= c ?x)
3333 (read-minibuffer prompt))
3334 ((= c ?x)
3335 (eval-minibuffer prompt))
3336 ;; And here the new specs come.
3337 ((= c ?y)
3338 gnus-current-prefix-symbol)
3339 ((= c ?Y)
3340 gnus-current-prefix-symbols)
3341 ((= c ?g)
3342 (gnus-group-group-name))
3343 ((= c ?A)
3344 (gnus-summary-skip-intangible)
3345 (or (get-text-property (point) 'gnus-number)
3346 (gnus-summary-last-subject)))
3347 ((= c ?H)
3348 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3349 (t
3350 (error "Non-implemented spec")))
3351 out)
3352 (cond
3353 ((= c ?r)
fa066d09
GM
3354 (push (if (< (point) (mark)) (point) (mark)) out)
3355 (push (if (> (point) (mark)) (point) (mark)) out))))
6748645f
LMI
3356 (setq out (delq 'gnus-prefix-nil out))
3357 (nreverse out)))
3358
3359(defun gnus-symbolic-argument (&optional arg)
3360 "Read a symbolic argument and a command, and then execute command."
3361 (interactive "P")
3362 (let* ((in-command (this-command-keys))
3363 (command in-command)
3364 gnus-current-prefix-symbols
3365 gnus-current-prefix-symbol
3366 syms)
3367 (while (equal in-command command)
3368 (message "%s-" (key-description (this-command-keys)))
3369 (push (intern (char-to-string (read-char))) syms)
3370 (setq command (read-key-sequence nil t)))
3371 (setq gnus-current-prefix-symbols (nreverse syms)
3372 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3373 (call-interactively (key-binding command t))))
3374
eec82323
LMI
3375;;; More various functions.
3376
a36c8d02
RS
3377(defsubst gnus-check-backend-function (func group)
3378 "Check whether GROUP supports function FUNC.
3379GROUP can either be a string (a group name) or a select method."
3380 (ignore-errors
3381 (let ((method (if (stringp group)
3382 (car (gnus-find-method-for-group group))
3383 group)))
3384 (unless (featurep method)
3385 (require method))
3386 (fboundp (intern (format "%s-%s" method func))))))
3387
eec82323
LMI
3388(defun gnus-group-read-only-p (&optional group)
3389 "Check whether GROUP supports editing or not.
65a32076 3390If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
eec82323
LMI
3391that that variable is buffer-local to the summary buffers."
3392 (let ((group (or group gnus-newsgroup-name)))
3393 (not (gnus-check-backend-function 'request-replace-article group))))
3394
eec82323
LMI
3395(defun gnus-virtual-group-p (group)
3396 "Say whether GROUP is virtual or not."
3397 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3398 gnus-valid-select-methods)))
3399
3400(defun gnus-news-group-p (group &optional article)
3401 "Return non-nil if GROUP (and ARTICLE) come from a news server."
23f87bed 3402 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
f7aa248a 3403 t) ;is news of course.
23f87bed
MB
3404 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3405 nil) ;must be mail then.
3406 ((vectorp article) ;Has header info.
3407 (eq (gnus-request-type group (mail-header-id article)) 'news))
f7aa248a 3408 ((null article) ;Hasn't header info
23f87bed 3409 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
f7aa248a 3410 ((< article 0) ;Virtual message
23f87bed
MB
3411 nil) ;we don't know, guess mail.
3412 (t ;Has positive number
3413 (eq (gnus-request-type group article) 'news)))) ;use it.
eec82323 3414
eec82323
LMI
3415;; Check whether to use long file names.
3416(defun gnus-use-long-file-name (symbol)
3417 ;; The variable has to be set...
3418 (and gnus-use-long-file-name
3419 ;; If it isn't a list, then we return t.
3420 (or (not (listp gnus-use-long-file-name))
3421 ;; If it is a list, and the list contains `symbol', we
3422 ;; return nil.
3423 (not (memq symbol gnus-use-long-file-name)))))
3424
3425;; Generate a unique new group name.
3426(defun gnus-generate-new-group-name (leaf)
3427 (let ((name leaf)
3428 (num 0))
01c52d31 3429 (while (gnus-group-entry name)
eec82323
LMI
3430 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3431 name))
3432
3433(defun gnus-ephemeral-group-p (group)
3434 "Say whether GROUP is ephemeral or not."
6748645f 3435 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3436
3437(defun gnus-group-quit-config (group)
3438 "Return the quit-config of GROUP."
6748645f 3439 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3440
3441(defun gnus-kill-ephemeral-group (group)
3442 "Remove ephemeral GROUP from relevant structures."
3443 (gnus-sethash group nil gnus-newsrc-hashtb))
3444
3445(defun gnus-simplify-mode-line ()
3446 "Make mode lines a bit simpler."
a8151ef7 3447 (setq mode-line-modified (cdr gnus-mode-line-modified))
eec82323
LMI
3448 (when (listp mode-line-format)
3449 (make-local-variable 'mode-line-format)
3450 (setq mode-line-format (copy-sequence mode-line-format))
3451 (when (equal (nth 3 mode-line-format) " ")
3452 (setcar (nthcdr 3 mode-line-format) " "))))
3453
3454;;; Servers and groups.
3455
3456(defsubst gnus-server-add-address (method)
3457 (let ((method-name (symbol-name (car method))))
3458 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3459 (not (assq (intern (concat method-name "-address")) method))
3460 (memq 'physical-address (assq (car method)
3461 gnus-valid-select-methods)))
3462 (append method (list (list (intern (concat method-name "-address"))
3463 (nth 1 method))))
3464 method)))
3465
b069e5a6 3466(defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
14e20e13
MB
3467 (catch 'server-name
3468 (setq method (or method gnus-select-method))
3469
3470 ;; Perhaps it is already in the cache.
b890d447
MB
3471 (unless nocache
3472 (mapc (lambda (name-method)
3473 (if (equal (cdr name-method) method)
3474 (throw 'server-name (car name-method))))
3475 gnus-server-method-cache))
14e20e13
MB
3476
3477 (mapc
3478 (lambda (server-alist)
3479 (mapc (lambda (name-method)
01c52d31
MB
3480 (when (gnus-methods-equal-p (cdr name-method) method)
3481 (unless (member name-method gnus-server-method-cache)
3482 (push name-method gnus-server-method-cache))
3483 (throw 'server-name (car name-method))))
3484 server-alist))
3485 (list gnus-server-alist
3486 gnus-predefined-server-alist))
14e20e13
MB
3487
3488 (let* ((name (if (member (cadr method) '(nil ""))
01c52d31
MB
3489 (format "%s" (car method))
3490 (format "%s:%s" (car method) (cadr method))))
3491 (name-method (cons name method)))
b069e5a6
G
3492 (when (and (not (member name-method gnus-server-method-cache))
3493 (not no-enter-cache)
3494 (not (assoc (car name-method) gnus-server-method-cache)))
01c52d31 3495 (push name-method gnus-server-method-cache))
14e20e13
MB
3496 name)))
3497
23f87bed
MB
3498(defsubst gnus-server-to-method (server)
3499 "Map virtual server names to select methods."
3500 (or (and server (listp server) server)
3501 (cdr (assoc server gnus-server-method-cache))
3502 (let ((result
3503 (or
3504 ;; Perhaps this is the native server?
3505 (and (equal server "native") gnus-select-method)
3506 ;; It should be in the server alist.
3507 (cdr (assoc server gnus-server-alist))
3508 ;; It could be in the predefined server alist.
3509 (cdr (assoc server gnus-predefined-server-alist))
3510 ;; If not, we look through all the opened server
3511 ;; to see whether we can find it there.
3512 (let ((opened gnus-opened-servers))
3513 (while (and opened
3514 (not (equal server (format "%s:%s" (caaar opened)
3515 (cadaar opened)))))
3516 (pop opened))
3517 (caar opened))
3518 ;; It could be a named method, search all servers
3519 (let ((servers gnus-secondary-select-methods))
3520 (while (and servers
3521 (not (equal server (format "%s:%s" (caar servers)
3522 (cadar servers)))))
3523 (pop servers))
3524 (car servers))
fdc90613
MB
3525 ;; This could be some sort of foreign server that I
3526 ;; simply haven't opened (yet). Do a brute-force scan
3527 ;; of the entire gnus-newsrc-alist for the server name
3528 ;; of every method. As a side-effect, loads the
3529 ;; gnus-server-method-cache so this only happens once,
3530 ;; if at all.
3531 (let ((alist (cdr gnus-newsrc-alist))
3532 method match)
3533 (while alist
3534 (setq method (gnus-info-method (pop alist)))
3535 (when (and (not (stringp method))
b069e5a6
G
3536 (equal server
3537 (gnus-method-to-server method nil t)))
fdc90613
MB
3538 (setq match method
3539 alist nil)))
3540 match))))
b069e5a6
G
3541 (when (and result
3542 (not (assoc server gnus-server-method-cache)))
fdc90613 3543 (push (cons server result) gnus-server-method-cache))
23f87bed
MB
3544 result)))
3545
eec82323
LMI
3546(defsubst gnus-server-get-method (group method)
3547 ;; Input either a server name, and extended server name, or a
3548 ;; select method, and return a select method.
3549 (cond ((stringp method)
3550 (gnus-server-to-method method))
3551 ((equal method gnus-select-method)
3552 gnus-select-method)
6748645f
LMI
3553 ((and (stringp (car method))
3554 group)
eec82323 3555 (gnus-server-extend-method group method))
6748645f
LMI
3556 ((and method
3557 (not group)
eec82323
LMI
3558 (equal (cadr method) ""))
3559 method)
3560 (t
3561 (gnus-server-add-address method))))
3562
eec82323
LMI
3563(defmacro gnus-method-equal (ss1 ss2)
3564 "Say whether two servers are equal."
3565 `(let ((s1 ,ss1)
3566 (s2 ,ss2))
3567 (or (equal s1 s2)
3568 (and (= (length s1) (length s2))
3569 (progn
3570 (while (and s1 (member (car s1) s2))
3571 (setq s1 (cdr s1)))
3572 (null s1))))))
3573
16409b0b
GM
3574(defun gnus-methods-equal-p (m1 m2)
3575 (let ((m1 (or m1 gnus-select-method))
3576 (m2 (or m2 gnus-select-method)))
3577 (or (equal m1 m2)
3578 (and (eq (car m1) (car m2))
3579 (or (not (memq 'address (assoc (symbol-name (car m1))
3580 gnus-valid-select-methods)))
3581 (equal (nth 1 m1) (nth 1 m2)))))))
3582
0617bb00 3583(defsubst gnus-sloppily-equal-method-parameters (m1 m2)
4c36be58 3584 ;; Check parameters for sloppy equality.
61b1af82
G
3585 (let ((p1 (copy-sequence (cddr m1)))
3586 (p2 (copy-sequence (cddr m2)))
0617bb00
LMI
3587 e1 e2)
3588 (block nil
3589 (while (setq e1 (pop p1))
3590 (unless (setq e2 (assq (car e1) p2))
3591 ;; The parameter doesn't exist in p2.
3592 (return nil))
3593 (setq p2 (delq e2 p2))
61b1af82 3594 (unless (equal e1 e2)
0617bb00
LMI
3595 (if (not (and (stringp (cadr e1))
3596 (stringp (cadr e2))))
3597 (return nil)
3598 ;; Special-case string parameter comparison so that we
3599 ;; can uniquify them.
3600 (let ((s1 (cadr e1))
3601 (s2 (cadr e2)))
3602 (when (string-match "/$" s1)
3603 (setq s1 (directory-file-name s1)))
3604 (when (string-match "/$" s2)
3605 (setq s2 (directory-file-name s2)))
3606 (unless (equal s1 s2)
3607 (return nil))))))
3608 ;; If p2 now is empty, they were equal.
3609 (null p2))))
bdaa75c7 3610
a427f84d
JB
3611(defun gnus-method-ephemeral-p (method)
3612 (let ((equal nil))
3613 (dolist (ephemeral gnus-ephemeral-servers)
3614 (when (gnus-sloppily-equal-method-parameters method ephemeral)
3615 (setq equal t)))
3616 equal))
3617
f979f37e
GM
3618(defun gnus-methods-sloppily-equal (m1 m2)
3619 ;; Same method.
3620 (or
3621 (eq m1 m2)
3622 ;; Type and name are equal.
3623 (and
3624 (eq (car m1) (car m2))
3625 (equal (cadr m1) (cadr m2))
3626 (gnus-sloppily-equal-method-parameters m1 m2))))
3627
eec82323
LMI
3628(defun gnus-server-equal (m1 m2)
3629 "Say whether two methods are equal."
3630 (let ((m1 (cond ((null m1) gnus-select-method)
3631 ((stringp m1) (gnus-server-to-method m1))
3632 (t m1)))
3633 (m2 (cond ((null m2) gnus-select-method)
3634 ((stringp m2) (gnus-server-to-method m2))
3635 (t m2))))
3636 (gnus-method-equal m1 m2)))
3637
3638(defun gnus-servers-using-backend (backend)
3639 "Return a list of known servers using BACKEND."
3640 (let ((opened gnus-opened-servers)
3641 out)
3642 (while opened
3643 (when (eq backend (caaar opened))
3644 (push (caar opened) out))
3645 (pop opened))
3646 out))
3647
3648(defun gnus-archive-server-wanted-p ()
3649 "Say whether the user wants to use the archive server."
3650 (cond
3651 ((or (not gnus-message-archive-method)
3652 (not gnus-message-archive-group))
3653 nil)
3654 ((and gnus-message-archive-method gnus-message-archive-group)
3655 t)
3656 (t
3657 (let ((active (cadr (assq 'nnfolder-active-file
3658 gnus-message-archive-method))))
3659 (and active
3660 (file-exists-p active))))))
3661
23f87bed
MB
3662(defsubst gnus-method-to-server-name (method)
3663 (concat
3664 (format "%s" (car method))
3665 (when (and
3666 (or (assoc (format "%s" (car method))
3667 (gnus-methods-using 'address))
3668 (gnus-server-equal method gnus-message-archive-method))
3669 (nth 1 method)
3670 (not (string= (nth 1 method) "")))
3671 (concat "+" (nth 1 method)))))
3672
3673(defsubst gnus-method-to-full-server-name (method)
3674 (format "%s+%s" (car method) (nth 1 method)))
3675
3676(defun gnus-group-prefixed-name (group method &optional full)
3677 "Return the whole name from GROUP and METHOD.
3678Call with full set to get the fully qualified group name (even if the
3679server is native)."
3680 (when (stringp method)
3681 (setq method (gnus-server-to-method method)))
6748645f 3682 (if (or (not method)
23f87bed
MB
3683 (and (not full) (gnus-server-equal method "native"))
3684 ;;;!!! This might not be right. We'll see...
3685 ;(string-match ":" group)
3686 )
eec82323 3687 group
23f87bed
MB
3688 (concat (gnus-method-to-server-name method) ":" group)))
3689
23f87bed
MB
3690(defun gnus-group-full-name (group method)
3691 "Return the full name from GROUP and METHOD, even if the method is native."
3692 (gnus-group-prefixed-name group method t))
3693
23f87bed
MB
3694(defun gnus-group-guess-full-name-from-command-method (group)
3695 "Guess the full name from GROUP, even if the method is native."
3696 (if (gnus-group-prefixed-p group)
3697 group
3698 (gnus-group-full-name group gnus-command-method)))
eec82323
LMI
3699
3700(defun gnus-group-real-prefix (group)
3701 "Return the prefix of the current group name."
23f87bed
MB
3702 (if (stringp group)
3703 (if (string-match "^[^:]+:" group)
3704 (substring group 0 (match-end 0))
3705 "")
3706 nil))
3707
3708(defun gnus-group-short-name (group)
3709 "Return the short group name."
3710 (let ((prefix (gnus-group-real-prefix group)))
3711 (if (< 0 (length prefix))
3712 (substring group (length prefix) nil)
3713 group)))
3714
3715(defun gnus-group-prefixed-p (group)
3716 "Return the prefix of the current group name."
3717 (< 0 (length (gnus-group-real-prefix group))))
3718
c7e9cfaf
GM
3719(declare-function gnus-group-decoded-name "gnus-group" (string))
3720
23f87bed
MB
3721(defun gnus-summary-buffer-name (group)
3722 "Return the summary buffer name of GROUP."
3723 (concat "*Summary " (gnus-group-decoded-name group) "*"))
eec82323
LMI
3724
3725(defun gnus-group-method (group)
3726 "Return the server or method used for selecting GROUP.
3727You should probably use `gnus-find-method-for-group' instead."
3728 (let ((prefix (gnus-group-real-prefix group)))
3729 (if (equal prefix "")
3730 gnus-select-method
3731 (let ((servers gnus-opened-servers)
3732 (server "")
3733 backend possible found)
3734 (if (string-match "^[^\\+]+\\+" prefix)
3735 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3736 server (substring prefix (match-end 0) (1- (length prefix))))
3737 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3738 (while servers
3739 (when (eq (caaar servers) backend)
3740 (setq possible (caar servers))
3741 (when (equal (cadaar servers) server)
3742 (setq found (caar servers))))
3743 (pop servers))
3744 (or (car (rassoc found gnus-server-alist))
3745 found
3746 (car (rassoc possible gnus-server-alist))
3747 possible
3748 (list backend server))))))
3749
16409b0b
GM
3750(defsubst gnus-native-method-p (method)
3751 "Return whether METHOD is the native select method."
3752 (gnus-method-equal method gnus-select-method))
3753
eec82323
LMI
3754(defsubst gnus-secondary-method-p (method)
3755 "Return whether METHOD is a secondary select method."
3756 (let ((methods gnus-secondary-select-methods)
23f87bed 3757 (gmethod (inline (gnus-server-get-method nil method))))
eec82323 3758 (while (and methods
16409b0b 3759 (not (gnus-method-equal
23f87bed 3760 (inline (gnus-server-get-method nil (car methods)))
16409b0b 3761 gmethod)))
eec82323
LMI
3762 (setq methods (cdr methods)))
3763 methods))
3764
16409b0b
GM
3765(defun gnus-method-simplify (method)
3766 "Return the shortest uniquely identifying string or method for METHOD."
3767 (cond ((stringp method)
3768 method)
3769 ((gnus-native-method-p method)
3770 nil)
3771 ((gnus-secondary-method-p method)
3772 (format "%s:%s" (nth 0 method) (nth 1 method)))
3773 (t
3774 method)))
3775
6748645f
LMI
3776(defun gnus-groups-from-server (server)
3777 "Return a list of all groups that are fetched from SERVER."
3778 (let ((alist (cdr gnus-newsrc-alist))
3779 info groups)
3780 (while (setq info (pop alist))
3781 (when (gnus-server-equal (gnus-info-method info) server)
3782 (push (gnus-info-group info) groups)))
3783 (sort groups 'string<)))
3784
eec82323
LMI
3785(defun gnus-group-foreign-p (group)
3786 "Say whether a group is foreign or not."
3787 (and (not (gnus-group-native-p group))
3788 (not (gnus-group-secondary-p group))))
3789
3790(defun gnus-group-native-p (group)
3791 "Say whether the group is native or not."
3792 (not (string-match ":" group)))
3793
3794(defun gnus-group-secondary-p (group)
3795 "Say whether the group is secondary or not."
3796 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3797
23f87bed
MB
3798(defun gnus-parameters-get-parameter (group)
3799 "Return the group parameters for GROUP from `gnus-parameters'."
e8beac8a
MB
3800 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3801 case-fold-search
3802 gnus-parameters-case-fold-search))
3803 params-list)
23f87bed
MB
3804 (dolist (elem gnus-parameters)
3805 (when (string-match (car elem) group)
3806 (setq params-list
3807 (nconc (gnus-expand-group-parameters
3808 (car elem) (cdr elem) group)
3809 params-list))))
3810 params-list))
3811
3812(defun gnus-expand-group-parameter (match value group)
3813 "Use MATCH to expand VALUE in GROUP."
d2abc29a
JD
3814 (let ((start (string-match match group)))
3815 (if start
3816 (let ((matched-string (substring group start (match-end 0))))
3817 ;; Build match groups
3818 (string-match match matched-string)
3819 (replace-match value nil nil matched-string))
3820 group)))
23f87bed
MB
3821
3822(defun gnus-expand-group-parameters (match parameters group)
3823 "Go through PARAMETERS and expand them according to the match data."
3824 (let (new)
3825 (dolist (elem parameters)
3826 (if (and (stringp (cdr elem))
3827 (string-match "\\\\[0-9&]" (cdr elem)))
3828 (push (cons (car elem)
3829 (gnus-expand-group-parameter match (cdr elem) group))
3830 new)
3831 (push elem new)))
3832 new))
3833
3834(defun gnus-group-fast-parameter (group symbol &optional allow-list)
3835 "For GROUP, return the value of SYMBOL.
3836
3837You should call this in the `gnus-group-buffer' buffer.
3838The function `gnus-group-find-parameter' will do that for you."
3839 ;; The speed trick: No cons'ing and quit early.
3840 (let* ((params (funcall gnus-group-get-parameter-function group))
3841 ;; Start easy, check the "real" group parameters.
3842 (simple-results
3843 (gnus-group-parameter-value params symbol allow-list t)))
3844 (if simple-results
3845 ;; Found results; return them.
3846 (car simple-results)
01c52d31 3847 ;; We didn't find it there, try `gnus-parameters'.
23f87bed
MB
3848 (let ((result nil)
3849 (head nil)
3850 (tail gnus-parameters))
3851 ;; A good old-fashioned non-cl loop.
3852 (while tail
3853 (setq head (car tail)
3854 tail (cdr tail))
3855 ;; The car is regexp matching for matching the group name.
3856 (when (string-match (car head) group)
3857 ;; The cdr is the parameters.
e7719ea1
G
3858 (let ((this-result
3859 (gnus-group-parameter-value (cdr head) symbol allow-list t)))
3860 (when this-result
3861 (setq result (car this-result))
3862 ;; Expand if necessary.
3863 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3864 (setq result (gnus-expand-group-parameter
3865 (car head) result group)))))))
23f87bed
MB
3866 ;; Done.
3867 result))))
3868
6748645f 3869(defun gnus-group-find-parameter (group &optional symbol allow-list)
eec82323 3870 "Return the group parameters for GROUP.
23f87bed
MB
3871If SYMBOL, return the value of that symbol in the group parameters.
3872
3873If you call this function inside a loop, consider using the faster
3874`gnus-group-fast-parameter' instead."
f4887f8b 3875 (with-current-buffer (if (buffer-live-p (get-buffer gnus-group-buffer))
e7719ea1
G
3876 gnus-group-buffer
3877 (current-buffer))
23f87bed
MB
3878 (if symbol
3879 (gnus-group-fast-parameter group symbol allow-list)
3880 (nconc
3881 (copy-sequence
3882 (funcall gnus-group-get-parameter-function group))
3883 (gnus-parameters-get-parameter group)))))
eec82323 3884
6748645f 3885(defun gnus-group-get-parameter (group &optional symbol allow-list)
eec82323 3886 "Return the group parameters for GROUP.
6748645f 3887If SYMBOL, return the value of that symbol in the group parameters.
3031d8b0 3888If ALLOW-LIST, also allow list as a result.
6748645f
LMI
3889Most functions should use `gnus-group-find-parameter', which
3890also examines the topic parameters."
eec82323
LMI
3891 (let ((params (gnus-info-params (gnus-get-info group))))
3892 (if symbol
6748645f 3893 (gnus-group-parameter-value params symbol allow-list)
eec82323
LMI
3894 params)))
3895
23f87bed
MB
3896(defun gnus-group-parameter-value (params symbol &optional
3897 allow-list present-p)
3031d8b0
MB
3898 "Return the value of SYMBOL in group PARAMS.
3899If ALLOW-LIST, also allow list as a result."
6748645f
LMI
3900 ;; We only wish to return group parameters (dotted lists) and
3901 ;; not local variables, which may have the same names.
3902 ;; But first we handle single elements...
3903 (or (car (memq symbol params))
3904 ;; Handle alist.
3905 (let (elem)
3906 (catch 'found
3907 (while (setq elem (pop params))
3908 (when (and (consp elem)
3909 (eq (car elem) symbol)
3910 (or allow-list
3911 (atom (cdr elem))))
23f87bed
MB
3912 (throw 'found (if present-p (list (cdr elem))
3913 (cdr elem)))))))))
eec82323
LMI
3914
3915(defun gnus-group-add-parameter (group param)
3916 "Add parameter PARAM to GROUP."
3917 (let ((info (gnus-get-info group)))
3918 (when info
3919 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3920 ;; Cons the new param to the old one and update.
3921 (gnus-group-set-info (cons param (gnus-info-params info))
3922 group 'params))))
3923
3924(defun gnus-group-set-parameter (group name value)
f7aa248a
G
3925 "Set parameter NAME to VALUE in GROUP.
3926GROUP can also be an INFO structure."
3927 (let ((info (if (listp group)
3928 group
3929 (gnus-get-info group))))
eec82323
LMI
3930 (when info
3931 (gnus-group-remove-parameter group name)
3932 (let ((old-params (gnus-info-params info))
3933 (new-params (list (cons name value))))
3934 (while old-params
3935 (when (or (not (listp (car old-params)))
3936 (not (eq (caar old-params) name)))
3937 (setq new-params (append new-params (list (car old-params)))))
3938 (setq old-params (cdr old-params)))
7cad71ad
G
3939 (if (listp group)
3940 (gnus-info-set-params info new-params t)
3941 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
eec82323
LMI
3942
3943(defun gnus-group-remove-parameter (group name)
f7aa248a
G
3944 "Remove parameter NAME from GROUP.
3945GROUP can also be an INFO structure."
3946 (let ((info (if (listp group)
3947 group
3948 (gnus-get-info group))))
eec82323
LMI
3949 (when info
3950 (let ((params (gnus-info-params info)))
3951 (when params
3952 (setq params (delq name params))
3953 (while (assq name params)
36d3245f 3954 (gnus-alist-pull name params))
eec82323
LMI
3955 (gnus-info-set-params info params))))))
3956
3957(defun gnus-group-add-score (group &optional score)
3958 "Add SCORE to the GROUP score.
3959If SCORE is nil, add 1 to the score of GROUP."
3960 (let ((info (gnus-get-info group)))
3961 (when info
3962 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3963
eec82323
LMI
3964(defun gnus-short-group-name (group &optional levels)
3965 "Collapse GROUP name LEVELS.
3966Select methods are stripped and any remote host name is stripped down to
3967just the host name."
6748645f
LMI
3968 (let* ((name "")
3969 (foreign "")
3970 (depth 0)
3971 (skip 1)
eec82323 3972 (levels (or levels
16409b0b 3973 gnus-group-uncollapsed-levels
eec82323
LMI
3974 (progn
3975 (while (string-match "\\." group skip)
3976 (setq skip (match-end 0)
3977 depth (+ depth 1)))
3978 depth))))
16409b0b 3979 ;; Separate foreign select method from group name and collapse.
23f87bed 3980 ;; If method contains a server, collapse to non-domain server name,
16409b0b
GM
3981 ;; otherwise collapse to select method.
3982 (let* ((colon (string-match ":" group))
3983 (server (and colon (substring group 0 colon)))
3984 (plus (and server (string-match "+" server))))
3985 (when server
3986 (if plus
3987 (setq foreign (substring server (+ 1 plus)
3988 (string-match "\\." server))
3989 group (substring group (+ 1 colon)))
3990 (setq foreign server
3991 group (substring group (+ 1 colon))))
3992 (setq foreign (concat foreign ":")))
3993 ;; Collapse group name leaving LEVELS uncollapsed elements
3994 (let* ((slist (split-string group "/"))
3995 (slen (length slist))
3996 (dlist (split-string group "\\."))
3997 (dlen (length dlist))
3998 glist
3999 glen
4000 gsep
4001 res)
4002 (if (> slen dlen)
4003 (setq glist slist
4004 glen slen
4005 gsep "/")
4006 (setq glist dlist
4007 glen dlen
4008 gsep "."))
4009 (setq levels (- glen levels))
4010 (dolist (g glist)
4011 (push (if (>= (decf levels) 0)
4012 (if (zerop (length g))
4013 ""
4014 (substring g 0 1))
4015 g)
4016 res))
4017 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
eec82323
LMI
4018
4019(defun gnus-narrow-to-body ()
4020 "Narrow to the body of an article."
4021 (narrow-to-region
4022 (progn
4023 (goto-char (point-min))
4024 (or (search-forward "\n\n" nil t)
4025 (point-max)))
4026 (point-max)))
4027
4028\f
4029;;;
4030;;; Kill file handling.
4031;;;
4032
4033(defun gnus-apply-kill-file ()
4034 "Apply a kill file to the current newsgroup.
4035Returns the number of articles marked as read."
4036 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4037 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4038 (gnus-apply-kill-file-internal)
4039 0))
4040
4041(defun gnus-kill-save-kill-buffer ()
4042 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4043 (when (get-file-buffer file)
765abcce 4044 (with-current-buffer (get-file-buffer file)
eec82323
LMI
4045 (when (buffer-modified-p)
4046 (save-buffer))
4047 (kill-buffer (current-buffer))))))
4048
4049(defcustom gnus-kill-file-name "KILL"
4050 "Suffix of the kill files."
4051 :group 'gnus-score-kill
4052 :group 'gnus-score-files
4053 :type 'string)
4054
4055(defun gnus-newsgroup-kill-file (newsgroup)
4056 "Return the name of a kill file name for NEWSGROUP.
4057If NEWSGROUP is nil, return the global kill file name instead."
4058 (cond
4059 ;; The global KILL file is placed at top of the directory.
4060 ((or (null newsgroup)
4061 (string-equal newsgroup ""))
4062 (expand-file-name gnus-kill-file-name
4063 gnus-kill-files-directory))
4064 ;; Append ".KILL" to newsgroup name.
4065 ((gnus-use-long-file-name 'not-kill)
4066 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4067 "." gnus-kill-file-name)
4068 gnus-kill-files-directory))
4069 ;; Place "KILL" under the hierarchical directory.
4070 (t
4071 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4072 "/" gnus-kill-file-name)
4073 gnus-kill-files-directory))))
4074
4075;;; Server things.
4076
4077(defun gnus-member-of-valid (symbol group)
4078 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4079 (memq symbol (assoc
4080 (symbol-name (car (gnus-find-method-for-group group)))
4081 gnus-valid-select-methods)))
4082
4083(defun gnus-method-option-p (method option)
4084 "Return non-nil if select METHOD has OPTION as a parameter."
4085 (when (stringp method)
4086 (setq method (gnus-server-to-method method)))
4087 (memq option (assoc (format "%s" (car method))
4088 gnus-valid-select-methods)))
4089
4090(defun gnus-similar-server-opened (method)
bdaa75c7
LMI
4091 "Return non-nil if we have a similar server opened.
4092This is defined as a server with the same name, but different
4093parameters."
4094 (let ((opened gnus-opened-servers)
4095 open)
eec82323 4096 (while (and method opened)
bdaa75c7
LMI
4097 (setq open (car (pop opened)))
4098 ;; Type and name are the same...
4099 (when (and (equal (car method) (car open))
4100 (equal (cadr method) (cadr open))
4101 ;; ... but the rest of the parameters differ.
4102 (not (gnus-methods-sloppily-equal method open)))
4103 (setq method nil)))
eec82323
LMI
4104 (not method)))
4105
4106(defun gnus-server-extend-method (group method)
65a32076 4107 ;; This function "extends" a virtual server. If the server is
eec82323
LMI
4108 ;; "hello", and the select method is ("hello" (my-var "something"))
4109 ;; in the group "alt.alt", this will result in a new virtual server
4110 ;; called "hello+alt.alt".
4111 (if (or (not (inline (gnus-similar-server-opened method)))
4112 (not (cddr method)))
4113 method
d25ceb52
LI
4114 (let ((address-slot
4115 (intern (format "%s-address" (car method)))))
4116 (setq method
4117 (if (assq address-slot (cddr method))
4118 `(,(car method) ,(concat (cadr method) "+" group)
4119 ,@(cddr method))
4120 `(,(car method) ,(concat (cadr method) "+" group)
4121 (,address-slot ,(cadr method))
4122 ,@(cddr method))))
4123 (push method gnus-extended-servers)
4124 method)))
eec82323
LMI
4125
4126(defun gnus-server-status (method)
4127 "Return the status of METHOD."
4128 (nth 1 (assoc method gnus-opened-servers)))
4129
4130(defun gnus-group-name-to-method (group)
4131 "Guess a select method based on GROUP."
4132 (if (string-match ":" group)
4133 (let ((server (substring group 0 (match-beginning 0))))
4134 (if (string-match "\\+" server)
4135 (list (intern (substring server 0 (match-beginning 0)))
4136 (substring server (match-end 0)))
4137 (list (intern server) "")))
4138 gnus-select-method))
4139
23f87bed
MB
4140(defun gnus-server-string (server)
4141 "Return a readable string that describes SERVER."
4142 (let* ((server (gnus-server-to-method server))
4143 (address (nth 1 server)))
4144 (if (and address
4145 (not (zerop (length address))))
4146 (format "%s using %s" address (car server))
4147 (format "%s" (car server)))))
4148
0617bb00
LMI
4149(defun gnus-same-method-different-name (method)
4150 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4151 (unless (assq slot (cddr method))
4152 (setq method
4153 (append method (list (list slot (nth 1 method)))))))
4154 (let ((methods gnus-extended-servers)
4155 open found)
4156 (while (and (not found)
4157 (setq open (pop methods)))
4158 (when (and (eq (car method) (car open))
4159 (gnus-sloppily-equal-method-parameters method open))
4160 (setq found open)))
4161 found))
4162
eec82323
LMI
4163(defun gnus-find-method-for-group (group &optional info)
4164 "Find the select method that GROUP uses."
4165 (or gnus-override-method
4166 (and (not group)
4167 gnus-select-method)
6c5d6b6c 4168 (and (not (gnus-group-entry group))
01c52d31
MB
4169 ;; Killed or otherwise unknown group.
4170 (or
4171 ;; If we know a virtual server by that name, return its method.
4172 (gnus-server-to-method (gnus-group-server group))
4173 ;; Guess a new method as last resort.
4174 (gnus-group-name-to-method group)))
eec82323
LMI
4175 (let ((info (or info (gnus-get-info group)))
4176 method)
4177 (if (or (not info)
4178 (not (setq method (gnus-info-method info)))
4179 (equal method "native"))
4180 gnus-select-method
4181 (setq method
4182 (cond ((stringp method)
4183 (inline (gnus-server-to-method method)))
4184 ((stringp (cadr method))
0617bb00
LMI
4185 (or
4186 (inline
4187 (gnus-same-method-different-name method))
4188 (inline (gnus-server-extend-method group method))))
eec82323
LMI
4189 (t
4190 method)))
4191 (cond ((equal (cadr method) "")
4192 method)
4193 ((null (cadr method))
4194 (list (car method) ""))
4195 (t
4196 (gnus-server-add-address method)))))))
4197
eec82323
LMI
4198(defun gnus-methods-using (feature)
4199 "Find all methods that have FEATURE."
4200 (let ((valids gnus-valid-select-methods)
4201 outs)
4202 (while valids
4203 (when (memq feature (car valids))
4204 (push (car valids) outs))
4205 (setq valids (cdr valids)))
4206 outs))
4207
8654e13a
MB
4208(eval-and-compile
4209 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4210
eec82323
LMI
4211(defun gnus-read-group (prompt &optional default)
4212 "Prompt the user for a group name.
16409b0b 4213Disallow invalid group names."
eec82323
LMI
4214 (let ((prefix "")
4215 group)
4216 (while (not group)
a1506d29 4217 (when (string-match
16409b0b 4218 gnus-invalid-group-regexp
eec82323
LMI
4219 (setq group (read-string (concat prefix prompt)
4220 (cons (or default "") 0)
4221 'gnus-group-history)))
23f87bed
MB
4222 (let ((match (match-string 0 group)))
4223 ;; Might be okay (e.g. for nnimap), so ask the user:
4224 (unless (and (not (string-match "^$\\|:" match))
4225 (message-y-or-n-p
4226 "Proceed and create group anyway? " t
4227"The group name \"" group "\" contains a forbidden character: \"" match "\".
4228
4229Usually, it's dangerous to create a group with this name, because it's not
4230supported by all back ends and servers. On IMAP servers it should work,
4231though. If you are really sure, you can proceed anyway and create the group.
4232
4233You may customize the variable `gnus-invalid-group-regexp', which currently is
4234set to \"" gnus-invalid-group-regexp
4235"\", if you want to get rid of this query permanently."))
4236 (setq prefix (format "Invalid group name: \"%s\". " group)
4237 group nil)))))
eec82323
LMI
4238 group))
4239
4240(defun gnus-read-method (prompt)
4241 "Prompt the user for a method.
4242Allow completion over sensible values."
23f87bed
MB
4243 (let* ((open-servers
4244 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4245 gnus-opened-servers))
4246 (valid-methods
4247 (let (methods)
4248 (dolist (method gnus-valid-select-methods)
4249 (if (or (memq 'prompt-address method)
4250 (not (assoc (format "%s:" (car method)) open-servers)))
4251 (push method methods)))
4252 methods))
4253 (servers
4254 (append valid-methods
4255 open-servers
6748645f
LMI
4256 gnus-predefined-server-alist
4257 gnus-server-alist))
4258 (method
229b59da
G
4259 (gnus-completing-read
4260 prompt (mapcar 'car servers)
4261 t nil 'gnus-method-history)))
eec82323
LMI
4262 (cond
4263 ((equal method "")
4264 (setq method gnus-select-method))
4265 ((assoc method gnus-valid-select-methods)
16409b0b
GM
4266 (let ((address (if (memq 'prompt-address
4267 (assoc method gnus-valid-select-methods))
4268 (read-string "Address: ")
4269 "")))
23f87bed 4270 (or (cadr (assoc (format "%s:%s" method address) open-servers))
16409b0b 4271 (list (intern method) address))))
6748645f 4272 ((assoc method servers)
eec82323
LMI
4273 method)
4274 (t
4275 (list (intern method) "")))))
4276
23f87bed
MB
4277;;; Agent functions
4278
b890d447 4279(defun gnus-agent-method-p (method-or-server)
23f87bed 4280 "Say whether METHOD is covered by the agent."
b890d447
MB
4281 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4282 (let* ((method (if (stringp method-or-server)
4283 (gnus-server-to-method method-or-server)
4284 method-or-server))
4285 (server (gnus-method-to-server method t)))
4286 (setq gnus-agent-method-p-cache
4287 (cons method-or-server
4288 (member server gnus-agent-covered-methods)))))
23f87bed
MB
4289 (cdr gnus-agent-method-p-cache))
4290
4291(defun gnus-online (method)
4292 (not
4293 (if gnus-plugged
4294 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4295 (gnus-agent-method-p method))))
4296
eec82323
LMI
4297;;; User-level commands.
4298
4299;;;###autoload
4300(defun gnus-slave-no-server (&optional arg)
23f87bed 4301 "Read network news as a slave, without connecting to the local server."
eec82323
LMI
4302 (interactive "P")
4303 (gnus-no-server arg t))
4304
4305;;;###autoload
4306(defun gnus-no-server (&optional arg slave)
4307 "Read network news.
23f87bed
MB
4308If ARG is a positive number, Gnus will use that as the startup
4309level. If ARG is nil, Gnus will be started at level 2. If ARG is
4310non-nil and not a positive number, Gnus will prompt the user for the
4311name of an NNTP server to use.
4312As opposed to `gnus', this command will not connect to the local
4313server."
eec82323
LMI
4314 (interactive "P")
4315 (gnus-no-server-1 arg slave))
4316
4317;;;###autoload
4318(defun gnus-slave (&optional arg)
4319 "Read news as a slave."
4320 (interactive "P")
4321 (gnus arg nil 'slave))
4322
4323;;;###autoload
23f87bed
MB
4324(defun gnus-other-frame (&optional arg display)
4325 "Pop up a frame to read news.
4326This will call one of the Gnus commands which is specified by the user
4327option `gnus-other-frame-function' (default `gnus') with the argument
4328ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4329optional second argument DISPLAY should be a standard display string
4330such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4331omitted or the function `make-frame-on-display' is not available, the
4332current display is used."
eec82323 4333 (interactive "P")
23f87bed
MB
4334 (if (fboundp 'make-frame-on-display)
4335 (unless display
4336 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4337 (setq display nil))
4338 (let ((alive (gnus-alive-p)))
4339 (unless (and alive
4340 (catch 'found
4341 (walk-windows
4342 (lambda (window)
4343 (when (and (or (not display)
4344 (equal display
4345 (gnus-frame-or-window-display-name
4346 window)))
4347 (with-current-buffer (window-buffer window)
4348 (string-match "\\`gnus-"
4349 (symbol-name major-mode))))
4350 (gnus-select-frame-set-input-focus
4351 (setq gnus-other-frame-object (window-frame window)))
4352 (select-window window)
4353 (throw 'found t)))
4354 'ignore t)))
4355 (gnus-select-frame-set-input-focus
4356 (setq gnus-other-frame-object
4357 (if display
4358 (make-frame-on-display display gnus-other-frame-parameters)
4359 (make-frame gnus-other-frame-parameters))))
4360 (if alive
4361 (switch-to-buffer gnus-group-buffer)
4362 (funcall gnus-other-frame-function arg)
4363 (add-hook 'gnus-exit-gnus-hook
4f91a816
SM
4364 (lambda nil
4365 (when (and (frame-live-p gnus-other-frame-object)
4366 (cdr (frame-list)))
4367 (delete-frame gnus-other-frame-object))
4368 (setq gnus-other-frame-object nil)))))))
eec82323
LMI
4369
4370;;;###autoload
4371(defun gnus (&optional arg dont-connect slave)
4372 "Read network news.
4373If ARG is non-nil and a positive number, Gnus will use that as the
23f87bed 4374startup level. If ARG is non-nil and not a positive number, Gnus will
eec82323
LMI
4375prompt the user for the name of an NNTP server to use."
4376 (interactive "P")
bdaa75c7
LMI
4377 ;; When using the development version of Gnus, load the gnus-load
4378 ;; file.
4379 (unless (string-match "^Gnus" gnus-version)
8ccbef23 4380 (load "gnus-load" nil t))
23f87bed
MB
4381 (unless (byte-code-function-p (symbol-function 'gnus))
4382 (message "You should byte-compile Gnus")
4383 (sit-for 2))
4478e074
G
4384 (let ((gnus-action-message-log (list nil)))
4385 (gnus-1 arg dont-connect slave)
4386 (gnus-final-warning)))
eec82323 4387
7b9946cf
AS
4388(eval-and-compile
4389 (unless (fboundp 'debbugs-gnu)
4390 (autoload 'debbugs-gnu "debbugs-gnu" "List all outstanding Emacs bugs." t)))
ecd283b9
LMI
4391(defun gnus-list-debbugs ()
4392 "List all open Gnus bug reports."
4393 (interactive)
c152c1d6 4394 (debbugs-gnu nil "gnus"))
ecd283b9 4395
eec82323
LMI
4396;; Allow redefinition of Gnus functions.
4397
4398(gnus-ems-redefine)
4399
4400(provide 'gnus)
4401
4402;;; gnus.el ends here