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