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