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