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