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