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