Synch to No Gnus 200409101504.
[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   :group 'gnus-group-various
990   :type '(repeat (cons regexp
991                        (repeat sexp))))
992
993 (defvar gnus-group-parameters-more nil)
994
995 (defvar gnus-colon-keywords
996   (eval-when-compile
997     (when (boundp 'dgnushack-colon-keywords)
998       (symbol-value 'dgnushack-colon-keywords)))
999   "List of the colon keywords should be bound at run-time.  This variable
1000 defaults to a proper value only if this file is byte-compiled by make.")
1001
1002 (dolist (keyword gnus-colon-keywords)
1003   (set keyword keyword))
1004
1005 (defmacro gnus-define-group-parameter (param &rest rest)
1006   "Define a group parameter PARAM.
1007 REST is a plist of following:
1008 :type               One of `bool', `list' or nil.
1009 :function           The name of the function.
1010 :function-document  The documentation of the function.
1011 :parameter-type     The type for customizing the parameter.
1012 :parameter-document The documentation for the parameter.
1013 :variable           The name of the variable.
1014 :variable-document  The documentation for the variable.
1015 :variable-group     The group for customizing the variable.
1016 :variable-type      The type for customizing the variable.
1017 :variable-default   The default value of the variable."
1018   (let* ((type (plist-get rest :type))
1019          (parameter-type (plist-get rest :parameter-type))
1020          (parameter-document (plist-get rest :parameter-document))
1021          (function (or (plist-get rest :function)
1022                        (intern (format "gnus-parameter-%s" param))))
1023          (function-document (or (plist-get rest :function-document) ""))
1024          (variable (or (plist-get rest :variable)
1025                        (intern (format "gnus-parameter-%s-alist" param))))
1026          (variable-document (or (plist-get rest :variable-document) ""))
1027          (variable-group (plist-get rest :variable-group))
1028          (variable-type (or (plist-get rest :variable-type)
1029                             `(quote (repeat
1030                                      (list (regexp :tag "Group")
1031                                            ,(car (cdr parameter-type)))))))
1032          (variable-default (plist-get rest :variable-default)))
1033     (list
1034      'progn
1035      `(defcustom ,variable ,variable-default
1036         ,variable-document
1037         :group 'gnus-group-parameter
1038         :group ',variable-group
1039         :type ,variable-type)
1040      `(setq gnus-group-parameters-more
1041             (delq (assq ',param gnus-group-parameters-more)
1042                   gnus-group-parameters-more))
1043      `(add-to-list 'gnus-group-parameters-more
1044                    (list ',param
1045                          ,parameter-type
1046                          ,parameter-document))
1047      (if (eq type 'bool)
1048          `(defun ,function (name)
1049             ,function-document
1050             (let ((params (gnus-group-find-parameter name))
1051                   val)
1052               (cond
1053                ((memq ',param params)
1054                 t)
1055                ((setq val (assq ',param params))
1056                 (cdr val))
1057                ((stringp ,variable)
1058                 (string-match ,variable name))
1059                (,variable
1060                 (let ((alist ,variable)
1061                       elem value)
1062                   (while (setq elem (pop alist))
1063                     (when (and name
1064                                (string-match (car elem) name))
1065                       (setq alist nil
1066                             value (cdr elem))))
1067                   (if (consp value) (car value) value))))))
1068        `(defun ,function (name)
1069           ,function-document
1070           (and name
1071                (or (gnus-group-find-parameter name ',param ,(and type t))
1072                    (let ((alist ,variable)
1073                          elem value)
1074                      (while (setq elem (pop alist))
1075                        (when (and name
1076                                   (string-match (car elem) name))
1077                          (setq alist nil
1078                                value (cdr elem))))
1079                      ,(if type
1080                           'value
1081                         '(if (consp value) (car value) value))))))))))
1082
1083 (defcustom gnus-home-directory "~/"
1084   "Directory variable that specifies the \"home\" directory.
1085 All other Gnus file and directory variables are initialized from this variable."
1086   :group 'gnus-files
1087   :type 'directory)
1088
1089 (defcustom gnus-directory (or (getenv "SAVEDIR")
1090                               (nnheader-concat gnus-home-directory "News/"))
1091   "*Directory variable from which all other Gnus file variables are derived.
1092
1093 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1094 This means that other directory variables that are initialized from
1095 this variable won't be set properly if you set this variable in `.gnus.el'.
1096 Set this variable in `.emacs' instead."
1097   :group 'gnus-files
1098   :type 'directory)
1099
1100 (defcustom gnus-default-directory nil
1101   "*Default directory for all Gnus buffers."
1102   :group 'gnus-files
1103   :type '(choice (const :tag "current" nil)
1104                  directory))
1105
1106 ;; Site dependent variables.  These variables should be defined in
1107 ;; paths.el.
1108
1109 (defvar gnus-default-nntp-server nil
1110   "Specify a default NNTP server.
1111 This variable should be defined in paths.el, and should never be set
1112 by the user.
1113 If you want to change servers, you should use `gnus-select-method'.
1114 See the documentation to that variable.")
1115
1116 ;; Don't touch this variable.
1117 (defvar gnus-nntp-service "nntp"
1118   "NNTP service name (\"nntp\" or 119).
1119 This is an obsolete variable, which is scarcely used.  If you use an
1120 nntp server for your newsgroup and want to change the port number
1121 used to 899, you would say something along these lines:
1122
1123  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1124
1125 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1126   "A file with only the name of the nntp server in it."
1127   :group 'gnus-files
1128   :group 'gnus-server
1129   :type 'file)
1130
1131 (defun gnus-getenv-nntpserver ()
1132   "Find default nntp server.
1133 Check the NNTPSERVER environment variable and the
1134 `gnus-nntpserver-file' file."
1135   (or (getenv "NNTPSERVER")
1136       (and (file-readable-p gnus-nntpserver-file)
1137            (with-temp-buffer
1138              (insert-file-contents gnus-nntpserver-file)
1139              (when (re-search-forward "[^ \t\n\r]+" nil t)
1140                (match-string 0))))))
1141
1142 (defcustom gnus-select-method
1143   (condition-case nil
1144       (nconc
1145        (list 'nntp (or (condition-case nil
1146                            (gnus-getenv-nntpserver)
1147                          (error nil))
1148                        (when (and gnus-default-nntp-server
1149                                   (not (string= gnus-default-nntp-server "")))
1150                          gnus-default-nntp-server)
1151                        "news"))
1152        (if (or (null gnus-nntp-service)
1153                (equal gnus-nntp-service "nntp"))
1154            nil
1155          (list gnus-nntp-service)))
1156     (error nil))
1157   "Default method for selecting a newsgroup.
1158 This variable should be a list, where the first element is how the
1159 news is to be fetched, the second is the address.
1160
1161 For instance, if you want to get your news via \"flab.flab.edu\" using
1162 NNTP, you could say:
1163
1164 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1165
1166 If you want to use your local spool, say:
1167
1168 \(setq gnus-select-method (list 'nnspool (system-name)))
1169
1170 If you use this variable, you must set `gnus-nntp-server' to nil.
1171
1172 There is a lot more to know about select methods and virtual servers -
1173 see the manual for details."
1174   :group 'gnus-server
1175   :type 'gnus-select-method)
1176
1177 (defcustom gnus-message-archive-method "archive"
1178   "*Method used for archiving messages you've sent.
1179 This should be a mail method."
1180   :group 'gnus-server
1181   :group 'gnus-message
1182   :type '(choice (const :tag "Default archive method" "archive")
1183                  gnus-select-method))
1184
1185 (defcustom gnus-message-archive-group nil
1186   "*Name of the group in which to save the messages you've written.
1187 This can either be a string; a list of strings; or an alist
1188 of regexps/functions/forms to be evaluated to return a string (or a list
1189 of strings).  The functions are called with the name of the current
1190 group (or nil) as a parameter.
1191
1192 If you want to save your mail in one group and the news articles you
1193 write in another group, you could say something like:
1194
1195  \(setq gnus-message-archive-group
1196         '((if (message-news-p)
1197               \"misc-news\"
1198             \"misc-mail\")))
1199
1200 Normally the group names returned by this variable should be
1201 unprefixed -- which implicitly means \"store on the archive server\".
1202 However, you may wish to store the message on some other server.  In
1203 that case, just return a fully prefixed name of the group --
1204 \"nnml+private:mail.misc\", for instance."
1205   :group 'gnus-message
1206   :type '(choice (const :tag "none" nil)
1207                  function
1208                  sexp
1209                  string))
1210
1211 (defcustom gnus-secondary-servers nil
1212   "List of NNTP servers that the user can choose between interactively.
1213 To make Gnus query you for a server, you have to give `gnus' a
1214 non-numeric prefix - `C-u M-x gnus', in short."
1215   :group 'gnus-server
1216   :type '(repeat string))
1217
1218 (defcustom gnus-nntp-server nil
1219   "*The name of the host running the NNTP server.
1220 This variable is semi-obsolete.  Use the `gnus-select-method'
1221 variable instead."
1222   :group 'gnus-server
1223   :type '(choice (const :tag "disable" nil)
1224                  string))
1225
1226 (defcustom gnus-secondary-select-methods nil
1227   "A list of secondary methods that will be used for reading news.
1228 This is a list where each element is a complete select method (see
1229 `gnus-select-method').
1230
1231 If, for instance, you want to read your mail with the nnml back end,
1232 you could set this variable:
1233
1234 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1235   :group 'gnus-server
1236   :type '(repeat gnus-select-method))
1237
1238 (defvar gnus-backup-default-subscribed-newsgroups
1239   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1240   "Default default new newsgroups the first time Gnus is run.
1241 Should be set in paths.el, and shouldn't be touched by the user.")
1242
1243 (defcustom gnus-local-domain nil
1244   "Local domain name without a host name.
1245 The DOMAINNAME environment variable is used instead if it is defined.
1246 If the function `system-name' returns the full Internet name, there is
1247 no need to set this variable."
1248   :group 'gnus-message
1249   :type '(choice (const :tag "default" nil)
1250                  string))
1251
1252 (defvar gnus-local-organization nil
1253   "String with a description of what organization (if any) the user belongs to.
1254 Obsolete variable; use `message-user-organization' instead.")
1255
1256 ;; Customization variables
1257
1258 (defcustom gnus-refer-article-method nil
1259   "Preferred method for fetching an article by Message-ID.
1260 If you are reading news from the local spool (with nnspool), fetching
1261 articles by Message-ID is painfully slow.  By setting this method to an
1262 nntp method, you might get acceptable results.
1263
1264 The value of this variable must be a valid select method as discussed
1265 in the documentation of `gnus-select-method'.
1266
1267 It can also be a list of select methods, as well as the special symbol
1268 `current', which means to use the current select method.  If it is a
1269 list, Gnus will try all the methods in the list until it finds a match."
1270   :group 'gnus-server
1271   :type '(choice (const :tag "default" nil)
1272                  (const current)
1273                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1274                  gnus-select-method
1275                  (repeat :menu-tag "Try multiple"
1276                          :tag "Multiple"
1277                          :value (current (nnweb "refer" (nnweb-type google)))
1278                          (choice :tag "Method"
1279                                  (const current)
1280                                  (const :tag "Google"
1281                                         (nnweb "refer" (nnweb-type google)))
1282                                  gnus-select-method))))
1283
1284 (defcustom gnus-group-faq-directory
1285   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1286     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1287     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1288     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1289     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1290     "/ftp@rtfm.mit.edu:/pub/usenet/"
1291     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1292     "/ftp@ftp.sunet.se:/pub/usenet/"
1293     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1294     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1295     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1296   "*Directory where the group FAQs are stored.
1297 This will most commonly be on a remote machine, and the file will be
1298 fetched by ange-ftp.
1299
1300 This variable can also be a list of directories.  In that case, the
1301 first element in the list will be used by default.  The others can
1302 be used when being prompted for a site.
1303
1304 Note that Gnus uses an aol machine as the default directory.  If this
1305 feels fundamentally unclean, just think of it as a way to finally get
1306 something of value back from them.
1307
1308 If the default site is too slow, try one of these:
1309
1310    North America: mirrors.aol.com                /pub/rtfm/usenet
1311                   ftp.seas.gwu.edu               /pub/rtfm
1312                   rtfm.mit.edu                   /pub/usenet
1313    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1314                   src.doc.ic.ac.uk               /usenet/news-FAQS
1315                   ftp.sunet.se                   /pub/usenet
1316                   ftp.pasteur.fr                 /pub/FAQ
1317    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1318                   hwarang.postech.ac.kr          /pub/usenet
1319                   ftp.hk.super.net               /mirror/faqs"
1320   :group 'gnus-group-various
1321   :type '(choice directory
1322                  (repeat directory)))
1323
1324 (defcustom gnus-group-charter-alist
1325   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1326     ("de" . (concat "http://purl.net/charta/" name ".html"))
1327     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1328     ("england" . (concat "http://england.news-admin.org/charters/" name))
1329     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1330     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1331                         (gnus-replace-in-string name "europa\\." "") ".html"))
1332     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1333     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1334     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1335     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1336     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1337     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1338     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1339     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1340                     (gnus-replace-in-string name "\\." "_") ".html"))
1341     ("milw" . (concat "http://usenet.mil.wi.us/"
1342                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1343     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1344     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1345                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1346   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1347 When FORM is evaluated `name' is bound to the name of the group."
1348   :group 'gnus-group-various
1349   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1350
1351 (defcustom gnus-group-fetch-control-use-browse-url nil
1352   "*Non-nil means that control messages are displayed using `browse-url'.
1353 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1354 group."
1355   :group 'gnus-group-various
1356   :type 'boolean)
1357
1358 (defcustom gnus-use-cross-reference t
1359   "*Non-nil means that cross referenced articles will be marked as read.
1360 If nil, ignore cross references.  If t, mark articles as read in
1361 subscribed newsgroups.  If neither t nor nil, mark as read in all
1362 newsgroups."
1363   :group 'gnus-server
1364   :type '(choice (const :tag "off" nil)
1365                  (const :tag "subscribed" t)
1366                  (sexp :format "all"
1367                        :value always)))
1368
1369 (defcustom gnus-process-mark ?#
1370   "*Process mark."
1371   :group 'gnus-group-visual
1372   :group 'gnus-summary-marks
1373   :type 'character)
1374
1375 (defcustom gnus-large-newsgroup 200
1376   "*The number of articles which indicates a large newsgroup.
1377 If the number of articles in a newsgroup is greater than this value,
1378 confirmation is required for selecting the newsgroup.
1379 If it is nil, no confirmation is required."
1380   :group 'gnus-group-select
1381   :type '(choice (const :tag "No limit" nil)
1382                  integer))
1383
1384 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1385   "*Non-nil means that the default name of a file to save articles in is the group name.
1386 If it's nil, the directory form of the group name is used instead.
1387
1388 If this variable is a list, and the list contains the element
1389 `not-score', long file names will not be used for score files; if it
1390 contains the element `not-save', long file names will not be used for
1391 saving; and if it contains the element `not-kill', long file names
1392 will not be used for kill files.
1393
1394 Note that the default for this variable varies according to what system
1395 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1396 to nil while on all other systems it defaults to t."
1397   :group 'gnus-start
1398   :type '(radio (sexp :format "Non-nil\n"
1399                       :match (lambda (widget value)
1400                                (and value (not (listp value))))
1401                       :value t)
1402                 (const nil)
1403                 (checklist (const :format "%v " not-score)
1404                            (const :format "%v " not-save)
1405                            (const not-kill))))
1406
1407 (defcustom gnus-kill-files-directory gnus-directory
1408   "*Name of the directory where kill files will be stored (default \"~/News\")."
1409   :group 'gnus-score-files
1410   :group 'gnus-score-kill
1411   :type 'directory)
1412
1413 (defcustom gnus-save-score nil
1414   "*If non-nil, save group scoring info."
1415   :group 'gnus-score-various
1416   :group 'gnus-start
1417   :type 'boolean)
1418
1419 (defcustom gnus-use-undo t
1420   "*If non-nil, allow undoing in Gnus group mode buffers."
1421   :group 'gnus-meta
1422   :type 'boolean)
1423
1424 (defcustom gnus-use-adaptive-scoring nil
1425   "*If non-nil, use some adaptive scoring scheme.
1426 If a list, then the values `word' and `line' are meaningful.  The
1427 former will perform adaption on individual words in the subject
1428 header while `line' will perform adaption on several headers."
1429   :group 'gnus-meta
1430   :group 'gnus-score-adapt
1431   :type '(set (const word) (const line)))
1432
1433 (defcustom gnus-use-cache 'passive
1434   "*If nil, Gnus will ignore the article cache.
1435 If `passive', it will allow entering (and reading) articles
1436 explicitly entered into the cache.  If anything else, use the
1437 cache to the full extent of the law."
1438   :group 'gnus-meta
1439   :group 'gnus-cache
1440   :type '(choice (const :tag "off" nil)
1441                  (const :tag "passive" passive)
1442                  (const :tag "active" t)))
1443
1444 (defcustom gnus-use-trees nil
1445   "*If non-nil, display a thread tree buffer."
1446   :group 'gnus-meta
1447   :type 'boolean)
1448
1449 (defcustom gnus-keep-backlog 20
1450   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1451 If it is a number N, then Gnus will only keep the last N articles
1452 read.  If it is neither nil nor a number, Gnus will keep all read
1453 articles.  This is not a good idea."
1454   :group 'gnus-meta
1455   :type '(choice (const :tag "off" nil)
1456                  integer
1457                  (sexp :format "all"
1458                        :value t)))
1459
1460 (defcustom gnus-use-nocem nil
1461   "*If non-nil, Gnus will read NoCeM cancel messages."
1462   :group 'gnus-meta
1463   :type 'boolean)
1464
1465 (defcustom gnus-suppress-duplicates nil
1466   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1467   :group 'gnus-meta
1468   :type 'boolean)
1469
1470 (defcustom gnus-use-scoring t
1471   "*If non-nil, enable scoring."
1472   :group 'gnus-meta
1473   :type 'boolean)
1474
1475 (defcustom gnus-summary-prepare-exit-hook
1476   '(gnus-summary-expire-articles)
1477   "*A hook called when preparing to exit from the summary buffer.
1478 It calls `gnus-summary-expire-articles' by default."
1479   :group 'gnus-summary-exit
1480   :type 'hook)
1481
1482 (defcustom gnus-novice-user t
1483   "*Non-nil means that you are a Usenet novice.
1484 If non-nil, verbose messages may be displayed and confirmations may be
1485 required."
1486   :group 'gnus-meta
1487   :type 'boolean)
1488
1489 (defcustom gnus-expert-user nil
1490   "*Non-nil means that you will never be asked for confirmation about anything.
1491 That doesn't mean *anything* anything; particularly destructive
1492 commands will still require prompting."
1493   :group 'gnus-meta
1494   :type 'boolean)
1495
1496 (defcustom gnus-interactive-catchup t
1497   "*If non-nil, require your confirmation when catching up a group."
1498   :group 'gnus-group-select
1499   :type 'boolean)
1500
1501 (defcustom gnus-interactive-exit t
1502   "*If non-nil, require your confirmation when exiting Gnus."
1503   :group 'gnus-exit
1504   :type 'boolean)
1505
1506 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1507   "Function for extracting address components from a From header.
1508 Three pre-defined functions exist: `gnus-extract-address-components',
1509 which is the default, quite fast, and too simplistic solution,
1510 `mail-extract-address-components', which works much better, but is
1511 slower, and `std11-extract-address-components'."
1512   :group 'gnus-summary-format
1513   :type '(radio (function-item gnus-extract-address-components)
1514                 (function-item mail-extract-address-components)
1515                 (function-item std11-extract-address-components)
1516                 (function :tag "Other")))
1517
1518 (defcustom gnus-carpal nil
1519   "*If non-nil, display clickable icons."
1520   :group 'gnus-meta
1521   :type 'boolean)
1522
1523 (defcustom gnus-shell-command-separator ";"
1524   "String used to separate shell commands."
1525   :group 'gnus-files
1526   :type 'string)
1527
1528 (defcustom gnus-valid-select-methods
1529   '(("nntp" post address prompt-address physical-address)
1530     ("nnspool" post address)
1531     ("nnvirtual" post-mail virtual prompt-address)
1532     ("nnmbox" mail respool address)
1533     ("nnml" post-mail respool address)
1534     ("nnmh" mail respool address)
1535     ("nndir" post-mail prompt-address physical-address)
1536     ("nneething" none address prompt-address physical-address)
1537     ("nndoc" none address prompt-address)
1538     ("nnbabyl" mail address respool)
1539     ("nnkiboze" post virtual)
1540     ("nnsoup" post-mail address)
1541     ("nndraft" post-mail)
1542     ("nnfolder" mail respool address)
1543     ("nngateway" post-mail address prompt-address physical-address)
1544     ("nnweb" none)
1545     ("nngoogle" post)
1546     ("nnslashdot" post)
1547     ("nnultimate" none)
1548     ("nnrss" none)
1549     ("nnwfm" none)
1550     ("nnwarchive" none)
1551     ("nnlistserv" none)
1552     ("nnagent" post-mail)
1553     ("nnimap" post-mail address prompt-address physical-address)
1554     ("nnmaildir" mail respool address)
1555     ("nnnil" none))
1556   "*An alist of valid select methods.
1557 The first element of each list lists should be a string with the name
1558 of the select method.  The other elements may be the category of
1559 this method (i. e., `post', `mail', `none' or whatever) or other
1560 properties that this method has (like being respoolable).
1561 If you implement a new select method, all you should have to change is
1562 this variable.  I think."
1563   :group 'gnus-server
1564   :type '(repeat (group (string :tag "Name")
1565                         (radio-button-choice (const :format "%v " post)
1566                                              (const :format "%v " mail)
1567                                              (const :format "%v " none)
1568                                              (const post-mail))
1569                         (checklist :inline t
1570                                    (const :format "%v " address)
1571                                    (const :format "%v " prompt-address)
1572                                    (const :format "%v " physical-address)
1573                                    (const :format "%v " virtual)
1574                                    (const respool)))))
1575
1576 (defun gnus-redefine-select-method-widget ()
1577   "Recomputes the select-method widget based on the value of
1578 `gnus-valid-select-methods'."
1579   (define-widget 'gnus-select-method 'list
1580     "Widget for entering a select method."
1581     :value '(nntp "")
1582     :tag "Select Method"
1583     :args `((choice :tag "Method"
1584                     ,@(mapcar (lambda (entry)
1585                                 (list 'const :format "%v\n"
1586                                       (intern (car entry))))
1587                               gnus-valid-select-methods)
1588                     (symbol :tag "other"))
1589             (string :tag "Address")
1590             (repeat :tag "Options"
1591                     :inline t
1592                     (list :format "%v"
1593                           variable
1594                           (sexp :tag "Value"))))))
1595
1596 (gnus-redefine-select-method-widget)
1597
1598 (defcustom gnus-updated-mode-lines '(group article summary tree)
1599   "List of buffers that should update their mode lines.
1600 The list may contain the symbols `group', `article', `tree' and
1601 `summary'.  If the corresponding symbol is present, Gnus will keep
1602 that mode line updated with information that may be pertinent.
1603 If this variable is nil, screen refresh may be quicker."
1604   :group 'gnus-various
1605   :type '(set (const group)
1606               (const article)
1607               (const summary)
1608               (const tree)))
1609
1610 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1611 (defcustom gnus-mode-non-string-length nil
1612   "*Max length of mode-line non-string contents.
1613 If this is nil, Gnus will take space as is needed, leaving the rest
1614 of the mode line intact.  Note that the default of nil is unlikely
1615 to be desirable; see the manual for further details."
1616   :group 'gnus-various
1617   :type '(choice (const nil)
1618                  integer))
1619
1620 ;; There should be special validation for this.
1621 (define-widget 'gnus-email-address 'string
1622   "An email address.")
1623
1624 (gnus-define-group-parameter
1625  to-address
1626  :function-document
1627  "Return GROUP's to-address."
1628  :variable-document
1629  "*Alist of group regexps and correspondent to-addresses."
1630  :variable-group gnus-group-parameter
1631  :parameter-type '(gnus-email-address :tag "To Address")
1632  :parameter-document "\
1633 This will be used when doing followups and posts.
1634
1635 This is primarily useful in mail groups that represent closed
1636 mailing lists--mailing lists where it's expected that everybody that
1637 writes to the mailing list is subscribed to it.  Since using this
1638 parameter ensures that the mail only goes to the mailing list itself,
1639 it means that members won't receive two copies of your followups.
1640
1641 Using `to-address' will actually work whether the group is foreign or
1642 not.  Let's say there's a group on the server that is called
1643 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1644 articles from a mail-to-news gateway.  Posting directly to this group
1645 is therefore impossible--you have to send mail to the mailing list
1646 address instead.
1647
1648 The gnus-group-split mail splitting mechanism will behave as if this
1649 address was listed in gnus-group-split Addresses (see below).")
1650
1651 (gnus-define-group-parameter
1652  to-list
1653  :function-document
1654  "Return GROUP's to-list."
1655  :variable-document
1656  "*Alist of group regexps and correspondent to-lists."
1657  :variable-group gnus-group-parameter
1658  :parameter-type '(gnus-email-address :tag "To List")
1659  :parameter-document "\
1660 This address will be used when doing a `a' in the group.
1661
1662 It is totally ignored when doing a followup--except that if it is
1663 present in a news group, you'll get mail group semantics when doing
1664 `f'.
1665
1666 The gnus-group-split mail splitting mechanism will behave as if this
1667 address was listed in gnus-group-split Addresses (see below).")
1668
1669 (gnus-define-group-parameter
1670  subscribed
1671  :type bool
1672  :function-document
1673  "Return GROUP's subscription status."
1674  :variable-document
1675  "*Groups which are automatically considered subscribed."
1676  :variable-group gnus-group-parameter
1677  :parameter-type '(const :tag "Subscribed" t)
1678  :parameter-document "\
1679 Gnus assumed that you are subscribed to the To/List address.
1680
1681 When constructing a list of subscribed groups using
1682 `gnus-find-subscribed-addresses', Gnus includes the To address given
1683 above, or the list address (if the To address has not been set).")
1684
1685 (gnus-define-group-parameter
1686  auto-expire
1687  :type bool
1688  :function gnus-group-auto-expirable-p
1689  :function-document
1690  "Check whether GROUP is auto-expirable or not."
1691  :variable gnus-auto-expirable-newsgroups
1692  :variable-default nil
1693  :variable-document
1694  "*Groups in which to automatically mark read articles as expirable.
1695 If non-nil, this should be a regexp that should match all groups in
1696 which to perform auto-expiry.  This only makes sense for mail groups."
1697  :variable-group nnmail-expire
1698  :variable-type '(choice (const nil)
1699                          regexp)
1700  :parameter-type '(const :tag "Automatic Expire" t)
1701  :parameter-document
1702  "All articles that are read will be marked as expirable.")
1703
1704 (gnus-define-group-parameter
1705  total-expire
1706  :type bool
1707  :function gnus-group-total-expirable-p
1708  :function-document
1709  "Check whether GROUP is total-expirable or not."
1710  :variable gnus-total-expirable-newsgroups
1711  :variable-default nil
1712  :variable-document
1713  "*Groups in which to perform expiry of all read articles.
1714 Use with extreme caution.  All groups that match this regexp will be
1715 expiring - which means that all read articles will be deleted after
1716 \(say) one week.         (This only goes for mail groups and the like, of
1717 course.)"
1718  :variable-group nnmail-expire
1719  :variable-type '(choice (const nil)
1720                          regexp)
1721  :parameter-type '(const :tag "Total Expire" t)
1722  :parameter-document
1723  "All read articles will be put through the expiry process
1724
1725 This happens even if they are not marked as expirable.
1726 Use with caution.")
1727
1728 (gnus-define-group-parameter
1729  charset
1730  :function-document
1731  "Return the default charset of GROUP."
1732  :variable gnus-group-charset-alist
1733  :variable-default
1734  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1735    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1736    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1737    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1738    ("\\(^\\|:\\)relcom\\>" koi8-r)
1739    ("\\(^\\|:\\)fido7\\>" koi8-r)
1740    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1741    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1742    ("\\(^\\|:\\)han\\>" euc-kr)
1743    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1744    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1745    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1746  :variable-document
1747  "Alist of regexps (to match group names) and default charsets to be used when reading."
1748  :variable-group gnus-charset
1749  :variable-type '(repeat (list (regexp :tag "Group")
1750                                (symbol :tag "Charset")))
1751  :parameter-type '(symbol :tag "Charset")
1752  :parameter-document "\
1753 The default charset to use in the group.")
1754
1755 (gnus-define-group-parameter
1756  post-method
1757  :type list
1758  :function-document
1759  "Return a posting method for GROUP."
1760  :variable gnus-post-method-alist
1761  :variable-document
1762  "Alist of regexps (to match group names) and method to be used when
1763 posting an article."
1764  :variable-group gnus-group-foreign
1765  :parameter-type
1766  '(choice :tag "Posting Method"
1767           (const :tag "Use native server" native)
1768           (const :tag "Use current server" current)
1769           (list :convert-widget
1770                 (lambda (widget)
1771                   (list 'sexp :tag "Methods"
1772                         :value gnus-select-method))))
1773  :parameter-document
1774  "Posting method for this group.")
1775
1776 (gnus-define-group-parameter
1777  large-newsgroup-initial
1778  :type integer
1779  :function-document
1780  "Return GROUP's initial input of the number of articles."
1781  :variable-document
1782  "*Alist of group regexps and its initial input of the number of articles."
1783  :variable-group gnus-group-parameter
1784  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1785                           (const :tag "All" nil)
1786                           (integer))
1787  :parameter-document "\
1788
1789 This number will be prompted as the initial value of the number of
1790 articles to list when the group is a large newsgroup (see
1791 `gnus-large-newsgroup').  If it is nil, the default value is the
1792 total number of articles in the group.")
1793
1794 ;; The Gnus registry's ignored groups
1795 (gnus-define-group-parameter
1796  registry-ignore
1797  :type list
1798  :function-document
1799  "Whether this group should be ignored by the registry."
1800  :variable gnus-registry-ignored-groups
1801  :variable-default nil
1802  :variable-document
1803  "*Groups in which the registry should be turned off."
1804  :variable-group gnus-registry
1805  :variable-type '(repeat
1806                   (list
1807                    (regexp :tag "Group Name Regular Expression")
1808                    (boolean :tag "Ignored")))
1809  
1810  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1811  :parameter-document
1812  "Whether the Gnus Registry should ignore this group.")
1813
1814 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1815 (defcustom gnus-install-group-spam-parameters t
1816   "*Disable the group parameters for spam detection.
1817 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1818   :type 'boolean
1819   :group 'gnus-start)
1820
1821 (when gnus-install-group-spam-parameters
1822   (defvar gnus-group-spam-classification-spam t
1823     "Spam group classification (requires spam.el).
1824 This group contains spam messages.  On summary entry, unread messages
1825 will be marked as spam.  On summary exit, the specified spam
1826 processors will be invoked on spam-marked messages, then those
1827 messages will be expired, so the spam processor will only see a
1828 spam-marked message once.")
1829
1830   (defvar gnus-group-spam-classification-ham 'ask
1831     "The ham value for the spam group parameter (requires spam.el).
1832 On summary exit, the specified ham processors will be invoked on
1833 ham-marked messages.  Exercise caution, since the ham processor will
1834 see the same message more than once because there is no ham message
1835 registry.")
1836
1837   (gnus-define-group-parameter
1838    spam-contents
1839    :type list
1840    :function-document
1841    "The spam type (spam, ham, or neither) of the group."
1842    :variable gnus-spam-newsgroup-contents
1843    :variable-default nil
1844    :variable-document
1845    "*Groups in which to automatically mark new articles as spam on
1846 summary entry.  If non-nil, this should be a list of group name
1847 regexps that should match all groups in which to do automatic spam
1848 tagging, associated with a classification (spam, ham, or neither).
1849 This only makes sense for mail groups."
1850    :variable-group spam
1851    :variable-type '(repeat
1852                     (list :tag "Group contents spam/ham classification"
1853                           (regexp :tag "Group")
1854                           (choice
1855                            (variable-item gnus-group-spam-classification-spam)
1856                            (variable-item gnus-group-spam-classification-ham)
1857                            (const :tag "Unclassified" nil))))
1858
1859    :parameter-type '(list :tag "Group contents spam/ham classification"
1860                           (choice :tag "Group contents classification for spam sorting"
1861                                   (variable-item gnus-group-spam-classification-spam)
1862                                   (variable-item gnus-group-spam-classification-ham)
1863                                   (const :tag "Unclassified" nil)))
1864    :parameter-document
1865    "The spam classification (spam, ham, or neither) of this group.
1866 When a spam group is entered, all unread articles are marked as spam.")
1867
1868   (gnus-define-group-parameter
1869    spam-resend-to
1870    :type list
1871    :function-document
1872    "The address to get spam resent (through spam-report-resend)."
1873    :variable gnus-spam-resend-to
1874    :variable-default nil
1875    :variable-document
1876    "The address to get spam resent (through spam-report-resend)."
1877    :variable-group spam
1878    :variable-type '(repeat
1879                     (list :tag "Group address for resending spam"
1880                           (regexp :tag "Group")
1881                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1882    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1883    :parameter-document
1884    "The address to get spam resent (through spam-report-resend).")
1885
1886   (gnus-define-group-parameter
1887    ham-resend-to
1888    :type list
1889    :function-document
1890    "The address to get ham resent (through spam-report-resend)."
1891    :variable gnus-ham-resend-to
1892    :variable-default nil
1893    :variable-document
1894    "The address to get ham resent (through spam-report-resend)."
1895    :variable-group spam
1896    :variable-type '(repeat
1897                     (list :tag "Group address for resending ham"
1898                           (regexp :tag "Group")
1899                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1900    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1901    :parameter-document
1902    "The address to get ham resent (through spam-report-resend).")
1903
1904   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1905     "OBSOLETE: The ifile summary exit spam processor.")
1906
1907   (defvar gnus-group-spam-exit-processor-stat "stat"
1908     "OBSOLETE: The spam-stat summary exit spam processor.")
1909
1910   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1911     "OBSOLETE: The Bogofilter summary exit spam processor.")
1912
1913   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1914     "OBSOLETE: The Blacklist summary exit spam processor.")
1915
1916   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1917     "OBSOLETE: The Gmane reporting summary exit spam processor.
1918 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1919
1920   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1921     "OBSOLETE: The spamoracle summary exit spam processor.")
1922
1923   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1924     "OBSOLETE: The ifile summary exit ham processor.
1925 Only applicable to non-spam (unclassified and ham) groups.")
1926
1927   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1928     "OBSOLETE: The Bogofilter summary exit ham processor.
1929 Only applicable to non-spam (unclassified and ham) groups.")
1930
1931   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1932     "OBSOLETE: The spam-stat summary exit ham processor.
1933 Only applicable to non-spam (unclassified and ham) groups.")
1934
1935   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1936     "OBSOLETE: The whitelist summary exit ham processor.
1937 Only applicable to non-spam (unclassified and ham) groups.")
1938
1939   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1940     "OBSOLETE: The BBDB summary exit ham processor.
1941 Only applicable to non-spam (unclassified and ham) groups.")
1942
1943   (defvar gnus-group-ham-exit-processor-copy "copy"
1944     "OBSOLETE: The ham copy exit ham processor.
1945 Only applicable to non-spam (unclassified and ham) groups.")
1946
1947   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1948     "OBSOLETE: The spamoracle summary exit ham processor.
1949 Only applicable to non-spam (unclassified and ham) groups.")
1950
1951   (gnus-define-group-parameter
1952    spam-process
1953    :type list
1954    :parameter-type 
1955    '(choice 
1956      :tag "Spam Summary Exit Processor"
1957      :value nil
1958      (list :tag "Spam Summary Exit Processor Choices"
1959            (set
1960             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1961             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1962             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
1963             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1964             (const :tag "Spam: Resend Message"(spam spam-use-resend))
1965             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1966             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1967             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1968             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1969             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
1970             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1971             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1972             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
1973             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1974             (const :tag "Ham: Resend Message" (ham spam-use-resend))
1975             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1976             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
1977             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1978             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1979             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
1980             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1981             (variable-item gnus-group-spam-exit-processor-ifile)
1982             (variable-item gnus-group-spam-exit-processor-stat)
1983             (variable-item gnus-group-spam-exit-processor-bogofilter)
1984             (variable-item gnus-group-spam-exit-processor-blacklist)
1985             (variable-item gnus-group-spam-exit-processor-spamoracle)
1986             (variable-item gnus-group-spam-exit-processor-report-gmane)
1987             (variable-item gnus-group-ham-exit-processor-bogofilter)
1988             (variable-item gnus-group-ham-exit-processor-ifile)
1989             (variable-item gnus-group-ham-exit-processor-stat)
1990             (variable-item gnus-group-ham-exit-processor-whitelist)
1991             (variable-item gnus-group-ham-exit-processor-BBDB)
1992             (variable-item gnus-group-ham-exit-processor-spamoracle)
1993             (variable-item gnus-group-ham-exit-processor-copy))))
1994    :function-document
1995    "Which spam or ham processors will be applied when the summary is exited."
1996    :variable gnus-spam-process-newsgroups
1997    :variable-default nil
1998    :variable-document
1999    "*Groups in which to automatically process spam or ham articles with
2000 a backend on summary exit.  If non-nil, this should be a list of group
2001 name regexps that should match all groups in which to do automatic
2002 spam processing, associated with the appropriate processor."
2003    :variable-group spam
2004    :variable-type 
2005    '(repeat :tag "Spam/Ham Processors"
2006             (list :tag "Spam Summary Exit Processor Choices"
2007                   (regexp :tag "Group Regexp")
2008                   (set 
2009                    :tag "Spam/Ham Summary Exit Processor"
2010                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2011                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2012                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2013                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2014                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2015                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2016                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2017                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2018                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2019                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2020                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2021                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2022                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2023                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2024                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2025                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2026                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2027                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2028                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2029                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2030                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2031                    (variable-item gnus-group-spam-exit-processor-ifile)
2032                    (variable-item gnus-group-spam-exit-processor-stat)
2033                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2034                    (variable-item gnus-group-spam-exit-processor-blacklist)
2035                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2036                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2037                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2038                    (variable-item gnus-group-ham-exit-processor-ifile)
2039                    (variable-item gnus-group-ham-exit-processor-stat)
2040                    (variable-item gnus-group-ham-exit-processor-whitelist)
2041                    (variable-item gnus-group-ham-exit-processor-BBDB)
2042                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2043                    (variable-item gnus-group-ham-exit-processor-copy))))
2044
2045    :parameter-document
2046    "Which spam or ham processors will be applied when the summary is exited.")
2047
2048   (gnus-define-group-parameter
2049    spam-autodetect
2050    :type list
2051    :parameter-type 
2052    '(boolean :tag "Spam autodetection")
2053    :function-document
2054    "Should spam be autodetected (with spam-split) in this group?"
2055    :variable gnus-spam-autodetect
2056    :variable-default nil
2057    :variable-document
2058    "*Groups in which spam should be autodetected when they are entered.
2059    Only unseen articles will be examined, unless
2060    spam-autodetect-recheck-messages is set."
2061    :variable-group spam
2062    :variable-type 
2063    '(repeat
2064      :tag "Autodetection setting"
2065      (list
2066       (regexp :tag "Group Regexp")
2067       boolean))
2068    :parameter-document
2069    "Spam autodetection.
2070 Only unseen articles will be examined, unless
2071 spam-autodetect-recheck-messages is set.")
2072
2073   (gnus-define-group-parameter
2074    spam-autodetect-methods
2075    :type list
2076    :parameter-type 
2077    '(choice :tag "Spam autodetection-specific methods"
2078      (const none)
2079      (const default)
2080      (set :tag "Use specific methods"
2081           (variable-item spam-use-blacklist)
2082           (variable-item spam-use-gmane-xref)
2083           (variable-item spam-use-regex-headers)
2084           (variable-item spam-use-regex-body)
2085           (variable-item spam-use-whitelist)
2086           (variable-item spam-use-BBDB)
2087           (variable-item spam-use-ifile)
2088           (variable-item spam-use-spamoracle)
2089           (variable-item spam-use-crm114)
2090           (variable-item spam-use-spamassassin)
2091           (variable-item spam-use-spamassassin-headers)
2092           (variable-item spam-use-bsfilter)
2093           (variable-item spam-use-bsfilter-headers)
2094           (variable-item spam-use-stat)
2095           (variable-item spam-use-blackholes)
2096           (variable-item spam-use-hashcash)
2097           (variable-item spam-use-bogofilter-headers)
2098           (variable-item spam-use-bogofilter)))
2099    :function-document
2100    "Methods to be used for autodetection in each group"
2101    :variable gnus-spam-autodetect-methods
2102    :variable-default nil
2103    :variable-document
2104    "*Methods for autodetecting spam per group.
2105 Requires the spam-autodetect parameter.  Only unseen articles
2106 will be examined, unless spam-autodetect-recheck-messages is
2107 set."
2108    :variable-group spam
2109    :variable-type 
2110    '(repeat
2111      :tag "Autodetection methods"
2112      (list
2113       (regexp :tag "Group Regexp")
2114       (choice
2115        (const none)
2116        (const default)
2117        (set :tag "Use specific methods"
2118         (variable-item spam-use-blacklist)
2119         (variable-item spam-use-gmane-xref)
2120         (variable-item spam-use-regex-headers)
2121         (variable-item spam-use-regex-body)
2122         (variable-item spam-use-whitelist)
2123         (variable-item spam-use-BBDB)
2124         (variable-item spam-use-ifile)
2125         (variable-item spam-use-spamoracle)
2126         (variable-item spam-use-crm114)
2127         (variable-item spam-use-stat)
2128         (variable-item spam-use-blackholes)
2129         (variable-item spam-use-hashcash)
2130         (variable-item spam-use-spamassassin)
2131         (variable-item spam-use-spamassassin-headers)
2132         (variable-item spam-use-bsfilter)
2133         (variable-item spam-use-bsfilter-headers)
2134         (variable-item spam-use-bogofilter-headers)
2135         (variable-item spam-use-bogofilter)))))
2136      :parameter-document
2137    "Spam autodetection methods.  
2138 Requires the spam-autodetect parameter.  Only unseen articles
2139 will be examined, unless spam-autodetect-recheck-messages is
2140 set.")
2141
2142   (gnus-define-group-parameter
2143    spam-process-destination
2144    :type list
2145    :parameter-type 
2146    '(choice :tag "Destination for spam-processed articles at summary exit"
2147             (string :tag "Move to a group")
2148             (repeat :tag "Move to multiple groups"
2149                     (string :tag "Destination group"))
2150             (const :tag "Expire" nil))
2151    :function-document
2152    "Where spam-processed articles will go at summary exit."
2153    :variable gnus-spam-process-destinations
2154    :variable-default nil
2155    :variable-document
2156    "*Groups in which to explicitly send spam-processed articles to
2157 another group, or expire them (the default).  If non-nil, this should
2158 be a list of group name regexps that should match all groups in which
2159 to do spam-processed article moving, associated with the destination
2160 group or nil for explicit expiration.  This only makes sense for
2161 mail groups."
2162    :variable-group spam
2163    :variable-type 
2164    '(repeat
2165      :tag "Spam-processed articles destination"
2166      (list
2167       (regexp :tag "Group Regexp")
2168       (choice
2169        :tag "Destination for spam-processed articles at summary exit"
2170        (string :tag "Move to a group")
2171        (repeat :tag "Move to multiple groups"
2172                (string :tag "Destination group"))
2173        (const :tag "Expire" nil))))
2174    :parameter-document
2175    "Where spam-processed articles will go at summary exit.")
2176   
2177   (gnus-define-group-parameter
2178    ham-process-destination
2179    :type list
2180    :parameter-type 
2181    '(choice
2182      :tag "Destination for ham articles at summary exit from a spam group"
2183      (string :tag "Move to a group")
2184      (repeat :tag "Move to multiple groups"
2185              (string :tag "Destination group"))
2186      (const :tag "Respool" respool)
2187      (const :tag "Do nothing" nil))
2188    :function-document
2189    "Where ham articles will go at summary exit from a spam group."
2190    :variable gnus-ham-process-destinations
2191    :variable-default nil
2192    :variable-document
2193    "*Groups in which to explicitly send ham articles to
2194 another group, or do nothing (the default).  If non-nil, this should
2195 be a list of group name regexps that should match all groups in which
2196 to do ham article moving, associated with the destination
2197 group or nil for explicit ignoring.  This only makes sense for
2198 mail groups, and only works in spam groups."
2199    :variable-group spam
2200    :variable-type 
2201    '(repeat
2202      :tag "Ham articles destination"
2203      (list
2204       (regexp :tag "Group Regexp")
2205       (choice
2206        :tag "Destination for ham articles at summary exit from spam group"
2207        (string :tag "Move to a group")
2208        (repeat :tag "Move to multiple groups"
2209                 (string :tag "Destination group"))
2210        (const :tag "Respool" respool)
2211        (const :tag "Expire" nil))))
2212    :parameter-document
2213    "Where ham articles will go at summary exit from a spam group.")
2214
2215   (gnus-define-group-parameter
2216    ham-marks
2217    :type 'list
2218    :parameter-type '(list :tag "Ham mark choices"
2219                           (set
2220                            (variable-item gnus-del-mark)
2221                            (variable-item gnus-read-mark)
2222                            (variable-item gnus-ticked-mark)
2223                            (variable-item gnus-killed-mark)
2224                            (variable-item gnus-kill-file-mark)
2225                            (variable-item gnus-low-score-mark)))
2226
2227    :parameter-document
2228    "Marks considered ham (positively not spam).  Such articles will be
2229 processed as ham (non-spam) on group exit.  When nil, the global
2230 spam-ham-marks variable takes precedence."
2231    :variable-default '((".*" ((gnus-del-mark
2232                                gnus-read-mark
2233                                gnus-killed-mark
2234                                gnus-kill-file-mark
2235                                gnus-low-score-mark))))
2236    :variable-group spam
2237    :variable-document
2238    "*Groups in which to explicitly set the ham marks to some value.")
2239
2240   (gnus-define-group-parameter
2241    spam-marks
2242    :type 'list
2243    :parameter-type '(list :tag "Spam mark choices"
2244                           (set
2245                            (variable-item gnus-spam-mark)
2246                            (variable-item gnus-killed-mark)
2247                            (variable-item gnus-kill-file-mark)
2248                            (variable-item gnus-low-score-mark)))
2249
2250    :parameter-document
2251    "Marks considered spam.
2252 Such articles will be processed as spam on group exit.  When nil, the global
2253 spam-spam-marks variable takes precedence."
2254    :variable-default '((".*" ((gnus-spam-mark))))
2255    :variable-group spam
2256    :variable-document
2257    "*Groups in which to explicitly set the spam marks to some value."))
2258
2259 (defcustom gnus-group-uncollapsed-levels 1
2260   "Number of group name elements to leave alone when making a short group name."
2261   :group 'gnus-group-visual
2262   :type 'integer)
2263
2264 (defcustom gnus-group-use-permanent-levels nil
2265   "*If non-nil, once you set a level, Gnus will use this level."
2266   :group 'gnus-group-levels
2267   :type 'boolean)
2268
2269 ;; Hooks.
2270
2271 (defcustom gnus-load-hook nil
2272   "A hook run while Gnus is loaded."
2273   :group 'gnus-start
2274   :type 'hook)
2275
2276 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2277   "A hook called to apply kill files to a group.
2278 This hook is intended to apply a kill file to the selected newsgroup.
2279 The function `gnus-apply-kill-file' is called by default.
2280
2281 Since a general kill file is too heavy to use only for a few
2282 newsgroups, I recommend you to use a lighter hook function.  For
2283 example, if you'd like to apply a kill file to articles which contains
2284 a string `rmgroup' in subject in newsgroup `control', you can use the
2285 following hook:
2286
2287  (setq gnus-apply-kill-hook
2288       (list
2289         (lambda ()
2290           (cond ((string-match \"control\" gnus-newsgroup-name)
2291                  (gnus-kill \"Subject\" \"rmgroup\")
2292                  (gnus-expunge \"X\"))))))"
2293   :group 'gnus-score-kill
2294   :options '(gnus-apply-kill-file)
2295   :type 'hook)
2296
2297 (defcustom gnus-group-change-level-function nil
2298   "Function run when a group level is changed.
2299 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2300   :group 'gnus-group-levels
2301   :type 'function)
2302
2303 ;;; Face thingies.
2304
2305 (defcustom gnus-visual
2306   '(summary-highlight group-highlight article-highlight
2307                       mouse-face
2308                       summary-menu group-menu article-menu
2309                       tree-highlight menu highlight
2310                       browse-menu server-menu
2311                       page-marker tree-menu binary-menu pick-menu)
2312   "*Enable visual features.
2313 If `visual' is disabled, there will be no menus and few faces.  Most of
2314 the visual customization options below will be ignored.  Gnus will use
2315 less space and be faster as a result.
2316
2317 This variable can also be a list of visual elements to switch on.  For
2318 instance, to switch off all visual things except menus, you can say:
2319
2320    (setq gnus-visual '(menu))
2321
2322 Valid elements include `summary-highlight', `group-highlight',
2323 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2324 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2325 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2326   :group 'gnus-meta
2327   :group 'gnus-visual
2328   :type '(set (const summary-highlight)
2329               (const group-highlight)
2330               (const article-highlight)
2331               (const mouse-face)
2332               (const summary-menu)
2333               (const group-menu)
2334               (const article-menu)
2335               (const tree-highlight)
2336               (const menu)
2337               (const highlight)
2338               (const browse-menu)
2339               (const server-menu)
2340               (const page-marker)
2341               (const tree-menu)
2342               (const binary-menu)
2343               (const pick-menu)))
2344
2345 ;; Byte-compiler warning.
2346 (defvar gnus-visual)
2347 ;; Find out whether the gnus-visual TYPE is wanted.
2348 (defun gnus-visual-p (&optional type class)
2349   (and gnus-visual                      ; Has to be non-nil, at least.
2350        (if (not type)                   ; We don't care about type.
2351            gnus-visual
2352          (if (listp gnus-visual)        ; It's a list, so we check it.
2353              (or (memq type gnus-visual)
2354                  (memq class gnus-visual))
2355            t))))
2356
2357 (defcustom gnus-mouse-face
2358   (condition-case ()
2359       (if (gnus-visual-p 'mouse-face 'highlight)
2360           (if (boundp 'gnus-mouse-face)
2361               (or gnus-mouse-face 'highlight)
2362             'highlight)
2363         'default)
2364     (error 'highlight))
2365   "*Face used for group or summary buffer mouse highlighting.
2366 The line beneath the mouse pointer will be highlighted with this
2367 face."
2368   :group 'gnus-visual
2369   :type 'face)
2370
2371 (defcustom gnus-article-save-directory gnus-directory
2372   "*Name of the directory articles will be saved in (default \"~/News\")."
2373   :group 'gnus-article-saving
2374   :type 'directory)
2375
2376 (defvar gnus-plugged t
2377   "Whether Gnus is plugged or not.")
2378
2379 (defcustom gnus-agent-cache t
2380   "Controls use of the agent cache while plugged.
2381 When set, Gnus will prefer using the locally stored content rather
2382 than re-fetching it from the server.  You also need to enable
2383 `gnus-agent' for this to have any affect."
2384   :version "21.3"
2385   :group 'gnus-agent
2386   :type 'boolean)
2387
2388 (defcustom gnus-default-charset 'undecided
2389   "Default charset assumed to be used when viewing non-ASCII characters.
2390 This variable is overridden on a group-to-group basis by the
2391 `gnus-group-charset-alist' variable and is only used on groups not
2392 covered by that variable."
2393   :type 'symbol
2394   :group 'gnus-charset)
2395
2396 ;; Fixme: Doc reference to agent.
2397 (defcustom gnus-agent t
2398   "Whether we want to use the Gnus agent or not.
2399
2400 You may customize gnus-agent to disable its use.  However, some
2401 back ends have started to use the agent as a client-side cache.
2402 Disabling the agent may result in noticeable loss of performance."
2403   :version "21.3"
2404   :group 'gnus-agent
2405   :type 'boolean)
2406
2407 (defcustom gnus-other-frame-function 'gnus
2408   "Function called by the command `gnus-other-frame'."
2409   :group 'gnus-start
2410   :type '(choice (function-item gnus)
2411                  (function-item gnus-no-server)
2412                  (function-item gnus-slave)
2413                  (function-item gnus-slave-no-server)))
2414
2415 (defcustom gnus-other-frame-parameters nil
2416   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2417 This should be an alist for Emacs, or a plist for XEmacs."
2418   :group 'gnus-start
2419   :type (if (featurep 'xemacs)
2420             '(repeat (list :inline t :format "%v"
2421                            (symbol :tag "Property")
2422                            (sexp :tag "Value")))
2423           '(repeat (cons :format "%v"
2424                          (symbol :tag "Parameter")
2425                          (sexp :tag "Value")))))
2426
2427 (defcustom gnus-user-agent 'gnus-mime-edit
2428   "Which information should be exposed in the User-Agent header.
2429
2430 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2431 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2432 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2433 `emacs-gnus' plus system type\), `gnus-mime-edit' \(show Gnus version and
2434 MIME Edit User-Agent\) or a custom string.  If you set it to a string,
2435 be sure to use a valid format, see RFC 2616."
2436   :group 'gnus-message
2437   :type '(choice
2438           (item :tag "Show Gnus version and MIME Edit User-Agent"
2439                 gnus-mime-edit)
2440           (item :tag "Show Gnus and Emacs versions and system type"
2441                 emacs-gnus-type)
2442           (item :tag "Show Gnus and Emacs versions and system configuration"
2443                 emacs-gnus-config)
2444           (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2445           (item :tag "Show only Gnus version" gnus)
2446           (string :tag "Other")))
2447
2448 \f
2449 ;;; Internal variables
2450
2451 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2452 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2453 (defvar gnus-agent-method-p-cache nil
2454   ; Reset each time gnus-agent-covered-methods is changed else
2455   ; gnus-agent-method-p may mis-report a methods status.
2456   )
2457 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2458 (defvar gnus-draft-meta-information-header "X-Draft-From")
2459 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2460 (defvar gnus-original-article-buffer " *Original Article*")
2461 (defvar gnus-newsgroup-name nil)
2462 (defvar gnus-ephemeral-servers nil)
2463 (defvar gnus-server-method-cache nil)
2464
2465 (defvar gnus-agent-fetching nil
2466   "Whether Gnus agent is in fetching mode.")
2467
2468 (defvar gnus-agent-covered-methods nil
2469   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2470
2471 (defvar gnus-command-method nil
2472   "Dynamically bound variable that says what the current back end is.")
2473
2474 (defvar gnus-current-select-method nil
2475   "The current method for selecting a newsgroup.")
2476
2477 (defvar gnus-tree-buffer "*Tree*"
2478   "Buffer where Gnus thread trees are displayed.")
2479
2480 ;; Dummy variable.
2481 (defvar gnus-use-generic-from nil)
2482
2483 ;; Variable holding the user answers to all method prompts.
2484 (defvar gnus-method-history nil)
2485
2486 ;; Variable holding the user answers to all mail method prompts.
2487 (defvar gnus-mail-method-history nil)
2488
2489 ;; Variable holding the user answers to all group prompts.
2490 (defvar gnus-group-history nil)
2491
2492 (defvar gnus-server-alist nil
2493   "List of available servers.")
2494
2495 (defcustom gnus-cache-directory
2496   (nnheader-concat gnus-directory "cache/")
2497   "*The directory where cached articles will be stored."
2498   :group 'gnus-cache
2499   :type 'directory)
2500
2501 (defvar gnus-predefined-server-alist
2502   `(("cache"
2503      nnspool "cache"
2504      (nnspool-spool-directory ,gnus-cache-directory)
2505      (nnspool-nov-directory ,gnus-cache-directory)
2506      (nnspool-active-file
2507       ,(nnheader-concat gnus-cache-directory "active"))))
2508   "List of predefined (convenience) servers.")
2509
2510 (defvar gnus-topic-indentation "");; Obsolete variable.
2511
2512 (defconst gnus-article-mark-lists
2513   '((marked . tick) (replied . reply)
2514     (expirable . expire) (killed . killed)
2515     (bookmarks . bookmark) (dormant . dormant)
2516     (scored . score) (saved . save)
2517     (cached . cache) (downloadable . download)
2518     (unsendable . unsend) (forwarded . forward)
2519     (recent . recent) (seen . seen)))
2520
2521 (defconst gnus-article-special-mark-lists
2522   '((seen range)
2523     (killed range)
2524     (bookmark tuple)
2525     (score tuple)))
2526
2527 ;; Propagate flags to server, with the following exceptions:
2528 ;; `seen' is private to each gnus installation
2529 ;; `cache' is a internal gnus flag for each gnus installation
2530 ;; `download' is a agent flag private to each gnus installation
2531 ;; `unsend' are for nndraft groups only
2532 ;; `score' is not a proper mark
2533 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2534 (defconst gnus-article-unpropagated-mark-lists
2535   '(seen cache download unsend score bookmark)
2536   "Marks that shouldn't be propagated to back ends.
2537 Typical marks are those that make no sense in a standalone back end,
2538 such as a mark that says whether an article is stored in the cache
2539 \(which doesn't make sense in a standalone back end).")
2540
2541 (defvar gnus-headers-retrieved-by nil)
2542 (defvar gnus-article-reply nil)
2543 (defvar gnus-override-method nil)
2544 (defvar gnus-opened-servers nil)
2545
2546 (defvar gnus-current-kill-article nil)
2547
2548 (defvar gnus-have-read-active-file nil)
2549
2550 (defconst gnus-maintainer
2551   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2552   "The mail address of the T-gnus maintainers.")
2553
2554 (defcustom gnus-info-filename nil
2555   "*Controls language of gnus Info.
2556 If nil and current-language-environment is Japanese, go to gnus-ja.
2557 Otherwise go to corresponding Info.
2558 This variable can be nil, gnus or gnus-ja."
2559   :group 'gnus-start
2560   :type '(choice (const nil)
2561                  (const :tag "English" gnus)
2562                  (const :tag "Japanese" gnus-ja)))
2563
2564 (defvar gnus-info-nodes
2565   '((gnus-group-mode "Group Buffer")
2566     (gnus-summary-mode "Summary Buffer")
2567     (gnus-article-mode "Article Buffer")
2568     (gnus-server-mode "Server Buffer")
2569     (gnus-browse-mode "Browse Foreign Server")
2570     (gnus-tree-mode "Tree Display"))
2571   "Alist of major modes and related Info nodes.")
2572
2573 (defvar gnus-group-buffer "*Group*")
2574 (defvar gnus-summary-buffer "*Summary*")
2575 (defvar gnus-article-buffer "*Article*")
2576 (defvar gnus-server-buffer "*Server*")
2577
2578 (defvar gnus-slave nil
2579   "Whether this Gnus is a slave or not.")
2580
2581 (defvar gnus-batch-mode nil
2582   "Whether this Gnus is running in batch mode or not.")
2583
2584 (defvar gnus-variable-list
2585   '(gnus-newsrc-options gnus-newsrc-options-n
2586                         gnus-newsrc-last-checked-date
2587                         gnus-newsrc-alist gnus-server-alist
2588                         gnus-killed-list gnus-zombie-list
2589                         gnus-topic-topology gnus-topic-alist)
2590   "Gnus variables saved in the quick startup file.")
2591
2592 (defvar gnus-product-variable-file-list
2593   (let ((version (product-version (product-find 'gnus-vers))))
2594     `(("strict-cache"
2595        ((product-version ,version)
2596         (emacs-version)
2597         (correct-string-widths))
2598        binary
2599        gnus-format-specs-compiled)
2600       ("cache"
2601        ((product-version ,version)
2602         (emacs-version)
2603         (correct-string-widths))
2604        ctext
2605        gnus-format-specs)))
2606   "Alist of the methods for checking whether the contents of the T-gnus
2607 quick startup files are valid.  One is for the byte-compiled format
2608 specifications, the other is for the source form.  Each element should
2609 be a list which looks like follows:
2610
2611 \(\"FILE_NAME\"
2612  ((VARIABLE EXPECTED_VALUE_or_NIL)
2613   (VARIABLE EXPECTED_VALUE_or_NIL)
2614   ...)
2615  CODING-SYSTEM_FOR_READING_FILE
2616  SYMBOL_OF_FORMAT_SPECS)")
2617
2618 (defcustom gnus-compile-user-specs t
2619   "If non-nil, the user-defined format specs will be byte-compiled
2620 automatically.
2621 It has an effect on the values of `gnus-*-line-format-spec'."
2622   :group 'gnus
2623   :type 'boolean)
2624
2625 (defvar gnus-newsrc-alist nil
2626   "Assoc list of read articles.
2627 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2628
2629 (defvar gnus-registry-alist nil
2630   "Assoc list of registry data.
2631 gnus-registry.el will populate this if it's loaded.")
2632
2633 (defvar gnus-newsrc-hashtb nil
2634   "Hashtable of `gnus-newsrc-alist'.")
2635
2636 (defvar gnus-killed-list nil
2637   "List of killed newsgroups.")
2638
2639 (defvar gnus-killed-hashtb nil
2640   "Hash table equivalent of `gnus-killed-list'.")
2641
2642 (defvar gnus-zombie-list nil
2643   "List of almost dead newsgroups.")
2644
2645 (defvar gnus-description-hashtb nil
2646   "Descriptions of newsgroups.")
2647
2648 (defvar gnus-list-of-killed-groups nil
2649   "List of newsgroups that have recently been killed by the user.")
2650
2651 (defvar gnus-active-hashtb nil
2652   "Hashtable of active articles.")
2653
2654 (defvar gnus-moderated-hashtb nil
2655   "Hashtable of moderated newsgroups.")
2656
2657 ;; Save window configuration.
2658 (defvar gnus-prev-winconf nil)
2659
2660 (defvar gnus-reffed-article-number nil)
2661
2662 ;;; Let the byte-compiler know that we know about this variable.
2663 (defvar rmail-default-rmail-file)
2664
2665 (defvar gnus-dead-summary nil)
2666
2667 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2668   "Regexp matching invalid groups.")
2669
2670 (defvar gnus-other-frame-object nil
2671   "A frame object which will be created by `gnus-other-frame'.")
2672
2673 ;;; End of variables.
2674
2675 ;; Define some autoload functions Gnus might use.
2676 (eval-and-compile
2677
2678   ;; This little mapcar goes through the list below and marks the
2679   ;; symbols in question as autoloaded functions.
2680   (mapcar
2681    (lambda (package)
2682      (let ((interactive (nth 1 (memq ':interactive package))))
2683        (mapcar
2684         (lambda (function)
2685           (let (keymap)
2686             (when (consp function)
2687               (setq keymap (car (memq 'keymap function)))
2688               (setq function (car function)))
2689             (unless (fboundp function)
2690               (autoload function (car package) nil interactive keymap))))
2691         (if (eq (nth 1 package) ':interactive)
2692             (nthcdr 3 package)
2693           (cdr package)))))
2694    '(("info" :interactive t Info-goto-node)
2695      ("pp" pp-to-string)
2696      ("ps-print" ps-print-preprint)
2697      ("message" :interactive t
2698       message-send-and-exit message-yank-original)
2699      ("babel" babel-as-string)
2700      ("nnmail" nnmail-split-fancy nnmail-article-group)
2701      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2702      ("rmailout" rmail-output rmail-output-to-rmail-file)
2703      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2704       rmail-show-message rmail-summary-exists
2705       rmail-select-summary rmail-update-summary)
2706      ("gnus-audio" :interactive t gnus-audio-play)
2707      ("gnus-xmas" gnus-xmas-splash)
2708      ("gnus-soup" :interactive t
2709       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2710       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2711      ("nnsoup" nnsoup-pack-replies)
2712      ("score-mode" :interactive t gnus-score-mode)
2713      ("gnus-mh" gnus-summary-save-article-folder
2714       gnus-Folder-save-name gnus-folder-save-name)
2715      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2716      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2717       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2718       gnus-demon-add-disconnection gnus-demon-add-handler
2719       gnus-demon-remove-handler)
2720      ("gnus-demon" :interactive t
2721       gnus-demon-init gnus-demon-cancel)
2722      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2723       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2724       gnus-face-from-file)
2725      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2726       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2727      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2728       gnus-nocem-unwanted-article-p)
2729      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2730       gnus-server-server-name)
2731      ("gnus-srvr" gnus-browse-foreign-server)
2732      ("gnus-cite" :interactive t
2733       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2734       gnus-article-hide-citation gnus-article-fill-cited-article
2735       gnus-article-hide-citation-in-followups)
2736      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2737       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2738       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2739      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2740       gnus-cache-possibly-remove-articles gnus-cache-request-article
2741       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2742       gnus-cache-enter-remove-article gnus-cached-article-p
2743       gnus-cache-open gnus-cache-close gnus-cache-update-article
2744       gnus-cache-articles-in-group)
2745      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2746       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2747      ("gnus-score" :interactive t
2748       gnus-summary-increase-score gnus-summary-set-score
2749       gnus-summary-raise-thread gnus-summary-raise-same-subject
2750       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2751       gnus-summary-lower-thread gnus-summary-lower-same-subject
2752       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2753       gnus-summary-current-score gnus-score-delta-default
2754       gnus-score-flush-cache gnus-score-close
2755       gnus-possibly-score-headers gnus-score-followup-article
2756       gnus-score-followup-thread)
2757      ("gnus-score"
2758       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2759       gnus-current-score-file-nondirectory gnus-score-adaptive
2760       gnus-score-find-trace gnus-score-file-name)
2761      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2762       gnus-score-customize)
2763      ("gnus-topic" :interactive t gnus-topic-mode)
2764      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2765       gnus-subscribe-topics)
2766      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2767      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2768      ("gnus-uu" :interactive t
2769       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2770       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2771       gnus-uu-mark-by-regexp gnus-uu-mark-all
2772       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2773       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2774       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2775       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2776       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2777       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2778       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2779       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2780      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2781       gnus-uu-unmark-thread)
2782      ("gnus-msg" (gnus-summary-send-map keymap)
2783       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2784      ("gnus-msg" :interactive t
2785       gnus-group-post-news gnus-group-mail gnus-group-news
2786       gnus-summary-post-news gnus-summary-news-other-window
2787       gnus-summary-followup gnus-summary-followup-with-original
2788       gnus-summary-cancel-article gnus-summary-supersede-article
2789       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2790       gnus-summary-mail-forward gnus-summary-mail-other-window
2791       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2792       gnus-summary-wide-reply gnus-summary-followup-to-mail
2793       gnus-summary-followup-to-mail-with-original gnus-bug
2794       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2795       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2796      ("gnus-picon" :interactive t gnus-treat-from-picon)
2797      ("smiley" :interactive t smiley-region)
2798      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2799      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2800       gnus-list-of-unread-articles gnus-list-of-read-articles
2801       gnus-offer-save-summaries gnus-make-thread-indent-array
2802       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2803       gnus-summary-skip-intangible gnus-summary-article-number
2804       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2805      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2806       gnus-group-list-groups gnus-group-first-unread-group
2807       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2808       gnus-group-setup-buffer gnus-group-get-new-news
2809       gnus-group-make-help-group gnus-group-update-group
2810       gnus-group-iterate gnus-group-group-name)
2811      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2812       gnus-backlog-remove-article)
2813      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2814       gnus-article-prepare gnus-article-set-window-start
2815       gnus-article-next-page gnus-article-prev-page
2816       gnus-request-article-this-buffer gnus-article-mode
2817       gnus-article-setup-buffer gnus-narrow-to-page
2818       gnus-article-delete-invisible-text gnus-treat-article)
2819      ("gnus-art" :interactive t
2820       gnus-article-hide-headers gnus-article-hide-boring-headers
2821       gnus-article-treat-overstrike
2822       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2823       gnus-article-display-x-face
2824       gnus-article-decode-HZ
2825       gnus-article-wash-html
2826       gnus-article-unsplit-urls
2827       gnus-article-hide-pem gnus-article-hide-signature
2828       gnus-article-strip-leading-blank-lines gnus-article-date-local
2829       gnus-article-date-original gnus-article-date-lapsed
2830       gnus-article-show-all-headers
2831       ;; gnus-article-show-all
2832       gnus-article-edit-mode gnus-article-edit-article
2833       gnus-article-edit-done article-decode-encoded-words
2834       gnus-start-date-timer gnus-stop-date-timer)
2835      ("gnus-int" gnus-request-type)
2836      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2837       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2838      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2839       gnus-dup-enter-articles)
2840      ("gnus-range" gnus-copy-sequence)
2841      ("gnus-eform" gnus-edit-form)
2842      ("gnus-move" :interactive t
2843       gnus-group-move-group-to-server gnus-change-server)
2844      ("gnus-logic" gnus-score-advanced)
2845      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2846      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2847       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2848       gnus-async-halt-prefetch)
2849      ("gnus-offline"
2850       gnus-offline-setup)
2851      ("gnus-offline" :interactive t
2852       gnus-offline-toggle-plugged
2853       gnus-offline-set-unplugged-state
2854       gnus-offline-toggle-auto-hangup
2855       gnus-offline-toggle-on/off-send-mail
2856       gnus-offline-toggle-articles-to-fetch
2857       gnus-offline-set-interval-time
2858       gnus-offline-agent-expire)
2859      ("miee" :interactive t gnspool-get-news
2860       mail-spool-send news-spool-post)
2861      ("international/mw32misc" define-process-argument-editing
2862       general-process-argument-editing-function)
2863      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2864       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2865       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2866       gnus-summary-set-agent-mark gnus-agent-save-group-info
2867       gnus-agent-request-article gnus-agent-retrieve-headers)
2868      ("gnus-agent" :interactive t
2869       gnus-unplugged gnus-agentize gnus-agent-batch)
2870      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2871       gnus-summary-save-article-vm)
2872      ("compface" uncompface)
2873      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2874      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2875      ("gnus-mlspl" :interactive t gnus-group-split-setup
2876       gnus-group-split-update)
2877      ("gnus-delay" gnus-delay-initialize))))
2878
2879 (eval-and-compile
2880   (unless (featurep 'xemacs)
2881     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2882
2883 (unless (and (fboundp 'base64-encode-string)
2884              (subrp (symbol-function 'base64-encode-string)))
2885   (require 'base64))
2886
2887 ;; To search articles with Namazu.
2888 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2889 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2890 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2891 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2892
2893 ;; To make nnir groups.
2894 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2895
2896 ;; To make shimbun groups.
2897 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2898
2899 ;;; gnus-sum.el thingies
2900
2901 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2902   "*The format specification of the lines in the summary buffer.
2903
2904 It works along the same lines as a normal formatting string,
2905 with some simple extensions.
2906
2907 %N   Article number, left padded with spaces (string)
2908 %S   Subject (string)
2909 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2910 %n   Name of the poster (string)
2911 %a   Extracted name of the poster (string)
2912 %A   Extracted address of the poster (string)
2913 %F   Contents of the From: header (string)
2914 %f   Contents of the From: or To: headers (string)
2915 %x   Contents of the Xref: header (string)
2916 %D   Date of the article (string)
2917 %d   Date of the article (string) in DD-MMM format
2918 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2919 %M   Message-id of the article (string)
2920 %r   References of the article (string)
2921 %c   Number of characters in the article (integer)
2922 %k   Pretty-printed version of the above (string)
2923      For example, \"1.2k\" or \"0.4M\".
2924 %L   Number of lines in the article (integer)
2925 %I   Indentation based on thread level (a string of spaces)
2926 %B   A complex trn-style thread tree (string)
2927      The variables `gnus-sum-thread-*' can be used for customization.
2928 %T   A string with two possible values: 80 spaces if the article
2929      is on thread level two or larger and 0 spaces on level one
2930 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2931 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2932 %[   Opening bracket (character, \"[\" or \"<\")
2933 %]   Closing bracket (character, \"]\" or \">\")
2934 %>   Spaces of length thread-level (string)
2935 %<   Spaces of length (- 20 thread-level) (string)
2936 %i   Article score (number)
2937 %z   Article zcore (character)
2938 %t   Number of articles under the current thread (number).
2939 %e   Whether the thread is empty or not (character).
2940 %V   Total thread score (number).
2941 %P   The line number (number).
2942 %O   Download mark (character).
2943 %*   If present, indicates desired cursor position
2944      (instead of after first colon).
2945 %u   User defined specifier.  The next character in the format string should
2946      be a letter.  Gnus will call the function gnus-user-format-function-X,
2947      where X is the letter following %u.  The function will be passed the
2948      current header as argument.  The function should return a string, which
2949      will be inserted into the summary just like information from any other
2950      summary specifier.
2951
2952 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2953 with care.  For reasons of efficiency, Gnus will compute what column
2954 these characters will end up in, and \"hard-code\" that.  This means that
2955 it is invalid to have these specs after a variable-length spec.  Well,
2956 you might not be arrested, but your summary buffer will look strange,
2957 which is bad enough.
2958
2959 The smart choice is to have these specs as far to the left as
2960 possible.
2961
2962 This restriction may disappear in later versions of Gnus.
2963
2964 General format specifiers can also be used.
2965 See Info node `(gnus)Formatting Variables'."
2966   :link '(custom-manual "(gnus)Formatting Variables")
2967   :type 'string
2968   :group 'gnus-summary-format)
2969
2970 ;;;
2971 ;;; Skeleton keymaps
2972 ;;;
2973
2974 (defun gnus-suppress-keymap (keymap)
2975   (suppress-keymap keymap)
2976   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2977     (while keys
2978       (define-key keymap (pop keys) 'undefined))))
2979
2980 (defvar gnus-article-mode-map
2981   (let ((keymap (make-sparse-keymap)))
2982     (gnus-suppress-keymap keymap)
2983     keymap))
2984 (defvar gnus-summary-mode-map
2985   (let ((keymap (make-keymap)))
2986     (gnus-suppress-keymap keymap)
2987     keymap))
2988 (defvar gnus-group-mode-map
2989   (let ((keymap (make-keymap)))
2990     (gnus-suppress-keymap keymap)
2991     keymap))
2992
2993 \f
2994
2995 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2996 ;; If you want the cursor to go somewhere else, set these two
2997 ;; functions in some startup hook to whatever you want.
2998 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2999 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3000
3001 ;;; Various macros and substs.
3002
3003 (defun gnus-header-from (header)
3004   (mail-header-from header))
3005
3006 (defmacro gnus-gethash (string hashtable)
3007   "Get hash value of STRING in HASHTABLE."
3008   `(symbol-value (intern-soft ,string ,hashtable)))
3009
3010 (defmacro gnus-gethash-safe (string hashtable)
3011   "Get hash value of STRING in HASHTABLE.
3012 Return nil if not defined."
3013   `(let ((sym (intern-soft ,string ,hashtable)))
3014      (and (boundp sym) (symbol-value sym))))
3015
3016 (defmacro gnus-sethash (string value hashtable)
3017   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3018   `(set (intern ,string ,hashtable) ,value))
3019 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3020
3021 (defmacro gnus-group-unread (group)
3022   "Get the currently computed number of unread articles in GROUP."
3023   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3024
3025 (defmacro gnus-group-entry (group)
3026   "Get the newsrc entry for GROUP."
3027   `(gnus-gethash ,group gnus-newsrc-hashtb))
3028
3029 (defmacro gnus-active (group)
3030   "Get active info on GROUP."
3031   `(gnus-gethash ,group gnus-active-hashtb))
3032
3033 (defmacro gnus-set-active (group active)
3034   "Set GROUP's active info."
3035   `(gnus-sethash ,group ,active gnus-active-hashtb))
3036
3037 ;; Info access macros.
3038
3039 (defmacro gnus-info-group (info)
3040   `(nth 0 ,info))
3041 (defmacro gnus-info-rank (info)
3042   `(nth 1 ,info))
3043 (defmacro gnus-info-read (info)
3044   `(nth 2 ,info))
3045 (defmacro gnus-info-marks (info)
3046   `(nth 3 ,info))
3047 (defmacro gnus-info-method (info)
3048   `(nth 4 ,info))
3049 (defmacro gnus-info-params (info)
3050   `(nth 5 ,info))
3051
3052 (defmacro gnus-info-level (info)
3053   `(let ((rank (gnus-info-rank ,info)))
3054      (if (consp rank)
3055          (car rank)
3056        rank)))
3057 (defmacro gnus-info-score (info)
3058   `(let ((rank (gnus-info-rank ,info)))
3059      (or (and (consp rank) (cdr rank)) 0)))
3060
3061 (defmacro gnus-info-set-group (info group)
3062   `(setcar ,info ,group))
3063 (defmacro gnus-info-set-rank (info rank)
3064   `(setcar (nthcdr 1 ,info) ,rank))
3065 (defmacro gnus-info-set-read (info read)
3066   `(setcar (nthcdr 2 ,info) ,read))
3067 (defmacro gnus-info-set-marks (info marks &optional extend)
3068   (if extend
3069       `(gnus-info-set-entry ,info ,marks 3)
3070     `(setcar (nthcdr 3 ,info) ,marks)))
3071 (defmacro gnus-info-set-method (info method &optional extend)
3072   (if extend
3073       `(gnus-info-set-entry ,info ,method 4)
3074     `(setcar (nthcdr 4 ,info) ,method)))
3075 (defmacro gnus-info-set-params (info params &optional extend)
3076   (if extend
3077       `(gnus-info-set-entry ,info ,params 5)
3078     `(setcar (nthcdr 5 ,info) ,params)))
3079
3080 (defun gnus-info-set-entry (info entry number)
3081   ;; Extend the info until we have enough elements.
3082   (while (<= (length info) number)
3083     (nconc info (list nil)))
3084   ;; Set the entry.
3085   (setcar (nthcdr number info) entry))
3086
3087 (defmacro gnus-info-set-level (info level)
3088   `(let ((rank (cdr ,info)))
3089      (if (consp (car rank))
3090          (setcar (car rank) ,level)
3091        (setcar rank ,level))))
3092 (defmacro gnus-info-set-score (info score)
3093   `(let ((rank (cdr ,info)))
3094      (if (consp (car rank))
3095          (setcdr (car rank) ,score)
3096        (setcar rank (cons (car rank) ,score)))))
3097
3098 (defmacro gnus-get-info (group)
3099   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3100
3101 ;;; Load the compatibility functions.
3102
3103 (require 'gnus-ems)
3104
3105 \f
3106 ;;;
3107 ;;; Shutdown
3108 ;;;
3109
3110 (defvar gnus-shutdown-alist nil)
3111
3112 (defun gnus-add-shutdown (function &rest symbols)
3113   "Run FUNCTION whenever one of SYMBOLS is shut down."
3114   (push (cons function symbols) gnus-shutdown-alist))
3115
3116 (defun gnus-shutdown (symbol)
3117   "Shut down everything that waits for SYMBOL."
3118   (let ((alist gnus-shutdown-alist)
3119         entry)
3120     (while (setq entry (pop 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