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