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