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