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