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