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