Don't quote lambda expressions with `quote'.
[bpt/emacs.git] / lisp / gnus / gnus.el
CommitLineData
5e67c784 1;;; gnus.el --- a newsreader for GNU Emacs
23f87bed 2
95df8112
GM
3;; Copyright (C) 1987-1990, 1993-1998, 2000-2011
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")))
d0859c9a
MB
703 "Face used for cancelled articles."
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
MB
1011 (neutral "#b4b4b4" "#878787")
1012 (september "#bf9900" "#ffcc00"))
1013 "Color alist used for the Gnus logo.")
1014
01c52d31 1015(defcustom gnus-logo-color-style 'no
23f87bed
MB
1016 "*Color styles used for the Gnus logo."
1017 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
1018 gnus-logo-color-alist))
1019 :group 'gnus-xmas)
1020
1021(defvar gnus-logo-colors
1022 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
1023 "Colors used for the Gnus logo.")
1024
12c9fab6
GM
1025(declare-function image-size "image.c" (spec &optional pixels frame))
1026
eec82323
LMI
1027(defun gnus-group-startup-message (&optional x y)
1028 "Insert startup message in current buffer."
1029 ;; Insert the message.
1030 (erase-buffer)
2ec4c966
JD
1031 (unless (and
1032 (fboundp 'find-image)
1033 (display-graphic-p)
389b76fa
G
1034 ;; Make sure the library defining `image-load-path' is
1035 ;; loaded (`find-image' is autoloaded) (and discard the
1036 ;; result). Else, we may get "defvar ignored because
1037 ;; image-load-path is let-bound" when calling `find-image'
1038 ;; below.
2ec4c966
JD
1039 (or (find-image '(nil (:type xpm :file "gnus.xpm"))) t)
1040 (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
1041 (image-load-path (cond (data-directory
1042 (list data-directory))
1043 ((boundp 'image-load-path)
1044 (symbol-value 'image-load-path))
1045 (t load-path)))
a5954fa5
G
1046 (image (gnus-splash-svg-color-symbols (find-image
1047 `((:type svg :file "gnus.svg"
1048 :color-symbols
1049 (("#bf9900" . ,(car gnus-logo-colors))
1050 ("#ffcc00" . ,(cadr gnus-logo-colors))))
1051 (:type xpm :file "gnus.xpm"
2ec4c966
JD
1052 :color-symbols
1053 (("thing" . ,(car gnus-logo-colors))
1054 ("shadow" . ,(cadr gnus-logo-colors))))
2ec4c966
JD
1055 (:type png :file "gnus.png")
1056 (:type pbm :file "gnus.pbm"
1057 ;; Account for the pbm's background.
1058 :background ,(face-foreground 'gnus-splash)
1059 :foreground ,(face-background 'default))
1060 (:type xbm :file "gnus.xbm"
1061 ;; Account for the xbm's background.
1062 :background ,(face-foreground 'gnus-splash)
a5954fa5 1063 :foreground ,(face-background 'default)))))))
2ec4c966
JD
1064 (when image
1065 (let ((size (image-size image)))
1066 (insert-char ?\n (max 0 (round (- (window-height)
1067 (or y (cdr size)) 1) 2)))
1068 (insert-char ?\ (max 0 (round (- (window-width)
1069 (or x (car size))) 2)))
1070 (insert-image image))
389b76fa 1071 (goto-char (point-min))
2ec4c966 1072 t)))
16409b0b 1073 (insert
389b76fa 1074 (format "
01c52d31
MB
1075 _ ___ _ _
1076 _ ___ __ ___ __ _ ___
1077 __ _ ___ __ ___
1078 _ ___ _
1079 _ _ __ _
1080 ___ __ _
1081 __ _
1082 _ _ _
1083 _ _ _
1084 _ _ _
1085 __ ___
1086 _ _ _ _
1087 _ _
1088 _ _
1089 _ _
1090 _
1091 __
eec82323 1092
2ec4c966 1093"))
16409b0b
GM
1094 ;; And then hack it.
1095 (gnus-indent-rigidly (point-min) (point-max)
1096 (/ (max (- (window-width) (or x 46)) 0) 2))
1097 (goto-char (point-min))
1098 (forward-line 1)
1099 (let* ((pheight (count-lines (point-min) (point-max)))
1100 (wheight (window-height))
1101 (rest (- wheight pheight)))
1102 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1103 ;; Fontify some.
0f49874b 1104 (put-text-property (point-min) (point-max) 'face 'gnus-splash)
2ec4c966
JD
1105 (goto-char (point-min))
1106 (setq mode-line-buffer-identification (concat " " gnus-version))
1107 (set-buffer-modified-p t)))
eec82323 1108
a5954fa5 1109(defun gnus-splash-svg-color-symbols (list)
70f6144d 1110 "Do color-symbol search-and-replace in svg file."
a5954fa5
G
1111 (let ((type (plist-get (cdr list) :type))
1112 (file (plist-get (cdr list) :file))
1113 (color-symbols (plist-get (cdr list) :color-symbols)))
1114 (if (string= type "svg")
70f6144d
SM
1115 (let ((data (with-temp-buffer (insert-file-contents file)
1116 (buffer-string))))
a5954fa5
G
1117 (mapc (lambda (rule)
1118 (setq data (replace-regexp-in-string
1119 (concat "fill:" (car rule))
70f6144d
SM
1120 (concat "fill:" (cdr rule)) data)))
1121 color-symbols)
a5954fa5
G
1122 (cons (car list) (list :type type :data data)))
1123 list)))
1124
eec82323
LMI
1125(eval-when (load)
1126 (let ((command (format "%s" this-command)))
23f87bed
MB
1127 (when (string-match "gnus" command)
1128 (if (string-match "gnus-other-frame" command)
1129 (gnus-get-buffer-create gnus-group-buffer)
1130 (gnus-splash)))))
eec82323
LMI
1131
1132;;; Do the rest.
1133
eec82323
LMI
1134(require 'gnus-util)
1135(require 'nnheader)
1136
23f87bed
MB
1137(defcustom gnus-parameters nil
1138 "Alist of group parameters.
1139
1140For example:
1141 ((\"mail\\\\..*\" (gnus-show-threads nil)
1142 (gnus-use-scoring nil)
1143 (gnus-summary-line-format
1144 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1145 (gcc-self . t)
1146 (display . all))
1147 (\"mail\\\\.me\" (gnus-use-scoring t))
1148 (\"list\\\\..*\" (total-expire . t)
1149 (broken-reply-to . t)))"
bf247b6e 1150 :version "22.1"
23f87bed
MB
1151 :group 'gnus-group-various
1152 :type '(repeat (cons regexp
1153 (repeat sexp))))
1154
e8beac8a
MB
1155(defcustom gnus-parameters-case-fold-search 'default
1156 "If it is t, ignore case of group names specified in `gnus-parameters'.
1157If it is nil, don't ignore case. If it is `default', which is for the
1158backward compatibility, use the value of `case-fold-search'."
1159 :version "22.1"
1160 :group 'gnus-group-various
1161 :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
1162 (const :tag "Use `case-fold-search'" default)
1163 (const nil)
1164 (const t)))
1165
23f87bed
MB
1166(defvar gnus-group-parameters-more nil)
1167
1168(defmacro gnus-define-group-parameter (param &rest rest)
1169 "Define a group parameter PARAM.
1170REST is a plist of following:
1171:type One of `bool', `list' or nil.
1172:function The name of the function.
1173:function-document The documentation of the function.
1174:parameter-type The type for customizing the parameter.
1175:parameter-document The documentation for the parameter.
1176:variable The name of the variable.
1177:variable-document The documentation for the variable.
1178:variable-group The group for customizing the variable.
1179:variable-type The type for customizing the variable.
1180:variable-default The default value of the variable."
1181 (let* ((type (plist-get rest :type))
1182 (parameter-type (plist-get rest :parameter-type))
1183 (parameter-document (plist-get rest :parameter-document))
1184 (function (or (plist-get rest :function)
1185 (intern (format "gnus-parameter-%s" param))))
1186 (function-document (or (plist-get rest :function-document) ""))
1187 (variable (or (plist-get rest :variable)
1188 (intern (format "gnus-parameter-%s-alist" param))))
1189 (variable-document (or (plist-get rest :variable-document) ""))
1190 (variable-group (plist-get rest :variable-group))
1191 (variable-type (or (plist-get rest :variable-type)
1192 `(quote (repeat
1193 (list (regexp :tag "Group")
1194 ,(car (cdr parameter-type)))))))
1195 (variable-default (plist-get rest :variable-default)))
1196 (list
1197 'progn
1198 `(defcustom ,variable ,variable-default
1199 ,variable-document
1200 :group 'gnus-group-parameter
1201 :group ',variable-group
1202 :type ,variable-type)
1203 `(setq gnus-group-parameters-more
1204 (delq (assq ',param gnus-group-parameters-more)
1205 gnus-group-parameters-more))
1206 `(add-to-list 'gnus-group-parameters-more
1207 (list ',param
1208 ,parameter-type
1209 ,parameter-document))
1210 (if (eq type 'bool)
1211 `(defun ,function (name)
1212 ,function-document
1213 (let ((params (gnus-group-find-parameter name))
1214 val)
1215 (cond
1216 ((memq ',param params)
1217 t)
1218 ((setq val (assq ',param params))
1219 (cdr val))
1220 ((stringp ,variable)
1221 (string-match ,variable name))
1222 (,variable
1223 (let ((alist ,variable)
1224 elem value)
1225 (while (setq elem (pop alist))
1226 (when (and name
1227 (string-match (car elem) name))
1228 (setq alist nil
1229 value (cdr elem))))
1230 (if (consp value) (car value) value))))))
1231 `(defun ,function (name)
1232 ,function-document
1233 (and name
1234 (or (gnus-group-find-parameter name ',param ,(and type t))
1235 (let ((alist ,variable)
1236 elem value)
1237 (while (setq elem (pop alist))
1238 (when (and name
1239 (string-match (car elem) name))
1240 (setq alist nil
1241 value (cdr elem))))
1242 ,(if type
1243 'value
1244 '(if (consp value) (car value) value))))))))))
1245
eec82323
LMI
1246(defcustom gnus-home-directory "~/"
1247 "Directory variable that specifies the \"home\" directory.
35ef97a5 1248All other Gnus file and directory variables are initialized from this variable."
eec82323
LMI
1249 :group 'gnus-files
1250 :type 'directory)
1251
1252(defcustom gnus-directory (or (getenv "SAVEDIR")
1253 (nnheader-concat gnus-home-directory "News/"))
6748645f
LMI
1254 "*Directory variable from which all other Gnus file variables are derived.
1255
1256Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1257This means that other directory variables that are initialized from
1258this variable won't be set properly if you set this variable in `.gnus.el'.
1259Set this variable in `.emacs' instead."
eec82323
LMI
1260 :group 'gnus-files
1261 :type 'directory)
1262
1263(defcustom gnus-default-directory nil
1264 "*Default directory for all Gnus buffers."
1265 :group 'gnus-files
1266 :type '(choice (const :tag "current" nil)
1267 directory))
1268
1269;; Site dependent variables. These variables should be defined in
1270;; paths.el.
1271
1272(defvar gnus-default-nntp-server nil
1273 "Specify a default NNTP server.
1274This variable should be defined in paths.el, and should never be set
1275by the user.
1276If you want to change servers, you should use `gnus-select-method'.
1277See the documentation to that variable.")
1278
eec82323
LMI
1279(defcustom gnus-nntpserver-file "/etc/nntpserver"
1280 "A file with only the name of the nntp server in it."
1281 :group 'gnus-files
1282 :group 'gnus-server
1283 :type 'file)
1284
eec82323 1285(defun gnus-getenv-nntpserver ()
23f87bed
MB
1286 "Find default nntp server.
1287Check the NNTPSERVER environment variable and the
1288`gnus-nntpserver-file' file."
eec82323
LMI
1289 (or (getenv "NNTPSERVER")
1290 (and (file-readable-p gnus-nntpserver-file)
23f87bed 1291 (with-temp-buffer
eec82323 1292 (insert-file-contents gnus-nntpserver-file)
f4dd4ae8
MB
1293 (when (re-search-forward "[^ \t\n\r]+" nil t)
1294 (match-string 0))))))
eec82323 1295
4573e0df
MB
1296;; `M-x customize-variable RET gnus-select-method RET' should work without
1297;; starting or even loading Gnus.
1298;;;###autoload(when (fboundp 'custom-autoload)
1299;;;###autoload (custom-autoload 'gnus-select-method "gnus"))
1300
eec82323 1301(defcustom gnus-select-method
99e65b2d
G
1302 (list 'nntp (or (gnus-getenv-nntpserver)
1303 (when (and gnus-default-nntp-server
1304 (not (string= gnus-default-nntp-server "")))
1305 gnus-default-nntp-server)
1306 "news"))
16409b0b 1307 "Default method for selecting a newsgroup.
eec82323
LMI
1308This variable should be a list, where the first element is how the
1309news is to be fetched, the second is the address.
1310
23f87bed
MB
1311For instance, if you want to get your news via \"flab.flab.edu\" using
1312NNTP, you could say:
eec82323
LMI
1313
1314\(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1315
1316If you want to use your local spool, say:
1317
1318\(setq gnus-select-method (list 'nnspool (system-name)))
1319
1320If you use this variable, you must set `gnus-nntp-server' to nil.
1321
1322There is a lot more to know about select methods and virtual servers -
1323see the manual for details."
1324 :group 'gnus-server
4573e0df
MB
1325 :group 'gnus-start
1326 :initialize 'custom-initialize-default
eec82323
LMI
1327 :type 'gnus-select-method)
1328
23f87bed 1329(defcustom gnus-message-archive-method "archive"
6748645f 1330 "*Method used for archiving messages you've sent.
01c52d31
MB
1331This should be a mail method.
1332
1333See also `gnus-update-message-archive-method'."
eec82323
LMI
1334 :group 'gnus-server
1335 :group 'gnus-message
23f87bed
MB
1336 :type '(choice (const :tag "Default archive method" "archive")
1337 gnus-select-method))
eec82323 1338
01c52d31
MB
1339(defcustom gnus-update-message-archive-method nil
1340 "Non-nil means always update the saved \"archive\" method.
1341
1342The archive method is initially set according to the value of
1343`gnus-message-archive-method' and is saved in the \"~/.newsrc.eld\" file
1344so that it may be used as a real method of the server which is named
1345\"archive\" ever since. If it once has been saved, it will never be
1346updated if the value of this variable is nil, even if you change the
1347value of `gnus-message-archive-method' afterward. If you want the
1348saved \"archive\" method to be updated whenever you change the value of
1349`gnus-message-archive-method', set this variable to a non-nil value."
d99bf2d8 1350 :version "23.1"
01c52d31
MB
1351 :group 'gnus-server
1352 :group 'gnus-message
1353 :type 'boolean)
1354
d99bf2d8 1355(defcustom gnus-message-archive-group '((format-time-string "sent.%Y-%m"))
eec82323
LMI
1356 "*Name of the group in which to save the messages you've written.
1357This can either be a string; a list of strings; or an alist
1358of regexps/functions/forms to be evaluated to return a string (or a list
1359of strings). The functions are called with the name of the current
1360group (or nil) as a parameter.
1361
1362If you want to save your mail in one group and the news articles you
1363write in another group, you could say something like:
1364
1365 \(setq gnus-message-archive-group
23f87bed
MB
1366 '((if (message-news-p)
1367 \"misc-news\"
1368 \"misc-mail\")))
eec82323
LMI
1369
1370Normally the group names returned by this variable should be
1371unprefixed -- which implicitly means \"store on the archive server\".
1372However, you may wish to store the message on some other server. In
1373that case, just return a fully prefixed name of the group --
1374\"nnml+private:mail.misc\", for instance."
d99bf2d8 1375 :version "24.1"
eec82323
LMI
1376 :group 'gnus-message
1377 :type '(choice (const :tag "none" nil)
514d9128
LMI
1378 (const :tag "Weekly" ((format-time-string "sent.%Yw%U")))
1379 (const :tag "Monthly" ((format-time-string "sent.%Y-%m")))
1380 (const :tag "Yearly" ((format-time-string "sent.%Y")))
16409b0b 1381 function
6748645f 1382 sexp
eec82323
LMI
1383 string))
1384
1385(defcustom gnus-secondary-servers nil
1386 "List of NNTP servers that the user can choose between interactively.
1387To make Gnus query you for a server, you have to give `gnus' a
1388non-numeric prefix - `C-u M-x gnus', in short."
1389 :group 'gnus-server
1390 :type '(repeat string))
99e65b2d 1391(make-obsolete-variable 'gnus-secondary-servers 'gnus-select-method "24.1")
eec82323
LMI
1392
1393(defcustom gnus-nntp-server nil
99e65b2d 1394 "The name of the host running the NNTP server."
eec82323
LMI
1395 :group 'gnus-server
1396 :type '(choice (const :tag "disable" nil)
1397 string))
99e65b2d 1398(make-obsolete-variable 'gnus-nntp-server 'gnus-select-method "24.1")
eec82323
LMI
1399
1400(defcustom gnus-secondary-select-methods nil
1401 "A list of secondary methods that will be used for reading news.
1402This is a list where each element is a complete select method (see
1403`gnus-select-method').
1404
23f87bed 1405If, for instance, you want to read your mail with the nnml back end,
eec82323
LMI
1406you could set this variable:
1407
1408\(setq gnus-secondary-select-methods '((nnml \"\")))"
16409b0b
GM
1409 :group 'gnus-server
1410 :type '(repeat gnus-select-method))
eec82323 1411
6f33b4d7
LMI
1412(defcustom gnus-local-domain nil
1413 "Local domain name without a host name.
1414The DOMAINNAME environment variable is used instead if it is defined.
1415If the function `system-name' returns the full Internet name, there is
1416no need to set this variable."
1417 :group 'gnus-message
1418 :type '(choice (const :tag "default" nil)
1419 string))
6b958814 1420(make-obsolete-variable 'gnus-local-domain nil "Emacs 24.1")
6f33b4d7 1421
eec82323
LMI
1422;; Customization variables
1423
a1347097 1424(defcustom gnus-refer-article-method 'current
eec82323
LMI
1425 "Preferred method for fetching an article by Message-ID.
1426If you are reading news from the local spool (with nnspool), fetching
1427articles by Message-ID is painfully slow. By setting this method to an
1428nntp method, you might get acceptable results.
1429
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
GM
1441 gnus-select-method
1442 (repeat :menu-tag "Try multiple"
1443 :tag "Multiple"
23f87bed 1444 :value (current (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1445 (choice :tag "Method"
1446 (const current)
23f87bed
MB
1447 (const :tag "Google"
1448 (nnweb "refer" (nnweb-type google)))
16409b0b 1449 gnus-select-method))))
eec82323 1450
eec82323
LMI
1451(defcustom gnus-use-cross-reference t
1452 "*Non-nil means that cross referenced articles will be marked as read.
1453If nil, ignore cross references. If t, mark articles as read in
65a32076 1454subscribed newsgroups. If neither t nor nil, mark as read in all
eec82323
LMI
1455newsgroups."
1456 :group 'gnus-server
1457 :type '(choice (const :tag "off" nil)
1458 (const :tag "subscribed" t)
1459 (sexp :format "all"
1460 :value always)))
1461
1462(defcustom gnus-process-mark ?#
1463 "*Process mark."
1464 :group 'gnus-group-visual
1465 :group 'gnus-summary-marks
1466 :type 'character)
1467
eec82323
LMI
1468(defcustom gnus-large-newsgroup 200
1469 "*The number of articles which indicates a large newsgroup.
1470If the number of articles in a newsgroup is greater than this value,
23f87bed 1471confirmation is required for selecting the newsgroup.
a3f57c41
G
1472If it is nil, no confirmation is required.
1473
1474Also see `gnus-large-ephemeral-newsgroup'."
eec82323 1475 :group 'gnus-group-select
23f87bed
MB
1476 :type '(choice (const :tag "No limit" nil)
1477 integer))
eec82323 1478
f3041af1 1479(defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v)))
99e65b2d 1480 "Non-nil means that the default name of a file to save articles in is the group name.
eec82323
LMI
1481If it's nil, the directory form of the group name is used instead.
1482
1483If this variable is a list, and the list contains the element
1484`not-score', long file names will not be used for score files; if it
1485contains the element `not-save', long file names will not be used for
1486saving; and if it contains the element `not-kill', long file names
1487will not be used for kill files.
1488
1489Note that the default for this variable varies according to what system
99e65b2d
G
1490type you're using. On `usg-unix-v' this variable defaults to nil while
1491on all other systems it defaults to t."
eec82323 1492 :group 'gnus-start
23f87bed
MB
1493 :type '(radio (sexp :format "Non-nil\n"
1494 :match (lambda (widget value)
1495 (and value (not (listp value))))
1496 :value t)
1497 (const nil)
1498 (checklist (const :format "%v " not-score)
1499 (const :format "%v " not-save)
1500 (const not-kill))))
eec82323
LMI
1501
1502(defcustom gnus-kill-files-directory gnus-directory
1503 "*Name of the directory where kill files will be stored (default \"~/News\")."
1504 :group 'gnus-score-files
1505 :group 'gnus-score-kill
1506 :type 'directory)
1507
1508(defcustom gnus-save-score nil
1509 "*If non-nil, save group scoring info."
1510 :group 'gnus-score-various
1511 :group 'gnus-start
1512 :type 'boolean)
1513
1514(defcustom gnus-use-undo t
1515 "*If non-nil, allow undoing in Gnus group mode buffers."
1516 :group 'gnus-meta
1517 :type 'boolean)
1518
1519(defcustom gnus-use-adaptive-scoring nil
1520 "*If non-nil, use some adaptive scoring scheme.
1521If a list, then the values `word' and `line' are meaningful. The
1522former will perform adaption on individual words in the subject
1523header while `line' will perform adaption on several headers."
1524 :group 'gnus-meta
1525 :group 'gnus-score-adapt
1526 :type '(set (const word) (const line)))
1527
1528(defcustom gnus-use-cache 'passive
1529 "*If nil, Gnus will ignore the article cache.
1530If `passive', it will allow entering (and reading) articles
1531explicitly entered into the cache. If anything else, use the
1532cache to the full extent of the law."
1533 :group 'gnus-meta
1534 :group 'gnus-cache
1535 :type '(choice (const :tag "off" nil)
1536 (const :tag "passive" passive)
1537 (const :tag "active" t)))
1538
1539(defcustom gnus-use-trees nil
1540 "*If non-nil, display a thread tree buffer."
1541 :group 'gnus-meta
1542 :type 'boolean)
1543
23f87bed 1544(defcustom gnus-keep-backlog 20
eec82323
LMI
1545 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1546If it is a number N, then Gnus will only keep the last N articles
1547read. If it is neither nil nor a number, Gnus will keep all read
1548articles. This is not a good idea."
1549 :group 'gnus-meta
1550 :type '(choice (const :tag "off" nil)
1551 integer
1552 (sexp :format "all"
1553 :value t)))
1554
eec82323
LMI
1555(defcustom gnus-suppress-duplicates nil
1556 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1557 :group 'gnus-meta
1558 :type 'boolean)
1559
eec82323
LMI
1560(defcustom gnus-use-scoring t
1561 "*If non-nil, enable scoring."
1562 :group 'gnus-meta
1563 :type 'boolean)
1564
eec82323
LMI
1565(defcustom gnus-summary-prepare-exit-hook
1566 '(gnus-summary-expire-articles)
6748645f 1567 "*A hook called when preparing to exit from the summary buffer.
eec82323
LMI
1568It calls `gnus-summary-expire-articles' by default."
1569 :group 'gnus-summary-exit
1570 :type 'hook)
1571
1572(defcustom gnus-novice-user t
23f87bed 1573 "*Non-nil means that you are a Usenet novice.
eec82323
LMI
1574If non-nil, verbose messages may be displayed and confirmations may be
1575required."
1576 :group 'gnus-meta
1577 :type 'boolean)
1578
1579(defcustom gnus-expert-user nil
1580 "*Non-nil means that you will never be asked for confirmation about anything.
6748645f
LMI
1581That doesn't mean *anything* anything; particularly destructive
1582commands will still require prompting."
eec82323
LMI
1583 :group 'gnus-meta
1584 :type 'boolean)
1585
1586(defcustom gnus-interactive-catchup t
1587 "*If non-nil, require your confirmation when catching up a group."
1588 :group 'gnus-group-select
1589 :type 'boolean)
1590
1591(defcustom gnus-interactive-exit t
1592 "*If non-nil, require your confirmation when exiting Gnus."
1593 :group 'gnus-exit
1594 :type 'boolean)
1595
1596(defcustom gnus-extract-address-components 'gnus-extract-address-components
1597 "*Function for extracting address components from a From header.
1598Two pre-defined function exist: `gnus-extract-address-components',
1599which is the default, quite fast, and too simplistic solution, and
1600`mail-extract-address-components', which works much better, but is
1601slower."
1602 :group 'gnus-summary-format
1603 :type '(radio (function-item gnus-extract-address-components)
1604 (function-item mail-extract-address-components)
1605 (function :tag "Other")))
1606
eec82323 1607(defcustom gnus-shell-command-separator ";"
23f87bed 1608 "String used to separate shell commands."
eec82323
LMI
1609 :group 'gnus-files
1610 :type 'string)
1611
1612(defcustom gnus-valid-select-methods
1613 '(("nntp" post address prompt-address physical-address)
1614 ("nnspool" post address)
1615 ("nnvirtual" post-mail virtual prompt-address)
1616 ("nnmbox" mail respool address)
23f87bed 1617 ("nnml" post-mail respool address)
eec82323
LMI
1618 ("nnmh" mail respool address)
1619 ("nndir" post-mail prompt-address physical-address)
1620 ("nneething" none address prompt-address physical-address)
1621 ("nndoc" none address prompt-address)
1622 ("nnbabyl" mail address respool)
eec82323
LMI
1623 ("nndraft" post-mail)
1624 ("nnfolder" mail respool address)
6748645f
LMI
1625 ("nngateway" post-mail address prompt-address physical-address)
1626 ("nnweb" none)
23f87bed 1627 ("nnrss" none)
16409b0b 1628 ("nnagent" post-mail)
706b5974
G
1629 ("nnimap" post-mail address prompt-address physical-address respool
1630 server-marks)
23f87bed
MB
1631 ("nnmaildir" mail respool address)
1632 ("nnnil" none))
6748645f 1633 "*An alist of valid select methods.
eec82323
LMI
1634The first element of each list lists should be a string with the name
1635of the select method. The other elements may be the category of
1636this method (i. e., `post', `mail', `none' or whatever) or other
1637properties that this method has (like being respoolable).
1638If you implement a new select method, all you should have to change is
65a32076 1639this variable. I think."
eec82323
LMI
1640 :group 'gnus-server
1641 :type '(repeat (group (string :tag "Name")
1642 (radio-button-choice (const :format "%v " post)
1643 (const :format "%v " mail)
1644 (const :format "%v " none)
1645 (const post-mail))
1646 (checklist :inline t
1647 (const :format "%v " address)
1648 (const :format "%v " prompt-address)
c06fc524 1649 (const :format "%v " physical-address)
eec82323 1650 (const :format "%v " virtual)
1a10d421
KY
1651 (const respool))))
1652 :version "24.1")
eec82323 1653
16409b0b
GM
1654(defun gnus-redefine-select-method-widget ()
1655 "Recomputes the select-method widget based on the value of
1656`gnus-valid-select-methods'."
1657 (define-widget 'gnus-select-method 'list
1658 "Widget for entering a select method."
1659 :value '(nntp "")
1660 :tag "Select Method"
1661 :args `((choice :tag "Method"
1662 ,@(mapcar (lambda (entry)
1663 (list 'const :format "%v\n"
1664 (intern (car entry))))
1665 gnus-valid-select-methods)
1666 (symbol :tag "other"))
1667 (string :tag "Address")
1668 (repeat :tag "Options"
1669 :inline t
1670 (list :format "%v"
1671 variable
23f87bed 1672 (sexp :tag "Value"))))))
16409b0b
GM
1673
1674(gnus-redefine-select-method-widget)
eec82323
LMI
1675
1676(defcustom gnus-updated-mode-lines '(group article summary tree)
1677 "List of buffers that should update their mode lines.
1678The list may contain the symbols `group', `article', `tree' and
1679`summary'. If the corresponding symbol is present, Gnus will keep
1680that mode line updated with information that may be pertinent.
1681If this variable is nil, screen refresh may be quicker."
1682 :group 'gnus-various
1683 :type '(set (const group)
1684 (const article)
1685 (const summary)
1686 (const tree)))
1687
a1347097 1688(defcustom gnus-mode-non-string-length 30
eec82323
LMI
1689 "*Max length of mode-line non-string contents.
1690If this is nil, Gnus will take space as is needed, leaving the rest
a1347097
LMI
1691of the mode line intact."
1692 :version "24.1"
eec82323
LMI
1693 :group 'gnus-various
1694 :type '(choice (const nil)
1695 integer))
1696
23f87bed
MB
1697;; There should be special validation for this.
1698(define-widget 'gnus-email-address 'string
1699 "An email address.")
1700
1701(gnus-define-group-parameter
1702 to-address
1703 :function-document
1704 "Return GROUP's to-address."
1705 :variable-document
1706 "*Alist of group regexps and correspondent to-addresses."
e79f14a4 1707 :variable-group gnus-group-parameter
23f87bed
MB
1708 :parameter-type '(gnus-email-address :tag "To Address")
1709 :parameter-document "\
1710This will be used when doing followups and posts.
1711
1712This is primarily useful in mail groups that represent closed
1713mailing lists--mailing lists where it's expected that everybody that
1714writes to the mailing list is subscribed to it. Since using this
1715parameter ensures that the mail only goes to the mailing list itself,
1716it means that members won't receive two copies of your followups.
1717
1718Using `to-address' will actually work whether the group is foreign or
1719not. Let's say there's a group on the server that is called
1720`fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1721articles from a mail-to-news gateway. Posting directly to this group
1722is therefore impossible--you have to send mail to the mailing list
1723address instead.
1724
1725The gnus-group-split mail splitting mechanism will behave as if this
1726address was listed in gnus-group-split Addresses (see below).")
1727
1728(gnus-define-group-parameter
1729 to-list
1730 :function-document
1731 "Return GROUP's to-list."
1732 :variable-document
1733 "*Alist of group regexps and correspondent to-lists."
e79f14a4 1734 :variable-group gnus-group-parameter
23f87bed
MB
1735 :parameter-type '(gnus-email-address :tag "To List")
1736 :parameter-document "\
1737This address will be used when doing a `a' in the group.
1738
1739It is totally ignored when doing a followup--except that if it is
1740present in a news group, you'll get mail group semantics when doing
1741`f'.
1742
1743The gnus-group-split mail splitting mechanism will behave as if this
1744address was listed in gnus-group-split Addresses (see below).")
1745
1746(gnus-define-group-parameter
1747 subscribed
1748 :type bool
1749 :function-document
1750 "Return GROUP's subscription status."
1751 :variable-document
1752 "*Groups which are automatically considered subscribed."
e79f14a4 1753 :variable-group gnus-group-parameter
23f87bed
MB
1754 :parameter-type '(const :tag "Subscribed" t)
1755 :parameter-document "\
1756Gnus assumed that you are subscribed to the To/List address.
1757
1758When constructing a list of subscribed groups using
1759`gnus-find-subscribed-addresses', Gnus includes the To address given
1760above, or the list address (if the To address has not been set).")
1761
1762(gnus-define-group-parameter
1763 auto-expire
1764 :type bool
1765 :function gnus-group-auto-expirable-p
1766 :function-document
1767 "Check whether GROUP is auto-expirable or not."
1768 :variable gnus-auto-expirable-newsgroups
1769 :variable-default nil
1770 :variable-document
1771 "*Groups in which to automatically mark read articles as expirable.
eec82323
LMI
1772If non-nil, this should be a regexp that should match all groups in
1773which to perform auto-expiry. This only makes sense for mail groups."
23f87bed
MB
1774 :variable-group nnmail-expire
1775 :variable-type '(choice (const nil)
1776 regexp)
1777 :parameter-type '(const :tag "Automatic Expire" t)
1778 :parameter-document
1779 "All articles that are read will be marked as expirable.")
1780
1781(gnus-define-group-parameter
1782 total-expire
1783 :type bool
1784 :function gnus-group-total-expirable-p
1785 :function-document
1786 "Check whether GROUP is total-expirable or not."
1787 :variable gnus-total-expirable-newsgroups
1788 :variable-default nil
1789 :variable-document
1790 "*Groups in which to perform expiry of all read articles.
eec82323
LMI
1791Use with extreme caution. All groups that match this regexp will be
1792expiring - which means that all read articles will be deleted after
65a32076 1793\(say) one week. (This only goes for mail groups and the like, of
eec82323 1794course.)"
23f87bed
MB
1795 :variable-group nnmail-expire
1796 :variable-type '(choice (const nil)
1797 regexp)
1798 :parameter-type '(const :tag "Total Expire" t)
1799 :parameter-document
1800 "All read articles will be put through the expiry process
1801
1802This happens even if they are not marked as expirable.
1803Use with caution.")
1804
1805(gnus-define-group-parameter
1806 charset
1807 :function-document
1808 "Return the default charset of GROUP."
1809 :variable gnus-group-charset-alist
1810 :variable-default
1811 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1812 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1813 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1814 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1815 ("\\(^\\|:\\)relcom\\>" koi8-r)
1816 ("\\(^\\|:\\)fido7\\>" koi8-r)
1817 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1818 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1819 ("\\(^\\|:\\)han\\>" euc-kr)
1820 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1821 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1822 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1823 :variable-document
1824 "Alist of regexps (to match group names) and default charsets to be used when reading."
1825 :variable-group gnus-charset
1826 :variable-type '(repeat (list (regexp :tag "Group")
1827 (symbol :tag "Charset")))
1828 :parameter-type '(symbol :tag "Charset")
1829 :parameter-document "\
1830The default charset to use in the group.")
1831
1832(gnus-define-group-parameter
1833 post-method
1834 :type list
1835 :function-document
1836 "Return a posting method for GROUP."
1837 :variable gnus-post-method-alist
1838 :variable-document
1839 "Alist of regexps (to match group names) and method to be used when
1840posting an article."
1841 :variable-group gnus-group-foreign
1842 :parameter-type
1843 '(choice :tag "Posting Method"
1844 (const :tag "Use native server" native)
1845 (const :tag "Use current server" current)
1846 (list :convert-widget
1847 (lambda (widget)
1848 (list 'sexp :tag "Methods"
1849 :value gnus-select-method))))
1850 :parameter-document
1851 "Posting method for this group.")
1852
1853(gnus-define-group-parameter
1854 large-newsgroup-initial
1855 :type integer
1856 :function-document
1857 "Return GROUP's initial input of the number of articles."
1858 :variable-document
1859 "*Alist of group regexps and its initial input of the number of articles."
e79f14a4 1860 :variable-group gnus-group-parameter
23f87bed
MB
1861 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1862 (const :tag "All" nil)
1863 (integer))
1864 :parameter-document "\
1865
1866This number will be prompted as the initial value of the number of
1867articles to list when the group is a large newsgroup (see
1868`gnus-large-newsgroup'). If it is nil, the default value is the
1869total number of articles in the group.")
1870
1871;; The Gnus registry's ignored groups
1872(gnus-define-group-parameter
1873 registry-ignore
1874 :type list
1875 :function-document
1876 "Whether this group should be ignored by the registry."
1877 :variable gnus-registry-ignored-groups
c024b021
TZ
1878 :variable-default (mapcar
1879 (lambda (g) (list g t))
1880 '("delayed$" "drafts$" "queue$" "INBOX$"
1881 "^nnmairix:" "archive"))
23f87bed
MB
1882 :variable-document
1883 "*Groups in which the registry should be turned off."
1884 :variable-group gnus-registry
1885 :variable-type '(repeat
1886 (list
1887 (regexp :tag "Group Name Regular Expression")
1888 (boolean :tag "Ignored")))
bf247b6e 1889
23f87bed
MB
1890 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1891 :parameter-document
1892 "Whether the Gnus Registry should ignore this group.")
1893
1894;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1895(defcustom gnus-install-group-spam-parameters t
1896 "*Disable the group parameters for spam detection.
1897Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
bf247b6e 1898 :version "22.1"
23f87bed
MB
1899 :type 'boolean
1900 :group 'gnus-start)
1901
1902(when gnus-install-group-spam-parameters
1903 (defvar gnus-group-spam-classification-spam t
1904 "Spam group classification (requires spam.el).
1905This group contains spam messages. On summary entry, unread messages
1906will be marked as spam. On summary exit, the specified spam
1907processors will be invoked on spam-marked messages, then those
1908messages will be expired, so the spam processor will only see a
1909spam-marked message once.")
1910
1911 (defvar gnus-group-spam-classification-ham 'ask
1912 "The ham value for the spam group parameter (requires spam.el).
1913On summary exit, the specified ham processors will be invoked on
1914ham-marked messages. Exercise caution, since the ham processor will
1915see the same message more than once because there is no ham message
1916registry.")
1917
1918 (gnus-define-group-parameter
1919 spam-contents
1920 :type list
1921 :function-document
1922 "The spam type (spam, ham, or neither) of the group."
1923 :variable gnus-spam-newsgroup-contents
1924 :variable-default nil
1925 :variable-document
270a576a
MB
1926 "*Group classification (spam, ham, or neither). Only
1927meaningful when spam.el is loaded. If non-nil, this should be a
1928list of group name regexps associated with a classification for
1929each one. In spam groups, new articles are marked as spam on
1930summary entry. There is other behavior associated with ham and
1931no classification when spam.el is loaded - see the manual."
23f87bed
MB
1932 :variable-group spam
1933 :variable-type '(repeat
1934 (list :tag "Group contents spam/ham classification"
1935 (regexp :tag "Group")
1936 (choice
1937 (variable-item gnus-group-spam-classification-spam)
1938 (variable-item gnus-group-spam-classification-ham)
1939 (const :tag "Unclassified" nil))))
1940
1941 :parameter-type '(list :tag "Group contents spam/ham classification"
1942 (choice :tag "Group contents classification for spam sorting"
1943 (variable-item gnus-group-spam-classification-spam)
1944 (variable-item gnus-group-spam-classification-ham)
1945 (const :tag "Unclassified" nil)))
1946 :parameter-document
1947 "The spam classification (spam, ham, or neither) of this group.
270a576a
MB
1948When a spam group is entered, all unread articles are marked as
1949spam. There is other behavior associated with ham and no
1950classification when spam.el is loaded - see the manual.")
23f87bed 1951
01c52d31
MB
1952 (gnus-define-group-parameter
1953 spam-resend-to
1954 :type list
1955 :function-document
1956 "The address to get spam resent (through spam-report-resend)."
1957 :variable gnus-spam-resend-to
1958 :variable-default nil
1959 :variable-document
1960 "The address to get spam resent (through spam-report-resend)."
1961 :variable-group spam
1962 :variable-type '(repeat
1963 (list :tag "Group address for resending spam"
1964 (regexp :tag "Group")
1965 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1966 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1967 :parameter-document
1968 "The address to get spam resent (through spam-report-resend).")
1969
1970 (gnus-define-group-parameter
1971 ham-resend-to
1972 :type list
1973 :function-document
1974 "The address to get ham resent (through spam-report-resend)."
1975 :variable gnus-ham-resend-to
1976 :variable-default nil
1977 :variable-document
1978 "The address to get ham resent (through spam-report-resend)."
1979 :variable-group spam
1980 :variable-type '(repeat
1981 (list :tag "Group address for resending ham"
1982 (regexp :tag "Group")
1983 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1984 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1985 :parameter-document
1986 "The address to get ham resent (through spam-report-resend).")
1987
23f87bed
MB
1988 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1989 "OBSOLETE: The ifile summary exit spam processor.")
1990
1991 (defvar gnus-group-spam-exit-processor-stat "stat"
1992 "OBSOLETE: The spam-stat summary exit spam processor.")
1993
1994 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1995 "OBSOLETE: The Bogofilter summary exit spam processor.")
1996
1997 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1998 "OBSOLETE: The Blacklist summary exit spam processor.")
1999
2000 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2001 "OBSOLETE: The Gmane reporting summary exit spam processor.
2002Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
2003
2004 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2005 "OBSOLETE: The spamoracle summary exit spam processor.")
2006
2007 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2008 "OBSOLETE: The ifile summary exit ham processor.
2009Only applicable to non-spam (unclassified and ham) groups.")
2010
2011 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2012 "OBSOLETE: The Bogofilter summary exit ham processor.
2013Only applicable to non-spam (unclassified and ham) groups.")
2014
2015 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2016 "OBSOLETE: The spam-stat summary exit ham processor.
2017Only applicable to non-spam (unclassified and ham) groups.")
2018
2019 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2020 "OBSOLETE: The whitelist summary exit ham processor.
2021Only applicable to non-spam (unclassified and ham) groups.")
2022
2023 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2024 "OBSOLETE: The BBDB summary exit ham processor.
2025Only applicable to non-spam (unclassified and ham) groups.")
2026
2027 (defvar gnus-group-ham-exit-processor-copy "copy"
2028 "OBSOLETE: The ham copy exit ham processor.
2029Only applicable to non-spam (unclassified and ham) groups.")
2030
2031 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2032 "OBSOLETE: The spamoracle summary exit ham processor.
2033Only applicable to non-spam (unclassified and ham) groups.")
2034
2035 (gnus-define-group-parameter
2036 spam-process
2037 :type list
bf247b6e
KS
2038 :parameter-type
2039 '(choice
23f87bed
MB
2040 :tag "Spam Summary Exit Processor"
2041 :value nil
2042 (list :tag "Spam Summary Exit Processor Choices"
2043 (set
01c52d31
MB
2044 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2045 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2046 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2047 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2048 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2049 (const :tag "Spam: ifile" (spam spam-use-ifile))
2050 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2051 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2052 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2053 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2054 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2055 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2056 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2057 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2058 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2059 (const :tag "Ham: ifile" (ham spam-use-ifile))
2060 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2061 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2062 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2063 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2064 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2065 (variable-item gnus-group-spam-exit-processor-ifile)
2066 (variable-item gnus-group-spam-exit-processor-stat)
2067 (variable-item gnus-group-spam-exit-processor-bogofilter)
2068 (variable-item gnus-group-spam-exit-processor-blacklist)
2069 (variable-item gnus-group-spam-exit-processor-spamoracle)
2070 (variable-item gnus-group-spam-exit-processor-report-gmane)
2071 (variable-item gnus-group-ham-exit-processor-bogofilter)
2072 (variable-item gnus-group-ham-exit-processor-ifile)
2073 (variable-item gnus-group-ham-exit-processor-stat)
2074 (variable-item gnus-group-ham-exit-processor-whitelist)
2075 (variable-item gnus-group-ham-exit-processor-BBDB)
2076 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2077 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2078 :function-document
2079 "Which spam or ham processors will be applied when the summary is exited."
2080 :variable gnus-spam-process-newsgroups
2081 :variable-default nil
2082 :variable-document
2083 "*Groups in which to automatically process spam or ham articles with
2084a backend on summary exit. If non-nil, this should be a list of group
2085name regexps that should match all groups in which to do automatic
2086spam processing, associated with the appropriate processor."
2087 :variable-group spam
bf247b6e 2088 :variable-type
23f87bed
MB
2089 '(repeat :tag "Spam/Ham Processors"
2090 (list :tag "Spam Summary Exit Processor Choices"
2091 (regexp :tag "Group Regexp")
bf247b6e 2092 (set
23f87bed 2093 :tag "Spam/Ham Summary Exit Processor"
01c52d31
MB
2094 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2095 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2096 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2097 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2098 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2099 (const :tag "Spam: ifile" (spam spam-use-ifile))
2100 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2101 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2102 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2103 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2104 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2105 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2106 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2107 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2108 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2109 (const :tag "Ham: ifile" (ham spam-use-ifile))
2110 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2111 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2112 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2113 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2114 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
23f87bed
MB
2115 (variable-item gnus-group-spam-exit-processor-ifile)
2116 (variable-item gnus-group-spam-exit-processor-stat)
2117 (variable-item gnus-group-spam-exit-processor-bogofilter)
2118 (variable-item gnus-group-spam-exit-processor-blacklist)
2119 (variable-item gnus-group-spam-exit-processor-spamoracle)
2120 (variable-item gnus-group-spam-exit-processor-report-gmane)
2121 (variable-item gnus-group-ham-exit-processor-bogofilter)
2122 (variable-item gnus-group-ham-exit-processor-ifile)
2123 (variable-item gnus-group-ham-exit-processor-stat)
2124 (variable-item gnus-group-ham-exit-processor-whitelist)
2125 (variable-item gnus-group-ham-exit-processor-BBDB)
2126 (variable-item gnus-group-ham-exit-processor-spamoracle)
01c52d31 2127 (variable-item gnus-group-ham-exit-processor-copy))))
23f87bed
MB
2128
2129 :parameter-document
2130 "Which spam or ham processors will be applied when the summary is exited.")
2131
2132 (gnus-define-group-parameter
2133 spam-autodetect
2134 :type list
bf247b6e 2135 :parameter-type
23f87bed
MB
2136 '(boolean :tag "Spam autodetection")
2137 :function-document
2138 "Should spam be autodetected (with spam-split) in this group?"
2139 :variable gnus-spam-autodetect
2140 :variable-default nil
2141 :variable-document
2142 "*Groups in which spam should be autodetected when they are entered.
2143 Only unseen articles will be examined, unless
2144 spam-autodetect-recheck-messages is set."
2145 :variable-group spam
bf247b6e 2146 :variable-type
23f87bed
MB
2147 '(repeat
2148 :tag "Autodetection setting"
2149 (list
2150 (regexp :tag "Group Regexp")
2151 boolean))
2152 :parameter-document
2153 "Spam autodetection.
2154Only unseen articles will be examined, unless
2155spam-autodetect-recheck-messages is set.")
2156
2157 (gnus-define-group-parameter
2158 spam-autodetect-methods
2159 :type list
bf247b6e 2160 :parameter-type
23f87bed
MB
2161 '(choice :tag "Spam autodetection-specific methods"
2162 (const none)
2163 (const default)
2164 (set :tag "Use specific methods"
2165 (variable-item spam-use-blacklist)
01c52d31 2166 (variable-item spam-use-gmane-xref)
23f87bed
MB
2167 (variable-item spam-use-regex-headers)
2168 (variable-item spam-use-regex-body)
2169 (variable-item spam-use-whitelist)
2170 (variable-item spam-use-BBDB)
2171 (variable-item spam-use-ifile)
2172 (variable-item spam-use-spamoracle)
01c52d31
MB
2173 (variable-item spam-use-crm114)
2174 (variable-item spam-use-spamassassin)
2175 (variable-item spam-use-spamassassin-headers)
2176 (variable-item spam-use-bsfilter)
2177 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2178 (variable-item spam-use-stat)
2179 (variable-item spam-use-blackholes)
2180 (variable-item spam-use-hashcash)
2181 (variable-item spam-use-bogofilter-headers)
2182 (variable-item spam-use-bogofilter)))
2183 :function-document
2184 "Methods to be used for autodetection in each group"
2185 :variable gnus-spam-autodetect-methods
2186 :variable-default nil
2187 :variable-document
2188 "*Methods for autodetecting spam per group.
2189Requires the spam-autodetect parameter. Only unseen articles
2190will be examined, unless spam-autodetect-recheck-messages is
2191set."
2192 :variable-group spam
bf247b6e 2193 :variable-type
23f87bed
MB
2194 '(repeat
2195 :tag "Autodetection methods"
2196 (list
2197 (regexp :tag "Group Regexp")
2198 (choice
2199 (const none)
2200 (const default)
2201 (set :tag "Use specific methods"
2202 (variable-item spam-use-blacklist)
01c52d31 2203 (variable-item spam-use-gmane-xref)
23f87bed
MB
2204 (variable-item spam-use-regex-headers)
2205 (variable-item spam-use-regex-body)
2206 (variable-item spam-use-whitelist)
2207 (variable-item spam-use-BBDB)
2208 (variable-item spam-use-ifile)
2209 (variable-item spam-use-spamoracle)
01c52d31 2210 (variable-item spam-use-crm114)
23f87bed
MB
2211 (variable-item spam-use-stat)
2212 (variable-item spam-use-blackholes)
2213 (variable-item spam-use-hashcash)
01c52d31
MB
2214 (variable-item spam-use-spamassassin)
2215 (variable-item spam-use-spamassassin-headers)
2216 (variable-item spam-use-bsfilter)
2217 (variable-item spam-use-bsfilter-headers)
23f87bed
MB
2218 (variable-item spam-use-bogofilter-headers)
2219 (variable-item spam-use-bogofilter)))))
2220 :parameter-document
bf247b6e 2221 "Spam autodetection methods.
23f87bed
MB
2222Requires the spam-autodetect parameter. Only unseen articles
2223will be examined, unless spam-autodetect-recheck-messages is
2224set.")
2225
2226 (gnus-define-group-parameter
2227 spam-process-destination
2228 :type list
bf247b6e 2229 :parameter-type
23f87bed
MB
2230 '(choice :tag "Destination for spam-processed articles at summary exit"
2231 (string :tag "Move to a group")
2232 (repeat :tag "Move to multiple groups"
2233 (string :tag "Destination group"))
2234 (const :tag "Expire" nil))
2235 :function-document
2236 "Where spam-processed articles will go at summary exit."
2237 :variable gnus-spam-process-destinations
2238 :variable-default nil
2239 :variable-document
2240 "*Groups in which to explicitly send spam-processed articles to
2241another group, or expire them (the default). If non-nil, this should
2242be a list of group name regexps that should match all groups in which
2243to do spam-processed article moving, associated with the destination
2244group or nil for explicit expiration. This only makes sense for
2245mail groups."
2246 :variable-group spam
bf247b6e 2247 :variable-type
23f87bed
MB
2248 '(repeat
2249 :tag "Spam-processed articles destination"
2250 (list
2251 (regexp :tag "Group Regexp")
2252 (choice
2253 :tag "Destination for spam-processed articles at summary exit"
2254 (string :tag "Move to a group")
2255 (repeat :tag "Move to multiple groups"
2256 (string :tag "Destination group"))
2257 (const :tag "Expire" nil))))
2258 :parameter-document
2259 "Where spam-processed articles will go at summary exit.")
bf247b6e 2260
23f87bed
MB
2261 (gnus-define-group-parameter
2262 ham-process-destination
2263 :type list
bf247b6e 2264 :parameter-type
23f87bed
MB
2265 '(choice
2266 :tag "Destination for ham articles at summary exit from a spam group"
2267 (string :tag "Move to a group")
2268 (repeat :tag "Move to multiple groups"
2269 (string :tag "Destination group"))
2270 (const :tag "Respool" respool)
2271 (const :tag "Do nothing" nil))
2272 :function-document
2273 "Where ham articles will go at summary exit from a spam group."
2274 :variable gnus-ham-process-destinations
2275 :variable-default nil
2276 :variable-document
2277 "*Groups in which to explicitly send ham articles to
2278another group, or do nothing (the default). If non-nil, this should
2279be a list of group name regexps that should match all groups in which
2280to do ham article moving, associated with the destination
2281group or nil for explicit ignoring. This only makes sense for
2282mail groups, and only works in spam groups."
2283 :variable-group spam
bf247b6e 2284 :variable-type
23f87bed
MB
2285 '(repeat
2286 :tag "Ham articles destination"
2287 (list
2288 (regexp :tag "Group Regexp")
2289 (choice
2290 :tag "Destination for ham articles at summary exit from spam group"
2291 (string :tag "Move to a group")
2292 (repeat :tag "Move to multiple groups"
2293 (string :tag "Destination group"))
2294 (const :tag "Respool" respool)
2295 (const :tag "Expire" nil))))
2296 :parameter-document
2297 "Where ham articles will go at summary exit from a spam group.")
2298
2299 (gnus-define-group-parameter
2300 ham-marks
2301 :type 'list
2302 :parameter-type '(list :tag "Ham mark choices"
2303 (set
2304 (variable-item gnus-del-mark)
2305 (variable-item gnus-read-mark)
2306 (variable-item gnus-ticked-mark)
2307 (variable-item gnus-killed-mark)
2308 (variable-item gnus-kill-file-mark)
2309 (variable-item gnus-low-score-mark)))
2310
2311 :parameter-document
2312 "Marks considered ham (positively not spam). Such articles will be
2313processed as ham (non-spam) on group exit. When nil, the global
2314spam-ham-marks variable takes precedence."
2315 :variable-default '((".*" ((gnus-del-mark
2316 gnus-read-mark
2317 gnus-killed-mark
2318 gnus-kill-file-mark
2319 gnus-low-score-mark))))
2320 :variable-group spam
2321 :variable-document
2322 "*Groups in which to explicitly set the ham marks to some value.")
2323
2324 (gnus-define-group-parameter
2325 spam-marks
2326 :type 'list
2327 :parameter-type '(list :tag "Spam mark choices"
2328 (set
2329 (variable-item gnus-spam-mark)
2330 (variable-item gnus-killed-mark)
2331 (variable-item gnus-kill-file-mark)
2332 (variable-item gnus-low-score-mark)))
2333
2334 :parameter-document
2335 "Marks considered spam.
2336Such articles will be processed as spam on group exit. When nil, the global
2337spam-spam-marks variable takes precedence."
2338 :variable-default '((".*" ((gnus-spam-mark))))
2339 :variable-group spam
2340 :variable-document
2341 "*Groups in which to explicitly set the spam marks to some value."))
eec82323
LMI
2342
2343(defcustom gnus-group-uncollapsed-levels 1
2344 "Number of group name elements to leave alone when making a short group name."
2345 :group 'gnus-group-visual
2346 :type 'integer)
2347
2348(defcustom gnus-group-use-permanent-levels nil
2349 "*If non-nil, once you set a level, Gnus will use this level."
2350 :group 'gnus-group-levels
2351 :type 'boolean)
2352
2353;; Hooks.
2354
2355(defcustom gnus-load-hook nil
2356 "A hook run while Gnus is loaded."
2357 :group 'gnus-start
2358 :type 'hook)
2359
2360(defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2361 "A hook called to apply kill files to a group.
2362This hook is intended to apply a kill file to the selected newsgroup.
2363The function `gnus-apply-kill-file' is called by default.
2364
2365Since a general kill file is too heavy to use only for a few
2366newsgroups, I recommend you to use a lighter hook function. For
2367example, if you'd like to apply a kill file to articles which contains
2368a string `rmgroup' in subject in newsgroup `control', you can use the
2369following hook:
2370
2371 (setq gnus-apply-kill-hook
2372 (list
2373 (lambda ()
2374 (cond ((string-match \"control\" gnus-newsgroup-name)
2375 (gnus-kill \"Subject\" \"rmgroup\")
2376 (gnus-expunge \"X\"))))))"
2377 :group 'gnus-score-kill
2378 :options '(gnus-apply-kill-file)
2379 :type 'hook)
2380
2381(defcustom gnus-group-change-level-function nil
2382 "Function run when a group level is changed.
2383It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
16409b0b 2384 :group 'gnus-group-levels
4a2358e9
MB
2385 :type '(choice (const nil)
2386 function))
eec82323
LMI
2387
2388;;; Face thingies.
2389
2390(defcustom gnus-visual
2391 '(summary-highlight group-highlight article-highlight
2392 mouse-face
2393 summary-menu group-menu article-menu
2394 tree-highlight menu highlight
2395 browse-menu server-menu
01c52d31 2396 page-marker tree-menu binary-menu pick-menu)
6748645f 2397 "*Enable visual features.
eec82323
LMI
2398If `visual' is disabled, there will be no menus and few faces. Most of
2399the visual customization options below will be ignored. Gnus will use
2400less space and be faster as a result.
2401
2402This variable can also be a list of visual elements to switch on. For
2403instance, to switch off all visual things except menus, you can say:
2404
2405 (setq gnus-visual '(menu))
2406
2407Valid elements include `summary-highlight', `group-highlight',
2408`article-highlight', `mouse-face', `summary-menu', `group-menu',
2409`article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
01c52d31 2410`server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
eec82323
LMI
2411 :group 'gnus-meta
2412 :group 'gnus-visual
2413 :type '(set (const summary-highlight)
2414 (const group-highlight)
2415 (const article-highlight)
2416 (const mouse-face)
2417 (const summary-menu)
2418 (const group-menu)
2419 (const article-menu)
2420 (const tree-highlight)
2421 (const menu)
2422 (const highlight)
2423 (const browse-menu)
2424 (const server-menu)
2425 (const page-marker)
2426 (const tree-menu)
2427 (const binary-menu)
01c52d31 2428 (const pick-menu)))
eec82323 2429
23f87bed
MB
2430;; Byte-compiler warning.
2431(defvar gnus-visual)
2432;; Find out whether the gnus-visual TYPE is wanted.
2433(defun gnus-visual-p (&optional type class)
2434 (and gnus-visual ; Has to be non-nil, at least.
2435 (if (not type) ; We don't care about type.
2436 gnus-visual
2437 (if (listp gnus-visual) ; It's a list, so we check it.
2438 (or (memq type gnus-visual)
2439 (memq class gnus-visual))
2440 t))))
2441
eec82323
LMI
2442(defcustom gnus-mouse-face
2443 (condition-case ()
2444 (if (gnus-visual-p 'mouse-face 'highlight)
2445 (if (boundp 'gnus-mouse-face)
2446 (or gnus-mouse-face 'highlight)
2447 'highlight)
2448 'default)
2449 (error 'highlight))
6748645f 2450 "*Face used for group or summary buffer mouse highlighting.
eec82323
LMI
2451The line beneath the mouse pointer will be highlighted with this
2452face."
2453 :group 'gnus-visual
2454 :type 'face)
2455
eec82323
LMI
2456(defcustom gnus-article-save-directory gnus-directory
2457 "*Name of the directory articles will be saved in (default \"~/News\")."
2458 :group 'gnus-article-saving
2459 :type 'directory)
2460
6748645f
LMI
2461(defvar gnus-plugged t
2462 "Whether Gnus is plugged or not.")
2463
23f87bed
MB
2464(defcustom gnus-agent-cache t
2465 "Controls use of the agent cache while plugged.
2466When set, Gnus will prefer using the locally stored content rather
2467than re-fetching it from the server. You also need to enable
2468`gnus-agent' for this to have any affect."
bf247b6e 2469 :version "22.1"
23f87bed
MB
2470 :group 'gnus-agent
2471 :type 'boolean)
2472
2473(defcustom gnus-default-charset 'undecided
16409b0b
GM
2474 "Default charset assumed to be used when viewing non-ASCII characters.
2475This variable is overridden on a group-to-group basis by the
23f87bed 2476`gnus-group-charset-alist' variable and is only used on groups not
16409b0b
GM
2477covered by that variable."
2478 :type 'symbol
2479 :group 'gnus-charset)
2480
23f87bed
MB
2481;; Fixme: Doc reference to agent.
2482(defcustom gnus-agent t
2483 "Whether we want to use the Gnus agent or not.
2484
2485You may customize gnus-agent to disable its use. However, some
2486back ends have started to use the agent as a client-side cache.
2487Disabling the agent may result in noticeable loss of performance."
bf247b6e 2488 :version "22.1"
23f87bed
MB
2489 :group 'gnus-agent
2490 :type 'boolean)
2491
2492(defcustom gnus-other-frame-function 'gnus
2493 "Function called by the command `gnus-other-frame'."
2494 :group 'gnus-start
2495 :type '(choice (function-item gnus)
2496 (function-item gnus-no-server)
2497 (function-item gnus-slave)
2498 (function-item gnus-slave-no-server)))
2499
2500(defcustom gnus-other-frame-parameters nil
2501 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2502This should be an alist for Emacs, or a plist for XEmacs."
2503 :group 'gnus-start
2504 :type (if (featurep 'xemacs)
2505 '(repeat (list :inline t :format "%v"
2506 (symbol :tag "Property")
2507 (sexp :tag "Value")))
2508 '(repeat (cons :format "%v"
2509 (symbol :tag "Parameter")
2510 (sexp :tag "Value")))))
2511
4a2358e9 2512(defcustom gnus-user-agent '(emacs gnus type)
23f87bed
MB
2513 "Which information should be exposed in the User-Agent header.
2514
4a2358e9
MB
2515Can be a list of symbols or a string. Valid symbols are `gnus'
2516\(show Gnus version\) and `emacs' \(show Emacs version\). In
2517addition to the Emacs version, you can add `codename' \(show
2518\(S\)XEmacs codename\) or either `config' \(show system
2519configuration\) or `type' \(show system type\). If you set it to
2520a string, be sure to use a valid format, see RFC 2616."
2521
bf247b6e 2522 :version "22.1"
23f87bed 2523 :group 'gnus-message
4a2358e9
MB
2524 :type '(choice (list (set :inline t
2525 (const gnus :tag "Gnus version")
2526 (const emacs :tag "Emacs version")
2527 (choice :tag "system"
2528 (const type :tag "system type")
2529 (const config :tag "system configuration"))
2530 (const codename :tag "Emacs codename")))
2531 (string)))
2532
01c52d31 2533;; Convert old (< 2005-01-10) symbol type values:
4a2358e9
MB
2534(when (symbolp gnus-user-agent)
2535 (setq gnus-user-agent
2536 (cond ((eq gnus-user-agent 'emacs-gnus-config)
2537 '(emacs gnus config))
2538 ((eq gnus-user-agent 'emacs-gnus-type)
2539 '(emacs gnus type))
2540 ((eq gnus-user-agent 'emacs-gnus)
2541 '(emacs gnus))
2542 ((eq gnus-user-agent 'gnus)
2543 '(gnus))
2544 (t gnus-user-agent)))
2545 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2546 (sit-for 1)
2547 (if (get 'gnus-user-agent 'saved-value)
2548 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2549 (gnus-message 1 "Edit your init file to make this change permanent.")
2550 (sit-for 2)))
16409b0b 2551
eec82323
LMI
2552\f
2553;;; Internal variables
2554
48df946a 2555(defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
16409b0b 2556(defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
23f87bed
MB
2557(defvar gnus-agent-method-p-cache nil
2558 ; Reset each time gnus-agent-covered-methods is changed else
2559 ; gnus-agent-method-p may mis-report a methods status.
2560 )
2561(defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2562(defvar gnus-draft-meta-information-header "X-Draft-From")
eec82323
LMI
2563(defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2564(defvar gnus-original-article-buffer " *Original Article*")
2565(defvar gnus-newsgroup-name nil)
6748645f 2566(defvar gnus-ephemeral-servers nil)
23f87bed 2567(defvar gnus-server-method-cache nil)
0617bb00 2568(defvar gnus-extended-servers nil)
6748645f 2569
3d319c8f 2570;; The carpal mode has been removed, but define the variable for
01c35094 2571;; backwards compatibility.
3d319c8f
LMI
2572(defvar gnus-carpal nil)
2573(make-obsolete-variable 'gnus-carpal nil "Emacs 24.1")
2574
48df946a
DL
2575(defvar gnus-agent-fetching nil
2576 "Whether Gnus agent is in fetching mode.")
2577
23f87bed
MB
2578(defvar gnus-agent-covered-methods nil
2579 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2580
6748645f 2581(defvar gnus-command-method nil
23f87bed 2582 "Dynamically bound variable that says what the current back end is.")
eec82323
LMI
2583
2584(defvar gnus-current-select-method nil
2585 "The current method for selecting a newsgroup.")
2586
2587(defvar gnus-tree-buffer "*Tree*"
2588 "Buffer where Gnus thread trees are displayed.")
2589
eec82323
LMI
2590;; Variable holding the user answers to all method prompts.
2591(defvar gnus-method-history nil)
eec82323
LMI
2592
2593;; Variable holding the user answers to all mail method prompts.
2594(defvar gnus-mail-method-history nil)
2595
2596;; Variable holding the user answers to all group prompts.
2597(defvar gnus-group-history nil)
2598
2599(defvar gnus-server-alist nil
2600 "List of available servers.")
2601
6748645f
LMI
2602(defcustom gnus-cache-directory
2603 (nnheader-concat gnus-directory "cache/")
2604 "*The directory where cached articles will be stored."
2605 :group 'gnus-cache
2606 :type 'directory)
2607
eec82323
LMI
2608(defvar gnus-predefined-server-alist
2609 `(("cache"
6748645f
LMI
2610 nnspool "cache"
2611 (nnspool-spool-directory ,gnus-cache-directory)
2612 (nnspool-nov-directory ,gnus-cache-directory)
2613 (nnspool-active-file
2614 ,(nnheader-concat gnus-cache-directory "active"))))
eec82323
LMI
2615 "List of predefined (convenience) servers.")
2616
eec82323
LMI
2617(defconst gnus-article-mark-lists
2618 '((marked . tick) (replied . reply)
2619 (expirable . expire) (killed . killed)
2620 (bookmarks . bookmark) (dormant . dormant)
2621 (scored . score) (saved . save)
6748645f 2622 (cached . cache) (downloadable . download)
23f87bed
MB
2623 (unsendable . unsend) (forwarded . forward)
2624 (recent . recent) (seen . seen)))
2625
2626(defconst gnus-article-special-mark-lists
2627 '((seen range)
2628 (killed range)
2629 (bookmark tuple)
20a673b2
KY
2630 (uid tuple)
2631 (active tuple)
23f87bed
MB
2632 (score tuple)))
2633
2634;; Propagate flags to server, with the following exceptions:
2635;; `seen' is private to each gnus installation
2636;; `cache' is a internal gnus flag for each gnus installation
2637;; `download' is a agent flag private to each gnus installation
2638;; `unsend' are for nndraft groups only
2639;; `score' is not a proper mark
2640;; `bookmark': don't propagated it, or fix the bug in update-mark.
2641(defconst gnus-article-unpropagated-mark-lists
2642 '(seen cache download unsend score bookmark)
2643 "Marks that shouldn't be propagated to back ends.
2644Typical marks are those that make no sense in a standalone back end,
2645such as a mark that says whether an article is stored in the cache
2646\(which doesn't make sense in a standalone back end).")
eec82323
LMI
2647
2648(defvar gnus-headers-retrieved-by nil)
2649(defvar gnus-article-reply nil)
2650(defvar gnus-override-method nil)
eec82323
LMI
2651(defvar gnus-opened-servers nil)
2652
2653(defvar gnus-current-kill-article nil)
2654
2655(defvar gnus-have-read-active-file nil)
2656
2657(defconst gnus-maintainer
2658 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2659 "The mail address of the Gnus maintainers.")
2660
2661(defvar gnus-info-nodes
23f87bed
MB
2662 '((gnus-group-mode "(gnus)Group Buffer")
2663 (gnus-summary-mode "(gnus)Summary Buffer")
2664 (gnus-article-mode "(gnus)Article Buffer")
2665 (gnus-server-mode "(gnus)Server Buffer")
eec82323
LMI
2666 (gnus-browse-mode "(gnus)Browse Foreign Server")
2667 (gnus-tree-mode "(gnus)Tree Display"))
2668 "Alist of major modes and related Info nodes.")
2669
2670(defvar gnus-group-buffer "*Group*")
2671(defvar gnus-summary-buffer "*Summary*")
2672(defvar gnus-article-buffer "*Article*")
2673(defvar gnus-server-buffer "*Server*")
2674
eec82323
LMI
2675(defvar gnus-slave nil
2676 "Whether this Gnus is a slave or not.")
2677
2678(defvar gnus-batch-mode nil
2679 "Whether this Gnus is running in batch mode or not.")
2680
2681(defvar gnus-variable-list
2682 '(gnus-newsrc-options gnus-newsrc-options-n
16409b0b
GM
2683 gnus-newsrc-last-checked-date
2684 gnus-newsrc-alist gnus-server-alist
2685 gnus-killed-list gnus-zombie-list
2686 gnus-topic-topology gnus-topic-alist
2687 gnus-format-specs)
eec82323
LMI
2688 "Gnus variables saved in the quick startup file.")
2689
2690(defvar gnus-newsrc-alist nil
2691 "Assoc list of read articles.
23f87bed
MB
2692`gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2693
2694(defvar gnus-registry-alist nil
2695 "Assoc list of registry data.
2696gnus-registry.el will populate this if it's loaded.")
eec82323
LMI
2697
2698(defvar gnus-newsrc-hashtb nil
23f87bed 2699 "Hashtable of `gnus-newsrc-alist'.")
eec82323
LMI
2700
2701(defvar gnus-killed-list nil
2702 "List of killed newsgroups.")
2703
2704(defvar gnus-killed-hashtb nil
23f87bed 2705 "Hash table equivalent of `gnus-killed-list'.")
eec82323
LMI
2706
2707(defvar gnus-zombie-list nil
2708 "List of almost dead newsgroups.")
2709
2710(defvar gnus-description-hashtb nil
2711 "Descriptions of newsgroups.")
2712
2713(defvar gnus-list-of-killed-groups nil
2714 "List of newsgroups that have recently been killed by the user.")
2715
2716(defvar gnus-active-hashtb nil
2717 "Hashtable of active articles.")
2718
2719(defvar gnus-moderated-hashtb nil
2720 "Hashtable of moderated newsgroups.")
2721
2722;; Save window configuration.
2723(defvar gnus-prev-winconf nil)
2724
2725(defvar gnus-reffed-article-number nil)
2726
eec82323
LMI
2727(defvar gnus-dead-summary nil)
2728
16409b0b
GM
2729(defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2730 "Regexp matching invalid groups.")
2731
23f87bed
MB
2732(defvar gnus-other-frame-object nil
2733 "A frame object which will be created by `gnus-other-frame'.")
2734
eec82323
LMI
2735;;; End of variables.
2736
2737;; Define some autoload functions Gnus might use.
2738(eval-and-compile
2739
2740 ;; This little mapcar goes through the list below and marks the
2741 ;; symbols in question as autoloaded functions.
01c52d31 2742 (mapc
eec82323
LMI
2743 (lambda (package)
2744 (let ((interactive (nth 1 (memq ':interactive package))))
2745 (mapcar
2746 (lambda (function)
2747 (let (keymap)
2748 (when (consp function)
2749 (setq keymap (car (memq 'keymap function)))
2750 (setq function (car function)))
16409b0b
GM
2751 (unless (fboundp function)
2752 (autoload function (car package) nil interactive keymap))))
eec82323 2753 (if (eq (nth 1 package) ':interactive)
16409b0b 2754 (nthcdr 3 package)
eec82323 2755 (cdr package)))))
16409b0b 2756 '(("info" :interactive t Info-goto-node)
ceaed79b 2757 ("pp" pp-to-string)
16409b0b 2758 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
eec82323 2759 ("ps-print" ps-print-preprint)
eec82323
LMI
2760 ("message" :interactive t
2761 message-send-and-exit message-yank-original)
16409b0b
GM
2762 ("babel" babel-as-string)
2763 ("nnmail" nnmail-split-fancy nnmail-article-group)
eec82323 2764 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
fe1f089f
GM
2765 ;; This is only used in message.el, which has an autoload.
2766 ("rmailout" rmail-output)
2767 ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2768 ("rmail" rmail-count-new-messages rmail-show-message
2769 ;; Next two only used in gnus-util.
2770 rmail-summary-exists rmail-select-summary)
2771 ;; Only used in gnus-util, which has an autoload.
2772 ("rmailsum" rmail-update-summary)
eec82323 2773 ("gnus-xmas" gnus-xmas-splash)
eec82323
LMI
2774 ("score-mode" :interactive t gnus-score-mode)
2775 ("gnus-mh" gnus-summary-save-article-folder
2776 gnus-Folder-save-name gnus-folder-save-name)
2777 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
8ccbef23 2778 ("gnus-demon" gnus-demon-add-scanmail
eec82323
LMI
2779 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2780 gnus-demon-add-disconnection gnus-demon-add-handler
2781 gnus-demon-remove-handler)
2782 ("gnus-demon" :interactive t
2783 gnus-demon-init gnus-demon-cancel)
23f87bed
MB
2784 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2785 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2786 gnus-face-from-file)
eec82323 2787 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
71e691a5 2788 gnus-tree-open gnus-tree-close)
6748645f
LMI
2789 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2790 gnus-server-server-name)
eec82323
LMI
2791 ("gnus-srvr" gnus-browse-foreign-server)
2792 ("gnus-cite" :interactive t
2793 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2794 gnus-article-hide-citation gnus-article-fill-cited-article
389b76fa
G
2795 gnus-article-hide-citation-in-followups
2796 gnus-article-fill-cited-long-lines)
eec82323
LMI
2797 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2798 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
16409b0b 2799 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
eec82323
LMI
2800 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2801 gnus-cache-possibly-remove-articles gnus-cache-request-article
2802 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2803 gnus-cache-enter-remove-article gnus-cached-article-p
16409b0b
GM
2804 gnus-cache-open gnus-cache-close gnus-cache-update-article
2805 gnus-cache-articles-in-group)
2806 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2807 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2808 ("gnus-score" :interactive t
2809 gnus-summary-increase-score gnus-summary-set-score
2810 gnus-summary-raise-thread gnus-summary-raise-same-subject
2811 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2812 gnus-summary-lower-thread gnus-summary-lower-same-subject
2813 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2814 gnus-summary-current-score gnus-score-delta-default
2815 gnus-score-flush-cache gnus-score-close
2816 gnus-possibly-score-headers gnus-score-followup-article
2817 gnus-score-followup-thread)
2818 ("gnus-score"
2819 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
eec82323
LMI
2820 gnus-current-score-file-nondirectory gnus-score-adaptive
2821 gnus-score-find-trace gnus-score-file-name)
2822 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2823 ("gnus-topic" :interactive t gnus-topic-mode)
16409b0b
GM
2824 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2825 gnus-subscribe-topics)
eec82323
LMI
2826 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2827 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2828 ("gnus-uu" :interactive t
2829 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2830 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2831 gnus-uu-mark-by-regexp gnus-uu-mark-all
2832 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2833 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2834 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2835 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2836 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2837 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
6748645f 2838 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
01c52d31 2839 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
16409b0b 2840 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
eec82323
LMI
2841 ("gnus-msg" (gnus-summary-send-map keymap)
2842 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2843 ("gnus-msg" :interactive t
23f87bed
MB
2844 gnus-group-post-news gnus-group-mail gnus-group-news
2845 gnus-summary-post-news gnus-summary-news-other-window
eec82323
LMI
2846 gnus-summary-followup gnus-summary-followup-with-original
2847 gnus-summary-cancel-article gnus-summary-supersede-article
2848 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2849 gnus-summary-mail-forward gnus-summary-mail-other-window
2850 gnus-summary-resend-message gnus-summary-resend-bounced-mail
6748645f
LMI
2851 gnus-summary-wide-reply gnus-summary-followup-to-mail
2852 gnus-summary-followup-to-mail-with-original gnus-bug
2853 gnus-summary-wide-reply-with-original
2854 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2855 gnus-summary-post-forward)
23f87bed 2856 ("gnus-picon" :interactive t gnus-treat-from-picon)
23f87bed 2857 ("smiley" :interactive t smiley-region)
eec82323
LMI
2858 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2859 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2860 gnus-list-of-unread-articles gnus-list-of-read-articles
2861 gnus-offer-save-summaries gnus-make-thread-indent-array
6748645f
LMI
2862 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2863 gnus-summary-skip-intangible gnus-summary-article-number
2864 gnus-data-header gnus-data-find)
eec82323
LMI
2865 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2866 gnus-group-list-groups gnus-group-first-unread-group
2867 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2868 gnus-group-setup-buffer gnus-group-get-new-news
6748645f 2869 gnus-group-make-help-group gnus-group-update-group
16409b0b 2870 gnus-group-iterate gnus-group-group-name)
eec82323
LMI
2871 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2872 gnus-backlog-remove-article)
2873 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2874 gnus-article-prepare gnus-article-set-window-start
2875 gnus-article-next-page gnus-article-prev-page
2876 gnus-request-article-this-buffer gnus-article-mode
2877 gnus-article-setup-buffer gnus-narrow-to-page
16409b0b 2878 gnus-article-delete-invisible-text gnus-treat-article)
eec82323
LMI
2879 ("gnus-art" :interactive t
2880 gnus-article-hide-headers gnus-article-hide-boring-headers
16409b0b 2881 gnus-article-treat-overstrike
eec82323
LMI
2882 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2883 gnus-article-display-x-face gnus-article-de-quoted-unreadable
16409b0b
GM
2884 gnus-article-de-base64-unreadable
2885 gnus-article-decode-HZ
2886 gnus-article-wash-html
23f87bed 2887 gnus-article-unsplit-urls
eec82323
LMI
2888 gnus-article-hide-pem gnus-article-hide-signature
2889 gnus-article-strip-leading-blank-lines gnus-article-date-local
2890 gnus-article-date-original gnus-article-date-lapsed
01c52d31 2891 ;;gnus-article-show-all-headers
eec82323 2892 gnus-article-edit-mode gnus-article-edit-article
16409b0b
GM
2893 gnus-article-edit-done gnus-article-decode-encoded-words
2894 gnus-start-date-timer gnus-stop-date-timer
2895 gnus-mime-view-all-parts)
eec82323
LMI
2896 ("gnus-int" gnus-request-type)
2897 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
01c52d31
MB
2898 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2899 gnus-check-reasonable-setup)
eec82323
LMI
2900 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2901 gnus-dup-enter-articles)
2902 ("gnus-range" gnus-copy-sequence)
2903 ("gnus-eform" gnus-edit-form)
eec82323
LMI
2904 ("gnus-logic" gnus-score-advanced)
2905 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2906 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2907 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2908 gnus-async-halt-prefetch)
6748645f 2909 ("gnus-agent" gnus-open-agent gnus-agent-get-function
fa9a04e1 2910 gnus-agent-save-active gnus-agent-method-p
6748645f 2911 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
23f87bed 2912 gnus-summary-set-agent-mark gnus-agent-save-group-info
f3b146e9
LMI
2913 gnus-agent-request-article gnus-agent-retrieve-headers
2914 gnus-agent-store-article gnus-agent-group-covered-p)
6748645f
LMI
2915 ("gnus-agent" :interactive t
2916 gnus-unplugged gnus-agentize gnus-agent-batch)
eec82323 2917 ("gnus-vm" :interactive t gnus-summary-save-in-vm
6748645f 2918 gnus-summary-save-article-vm)
23f87bed
MB
2919 ("compface" uncompface)
2920 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
16409b0b
GM
2921 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2922 ("gnus-mlspl" :interactive t gnus-group-split-setup
23f87bed
MB
2923 gnus-group-split-update)
2924 ("gnus-delay" gnus-delay-initialize))))
eec82323
LMI
2925
2926;;; gnus-sum.el thingies
2927
2928
23f87bed 2929(defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323
LMI
2930 "*The format specification of the lines in the summary buffer.
2931
2932It works along the same lines as a normal formatting string,
2933with some simple extensions.
2934
0d1c2cc8
G
2935%N Article number, left padded with spaces (string)
2936%S Subject (string)
2937%s Subject if it is at the root of a thread, and \"\"
2938 otherwise (string)
2939%n Name of the poster (string)
2940%a Extracted name of the poster (string)
2941%A Extracted address of the poster (string)
2942%F Contents of the From: header (string)
2943%f Contents of the From: or To: headers (string)
2944%x Contents of the Xref: header (string)
2945%D Date of the article (string)
2946%d Date of the article (string) in DD-MMM format
2947%o Date of the article (string) in YYYYMMDD`T'HHMMSS
2948 format
2949%M Message-id of the article (string)
2950%r References of the article (string)
2951%c Number of characters in the article (integer)
2952%k Pretty-printed version of the above (string)
2953 For example, \"1.2k\" or \"0.4M\".
2954%L Number of lines in the article (integer)
2955%I Indentation based on thread level (a string of
2956 spaces)
2957%B A complex trn-style thread tree (string)
2958 The variables `gnus-sum-thread-*' can be used for
2959 customization.
2960%T A string with two possible values: 80 spaces if the
2961 article is on thread level two or larger and 0 spaces
2962 on level one
2963%R \"A\" if this article has been replied to, \" \"
2964 otherwise (character)
2965%U Status of this article (character, \"R\", \"K\",
2966 \"-\" or \" \")
2967%[ Opening bracket (character, \"[\" or \"<\")
2968%] Closing bracket (character, \"]\" or \">\")
2969%> Spaces of length thread-level (string)
2970%< Spaces of length (- 20 thread-level) (string)
2971%i Article score (number)
2972%z Article zcore (character)
2973%t Number of articles under the current thread (number).
2974%e Whether the thread is empty or not (character).
2975%V Total thread score (number).
2976%P The line number (number).
2977%O Download mark (character).
2978%* If present, indicates desired cursor position
2979 (instead of after first colon).
2980%u User defined specifier. The next character in the
2981 format string should be a letter. Gnus will call the
2982 function gnus-user-format-function-X, where X is the
2983 letter following %u. The function will be passed the
2984 current header as argument. The function should
2985 return a string, which will be inserted into the
2986 summary just like information from any other summary
2987 specifier.
2988&user-date; Age sensitive date format. Various date format is
2989 defined in `gnus-summary-user-date-format-alist'.
2990
eec82323 2991
eec82323
LMI
2992The %U (status), %R (replied) and %z (zcore) specs have to be handled
2993with care. For reasons of efficiency, Gnus will compute what column
2994these characters will end up in, and \"hard-code\" that. This means that
65a32076 2995it is invalid to have these specs after a variable-length spec. Well,
eec82323
LMI
2996you might not be arrested, but your summary buffer will look strange,
2997which is bad enough.
2998
23f87bed 2999The smart choice is to have these specs as far to the left as
eec82323
LMI
3000possible.
3001
23f87bed
MB
3002This restriction may disappear in later versions of Gnus.
3003
3004General format specifiers can also be used.
3005See Info node `(gnus)Formatting Variables'."
3006 :link '(custom-manual "(gnus)Formatting Variables")
eec82323
LMI
3007 :type 'string
3008 :group 'gnus-summary-format)
3009
3010;;;
3011;;; Skeleton keymaps
3012;;;
3013
3014(defun gnus-suppress-keymap (keymap)
3015 (suppress-keymap keymap)
6748645f 3016 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
eec82323
LMI
3017 (while keys
3018 (define-key keymap (pop keys) 'undefined))))
3019
3020(defvar gnus-article-mode-map
16409b0b 3021 (let ((keymap (make-sparse-keymap)))
eec82323
LMI
3022 (gnus-suppress-keymap keymap)
3023 keymap))
3024(defvar gnus-summary-mode-map
3025 (let ((keymap (make-keymap)))
3026 (gnus-suppress-keymap keymap)
3027 keymap))
3028(defvar gnus-group-mode-map
3029 (let ((keymap (make-keymap)))
3030 (gnus-suppress-keymap keymap)
3031 keymap))
3032
3033\f
3034
3035;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3036;; If you want the cursor to go somewhere else, set these two
3037;; functions in some startup hook to whatever you want.
3038(defalias 'gnus-summary-position-point 'gnus-goto-colon)
3039(defalias 'gnus-group-position-point 'gnus-goto-colon)
3040
3041;;; Various macros and substs.
3042
3043(defun gnus-header-from (header)
3044 (mail-header-from header))
3045
3046(defmacro gnus-gethash (string hashtable)
3047 "Get hash value of STRING in HASHTABLE."
3048 `(symbol-value (intern-soft ,string ,hashtable)))
3049
23f87bed
MB
3050(defmacro gnus-gethash-safe (string hashtable)
3051 "Get hash value of STRING in HASHTABLE.
3052Return nil if not defined."
3053 `(let ((sym (intern-soft ,string ,hashtable)))
3054 (and (boundp sym) (symbol-value sym))))
3055
eec82323
LMI
3056(defmacro gnus-sethash (string value hashtable)
3057 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3058 `(set (intern ,string ,hashtable) ,value))
3059(put 'gnus-sethash 'edebug-form-spec '(form form form))
3060
3061(defmacro gnus-group-unread (group)
3062 "Get the currently computed number of unread articles in GROUP."
3063 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3064
3065(defmacro gnus-group-entry (group)
3066 "Get the newsrc entry for GROUP."
3067 `(gnus-gethash ,group gnus-newsrc-hashtb))
3068
3069(defmacro gnus-active (group)
3070 "Get active info on GROUP."
3071 `(gnus-gethash ,group gnus-active-hashtb))
3072
3073(defmacro gnus-set-active (group active)
3074 "Set GROUP's active info."
3075 `(gnus-sethash ,group ,active gnus-active-hashtb))
3076
eec82323
LMI
3077;; Info access macros.
3078
3079(defmacro gnus-info-group (info)
3080 `(nth 0 ,info))
3081(defmacro gnus-info-rank (info)
3082 `(nth 1 ,info))
3083(defmacro gnus-info-read (info)
3084 `(nth 2 ,info))
3085(defmacro gnus-info-marks (info)
3086 `(nth 3 ,info))
3087(defmacro gnus-info-method (info)
3088 `(nth 4 ,info))
3089(defmacro gnus-info-params (info)
3090 `(nth 5 ,info))
3091
3092(defmacro gnus-info-level (info)
3093 `(let ((rank (gnus-info-rank ,info)))
3094 (if (consp rank)
3095 (car rank)
3096 rank)))
3097(defmacro gnus-info-score (info)
3098 `(let ((rank (gnus-info-rank ,info)))
3099 (or (and (consp rank) (cdr rank)) 0)))
3100
3101(defmacro gnus-info-set-group (info group)
3102 `(setcar ,info ,group))
3103(defmacro gnus-info-set-rank (info rank)
3104 `(setcar (nthcdr 1 ,info) ,rank))
3105(defmacro gnus-info-set-read (info read)
3106 `(setcar (nthcdr 2 ,info) ,read))
3107(defmacro gnus-info-set-marks (info marks &optional extend)
3108 (if extend
3109 `(gnus-info-set-entry ,info ,marks 3)
3110 `(setcar (nthcdr 3 ,info) ,marks)))
3111(defmacro gnus-info-set-method (info method &optional extend)
3112 (if extend
3113 `(gnus-info-set-entry ,info ,method 4)
3114 `(setcar (nthcdr 4 ,info) ,method)))
3115(defmacro gnus-info-set-params (info params &optional extend)
3116 (if extend
3117 `(gnus-info-set-entry ,info ,params 5)
3118 `(setcar (nthcdr 5 ,info) ,params)))
3119
3120(defun gnus-info-set-entry (info entry number)
3121 ;; Extend the info until we have enough elements.
3122 (while (<= (length info) number)
3123 (nconc info (list nil)))
3124 ;; Set the entry.
3125 (setcar (nthcdr number info) entry))
3126
3127(defmacro gnus-info-set-level (info level)
3128 `(let ((rank (cdr ,info)))
3129 (if (consp (car rank))
3130 (setcar (car rank) ,level)
3131 (setcar rank ,level))))
3132(defmacro gnus-info-set-score (info score)
3133 `(let ((rank (cdr ,info)))
3134 (if (consp (car rank))
3135 (setcdr (car rank) ,score)
3136 (setcar rank (cons (car rank) ,score)))))
3137
3138(defmacro gnus-get-info (group)
3139 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3140
85e75ded
LI
3141(defun gnus-set-info (group info)
3142 (setcar (nthcdr 2 (gnus-gethash group gnus-newsrc-hashtb))
3143 info))
3144
8f688cb0 3145;;; Load the compatibility functions.
eec82323
LMI
3146
3147(require 'gnus-ems)
3148
3149\f
3150;;;
3151;;; Shutdown
3152;;;
3153
3154(defvar gnus-shutdown-alist nil)
3155
3156(defun gnus-add-shutdown (function &rest symbols)
3157 "Run FUNCTION whenever one of SYMBOLS is shut down."
3158 (push (cons function symbols) gnus-shutdown-alist))
3159
3160(defun gnus-shutdown (symbol)
3161 "Shut down everything that waits for SYMBOL."
01c52d31
MB
3162 (dolist (entry gnus-shutdown-alist)
3163 (when (memq symbol (cdr entry))
3164 (funcall (car entry)))))
eec82323
LMI
3165
3166\f
3167;;;
3168;;; Gnus Utility Functions
3169;;;
3170
23f87bed
MB
3171(defun gnus-find-subscribed-addresses ()
3172 "Return a regexp matching the addresses of all subscribed mail groups.
3173It consists of the `to-address' or `to-list' parameter of all groups
3174with a `subscribed' parameter."
3175 (let (group address addresses)
3176 (dolist (entry (cdr gnus-newsrc-alist))
3177 (setq group (car entry))
3178 (when (gnus-parameter-subscribed group)
3179 (setq address (mail-strip-quoted-names
3180 (or (gnus-group-fast-parameter group 'to-address)
3181 (gnus-group-fast-parameter group 'to-list))))
3182 (when address
3183 (add-to-list 'addresses address))))
3184 (when addresses
3185 (list (mapconcat 'regexp-quote addresses "\\|")))))
6748645f 3186
a8151ef7
LMI
3187(defmacro gnus-string-or (&rest strings)
3188 "Return the first element of STRINGS that is a non-blank string.
3189STRINGS will be evaluated in normal `or' order."
075843d3 3190 `(gnus-string-or-1 (list ,@strings)))
a8151ef7
LMI
3191
3192(defun gnus-string-or-1 (strings)
3193 (let (string)
3194 (while strings
075843d3 3195 (setq string (pop strings))
a8151ef7
LMI
3196 (if (string-match "^[ \t]*$" string)
3197 (setq string nil)
3198 (setq strings nil)))
3199 string))
3200
eec82323
LMI
3201(defun gnus-version (&optional arg)
3202 "Version number of this version of Gnus.
3203If ARG, insert string at point."
3204 (interactive "P")
6748645f
LMI
3205 (if arg
3206 (insert (message gnus-version))
3207 (message gnus-version)))
eec82323 3208
23f87bed 3209(defun gnus-continuum-version (&optional version)
eec82323 3210 "Return VERSION as a floating point number."
23f87bed
MB
3211 (unless version
3212 (setq version gnus-version))
eec82323
LMI
3213 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3214 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
6748645f
LMI
3215 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3216 (number (match-string 2 version))
3217 major minor least)
3218 (unless (string-match
3219 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3220 (error "Invalid version string: %s" version))
3221 (setq major (string-to-number (match-string 1 number))
3222 minor (string-to-number (match-string 2 number))
3223 least (if (match-beginning 3)
eec82323
LMI
3224 (string-to-number (match-string 3 number))
3225 0))
3226 (string-to-number
3227 (if (zerop major)
23f87bed
MB
3228 (format "%s00%02d%02d"
3229 (if (member alpha '("(ding)" "d"))
3230 "4.99"
3231 (+ 5 (* 0.02
3232 (abs
3233 (- (mm-char-int (aref (downcase alpha) 0))
3234 (mm-char-int ?t))))
3235 -0.01))
3236 minor least)
eec82323
LMI
3237 (format "%d.%02d%02d" major minor least))))))
3238
23f87bed 3239(defun gnus-info-find-node (&optional nodename)
eec82323
LMI
3240 "Find Info documentation of Gnus."
3241 (interactive)
3242 ;; Enlarge info window if needed.
3243 (let (gnus-info-buffer)
23f87bed 3244 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
eec82323
LMI
3245 (setq gnus-info-buffer (current-buffer))
3246 (gnus-configure-windows 'info)))
3247
6748645f
LMI
3248;;;
3249;;; gnus-interactive
3250;;;
3251
3252(defvar gnus-current-prefix-symbol nil
3253 "Current prefix symbol.")
3254
3255(defvar gnus-current-prefix-symbols nil
3256 "List of current prefix symbols.")
3257
3258(defun gnus-interactive (string &optional params)
3259 "Return a list that can be fed to `interactive'.
3260See `interactive' for full documentation.
3261
3262Adds the following specs:
3263
3264y -- The current symbolic prefix.
3265Y -- A list of the current symbolic prefix(es).
3266A -- Article number.
3267H -- Article header.
3268g -- Group name."
3269 (let ((i 0)
3270 out c prompt)
3271 (while (< i (length string))
3272 (string-match ".\\([^\n]*\\)\n?" string i)
3273 (setq c (aref string i))
3274 (when (match-end 1)
3275 (setq prompt (match-string 1 string)))
3276 (setq i (match-end 0))
3277 ;; We basically emulate just about everything that
3278 ;; `interactive' does, but add the specs listed above.
3279 (push
3280 (cond
3281 ((= c ?a)
3282 (completing-read prompt obarray 'fboundp t))
3283 ((= c ?b)
3284 (read-buffer prompt (current-buffer) t))
3285 ((= c ?B)
3286 (read-buffer prompt (other-buffer (current-buffer))))
3287 ((= c ?c)
3288 (read-char))
3289 ((= c ?C)
3290 (completing-read prompt obarray 'commandp t))
3291 ((= c ?d)
3292 (point))
3293 ((= c ?D)
7e27ce9c 3294 (read-directory-name prompt nil default-directory 'lambda))
6748645f
LMI
3295 ((= c ?f)
3296 (read-file-name prompt nil nil 'lambda))
3297 ((= c ?F)
3298 (read-file-name prompt))
3299 ((= c ?k)
3300 (read-key-sequence prompt))
3301 ((= c ?K)
3302 (error "Not implemented spec"))
3303 ((= c ?e)
3304 (error "Not implemented spec"))
3305 ((= c ?m)
3306 (mark))
3307 ((= c ?N)
3308 (error "Not implemented spec"))
3309 ((= c ?n)
3310 (string-to-number (read-from-minibuffer prompt)))
3311 ((= c ?p)
3312 (prefix-numeric-value current-prefix-arg))
3313 ((= c ?P)
3314 current-prefix-arg)
3315 ((= c ?r)
3316 'gnus-prefix-nil)
3317 ((= c ?s)
3318 (read-string prompt))
3319 ((= c ?S)
3320 (intern (read-string prompt)))
3321 ((= c ?v)
3322 (read-variable prompt))
3323 ((= c ?x)
3324 (read-minibuffer prompt))
3325 ((= c ?x)
3326 (eval-minibuffer prompt))
3327 ;; And here the new specs come.
3328 ((= c ?y)
3329 gnus-current-prefix-symbol)
3330 ((= c ?Y)
3331 gnus-current-prefix-symbols)
3332 ((= c ?g)
3333 (gnus-group-group-name))
3334 ((= c ?A)
3335 (gnus-summary-skip-intangible)
3336 (or (get-text-property (point) 'gnus-number)
3337 (gnus-summary-last-subject)))
3338 ((= c ?H)
3339 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3340 (t
3341 (error "Non-implemented spec")))
3342 out)
3343 (cond
3344 ((= c ?r)
fa066d09
GM
3345 (push (if (< (point) (mark)) (point) (mark)) out)
3346 (push (if (> (point) (mark)) (point) (mark)) out))))
6748645f
LMI
3347 (setq out (delq 'gnus-prefix-nil out))
3348 (nreverse out)))
3349
3350(defun gnus-symbolic-argument (&optional arg)
3351 "Read a symbolic argument and a command, and then execute command."
3352 (interactive "P")
3353 (let* ((in-command (this-command-keys))
3354 (command in-command)
3355 gnus-current-prefix-symbols
3356 gnus-current-prefix-symbol
3357 syms)
3358 (while (equal in-command command)
3359 (message "%s-" (key-description (this-command-keys)))
3360 (push (intern (char-to-string (read-char))) syms)
3361 (setq command (read-key-sequence nil t)))
3362 (setq gnus-current-prefix-symbols (nreverse syms)
3363 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3364 (call-interactively (key-binding command t))))
3365
eec82323
LMI
3366;;; More various functions.
3367
a36c8d02
RS
3368(defsubst gnus-check-backend-function (func group)
3369 "Check whether GROUP supports function FUNC.
3370GROUP can either be a string (a group name) or a select method."
3371 (ignore-errors
3372 (let ((method (if (stringp group)
3373 (car (gnus-find-method-for-group group))
3374 group)))
3375 (unless (featurep method)
3376 (require method))
3377 (fboundp (intern (format "%s-%s" method func))))))
3378
eec82323
LMI
3379(defun gnus-group-read-only-p (&optional group)
3380 "Check whether GROUP supports editing or not.
65a32076 3381If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
eec82323
LMI
3382that that variable is buffer-local to the summary buffers."
3383 (let ((group (or group gnus-newsgroup-name)))
3384 (not (gnus-check-backend-function 'request-replace-article group))))
3385
eec82323
LMI
3386(defun gnus-virtual-group-p (group)
3387 "Say whether GROUP is virtual or not."
3388 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3389 gnus-valid-select-methods)))
3390
3391(defun gnus-news-group-p (group &optional article)
3392 "Return non-nil if GROUP (and ARTICLE) come from a news server."
23f87bed 3393 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
f7aa248a 3394 t) ;is news of course.
23f87bed
MB
3395 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3396 nil) ;must be mail then.
3397 ((vectorp article) ;Has header info.
3398 (eq (gnus-request-type group (mail-header-id article)) 'news))
f7aa248a 3399 ((null article) ;Hasn't header info
23f87bed 3400 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
f7aa248a 3401 ((< article 0) ;Virtual message
23f87bed
MB
3402 nil) ;we don't know, guess mail.
3403 (t ;Has positive number
3404 (eq (gnus-request-type group article) 'news)))) ;use it.
eec82323
LMI
3405
3406;; Returns a list of writable groups.
3407(defun gnus-writable-groups ()
3408 (let ((alist gnus-newsrc-alist)
3409 groups group)
3410 (while (setq group (car (pop alist)))
3411 (unless (gnus-group-read-only-p group)
3412 (push group groups)))
3413 (nreverse groups)))
3414
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
LMI
3583(defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3584 ;; Check parameters for sloppy equalness.
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
f979f37e
GM
3611(defun gnus-methods-sloppily-equal (m1 m2)
3612 ;; Same method.
3613 (or
3614 (eq m1 m2)
3615 ;; Type and name are equal.
3616 (and
3617 (eq (car m1) (car m2))
3618 (equal (cadr m1) (cadr m2))
3619 (gnus-sloppily-equal-method-parameters m1 m2))))
3620
eec82323
LMI
3621(defun gnus-server-equal (m1 m2)
3622 "Say whether two methods are equal."
3623 (let ((m1 (cond ((null m1) gnus-select-method)
3624 ((stringp m1) (gnus-server-to-method m1))
3625 (t m1)))
3626 (m2 (cond ((null m2) gnus-select-method)
3627 ((stringp m2) (gnus-server-to-method m2))
3628 (t m2))))
3629 (gnus-method-equal m1 m2)))
3630
3631(defun gnus-servers-using-backend (backend)
3632 "Return a list of known servers using BACKEND."
3633 (let ((opened gnus-opened-servers)
3634 out)
3635 (while opened
3636 (when (eq backend (caaar opened))
3637 (push (caar opened) out))
3638 (pop opened))
3639 out))
3640
3641(defun gnus-archive-server-wanted-p ()
3642 "Say whether the user wants to use the archive server."
3643 (cond
3644 ((or (not gnus-message-archive-method)
3645 (not gnus-message-archive-group))
3646 nil)
3647 ((and gnus-message-archive-method gnus-message-archive-group)
3648 t)
3649 (t
3650 (let ((active (cadr (assq 'nnfolder-active-file
3651 gnus-message-archive-method))))
3652 (and active
3653 (file-exists-p active))))))
3654
23f87bed
MB
3655(defsubst gnus-method-to-server-name (method)
3656 (concat
3657 (format "%s" (car method))
3658 (when (and
3659 (or (assoc (format "%s" (car method))
3660 (gnus-methods-using 'address))
3661 (gnus-server-equal method gnus-message-archive-method))
3662 (nth 1 method)
3663 (not (string= (nth 1 method) "")))
3664 (concat "+" (nth 1 method)))))
3665
3666(defsubst gnus-method-to-full-server-name (method)
3667 (format "%s+%s" (car method) (nth 1 method)))
3668
3669(defun gnus-group-prefixed-name (group method &optional full)
3670 "Return the whole name from GROUP and METHOD.
3671Call with full set to get the fully qualified group name (even if the
3672server is native)."
3673 (when (stringp method)
3674 (setq method (gnus-server-to-method method)))
6748645f 3675 (if (or (not method)
23f87bed
MB
3676 (and (not full) (gnus-server-equal method "native"))
3677 ;;;!!! This might not be right. We'll see...
3678 ;(string-match ":" group)
3679 )
eec82323 3680 group
23f87bed
MB
3681 (concat (gnus-method-to-server-name method) ":" group)))
3682
3683(defun gnus-group-guess-prefixed-name (group)
3684 "Guess the whole name from GROUP and METHOD."
3685 (gnus-group-prefixed-name group (gnus-find-method-for-group
3686 group)))
3687
3688(defun gnus-group-full-name (group method)
3689 "Return the full name from GROUP and METHOD, even if the method is native."
3690 (gnus-group-prefixed-name group method t))
3691
3692(defun gnus-group-guess-full-name (group)
3693 "Guess the full name from GROUP, even if the method is native."
3694 (if (gnus-group-prefixed-p group)
3695 group
3696 (gnus-group-full-name group (gnus-find-method-for-group group))))
3697
3698(defun gnus-group-guess-full-name-from-command-method (group)
3699 "Guess the full name from GROUP, even if the method is native."
3700 (if (gnus-group-prefixed-p group)
3701 group
3702 (gnus-group-full-name group gnus-command-method)))
eec82323
LMI
3703
3704(defun gnus-group-real-prefix (group)
3705 "Return the prefix of the current group name."
23f87bed
MB
3706 (if (stringp group)
3707 (if (string-match "^[^:]+:" group)
3708 (substring group 0 (match-end 0))
3709 "")
3710 nil))
3711
3712(defun gnus-group-short-name (group)
3713 "Return the short group name."
3714 (let ((prefix (gnus-group-real-prefix group)))
3715 (if (< 0 (length prefix))
3716 (substring group (length prefix) nil)
3717 group)))
3718
3719(defun gnus-group-prefixed-p (group)
3720 "Return the prefix of the current group name."
3721 (< 0 (length (gnus-group-real-prefix group))))
3722
c7e9cfaf
GM
3723(declare-function gnus-group-decoded-name "gnus-group" (string))
3724
23f87bed
MB
3725(defun gnus-summary-buffer-name (group)
3726 "Return the summary buffer name of GROUP."
3727 (concat "*Summary " (gnus-group-decoded-name group) "*"))
eec82323
LMI
3728
3729(defun gnus-group-method (group)
3730 "Return the server or method used for selecting GROUP.
3731You should probably use `gnus-find-method-for-group' instead."
3732 (let ((prefix (gnus-group-real-prefix group)))
3733 (if (equal prefix "")
3734 gnus-select-method
3735 (let ((servers gnus-opened-servers)
3736 (server "")
3737 backend possible found)
3738 (if (string-match "^[^\\+]+\\+" prefix)
3739 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3740 server (substring prefix (match-end 0) (1- (length prefix))))
3741 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3742 (while servers
3743 (when (eq (caaar servers) backend)
3744 (setq possible (caar servers))
3745 (when (equal (cadaar servers) server)
3746 (setq found (caar servers))))
3747 (pop servers))
3748 (or (car (rassoc found gnus-server-alist))
3749 found
3750 (car (rassoc possible gnus-server-alist))
3751 possible
3752 (list backend server))))))
3753
16409b0b
GM
3754(defsubst gnus-native-method-p (method)
3755 "Return whether METHOD is the native select method."
3756 (gnus-method-equal method gnus-select-method))
3757
eec82323
LMI
3758(defsubst gnus-secondary-method-p (method)
3759 "Return whether METHOD is a secondary select method."
3760 (let ((methods gnus-secondary-select-methods)
23f87bed 3761 (gmethod (inline (gnus-server-get-method nil method))))
eec82323 3762 (while (and methods
16409b0b 3763 (not (gnus-method-equal
23f87bed 3764 (inline (gnus-server-get-method nil (car methods)))
16409b0b 3765 gmethod)))
eec82323
LMI
3766 (setq methods (cdr methods)))
3767 methods))
3768
16409b0b
GM
3769(defun gnus-method-simplify (method)
3770 "Return the shortest uniquely identifying string or method for METHOD."
3771 (cond ((stringp method)
3772 method)
3773 ((gnus-native-method-p method)
3774 nil)
3775 ((gnus-secondary-method-p method)
3776 (format "%s:%s" (nth 0 method) (nth 1 method)))
3777 (t
3778 method)))
3779
6748645f
LMI
3780(defun gnus-groups-from-server (server)
3781 "Return a list of all groups that are fetched from SERVER."
3782 (let ((alist (cdr gnus-newsrc-alist))
3783 info groups)
3784 (while (setq info (pop alist))
3785 (when (gnus-server-equal (gnus-info-method info) server)
3786 (push (gnus-info-group info) groups)))
3787 (sort groups 'string<)))
3788
eec82323
LMI
3789(defun gnus-group-foreign-p (group)
3790 "Say whether a group is foreign or not."
3791 (and (not (gnus-group-native-p group))
3792 (not (gnus-group-secondary-p group))))
3793
3794(defun gnus-group-native-p (group)
3795 "Say whether the group is native or not."
3796 (not (string-match ":" group)))
3797
3798(defun gnus-group-secondary-p (group)
3799 "Say whether the group is secondary or not."
3800 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3801
23f87bed
MB
3802(defun gnus-parameters-get-parameter (group)
3803 "Return the group parameters for GROUP from `gnus-parameters'."
e8beac8a
MB
3804 (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3805 case-fold-search
3806 gnus-parameters-case-fold-search))
3807 params-list)
23f87bed
MB
3808 (dolist (elem gnus-parameters)
3809 (when (string-match (car elem) group)
3810 (setq params-list
3811 (nconc (gnus-expand-group-parameters
3812 (car elem) (cdr elem) group)
3813 params-list))))
3814 params-list))
3815
3816(defun gnus-expand-group-parameter (match value group)
3817 "Use MATCH to expand VALUE in GROUP."
d2abc29a
JD
3818 (let ((start (string-match match group)))
3819 (if start
3820 (let ((matched-string (substring group start (match-end 0))))
3821 ;; Build match groups
3822 (string-match match matched-string)
3823 (replace-match value nil nil matched-string))
3824 group)))
23f87bed
MB
3825
3826(defun gnus-expand-group-parameters (match parameters group)
3827 "Go through PARAMETERS and expand them according to the match data."
3828 (let (new)
3829 (dolist (elem parameters)
3830 (if (and (stringp (cdr elem))
3831 (string-match "\\\\[0-9&]" (cdr elem)))
3832 (push (cons (car elem)
3833 (gnus-expand-group-parameter match (cdr elem) group))
3834 new)
3835 (push elem new)))
3836 new))
3837
3838(defun gnus-group-fast-parameter (group symbol &optional allow-list)
3839 "For GROUP, return the value of SYMBOL.
3840
3841You should call this in the `gnus-group-buffer' buffer.
3842The function `gnus-group-find-parameter' will do that for you."
3843 ;; The speed trick: No cons'ing and quit early.
3844 (let* ((params (funcall gnus-group-get-parameter-function group))
3845 ;; Start easy, check the "real" group parameters.
3846 (simple-results
3847 (gnus-group-parameter-value params symbol allow-list t)))
3848 (if simple-results
3849 ;; Found results; return them.
3850 (car simple-results)
01c52d31 3851 ;; We didn't find it there, try `gnus-parameters'.
23f87bed
MB
3852 (let ((result nil)
3853 (head nil)
3854 (tail gnus-parameters))
3855 ;; A good old-fashioned non-cl loop.
3856 (while tail
3857 (setq head (car tail)
3858 tail (cdr tail))
3859 ;; The car is regexp matching for matching the group name.
3860 (when (string-match (car head) group)
3861 ;; The cdr is the parameters.
3862 (setq result (gnus-group-parameter-value (cdr head)
3863 symbol allow-list))
3864 (when result
3865 ;; Expand if necessary.
3866 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3867 (setq result (gnus-expand-group-parameter (car head)
2d04f304 3868 result group))))))
23f87bed
MB
3869 ;; Done.
3870 result))))
3871
6748645f 3872(defun gnus-group-find-parameter (group &optional symbol allow-list)
eec82323 3873 "Return the group parameters for GROUP.
23f87bed
MB
3874If SYMBOL, return the value of that symbol in the group parameters.
3875
3876If you call this function inside a loop, consider using the faster
3877`gnus-group-fast-parameter' instead."
765abcce 3878 (with-current-buffer gnus-group-buffer
23f87bed
MB
3879 (if symbol
3880 (gnus-group-fast-parameter group symbol allow-list)
3881 (nconc
3882 (copy-sequence
3883 (funcall gnus-group-get-parameter-function group))
3884 (gnus-parameters-get-parameter group)))))
eec82323 3885
6748645f 3886(defun gnus-group-get-parameter (group &optional symbol allow-list)
eec82323 3887 "Return the group parameters for GROUP.
6748645f 3888If SYMBOL, return the value of that symbol in the group parameters.
3031d8b0 3889If ALLOW-LIST, also allow list as a result.
6748645f
LMI
3890Most functions should use `gnus-group-find-parameter', which
3891also examines the topic parameters."
eec82323
LMI
3892 (let ((params (gnus-info-params (gnus-get-info group))))
3893 (if symbol
6748645f 3894 (gnus-group-parameter-value params symbol allow-list)
eec82323
LMI
3895 params)))
3896
23f87bed
MB
3897(defun gnus-group-parameter-value (params symbol &optional
3898 allow-list present-p)
3031d8b0
MB
3899 "Return the value of SYMBOL in group PARAMS.
3900If ALLOW-LIST, also allow list as a result."
6748645f
LMI
3901 ;; We only wish to return group parameters (dotted lists) and
3902 ;; not local variables, which may have the same names.
3903 ;; But first we handle single elements...
3904 (or (car (memq symbol params))
3905 ;; Handle alist.
3906 (let (elem)
3907 (catch 'found
3908 (while (setq elem (pop params))
3909 (when (and (consp elem)
3910 (eq (car elem) symbol)
3911 (or allow-list
3912 (atom (cdr elem))))
23f87bed
MB
3913 (throw 'found (if present-p (list (cdr elem))
3914 (cdr elem)))))))))
eec82323
LMI
3915
3916(defun gnus-group-add-parameter (group param)
3917 "Add parameter PARAM to GROUP."
3918 (let ((info (gnus-get-info group)))
3919 (when info
3920 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3921 ;; Cons the new param to the old one and update.
3922 (gnus-group-set-info (cons param (gnus-info-params info))
3923 group 'params))))
3924
3925(defun gnus-group-set-parameter (group name value)
f7aa248a
G
3926 "Set parameter NAME to VALUE in GROUP.
3927GROUP can also be an INFO structure."
3928 (let ((info (if (listp group)
3929 group
3930 (gnus-get-info group))))
eec82323
LMI
3931 (when info
3932 (gnus-group-remove-parameter group name)
3933 (let ((old-params (gnus-info-params info))
3934 (new-params (list (cons name value))))
3935 (while old-params
3936 (when (or (not (listp (car old-params)))
3937 (not (eq (caar old-params) name)))
3938 (setq new-params (append new-params (list (car old-params)))))
3939 (setq old-params (cdr old-params)))
7cad71ad
G
3940 (if (listp group)
3941 (gnus-info-set-params info new-params t)
3942 (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
eec82323
LMI
3943
3944(defun gnus-group-remove-parameter (group name)
f7aa248a
G
3945 "Remove parameter NAME from GROUP.
3946GROUP can also be an INFO structure."
3947 (let ((info (if (listp group)
3948 group
3949 (gnus-get-info group))))
eec82323
LMI
3950 (when info
3951 (let ((params (gnus-info-params info)))
3952 (when params
3953 (setq params (delq name params))
3954 (while (assq name params)
36d3245f 3955 (gnus-alist-pull name params))
eec82323
LMI
3956 (gnus-info-set-params info params))))))
3957
3958(defun gnus-group-add-score (group &optional score)
3959 "Add SCORE to the GROUP score.
3960If SCORE is nil, add 1 to the score of GROUP."
3961 (let ((info (gnus-get-info group)))
3962 (when info
3963 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3964
eec82323
LMI
3965(defun gnus-short-group-name (group &optional levels)
3966 "Collapse GROUP name LEVELS.
3967Select methods are stripped and any remote host name is stripped down to
3968just the host name."
6748645f
LMI
3969 (let* ((name "")
3970 (foreign "")
3971 (depth 0)
3972 (skip 1)
eec82323 3973 (levels (or levels
16409b0b 3974 gnus-group-uncollapsed-levels
eec82323
LMI
3975 (progn
3976 (while (string-match "\\." group skip)
3977 (setq skip (match-end 0)
3978 depth (+ depth 1)))
3979 depth))))
16409b0b 3980 ;; Separate foreign select method from group name and collapse.
23f87bed 3981 ;; If method contains a server, collapse to non-domain server name,
16409b0b
GM
3982 ;; otherwise collapse to select method.
3983 (let* ((colon (string-match ":" group))
3984 (server (and colon (substring group 0 colon)))
3985 (plus (and server (string-match "+" server))))
3986 (when server
3987 (if plus
3988 (setq foreign (substring server (+ 1 plus)
3989 (string-match "\\." server))
3990 group (substring group (+ 1 colon)))
3991 (setq foreign server
3992 group (substring group (+ 1 colon))))
3993 (setq foreign (concat foreign ":")))
3994 ;; Collapse group name leaving LEVELS uncollapsed elements
3995 (let* ((slist (split-string group "/"))
3996 (slen (length slist))
3997 (dlist (split-string group "\\."))
3998 (dlen (length dlist))
3999 glist
4000 glen
4001 gsep
4002 res)
4003 (if (> slen dlen)
4004 (setq glist slist
4005 glen slen
4006 gsep "/")
4007 (setq glist dlist
4008 glen dlen
4009 gsep "."))
4010 (setq levels (- glen levels))
4011 (dolist (g glist)
4012 (push (if (>= (decf levels) 0)
4013 (if (zerop (length g))
4014 ""
4015 (substring g 0 1))
4016 g)
4017 res))
4018 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
eec82323
LMI
4019
4020(defun gnus-narrow-to-body ()
4021 "Narrow to the body of an article."
4022 (narrow-to-region
4023 (progn
4024 (goto-char (point-min))
4025 (or (search-forward "\n\n" nil t)
4026 (point-max)))
4027 (point-max)))
4028
4029\f
4030;;;
4031;;; Kill file handling.
4032;;;
4033
4034(defun gnus-apply-kill-file ()
4035 "Apply a kill file to the current newsgroup.
4036Returns the number of articles marked as read."
4037 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4038 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4039 (gnus-apply-kill-file-internal)
4040 0))
4041
4042(defun gnus-kill-save-kill-buffer ()
4043 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4044 (when (get-file-buffer file)
765abcce 4045 (with-current-buffer (get-file-buffer file)
eec82323
LMI
4046 (when (buffer-modified-p)
4047 (save-buffer))
4048 (kill-buffer (current-buffer))))))
4049
4050(defcustom gnus-kill-file-name "KILL"
4051 "Suffix of the kill files."
4052 :group 'gnus-score-kill
4053 :group 'gnus-score-files
4054 :type 'string)
4055
4056(defun gnus-newsgroup-kill-file (newsgroup)
4057 "Return the name of a kill file name for NEWSGROUP.
4058If NEWSGROUP is nil, return the global kill file name instead."
4059 (cond
4060 ;; The global KILL file is placed at top of the directory.
4061 ((or (null newsgroup)
4062 (string-equal newsgroup ""))
4063 (expand-file-name gnus-kill-file-name
4064 gnus-kill-files-directory))
4065 ;; Append ".KILL" to newsgroup name.
4066 ((gnus-use-long-file-name 'not-kill)
4067 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4068 "." gnus-kill-file-name)
4069 gnus-kill-files-directory))
4070 ;; Place "KILL" under the hierarchical directory.
4071 (t
4072 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4073 "/" gnus-kill-file-name)
4074 gnus-kill-files-directory))))
4075
4076;;; Server things.
4077
4078(defun gnus-member-of-valid (symbol group)
4079 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4080 (memq symbol (assoc
4081 (symbol-name (car (gnus-find-method-for-group group)))
4082 gnus-valid-select-methods)))
4083
4084(defun gnus-method-option-p (method option)
4085 "Return non-nil if select METHOD has OPTION as a parameter."
4086 (when (stringp method)
4087 (setq method (gnus-server-to-method method)))
4088 (memq option (assoc (format "%s" (car method))
4089 gnus-valid-select-methods)))
4090
4091(defun gnus-similar-server-opened (method)
bdaa75c7
LMI
4092 "Return non-nil if we have a similar server opened.
4093This is defined as a server with the same name, but different
4094parameters."
4095 (let ((opened gnus-opened-servers)
4096 open)
eec82323 4097 (while (and method opened)
bdaa75c7
LMI
4098 (setq open (car (pop opened)))
4099 ;; Type and name are the same...
4100 (when (and (equal (car method) (car open))
4101 (equal (cadr method) (cadr open))
4102 ;; ... but the rest of the parameters differ.
4103 (not (gnus-methods-sloppily-equal method open)))
4104 (setq method nil)))
eec82323
LMI
4105 (not method)))
4106
4107(defun gnus-server-extend-method (group method)
65a32076 4108 ;; This function "extends" a virtual server. If the server is
eec82323
LMI
4109 ;; "hello", and the select method is ("hello" (my-var "something"))
4110 ;; in the group "alt.alt", this will result in a new virtual server
4111 ;; called "hello+alt.alt".
4112 (if (or (not (inline (gnus-similar-server-opened method)))
4113 (not (cddr method)))
4114 method
0617bb00
LMI
4115 (setq method
4116 `(,(car method) ,(concat (cadr method) "+" group)
4117 (,(intern (format "%s-address" (car method))) ,(cadr method))
4118 ,@(cddr method)))
4119 (push method gnus-extended-servers)
4120 method))
eec82323
LMI
4121
4122(defun gnus-server-status (method)
4123 "Return the status of METHOD."
4124 (nth 1 (assoc method gnus-opened-servers)))
4125
4126(defun gnus-group-name-to-method (group)
4127 "Guess a select method based on GROUP."
4128 (if (string-match ":" group)
4129 (let ((server (substring group 0 (match-beginning 0))))
4130 (if (string-match "\\+" server)
4131 (list (intern (substring server 0 (match-beginning 0)))
4132 (substring server (match-end 0)))
4133 (list (intern server) "")))
4134 gnus-select-method))
4135
23f87bed
MB
4136(defun gnus-server-string (server)
4137 "Return a readable string that describes SERVER."
4138 (let* ((server (gnus-server-to-method server))
4139 (address (nth 1 server)))
4140 (if (and address
4141 (not (zerop (length address))))
4142 (format "%s using %s" address (car server))
4143 (format "%s" (car server)))))
4144
0617bb00
LMI
4145(defun gnus-same-method-different-name (method)
4146 (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4147 (unless (assq slot (cddr method))
4148 (setq method
4149 (append method (list (list slot (nth 1 method)))))))
4150 (let ((methods gnus-extended-servers)
4151 open found)
4152 (while (and (not found)
4153 (setq open (pop methods)))
4154 (when (and (eq (car method) (car open))
4155 (gnus-sloppily-equal-method-parameters method open))
4156 (setq found open)))
4157 found))
4158
eec82323
LMI
4159(defun gnus-find-method-for-group (group &optional info)
4160 "Find the select method that GROUP uses."
4161 (or gnus-override-method
4162 (and (not group)
4163 gnus-select-method)
6c5d6b6c 4164 (and (not (gnus-group-entry group))
01c52d31
MB
4165 ;; Killed or otherwise unknown group.
4166 (or
4167 ;; If we know a virtual server by that name, return its method.
4168 (gnus-server-to-method (gnus-group-server group))
4169 ;; Guess a new method as last resort.
4170 (gnus-group-name-to-method group)))
eec82323
LMI
4171 (let ((info (or info (gnus-get-info group)))
4172 method)
4173 (if (or (not info)
4174 (not (setq method (gnus-info-method info)))
4175 (equal method "native"))
4176 gnus-select-method
4177 (setq method
4178 (cond ((stringp method)
4179 (inline (gnus-server-to-method method)))
4180 ((stringp (cadr method))
0617bb00
LMI
4181 (or
4182 (inline
4183 (gnus-same-method-different-name method))
4184 (inline (gnus-server-extend-method group method))))
eec82323
LMI
4185 (t
4186 method)))
4187 (cond ((equal (cadr method) "")
4188 method)
4189 ((null (cadr method))
4190 (list (car method) ""))
4191 (t
4192 (gnus-server-add-address method)))))))
4193
eec82323
LMI
4194(defun gnus-methods-using (feature)
4195 "Find all methods that have FEATURE."
4196 (let ((valids gnus-valid-select-methods)
4197 outs)
4198 (while valids
4199 (when (memq feature (car valids))
4200 (push (car valids) outs))
4201 (setq valids (cdr valids)))
4202 outs))
4203
8654e13a
MB
4204(eval-and-compile
4205 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4206
eec82323
LMI
4207(defun gnus-read-group (prompt &optional default)
4208 "Prompt the user for a group name.
16409b0b 4209Disallow invalid group names."
eec82323
LMI
4210 (let ((prefix "")
4211 group)
4212 (while (not group)
a1506d29 4213 (when (string-match
16409b0b 4214 gnus-invalid-group-regexp
eec82323
LMI
4215 (setq group (read-string (concat prefix prompt)
4216 (cons (or default "") 0)
4217 'gnus-group-history)))
23f87bed
MB
4218 (let ((match (match-string 0 group)))
4219 ;; Might be okay (e.g. for nnimap), so ask the user:
4220 (unless (and (not (string-match "^$\\|:" match))
4221 (message-y-or-n-p
4222 "Proceed and create group anyway? " t
4223"The group name \"" group "\" contains a forbidden character: \"" match "\".
4224
4225Usually, it's dangerous to create a group with this name, because it's not
4226supported by all back ends and servers. On IMAP servers it should work,
4227though. If you are really sure, you can proceed anyway and create the group.
4228
4229You may customize the variable `gnus-invalid-group-regexp', which currently is
4230set to \"" gnus-invalid-group-regexp
4231"\", if you want to get rid of this query permanently."))
4232 (setq prefix (format "Invalid group name: \"%s\". " group)
4233 group nil)))))
eec82323
LMI
4234 group))
4235
4236(defun gnus-read-method (prompt)
4237 "Prompt the user for a method.
4238Allow completion over sensible values."
23f87bed
MB
4239 (let* ((open-servers
4240 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4241 gnus-opened-servers))
4242 (valid-methods
4243 (let (methods)
4244 (dolist (method gnus-valid-select-methods)
4245 (if (or (memq 'prompt-address method)
4246 (not (assoc (format "%s:" (car method)) open-servers)))
4247 (push method methods)))
4248 methods))
4249 (servers
4250 (append valid-methods
4251 open-servers
6748645f
LMI
4252 gnus-predefined-server-alist
4253 gnus-server-alist))
4254 (method
229b59da
G
4255 (gnus-completing-read
4256 prompt (mapcar 'car servers)
4257 t nil 'gnus-method-history)))
eec82323
LMI
4258 (cond
4259 ((equal method "")
4260 (setq method gnus-select-method))
4261 ((assoc method gnus-valid-select-methods)
16409b0b
GM
4262 (let ((address (if (memq 'prompt-address
4263 (assoc method gnus-valid-select-methods))
4264 (read-string "Address: ")
4265 "")))
23f87bed 4266 (or (cadr (assoc (format "%s:%s" method address) open-servers))
16409b0b 4267 (list (intern method) address))))
6748645f 4268 ((assoc method servers)
eec82323
LMI
4269 method)
4270 (t
4271 (list (intern method) "")))))
4272
23f87bed
MB
4273;;; Agent functions
4274
b890d447 4275(defun gnus-agent-method-p (method-or-server)
23f87bed 4276 "Say whether METHOD is covered by the agent."
b890d447
MB
4277 (or (eq (car gnus-agent-method-p-cache) method-or-server)
4278 (let* ((method (if (stringp method-or-server)
4279 (gnus-server-to-method method-or-server)
4280 method-or-server))
4281 (server (gnus-method-to-server method t)))
4282 (setq gnus-agent-method-p-cache
4283 (cons method-or-server
4284 (member server gnus-agent-covered-methods)))))
23f87bed
MB
4285 (cdr gnus-agent-method-p-cache))
4286
4287(defun gnus-online (method)
4288 (not
4289 (if gnus-plugged
4290 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4291 (gnus-agent-method-p method))))
4292
eec82323
LMI
4293;;; User-level commands.
4294
4295;;;###autoload
4296(defun gnus-slave-no-server (&optional arg)
23f87bed 4297 "Read network news as a slave, without connecting to the local server."
eec82323
LMI
4298 (interactive "P")
4299 (gnus-no-server arg t))
4300
4301;;;###autoload
4302(defun gnus-no-server (&optional arg slave)
4303 "Read network news.
23f87bed
MB
4304If ARG is a positive number, Gnus will use that as the startup
4305level. If ARG is nil, Gnus will be started at level 2. If ARG is
4306non-nil and not a positive number, Gnus will prompt the user for the
4307name of an NNTP server to use.
4308As opposed to `gnus', this command will not connect to the local
4309server."
eec82323
LMI
4310 (interactive "P")
4311 (gnus-no-server-1 arg slave))
4312
4313;;;###autoload
4314(defun gnus-slave (&optional arg)
4315 "Read news as a slave."
4316 (interactive "P")
4317 (gnus arg nil 'slave))
4318
4319;;;###autoload
23f87bed
MB
4320(defun gnus-other-frame (&optional arg display)
4321 "Pop up a frame to read news.
4322This will call one of the Gnus commands which is specified by the user
4323option `gnus-other-frame-function' (default `gnus') with the argument
4324ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4325optional second argument DISPLAY should be a standard display string
4326such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4327omitted or the function `make-frame-on-display' is not available, the
4328current display is used."
eec82323 4329 (interactive "P")
23f87bed
MB
4330 (if (fboundp 'make-frame-on-display)
4331 (unless display
4332 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4333 (setq display nil))
4334 (let ((alive (gnus-alive-p)))
4335 (unless (and alive
4336 (catch 'found
4337 (walk-windows
4338 (lambda (window)
4339 (when (and (or (not display)
4340 (equal display
4341 (gnus-frame-or-window-display-name
4342 window)))
4343 (with-current-buffer (window-buffer window)
4344 (string-match "\\`gnus-"
4345 (symbol-name major-mode))))
4346 (gnus-select-frame-set-input-focus
4347 (setq gnus-other-frame-object (window-frame window)))
4348 (select-window window)
4349 (throw 'found t)))
4350 'ignore t)))
4351 (gnus-select-frame-set-input-focus
4352 (setq gnus-other-frame-object
4353 (if display
4354 (make-frame-on-display display gnus-other-frame-parameters)
4355 (make-frame gnus-other-frame-parameters))))
4356 (if alive
4357 (switch-to-buffer gnus-group-buffer)
4358 (funcall gnus-other-frame-function arg)
4359 (add-hook 'gnus-exit-gnus-hook
4f91a816
SM
4360 (lambda nil
4361 (when (and (frame-live-p gnus-other-frame-object)
4362 (cdr (frame-list)))
4363 (delete-frame gnus-other-frame-object))
4364 (setq gnus-other-frame-object nil)))))))
eec82323
LMI
4365
4366;;;###autoload
4367(defun gnus (&optional arg dont-connect slave)
4368 "Read network news.
4369If ARG is non-nil and a positive number, Gnus will use that as the
23f87bed 4370startup level. If ARG is non-nil and not a positive number, Gnus will
eec82323
LMI
4371prompt the user for the name of an NNTP server to use."
4372 (interactive "P")
bdaa75c7
LMI
4373 ;; When using the development version of Gnus, load the gnus-load
4374 ;; file.
4375 (unless (string-match "^Gnus" gnus-version)
8ccbef23 4376 (load "gnus-load" nil t))
23f87bed
MB
4377 (unless (byte-code-function-p (symbol-function 'gnus))
4378 (message "You should byte-compile Gnus")
4379 (sit-for 2))
4478e074
G
4380 (let ((gnus-action-message-log (list nil)))
4381 (gnus-1 arg dont-connect slave)
4382 (gnus-final-warning)))
eec82323
LMI
4383
4384;; Allow redefinition of Gnus functions.
4385
4386(gnus-ems-redefine)
4387
4388(provide 'gnus)
4389
4390;;; gnus.el ends here