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