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