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