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