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