c9ce009c461a7d29819e5b70d6f76958d27736e3
[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, 2005 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   :version "21.4"
1351   :group 'gnus-group-various
1352   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1353
1354 (defcustom gnus-group-fetch-control-use-browse-url nil
1355   "*Non-nil means that control messages are displayed using `browse-url'.
1356 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1357 group."
1358   :version "21.4"
1359   :group 'gnus-group-various
1360   :type 'boolean)
1361
1362 (defcustom gnus-use-cross-reference t
1363   "*Non-nil means that cross referenced articles will be marked as read.
1364 If nil, ignore cross references.  If t, mark articles as read in
1365 subscribed newsgroups.  If neither t nor nil, mark as read in all
1366 newsgroups."
1367   :group 'gnus-server
1368   :type '(choice (const :tag "off" nil)
1369                  (const :tag "subscribed" t)
1370                  (sexp :format "all"
1371                        :value always)))
1372
1373 (defcustom gnus-process-mark ?#
1374   "*Process mark."
1375   :group 'gnus-group-visual
1376   :group 'gnus-summary-marks
1377   :type 'character)
1378
1379 (defcustom gnus-large-newsgroup 200
1380   "*The number of articles which indicates a large newsgroup.
1381 If the number of articles in a newsgroup is greater than this value,
1382 confirmation is required for selecting the newsgroup.
1383 If it is nil, no confirmation is required."
1384   :group 'gnus-group-select
1385   :type '(choice (const :tag "No limit" nil)
1386                  integer))
1387
1388 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1389   "*Non-nil means that the default name of a file to save articles in is the group name.
1390 If it's nil, the directory form of the group name is used instead.
1391
1392 If this variable is a list, and the list contains the element
1393 `not-score', long file names will not be used for score files; if it
1394 contains the element `not-save', long file names will not be used for
1395 saving; and if it contains the element `not-kill', long file names
1396 will not be used for kill files.
1397
1398 Note that the default for this variable varies according to what system
1399 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1400 to nil while on all other systems it defaults to t."
1401   :group 'gnus-start
1402   :type '(radio (sexp :format "Non-nil\n"
1403                       :match (lambda (widget value)
1404                                (and value (not (listp value))))
1405                       :value t)
1406                 (const nil)
1407                 (checklist (const :format "%v " not-score)
1408                            (const :format "%v " not-save)
1409                            (const not-kill))))
1410
1411 (defcustom gnus-kill-files-directory gnus-directory
1412   "*Name of the directory where kill files will be stored (default \"~/News\")."
1413   :group 'gnus-score-files
1414   :group 'gnus-score-kill
1415   :type 'directory)
1416
1417 (defcustom gnus-save-score nil
1418   "*If non-nil, save group scoring info."
1419   :group 'gnus-score-various
1420   :group 'gnus-start
1421   :type 'boolean)
1422
1423 (defcustom gnus-use-undo t
1424   "*If non-nil, allow undoing in Gnus group mode buffers."
1425   :group 'gnus-meta
1426   :type 'boolean)
1427
1428 (defcustom gnus-use-adaptive-scoring nil
1429   "*If non-nil, use some adaptive scoring scheme.
1430 If a list, then the values `word' and `line' are meaningful.  The
1431 former will perform adaption on individual words in the subject
1432 header while `line' will perform adaption on several headers."
1433   :group 'gnus-meta
1434   :group 'gnus-score-adapt
1435   :type '(set (const word) (const line)))
1436
1437 (defcustom gnus-use-cache 'passive
1438   "*If nil, Gnus will ignore the article cache.
1439 If `passive', it will allow entering (and reading) articles
1440 explicitly entered into the cache.  If anything else, use the
1441 cache to the full extent of the law."
1442   :group 'gnus-meta
1443   :group 'gnus-cache
1444   :type '(choice (const :tag "off" nil)
1445                  (const :tag "passive" passive)
1446                  (const :tag "active" t)))
1447
1448 (defcustom gnus-use-trees nil
1449   "*If non-nil, display a thread tree buffer."
1450   :group 'gnus-meta
1451   :type 'boolean)
1452
1453 (defcustom gnus-keep-backlog 20
1454   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1455 If it is a number N, then Gnus will only keep the last N articles
1456 read.  If it is neither nil nor a number, Gnus will keep all read
1457 articles.  This is not a good idea."
1458   :group 'gnus-meta
1459   :type '(choice (const :tag "off" nil)
1460                  integer
1461                  (sexp :format "all"
1462                        :value t)))
1463
1464 (defcustom gnus-use-nocem nil
1465   "*If non-nil, Gnus will read NoCeM cancel messages."
1466   :group 'gnus-meta
1467   :type 'boolean)
1468
1469 (defcustom gnus-suppress-duplicates nil
1470   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1471   :group 'gnus-meta
1472   :type 'boolean)
1473
1474 (defcustom gnus-use-scoring t
1475   "*If non-nil, enable scoring."
1476   :group 'gnus-meta
1477   :type 'boolean)
1478
1479 (defcustom gnus-summary-prepare-exit-hook
1480   '(gnus-summary-expire-articles)
1481   "*A hook called when preparing to exit from the summary buffer.
1482 It calls `gnus-summary-expire-articles' by default."
1483   :group 'gnus-summary-exit
1484   :type 'hook)
1485
1486 (defcustom gnus-novice-user t
1487   "*Non-nil means that you are a Usenet novice.
1488 If non-nil, verbose messages may be displayed and confirmations may be
1489 required."
1490   :group 'gnus-meta
1491   :type 'boolean)
1492
1493 (defcustom gnus-expert-user nil
1494   "*Non-nil means that you will never be asked for confirmation about anything.
1495 That doesn't mean *anything* anything; particularly destructive
1496 commands will still require prompting."
1497   :group 'gnus-meta
1498   :type 'boolean)
1499
1500 (defcustom gnus-interactive-catchup t
1501   "*If non-nil, require your confirmation when catching up a group."
1502   :group 'gnus-group-select
1503   :type 'boolean)
1504
1505 (defcustom gnus-interactive-exit t
1506   "*If non-nil, require your confirmation when exiting Gnus."
1507   :group 'gnus-exit
1508   :type 'boolean)
1509
1510 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1511   "Function for extracting address components from a From header.
1512 Three pre-defined functions exist: `gnus-extract-address-components',
1513 which is the default, quite fast, and too simplistic solution,
1514 `mail-extract-address-components', which works much better, but is
1515 slower, and `std11-extract-address-components'."
1516   :group 'gnus-summary-format
1517   :type '(radio (function-item gnus-extract-address-components)
1518                 (function-item mail-extract-address-components)
1519                 (function-item std11-extract-address-components)
1520                 (function :tag "Other")))
1521
1522 (defcustom gnus-carpal nil
1523   "*If non-nil, display clickable icons."
1524   :group 'gnus-meta
1525   :type 'boolean)
1526
1527 (defcustom gnus-shell-command-separator ";"
1528   "String used to separate shell commands."
1529   :group 'gnus-files
1530   :type 'string)
1531
1532 (defcustom gnus-valid-select-methods
1533   '(("nntp" post address prompt-address physical-address)
1534     ("nnspool" post address)
1535     ("nnvirtual" post-mail virtual prompt-address)
1536     ("nnmbox" mail respool address)
1537     ("nnml" post-mail respool address)
1538     ("nnmh" mail respool address)
1539     ("nndir" post-mail prompt-address physical-address)
1540     ("nneething" none address prompt-address physical-address)
1541     ("nndoc" none address prompt-address)
1542     ("nnbabyl" mail address respool)
1543     ("nnkiboze" post virtual)
1544     ("nnsoup" post-mail address)
1545     ("nndraft" post-mail)
1546     ("nnfolder" mail respool address)
1547     ("nngateway" post-mail address prompt-address physical-address)
1548     ("nnweb" none)
1549     ("nngoogle" post)
1550     ("nnslashdot" post)
1551     ("nnultimate" none)
1552     ("nnrss" none)
1553     ("nnwfm" none)
1554     ("nnwarchive" none)
1555     ("nnlistserv" none)
1556     ("nnagent" post-mail)
1557     ("nnimap" post-mail address prompt-address physical-address)
1558     ("nnmaildir" mail respool address)
1559     ("nnnil" none))
1560   "*An alist of valid select methods.
1561 The first element of each list lists should be a string with the name
1562 of the select method.  The other elements may be the category of
1563 this method (i. e., `post', `mail', `none' or whatever) or other
1564 properties that this method has (like being respoolable).
1565 If you implement a new select method, all you should have to change is
1566 this variable.  I think."
1567   :group 'gnus-server
1568   :type '(repeat (group (string :tag "Name")
1569                         (radio-button-choice (const :format "%v " post)
1570                                              (const :format "%v " mail)
1571                                              (const :format "%v " none)
1572                                              (const post-mail))
1573                         (checklist :inline t
1574                                    (const :format "%v " address)
1575                                    (const :format "%v " prompt-address)
1576                                    (const :format "%v " physical-address)
1577                                    (const :format "%v " virtual)
1578                                    (const respool)))))
1579
1580 (defun gnus-redefine-select-method-widget ()
1581   "Recomputes the select-method widget based on the value of
1582 `gnus-valid-select-methods'."
1583   (define-widget 'gnus-select-method 'list
1584     "Widget for entering a select method."
1585     :value '(nntp "")
1586     :tag "Select Method"
1587     :args `((choice :tag "Method"
1588                     ,@(mapcar (lambda (entry)
1589                                 (list 'const :format "%v\n"
1590                                       (intern (car entry))))
1591                               gnus-valid-select-methods)
1592                     (symbol :tag "other"))
1593             (string :tag "Address")
1594             (repeat :tag "Options"
1595                     :inline t
1596                     (list :format "%v"
1597                           variable
1598                           (sexp :tag "Value"))))))
1599
1600 (gnus-redefine-select-method-widget)
1601
1602 (defcustom gnus-updated-mode-lines '(group article summary tree)
1603   "List of buffers that should update their mode lines.
1604 The list may contain the symbols `group', `article', `tree' and
1605 `summary'.  If the corresponding symbol is present, Gnus will keep
1606 that mode line updated with information that may be pertinent.
1607 If this variable is nil, screen refresh may be quicker."
1608   :group 'gnus-various
1609   :type '(set (const group)
1610               (const article)
1611               (const summary)
1612               (const tree)))
1613
1614 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1615 (defcustom gnus-mode-non-string-length nil
1616   "*Max length of mode-line non-string contents.
1617 If this is nil, Gnus will take space as is needed, leaving the rest
1618 of the mode line intact.  Note that the default of nil is unlikely
1619 to be desirable; see the manual for further details."
1620   :group 'gnus-various
1621   :type '(choice (const nil)
1622                  integer))
1623
1624 ;; There should be special validation for this.
1625 (define-widget 'gnus-email-address 'string
1626   "An email address.")
1627
1628 (gnus-define-group-parameter
1629  to-address
1630  :function-document
1631  "Return GROUP's to-address."
1632  :variable-document
1633  "*Alist of group regexps and correspondent to-addresses."
1634  :variable-group gnus-group-parameter
1635  :parameter-type '(gnus-email-address :tag "To Address")
1636  :parameter-document "\
1637 This will be used when doing followups and posts.
1638
1639 This is primarily useful in mail groups that represent closed
1640 mailing lists--mailing lists where it's expected that everybody that
1641 writes to the mailing list is subscribed to it.  Since using this
1642 parameter ensures that the mail only goes to the mailing list itself,
1643 it means that members won't receive two copies of your followups.
1644
1645 Using `to-address' will actually work whether the group is foreign or
1646 not.  Let's say there's a group on the server that is called
1647 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1648 articles from a mail-to-news gateway.  Posting directly to this group
1649 is therefore impossible--you have to send mail to the mailing list
1650 address instead.
1651
1652 The gnus-group-split mail splitting mechanism will behave as if this
1653 address was listed in gnus-group-split Addresses (see below).")
1654
1655 (gnus-define-group-parameter
1656  to-list
1657  :function-document
1658  "Return GROUP's to-list."
1659  :variable-document
1660  "*Alist of group regexps and correspondent to-lists."
1661  :variable-group gnus-group-parameter
1662  :parameter-type '(gnus-email-address :tag "To List")
1663  :parameter-document "\
1664 This address will be used when doing a `a' in the group.
1665
1666 It is totally ignored when doing a followup--except that if it is
1667 present in a news group, you'll get mail group semantics when doing
1668 `f'.
1669
1670 The gnus-group-split mail splitting mechanism will behave as if this
1671 address was listed in gnus-group-split Addresses (see below).")
1672
1673 (gnus-define-group-parameter
1674  subscribed
1675  :type bool
1676  :function-document
1677  "Return GROUP's subscription status."
1678  :variable-document
1679  "*Groups which are automatically considered subscribed."
1680  :variable-group gnus-group-parameter
1681  :parameter-type '(const :tag "Subscribed" t)
1682  :parameter-document "\
1683 Gnus assumed that you are subscribed to the To/List address.
1684
1685 When constructing a list of subscribed groups using
1686 `gnus-find-subscribed-addresses', Gnus includes the To address given
1687 above, or the list address (if the To address has not been set).")
1688
1689 (gnus-define-group-parameter
1690  auto-expire
1691  :type bool
1692  :function gnus-group-auto-expirable-p
1693  :function-document
1694  "Check whether GROUP is auto-expirable or not."
1695  :variable gnus-auto-expirable-newsgroups
1696  :variable-default nil
1697  :variable-document
1698  "*Groups in which to automatically mark read articles as expirable.
1699 If non-nil, this should be a regexp that should match all groups in
1700 which to perform auto-expiry.  This only makes sense for mail groups."
1701  :variable-group nnmail-expire
1702  :variable-type '(choice (const nil)
1703                          regexp)
1704  :parameter-type '(const :tag "Automatic Expire" t)
1705  :parameter-document
1706  "All articles that are read will be marked as expirable.")
1707
1708 (gnus-define-group-parameter
1709  total-expire
1710  :type bool
1711  :function gnus-group-total-expirable-p
1712  :function-document
1713  "Check whether GROUP is total-expirable or not."
1714  :variable gnus-total-expirable-newsgroups
1715  :variable-default nil
1716  :variable-document
1717  "*Groups in which to perform expiry of all read articles.
1718 Use with extreme caution.  All groups that match this regexp will be
1719 expiring - which means that all read articles will be deleted after
1720 \(say) one week.         (This only goes for mail groups and the like, of
1721 course.)"
1722  :variable-group nnmail-expire
1723  :variable-type '(choice (const nil)
1724                          regexp)
1725  :parameter-type '(const :tag "Total Expire" t)
1726  :parameter-document
1727  "All read articles will be put through the expiry process
1728
1729 This happens even if they are not marked as expirable.
1730 Use with caution.")
1731
1732 (gnus-define-group-parameter
1733  charset
1734  :function-document
1735  "Return the default charset of GROUP."
1736  :variable gnus-group-charset-alist
1737  :variable-default
1738  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1739    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1740    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1741    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1742    ("\\(^\\|:\\)relcom\\>" koi8-r)
1743    ("\\(^\\|:\\)fido7\\>" koi8-r)
1744    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1745    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1746    ("\\(^\\|:\\)han\\>" euc-kr)
1747    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1748    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1749    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1750  :variable-document
1751  "Alist of regexps (to match group names) and default charsets to be used when reading."
1752  :variable-group gnus-charset
1753  :variable-type '(repeat (list (regexp :tag "Group")
1754                                (symbol :tag "Charset")))
1755  :parameter-type '(symbol :tag "Charset")
1756  :parameter-document "\
1757 The default charset to use in the group.")
1758
1759 (gnus-define-group-parameter
1760  post-method
1761  :type list
1762  :function-document
1763  "Return a posting method for GROUP."
1764  :variable gnus-post-method-alist
1765  :variable-document
1766  "Alist of regexps (to match group names) and method to be used when
1767 posting an article."
1768  :variable-group gnus-group-foreign
1769  :parameter-type
1770  '(choice :tag "Posting Method"
1771           (const :tag "Use native server" native)
1772           (const :tag "Use current server" current)
1773           (list :convert-widget
1774                 (lambda (widget)
1775                   (list 'sexp :tag "Methods"
1776                         :value gnus-select-method))))
1777  :parameter-document
1778  "Posting method for this group.")
1779
1780 (gnus-define-group-parameter
1781  large-newsgroup-initial
1782  :type integer
1783  :function-document
1784  "Return GROUP's initial input of the number of articles."
1785  :variable-document
1786  "*Alist of group regexps and its initial input of the number of articles."
1787  :variable-group gnus-group-parameter
1788  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1789                           (const :tag "All" nil)
1790                           (integer))
1791  :parameter-document "\
1792
1793 This number will be prompted as the initial value of the number of
1794 articles to list when the group is a large newsgroup (see
1795 `gnus-large-newsgroup').  If it is nil, the default value is the
1796 total number of articles in the group.")
1797
1798 ;; The Gnus registry's ignored groups
1799 (gnus-define-group-parameter
1800  registry-ignore
1801  :type list
1802  :function-document
1803  "Whether this group should be ignored by the registry."
1804  :variable gnus-registry-ignored-groups
1805  :variable-default nil
1806  :variable-document
1807  "*Groups in which the registry should be turned off."
1808  :variable-group gnus-registry
1809  :variable-type '(repeat
1810                   (list
1811                    (regexp :tag "Group Name Regular Expression")
1812                    (boolean :tag "Ignored")))
1813  
1814  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1815  :parameter-document
1816  "Whether the Gnus Registry should ignore this group.")
1817
1818 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1819 (defcustom gnus-install-group-spam-parameters t
1820   "*Disable the group parameters for spam detection.
1821 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1822   :version "21.4"
1823   :type 'boolean
1824   :group 'gnus-start)
1825
1826 (when gnus-install-group-spam-parameters
1827   (defvar gnus-group-spam-classification-spam t
1828     "Spam group classification (requires spam.el).
1829 This group contains spam messages.  On summary entry, unread messages
1830 will be marked as spam.  On summary exit, the specified spam
1831 processors will be invoked on spam-marked messages, then those
1832 messages will be expired, so the spam processor will only see a
1833 spam-marked message once.")
1834
1835   (defvar gnus-group-spam-classification-ham 'ask
1836     "The ham value for the spam group parameter (requires spam.el).
1837 On summary exit, the specified ham processors will be invoked on
1838 ham-marked messages.  Exercise caution, since the ham processor will
1839 see the same message more than once because there is no ham message
1840 registry.")
1841
1842   (gnus-define-group-parameter
1843    spam-contents
1844    :type list
1845    :function-document
1846    "The spam type (spam, ham, or neither) of the group."
1847    :variable gnus-spam-newsgroup-contents
1848    :variable-default nil
1849    :variable-document
1850    "*Groups in which to automatically mark new articles as spam on
1851 summary entry.  If non-nil, this should be a list of group name
1852 regexps that should match all groups in which to do automatic spam
1853 tagging, associated with a classification (spam, ham, or neither).
1854 This only makes sense for mail groups."
1855    :variable-group spam
1856    :variable-type '(repeat
1857                     (list :tag "Group contents spam/ham classification"
1858                           (regexp :tag "Group")
1859                           (choice
1860                            (variable-item gnus-group-spam-classification-spam)
1861                            (variable-item gnus-group-spam-classification-ham)
1862                            (const :tag "Unclassified" nil))))
1863
1864    :parameter-type '(list :tag "Group contents spam/ham classification"
1865                           (choice :tag "Group contents classification for spam sorting"
1866                                   (variable-item gnus-group-spam-classification-spam)
1867                                   (variable-item gnus-group-spam-classification-ham)
1868                                   (const :tag "Unclassified" nil)))
1869    :parameter-document
1870    "The spam classification (spam, ham, or neither) of this group.
1871 When a spam group is entered, all unread articles are marked as spam.")
1872
1873   (gnus-define-group-parameter
1874    spam-resend-to
1875    :type list
1876    :function-document
1877    "The address to get spam resent (through spam-report-resend)."
1878    :variable gnus-spam-resend-to
1879    :variable-default nil
1880    :variable-document
1881    "The address to get spam resent (through spam-report-resend)."
1882    :variable-group spam
1883    :variable-type '(repeat
1884                     (list :tag "Group address for resending spam"
1885                           (regexp :tag "Group")
1886                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1887    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1888    :parameter-document
1889    "The address to get spam resent (through spam-report-resend).")
1890
1891   (gnus-define-group-parameter
1892    ham-resend-to
1893    :type list
1894    :function-document
1895    "The address to get ham resent (through spam-report-resend)."
1896    :variable gnus-ham-resend-to
1897    :variable-default nil
1898    :variable-document
1899    "The address to get ham resent (through spam-report-resend)."
1900    :variable-group spam
1901    :variable-type '(repeat
1902                     (list :tag "Group address for resending ham"
1903                           (regexp :tag "Group")
1904                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1905    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1906    :parameter-document
1907    "The address to get ham resent (through spam-report-resend).")
1908
1909   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1910     "OBSOLETE: The ifile summary exit spam processor.")
1911
1912   (defvar gnus-group-spam-exit-processor-stat "stat"
1913     "OBSOLETE: The spam-stat summary exit spam processor.")
1914
1915   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1916     "OBSOLETE: The Bogofilter summary exit spam processor.")
1917
1918   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1919     "OBSOLETE: The Blacklist summary exit spam processor.")
1920
1921   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1922     "OBSOLETE: The Gmane reporting summary exit spam processor.
1923 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1924
1925   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1926     "OBSOLETE: The spamoracle summary exit spam processor.")
1927
1928   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1929     "OBSOLETE: The ifile summary exit ham processor.
1930 Only applicable to non-spam (unclassified and ham) groups.")
1931
1932   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1933     "OBSOLETE: The Bogofilter summary exit ham processor.
1934 Only applicable to non-spam (unclassified and ham) groups.")
1935
1936   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1937     "OBSOLETE: The spam-stat summary exit ham processor.
1938 Only applicable to non-spam (unclassified and ham) groups.")
1939
1940   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1941     "OBSOLETE: The whitelist summary exit ham processor.
1942 Only applicable to non-spam (unclassified and ham) groups.")
1943
1944   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1945     "OBSOLETE: The BBDB summary exit ham processor.
1946 Only applicable to non-spam (unclassified and ham) groups.")
1947
1948   (defvar gnus-group-ham-exit-processor-copy "copy"
1949     "OBSOLETE: The ham copy exit ham processor.
1950 Only applicable to non-spam (unclassified and ham) groups.")
1951
1952   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1953     "OBSOLETE: The spamoracle summary exit ham processor.
1954 Only applicable to non-spam (unclassified and ham) groups.")
1955
1956   (gnus-define-group-parameter
1957    spam-process
1958    :type list
1959    :parameter-type 
1960    '(choice 
1961      :tag "Spam Summary Exit Processor"
1962      :value nil
1963      (list :tag "Spam Summary Exit Processor Choices"
1964            (set
1965             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1966             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1967             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
1968             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1969             (const :tag "Spam: Resend Message"(spam spam-use-resend))
1970             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1971             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1972             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1973             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1974             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
1975             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1976             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1977             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
1978             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1979             (const :tag "Ham: Resend Message" (ham spam-use-resend))
1980             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1981             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
1982             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1983             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1984             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
1985             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1986             (variable-item gnus-group-spam-exit-processor-ifile)
1987             (variable-item gnus-group-spam-exit-processor-stat)
1988             (variable-item gnus-group-spam-exit-processor-bogofilter)
1989             (variable-item gnus-group-spam-exit-processor-blacklist)
1990             (variable-item gnus-group-spam-exit-processor-spamoracle)
1991             (variable-item gnus-group-spam-exit-processor-report-gmane)
1992             (variable-item gnus-group-ham-exit-processor-bogofilter)
1993             (variable-item gnus-group-ham-exit-processor-ifile)
1994             (variable-item gnus-group-ham-exit-processor-stat)
1995             (variable-item gnus-group-ham-exit-processor-whitelist)
1996             (variable-item gnus-group-ham-exit-processor-BBDB)
1997             (variable-item gnus-group-ham-exit-processor-spamoracle)
1998             (variable-item gnus-group-ham-exit-processor-copy))))
1999    :function-document
2000    "Which spam or ham processors will be applied when the summary is exited."
2001    :variable gnus-spam-process-newsgroups
2002    :variable-default nil
2003    :variable-document
2004    "*Groups in which to automatically process spam or ham articles with
2005 a backend on summary exit.  If non-nil, this should be a list of group
2006 name regexps that should match all groups in which to do automatic
2007 spam processing, associated with the appropriate processor."
2008    :variable-group spam
2009    :variable-type 
2010    '(repeat :tag "Spam/Ham Processors"
2011             (list :tag "Spam Summary Exit Processor Choices"
2012                   (regexp :tag "Group Regexp")
2013                   (set 
2014                    :tag "Spam/Ham Summary Exit Processor"
2015                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2016                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2017                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2018                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2019                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2020                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2021                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2022                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2023                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2024                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2025                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2026                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2027                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2028                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2029                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2030                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2031                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2032                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2033                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2034                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2035                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2036                    (variable-item gnus-group-spam-exit-processor-ifile)
2037                    (variable-item gnus-group-spam-exit-processor-stat)
2038                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2039                    (variable-item gnus-group-spam-exit-processor-blacklist)
2040                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2041                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2042                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2043                    (variable-item gnus-group-ham-exit-processor-ifile)
2044                    (variable-item gnus-group-ham-exit-processor-stat)
2045                    (variable-item gnus-group-ham-exit-processor-whitelist)
2046                    (variable-item gnus-group-ham-exit-processor-BBDB)
2047                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2048                    (variable-item gnus-group-ham-exit-processor-copy))))
2049
2050    :parameter-document
2051    "Which spam or ham processors will be applied when the summary is exited.")
2052
2053   (gnus-define-group-parameter
2054    spam-autodetect
2055    :type list
2056    :parameter-type 
2057    '(boolean :tag "Spam autodetection")
2058    :function-document
2059    "Should spam be autodetected (with spam-split) in this group?"
2060    :variable gnus-spam-autodetect
2061    :variable-default nil
2062    :variable-document
2063    "*Groups in which spam should be autodetected when they are entered.
2064    Only unseen articles will be examined, unless
2065    spam-autodetect-recheck-messages is set."
2066    :variable-group spam
2067    :variable-type 
2068    '(repeat
2069      :tag "Autodetection setting"
2070      (list
2071       (regexp :tag "Group Regexp")
2072       boolean))
2073    :parameter-document
2074    "Spam autodetection.
2075 Only unseen articles will be examined, unless
2076 spam-autodetect-recheck-messages is set.")
2077
2078   (gnus-define-group-parameter
2079    spam-autodetect-methods
2080    :type list
2081    :parameter-type 
2082    '(choice :tag "Spam autodetection-specific methods"
2083      (const none)
2084      (const default)
2085      (set :tag "Use specific methods"
2086           (variable-item spam-use-blacklist)
2087           (variable-item spam-use-gmane-xref)
2088           (variable-item spam-use-regex-headers)
2089           (variable-item spam-use-regex-body)
2090           (variable-item spam-use-whitelist)
2091           (variable-item spam-use-BBDB)
2092           (variable-item spam-use-ifile)
2093           (variable-item spam-use-spamoracle)
2094           (variable-item spam-use-crm114)
2095           (variable-item spam-use-spamassassin)
2096           (variable-item spam-use-spamassassin-headers)
2097           (variable-item spam-use-bsfilter)
2098           (variable-item spam-use-bsfilter-headers)
2099           (variable-item spam-use-stat)
2100           (variable-item spam-use-blackholes)
2101           (variable-item spam-use-hashcash)
2102           (variable-item spam-use-bogofilter-headers)
2103           (variable-item spam-use-bogofilter)))
2104    :function-document
2105    "Methods to be used for autodetection in each group"
2106    :variable gnus-spam-autodetect-methods
2107    :variable-default nil
2108    :variable-document
2109    "*Methods for autodetecting spam per group.
2110 Requires the spam-autodetect parameter.  Only unseen articles
2111 will be examined, unless spam-autodetect-recheck-messages is
2112 set."
2113    :variable-group spam
2114    :variable-type 
2115    '(repeat
2116      :tag "Autodetection methods"
2117      (list
2118       (regexp :tag "Group Regexp")
2119       (choice
2120        (const none)
2121        (const default)
2122        (set :tag "Use specific methods"
2123         (variable-item spam-use-blacklist)
2124         (variable-item spam-use-gmane-xref)
2125         (variable-item spam-use-regex-headers)
2126         (variable-item spam-use-regex-body)
2127         (variable-item spam-use-whitelist)
2128         (variable-item spam-use-BBDB)
2129         (variable-item spam-use-ifile)
2130         (variable-item spam-use-spamoracle)
2131         (variable-item spam-use-crm114)
2132         (variable-item spam-use-stat)
2133         (variable-item spam-use-blackholes)
2134         (variable-item spam-use-hashcash)
2135         (variable-item spam-use-spamassassin)
2136         (variable-item spam-use-spamassassin-headers)
2137         (variable-item spam-use-bsfilter)
2138         (variable-item spam-use-bsfilter-headers)
2139         (variable-item spam-use-bogofilter-headers)
2140         (variable-item spam-use-bogofilter)))))
2141      :parameter-document
2142    "Spam autodetection methods.  
2143 Requires the spam-autodetect parameter.  Only unseen articles
2144 will be examined, unless spam-autodetect-recheck-messages is
2145 set.")
2146
2147   (gnus-define-group-parameter
2148    spam-process-destination
2149    :type list
2150    :parameter-type 
2151    '(choice :tag "Destination for spam-processed articles at summary exit"
2152             (string :tag "Move to a group")
2153             (repeat :tag "Move to multiple groups"
2154                     (string :tag "Destination group"))
2155             (const :tag "Expire" nil))
2156    :function-document
2157    "Where spam-processed articles will go at summary exit."
2158    :variable gnus-spam-process-destinations
2159    :variable-default nil
2160    :variable-document
2161    "*Groups in which to explicitly send spam-processed articles to
2162 another group, or expire them (the default).  If non-nil, this should
2163 be a list of group name regexps that should match all groups in which
2164 to do spam-processed article moving, associated with the destination
2165 group or nil for explicit expiration.  This only makes sense for
2166 mail groups."
2167    :variable-group spam
2168    :variable-type 
2169    '(repeat
2170      :tag "Spam-processed articles destination"
2171      (list
2172       (regexp :tag "Group Regexp")
2173       (choice
2174        :tag "Destination for spam-processed articles at summary exit"
2175        (string :tag "Move to a group")
2176        (repeat :tag "Move to multiple groups"
2177                (string :tag "Destination group"))
2178        (const :tag "Expire" nil))))
2179    :parameter-document
2180    "Where spam-processed articles will go at summary exit.")
2181   
2182   (gnus-define-group-parameter
2183    ham-process-destination
2184    :type list
2185    :parameter-type 
2186    '(choice
2187      :tag "Destination for ham articles at summary exit from a spam group"
2188      (string :tag "Move to a group")
2189      (repeat :tag "Move to multiple groups"
2190              (string :tag "Destination group"))
2191      (const :tag "Respool" respool)
2192      (const :tag "Do nothing" nil))
2193    :function-document
2194    "Where ham articles will go at summary exit from a spam group."
2195    :variable gnus-ham-process-destinations
2196    :variable-default nil
2197    :variable-document
2198    "*Groups in which to explicitly send ham articles to
2199 another group, or do nothing (the default).  If non-nil, this should
2200 be a list of group name regexps that should match all groups in which
2201 to do ham article moving, associated with the destination
2202 group or nil for explicit ignoring.  This only makes sense for
2203 mail groups, and only works in spam groups."
2204    :variable-group spam
2205    :variable-type 
2206    '(repeat
2207      :tag "Ham articles destination"
2208      (list
2209       (regexp :tag "Group Regexp")
2210       (choice
2211        :tag "Destination for ham articles at summary exit from spam group"
2212        (string :tag "Move to a group")
2213        (repeat :tag "Move to multiple groups"
2214                 (string :tag "Destination group"))
2215        (const :tag "Respool" respool)
2216        (const :tag "Expire" nil))))
2217    :parameter-document
2218    "Where ham articles will go at summary exit from a spam group.")
2219
2220   (gnus-define-group-parameter
2221    ham-marks
2222    :type 'list
2223    :parameter-type '(list :tag "Ham mark choices"
2224                           (set
2225                            (variable-item gnus-del-mark)
2226                            (variable-item gnus-read-mark)
2227                            (variable-item gnus-ticked-mark)
2228                            (variable-item gnus-killed-mark)
2229                            (variable-item gnus-kill-file-mark)
2230                            (variable-item gnus-low-score-mark)))
2231
2232    :parameter-document
2233    "Marks considered ham (positively not spam).  Such articles will be
2234 processed as ham (non-spam) on group exit.  When nil, the global
2235 spam-ham-marks variable takes precedence."
2236    :variable-default '((".*" ((gnus-del-mark
2237                                gnus-read-mark
2238                                gnus-killed-mark
2239                                gnus-kill-file-mark
2240                                gnus-low-score-mark))))
2241    :variable-group spam
2242    :variable-document
2243    "*Groups in which to explicitly set the ham marks to some value.")
2244
2245   (gnus-define-group-parameter
2246    spam-marks
2247    :type 'list
2248    :parameter-type '(list :tag "Spam mark choices"
2249                           (set
2250                            (variable-item gnus-spam-mark)
2251                            (variable-item gnus-killed-mark)
2252                            (variable-item gnus-kill-file-mark)
2253                            (variable-item gnus-low-score-mark)))
2254
2255    :parameter-document
2256    "Marks considered spam.
2257 Such articles will be processed as spam on group exit.  When nil, the global
2258 spam-spam-marks variable takes precedence."
2259    :variable-default '((".*" ((gnus-spam-mark))))
2260    :variable-group spam
2261    :variable-document
2262    "*Groups in which to explicitly set the spam marks to some value."))
2263
2264 (defcustom gnus-group-uncollapsed-levels 1
2265   "Number of group name elements to leave alone when making a short group name."
2266   :group 'gnus-group-visual
2267   :type 'integer)
2268
2269 (defcustom gnus-group-use-permanent-levels nil
2270   "*If non-nil, once you set a level, Gnus will use this level."
2271   :group 'gnus-group-levels
2272   :type 'boolean)
2273
2274 ;; Hooks.
2275
2276 (defcustom gnus-load-hook nil
2277   "A hook run while Gnus is loaded."
2278   :group 'gnus-start
2279   :type 'hook)
2280
2281 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2282   "A hook called to apply kill files to a group.
2283 This hook is intended to apply a kill file to the selected newsgroup.
2284 The function `gnus-apply-kill-file' is called by default.
2285
2286 Since a general kill file is too heavy to use only for a few
2287 newsgroups, I recommend you to use a lighter hook function.  For
2288 example, if you'd like to apply a kill file to articles which contains
2289 a string `rmgroup' in subject in newsgroup `control', you can use the
2290 following hook:
2291
2292  (setq gnus-apply-kill-hook
2293       (list
2294         (lambda ()
2295           (cond ((string-match \"control\" gnus-newsgroup-name)
2296                  (gnus-kill \"Subject\" \"rmgroup\")
2297                  (gnus-expunge \"X\"))))))"
2298   :group 'gnus-score-kill
2299   :options '(gnus-apply-kill-file)
2300   :type 'hook)
2301
2302 (defcustom gnus-group-change-level-function nil
2303   "Function run when a group level is changed.
2304 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2305   :group 'gnus-group-levels
2306   :type 'function)
2307
2308 ;;; Face thingies.
2309
2310 (defcustom gnus-visual
2311   '(summary-highlight group-highlight article-highlight
2312                       mouse-face
2313                       summary-menu group-menu article-menu
2314                       tree-highlight menu highlight
2315                       browse-menu server-menu
2316                       page-marker tree-menu binary-menu pick-menu)
2317   "*Enable visual features.
2318 If `visual' is disabled, there will be no menus and few faces.  Most of
2319 the visual customization options below will be ignored.  Gnus will use
2320 less space and be faster as a result.
2321
2322 This variable can also be a list of visual elements to switch on.  For
2323 instance, to switch off all visual things except menus, you can say:
2324
2325    (setq gnus-visual '(menu))
2326
2327 Valid elements include `summary-highlight', `group-highlight',
2328 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2329 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2330 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2331   :group 'gnus-meta
2332   :group 'gnus-visual
2333   :type '(set (const summary-highlight)
2334               (const group-highlight)
2335               (const article-highlight)
2336               (const mouse-face)
2337               (const summary-menu)
2338               (const group-menu)
2339               (const article-menu)
2340               (const tree-highlight)
2341               (const menu)
2342               (const highlight)
2343               (const browse-menu)
2344               (const server-menu)
2345               (const page-marker)
2346               (const tree-menu)
2347               (const binary-menu)
2348               (const pick-menu)))
2349
2350 ;; Byte-compiler warning.
2351 (defvar gnus-visual)
2352 ;; Find out whether the gnus-visual TYPE is wanted.
2353 (defun gnus-visual-p (&optional type class)
2354   (and gnus-visual                      ; Has to be non-nil, at least.
2355        (if (not type)                   ; We don't care about type.
2356            gnus-visual
2357          (if (listp gnus-visual)        ; It's a list, so we check it.
2358              (or (memq type gnus-visual)
2359                  (memq class gnus-visual))
2360            t))))
2361
2362 (defcustom gnus-mouse-face
2363   (condition-case ()
2364       (if (gnus-visual-p 'mouse-face 'highlight)
2365           (if (boundp 'gnus-mouse-face)
2366               (or gnus-mouse-face 'highlight)
2367             'highlight)
2368         'default)
2369     (error 'highlight))
2370   "*Face used for group or summary buffer mouse highlighting.
2371 The line beneath the mouse pointer will be highlighted with this
2372 face."
2373   :group 'gnus-visual
2374   :type 'face)
2375
2376 (defcustom gnus-article-save-directory gnus-directory
2377   "*Name of the directory articles will be saved in (default \"~/News\")."
2378   :group 'gnus-article-saving
2379   :type 'directory)
2380
2381 (defvar gnus-plugged t
2382   "Whether Gnus is plugged or not.")
2383
2384 (defcustom gnus-agent-cache t
2385   "Controls use of the agent cache while plugged.
2386 When set, Gnus will prefer using the locally stored content rather
2387 than re-fetching it from the server.  You also need to enable
2388 `gnus-agent' for this to have any affect."
2389   :version "21.4"
2390   :group 'gnus-agent
2391   :type 'boolean)
2392
2393 (defcustom gnus-default-charset 'undecided
2394   "Default charset assumed to be used when viewing non-ASCII characters.
2395 This variable is overridden on a group-to-group basis by the
2396 `gnus-group-charset-alist' variable and is only used on groups not
2397 covered by that variable."
2398   :type 'symbol
2399   :group 'gnus-charset)
2400
2401 ;; Fixme: Doc reference to agent.
2402 (defcustom gnus-agent t
2403   "Whether we want to use the Gnus agent or not.
2404
2405 You may customize gnus-agent to disable its use.  However, some
2406 back ends have started to use the agent as a client-side cache.
2407 Disabling the agent may result in noticeable loss of performance."
2408   :version "21.4"
2409   :group 'gnus-agent
2410   :type 'boolean)
2411
2412 (defcustom gnus-other-frame-function 'gnus
2413   "Function called by the command `gnus-other-frame'."
2414   :group 'gnus-start
2415   :type '(choice (function-item gnus)
2416                  (function-item gnus-no-server)
2417                  (function-item gnus-slave)
2418                  (function-item gnus-slave-no-server)))
2419
2420 (defcustom gnus-other-frame-parameters nil
2421   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2422 This should be an alist for Emacs, or a plist for XEmacs."
2423   :group 'gnus-start
2424   :type (if (featurep 'xemacs)
2425             '(repeat (list :inline t :format "%v"
2426                            (symbol :tag "Property")
2427                            (sexp :tag "Value")))
2428           '(repeat (cons :format "%v"
2429                          (symbol :tag "Parameter")
2430                          (sexp :tag "Value")))))
2431
2432 (defcustom gnus-user-agent '(emacs gnus mime config mule)
2433   "Which information should be exposed in the User-Agent header.
2434
2435 Can be a list of symbols or a string.  Valid symbols are `gnus' (show
2436 Gnus version), `emacs' (show Emacs version) and `mime' (show SEMI,
2437 FLIM and APEL versions).  In addition to the Emacs version, you can
2438 add `codename' (show (S)XEmacs codename), `mule' (show Mule version
2439 and also Meadow version if it exists) or either `config' (show system
2440 configuration) or `type' (show system type).  If you set it to a
2441 string, be sure to use a valid format, see RFC 2616."
2442
2443   :version "21.4"
2444   :group 'gnus-message
2445   :type '(choice (list (set :format "%v" :inline t
2446                             (const gnus  :tag "Gnus version")
2447                             (const emacs :tag "Emacs version")
2448                             (choice :tag "system"
2449                                     (const type   :tag "system type")
2450                                     (const config :tag "system configuration"))
2451                             (const codename :tag "Emacs codename")
2452                             (const mime :tag "SEMI and FLIM versions")
2453                             (const mule
2454                                    :tag "Mule version (and Meadow version)")))
2455                  (string :format "%t:\n%v")))
2456
2457 ;; Convert old (< 2005-01-10) symbol type values:
2458 (when (symbolp gnus-user-agent)
2459   (setq gnus-user-agent
2460         (cond ((eq gnus-user-agent 'gnus-mime-edit)
2461                '(emacs gnus mime config mule))
2462               ((eq gnus-user-agent 'emacs-gnus-config)
2463                '(emacs gnus config))
2464               ((eq gnus-user-agent 'emacs-gnus-type)
2465                '(emacs gnus type))
2466               ((eq gnus-user-agent 'emacs-gnus)
2467                '(emacs gnus))
2468               ((eq gnus-user-agent 'gnus)
2469                '(gnus))
2470               (t gnus-user-agent)))
2471   (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2472   (sit-for 1)
2473   (if (get 'gnus-user-agent 'saved-value)
2474       (customize-save-variable 'gnus-user-agent gnus-user-agent)
2475     (gnus-message 1 "Edit your init file to make this change permanent.")
2476     (sit-for 2)))
2477
2478 \f
2479 ;;; Internal variables
2480
2481 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2482 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2483 (defvar gnus-agent-method-p-cache nil
2484   ; Reset each time gnus-agent-covered-methods is changed else
2485   ; gnus-agent-method-p may mis-report a methods status.
2486   )
2487 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2488 (defvar gnus-draft-meta-information-header "X-Draft-From")
2489 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2490 (defvar gnus-original-article-buffer " *Original Article*")
2491 (defvar gnus-newsgroup-name nil)
2492 (defvar gnus-ephemeral-servers nil)
2493 (defvar gnus-server-method-cache nil)
2494
2495 (defvar gnus-agent-fetching nil
2496   "Whether Gnus agent is in fetching mode.")
2497
2498 (defvar gnus-agent-covered-methods nil
2499   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2500
2501 (defvar gnus-command-method nil
2502   "Dynamically bound variable that says what the current back end is.")
2503
2504 (defvar gnus-current-select-method nil
2505   "The current method for selecting a newsgroup.")
2506
2507 (defvar gnus-tree-buffer "*Tree*"
2508   "Buffer where Gnus thread trees are displayed.")
2509
2510 ;; Dummy variable.
2511 (defvar gnus-use-generic-from nil)
2512
2513 ;; Variable holding the user answers to all method prompts.
2514 (defvar gnus-method-history nil)
2515
2516 ;; Variable holding the user answers to all mail method prompts.
2517 (defvar gnus-mail-method-history nil)
2518
2519 ;; Variable holding the user answers to all group prompts.
2520 (defvar gnus-group-history nil)
2521
2522 (defvar gnus-server-alist nil
2523   "List of available servers.")
2524
2525 (defcustom gnus-cache-directory
2526   (nnheader-concat gnus-directory "cache/")
2527   "*The directory where cached articles will be stored."
2528   :group 'gnus-cache
2529   :type 'directory)
2530
2531 (defvar gnus-predefined-server-alist
2532   `(("cache"
2533      nnspool "cache"
2534      (nnspool-spool-directory ,gnus-cache-directory)
2535      (nnspool-nov-directory ,gnus-cache-directory)
2536      (nnspool-active-file
2537       ,(nnheader-concat gnus-cache-directory "active"))))
2538   "List of predefined (convenience) servers.")
2539
2540 (defvar gnus-topic-indentation "");; Obsolete variable.
2541
2542 (defconst gnus-article-mark-lists
2543   '((marked . tick) (replied . reply)
2544     (expirable . expire) (killed . killed)
2545     (bookmarks . bookmark) (dormant . dormant)
2546     (scored . score) (saved . save)
2547     (cached . cache) (downloadable . download)
2548     (unsendable . unsend) (forwarded . forward)
2549     (recent . recent) (seen . seen)))
2550
2551 (defconst gnus-article-special-mark-lists
2552   '((seen range)
2553     (killed range)
2554     (bookmark tuple)
2555     (score tuple)))
2556
2557 ;; Propagate flags to server, with the following exceptions:
2558 ;; `seen' is private to each gnus installation
2559 ;; `cache' is a internal gnus flag for each gnus installation
2560 ;; `download' is a agent flag private to each gnus installation
2561 ;; `unsend' are for nndraft groups only
2562 ;; `score' is not a proper mark
2563 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2564 (defconst gnus-article-unpropagated-mark-lists
2565   '(seen cache download unsend score bookmark)
2566   "Marks that shouldn't be propagated to back ends.
2567 Typical marks are those that make no sense in a standalone back end,
2568 such as a mark that says whether an article is stored in the cache
2569 \(which doesn't make sense in a standalone back end).")
2570
2571 (defvar gnus-headers-retrieved-by nil)
2572 (defvar gnus-article-reply nil)
2573 (defvar gnus-override-method nil)
2574 (defvar gnus-opened-servers nil)
2575
2576 (defvar gnus-current-kill-article nil)
2577
2578 (defvar gnus-have-read-active-file nil)
2579
2580 (defconst gnus-maintainer
2581   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2582   "The mail address of the T-gnus maintainers.")
2583
2584 (defcustom gnus-info-filename nil
2585   "*Controls language of gnus Info.
2586 If nil and current-language-environment is Japanese, go to gnus-ja.
2587 Otherwise go to corresponding Info.
2588 This variable can be nil, gnus or gnus-ja."
2589   :group 'gnus-start
2590   :type '(choice (const nil)
2591                  (const :tag "English" gnus)
2592                  (const :tag "Japanese" gnus-ja)))
2593
2594 (defvar gnus-info-nodes
2595   '((gnus-group-mode "Group Buffer")
2596     (gnus-summary-mode "Summary Buffer")
2597     (gnus-article-mode "Article Buffer")
2598     (gnus-server-mode "Server Buffer")
2599     (gnus-browse-mode "Browse Foreign Server")
2600     (gnus-tree-mode "Tree Display"))
2601   "Alist of major modes and related Info nodes.")
2602
2603 (defvar gnus-group-buffer "*Group*")
2604 (defvar gnus-summary-buffer "*Summary*")
2605 (defvar gnus-article-buffer "*Article*")
2606 (defvar gnus-server-buffer "*Server*")
2607
2608 (defvar gnus-slave nil
2609   "Whether this Gnus is a slave or not.")
2610
2611 (defvar gnus-batch-mode nil
2612   "Whether this Gnus is running in batch mode or not.")
2613
2614 (defvar gnus-variable-list
2615   '(gnus-newsrc-options gnus-newsrc-options-n
2616                         gnus-newsrc-last-checked-date
2617                         gnus-newsrc-alist gnus-server-alist
2618                         gnus-killed-list gnus-zombie-list
2619                         gnus-topic-topology gnus-topic-alist)
2620   "Gnus variables saved in the quick startup file.")
2621
2622 (defvar gnus-product-variable-file-list
2623   (let ((version (product-version (product-find 'gnus-vers))))
2624     `(("strict-cache"
2625        ((product-version ,version)
2626         (emacs-version)
2627         (correct-string-widths))
2628        binary
2629        gnus-format-specs-compiled)
2630       ("cache"
2631        ((product-version ,version)
2632         (emacs-version)
2633         (correct-string-widths))
2634        ctext
2635        gnus-format-specs)))
2636   "Alist of the methods for checking whether the contents of the T-gnus
2637 quick startup files are valid.  One is for the byte-compiled format
2638 specifications, the other is for the source form.  Each element should
2639 be a list which looks like follows:
2640
2641 \(\"FILE_NAME\"
2642  ((VARIABLE EXPECTED_VALUE_or_NIL)
2643   (VARIABLE EXPECTED_VALUE_or_NIL)
2644   ...)
2645  CODING-SYSTEM_FOR_READING_FILE
2646  SYMBOL_OF_FORMAT_SPECS)")
2647
2648 (defcustom gnus-compile-user-specs t
2649   "If non-nil, the user-defined format specs will be byte-compiled
2650 automatically.
2651 It has an effect on the values of `gnus-*-line-format-spec'."
2652   :group 'gnus
2653   :type 'boolean)
2654
2655 (defvar gnus-newsrc-alist nil
2656   "Assoc list of read articles.
2657 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2658
2659 (defvar gnus-registry-alist nil
2660   "Assoc list of registry data.
2661 gnus-registry.el will populate this if it's loaded.")
2662
2663 (defvar gnus-newsrc-hashtb nil
2664   "Hashtable of `gnus-newsrc-alist'.")
2665
2666 (defvar gnus-killed-list nil
2667   "List of killed newsgroups.")
2668
2669 (defvar gnus-killed-hashtb nil
2670   "Hash table equivalent of `gnus-killed-list'.")
2671
2672 (defvar gnus-zombie-list nil
2673   "List of almost dead newsgroups.")
2674
2675 (defvar gnus-description-hashtb nil
2676   "Descriptions of newsgroups.")
2677
2678 (defvar gnus-list-of-killed-groups nil
2679   "List of newsgroups that have recently been killed by the user.")
2680
2681 (defvar gnus-active-hashtb nil
2682   "Hashtable of active articles.")
2683
2684 (defvar gnus-moderated-hashtb nil
2685   "Hashtable of moderated newsgroups.")
2686
2687 ;; Save window configuration.
2688 (defvar gnus-prev-winconf nil)
2689
2690 (defvar gnus-reffed-article-number nil)
2691
2692 ;;; Let the byte-compiler know that we know about this variable.
2693 (defvar rmail-default-rmail-file)
2694
2695 (defvar gnus-dead-summary nil)
2696
2697 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2698   "Regexp matching invalid groups.")
2699
2700 (defvar gnus-other-frame-object nil
2701   "A frame object which will be created by `gnus-other-frame'.")
2702
2703 ;;; End of variables.
2704
2705 ;; Define some autoload functions Gnus might use.
2706 (eval-and-compile
2707
2708   ;; This little mapcar goes through the list below and marks the
2709   ;; symbols in question as autoloaded functions.
2710   (mapcar
2711    (lambda (package)
2712      (let ((interactive (nth 1 (memq ':interactive package))))
2713        (mapcar
2714         (lambda (function)
2715           (let (keymap)
2716             (when (consp function)
2717               (setq keymap (car (memq 'keymap function)))
2718               (setq function (car function)))
2719             (unless (fboundp function)
2720               (autoload function (car package) nil interactive keymap))))
2721         (if (eq (nth 1 package) ':interactive)
2722             (nthcdr 3 package)
2723           (cdr package)))))
2724    '(("info" :interactive t Info-goto-node)
2725      ("pp" pp-to-string)
2726      ("ps-print" ps-print-preprint)
2727      ("message" :interactive t
2728       message-send-and-exit message-yank-original)
2729      ("babel" babel-as-string)
2730      ("nnmail" nnmail-split-fancy nnmail-article-group)
2731      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2732      ("rmailout" rmail-output rmail-output-to-rmail-file)
2733      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2734       rmail-show-message rmail-summary-exists
2735       rmail-select-summary rmail-update-summary)
2736      ("gnus-audio" :interactive t gnus-audio-play)
2737      ("gnus-xmas" gnus-xmas-splash)
2738      ("gnus-soup" :interactive t
2739       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2740       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2741      ("nnsoup" nnsoup-pack-replies)
2742      ("score-mode" :interactive t gnus-score-mode)
2743      ("gnus-mh" gnus-summary-save-article-folder
2744       gnus-Folder-save-name gnus-folder-save-name)
2745      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2746      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2747       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2748       gnus-demon-add-disconnection gnus-demon-add-handler
2749       gnus-demon-remove-handler)
2750      ("gnus-demon" :interactive t
2751       gnus-demon-init gnus-demon-cancel)
2752      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2753       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2754       gnus-face-from-file)
2755      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2756       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2757      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2758       gnus-nocem-unwanted-article-p)
2759      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2760       gnus-server-server-name)
2761      ("gnus-srvr" gnus-browse-foreign-server)
2762      ("gnus-cite" :interactive t
2763       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2764       gnus-article-hide-citation gnus-article-fill-cited-article
2765       gnus-article-hide-citation-in-followups)
2766      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2767       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2768       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2769      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2770       gnus-cache-possibly-remove-articles gnus-cache-request-article
2771       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2772       gnus-cache-enter-remove-article gnus-cached-article-p
2773       gnus-cache-open gnus-cache-close gnus-cache-update-article
2774       gnus-cache-articles-in-group)
2775      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2776       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2777      ("gnus-score" :interactive t
2778       gnus-summary-increase-score gnus-summary-set-score
2779       gnus-summary-raise-thread gnus-summary-raise-same-subject
2780       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2781       gnus-summary-lower-thread gnus-summary-lower-same-subject
2782       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2783       gnus-summary-current-score gnus-score-delta-default
2784       gnus-score-flush-cache gnus-score-close
2785       gnus-possibly-score-headers gnus-score-followup-article
2786       gnus-score-followup-thread)
2787      ("gnus-score"
2788       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2789       gnus-current-score-file-nondirectory gnus-score-adaptive
2790       gnus-score-find-trace gnus-score-file-name)
2791      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2792       gnus-score-customize)
2793      ("gnus-topic" :interactive t gnus-topic-mode)
2794      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2795       gnus-subscribe-topics)
2796      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2797      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2798      ("gnus-uu" :interactive t
2799       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2800       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2801       gnus-uu-mark-by-regexp gnus-uu-mark-all
2802       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2803       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2804       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2805       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2806       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2807       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2808       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2809       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2810      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2811       gnus-uu-unmark-thread)
2812      ("gnus-msg" (gnus-summary-send-map keymap)
2813       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2814      ("gnus-msg" :interactive t
2815       gnus-group-post-news gnus-group-mail gnus-group-news
2816       gnus-summary-post-news gnus-summary-news-other-window
2817       gnus-summary-followup gnus-summary-followup-with-original
2818       gnus-summary-cancel-article gnus-summary-supersede-article
2819       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2820       gnus-summary-mail-forward gnus-summary-mail-other-window
2821       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2822       gnus-summary-wide-reply gnus-summary-followup-to-mail
2823       gnus-summary-followup-to-mail-with-original gnus-bug
2824       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2825       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2826      ("gnus-picon" :interactive t gnus-treat-from-picon)
2827      ("smiley" :interactive t smiley-region)
2828      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2829      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2830       gnus-list-of-unread-articles gnus-list-of-read-articles
2831       gnus-offer-save-summaries gnus-make-thread-indent-array
2832       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2833       gnus-summary-skip-intangible gnus-summary-article-number
2834       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2835      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2836       gnus-group-list-groups gnus-group-first-unread-group
2837       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2838       gnus-group-setup-buffer gnus-group-get-new-news
2839       gnus-group-make-help-group gnus-group-update-group
2840       gnus-group-iterate gnus-group-group-name)
2841      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2842       gnus-backlog-remove-article)
2843      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2844       gnus-article-prepare gnus-article-set-window-start
2845       gnus-article-next-page gnus-article-prev-page
2846       gnus-request-article-this-buffer gnus-article-mode
2847       gnus-article-setup-buffer gnus-narrow-to-page
2848       gnus-article-delete-invisible-text gnus-treat-article)
2849      ("gnus-art" :interactive t
2850       gnus-article-hide-headers gnus-article-hide-boring-headers
2851       gnus-article-treat-overstrike
2852       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2853       gnus-article-display-x-face
2854       gnus-article-decode-HZ
2855       gnus-article-wash-html
2856       gnus-article-unsplit-urls
2857       gnus-article-hide-pem gnus-article-hide-signature
2858       gnus-article-strip-leading-blank-lines gnus-article-date-local
2859       gnus-article-date-original gnus-article-date-lapsed
2860       gnus-article-show-all-headers
2861       ;; gnus-article-show-all
2862       gnus-article-edit-mode gnus-article-edit-article
2863       gnus-article-edit-done article-decode-encoded-words
2864       gnus-start-date-timer gnus-stop-date-timer)
2865      ("gnus-int" gnus-request-type)
2866      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2867       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2868       gnus-check-reasonable-setup)
2869      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2870       gnus-dup-enter-articles)
2871      ("gnus-range" gnus-copy-sequence)
2872      ("gnus-eform" gnus-edit-form)
2873      ("gnus-move" :interactive t
2874       gnus-group-move-group-to-server gnus-change-server)
2875      ("gnus-logic" gnus-score-advanced)
2876      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2877      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2878       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2879       gnus-async-halt-prefetch)
2880      ("gnus-offline"
2881       gnus-offline-setup)
2882      ("gnus-offline" :interactive t
2883       gnus-offline-toggle-plugged
2884       gnus-offline-set-unplugged-state
2885       gnus-offline-toggle-auto-hangup
2886       gnus-offline-toggle-on/off-send-mail
2887       gnus-offline-toggle-articles-to-fetch
2888       gnus-offline-set-interval-time
2889       gnus-offline-agent-expire)
2890      ("miee" :interactive t gnspool-get-news
2891       mail-spool-send news-spool-post)
2892      ("international/mw32misc" define-process-argument-editing
2893       general-process-argument-editing-function)
2894      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2895       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2896       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2897       gnus-summary-set-agent-mark gnus-agent-save-group-info
2898       gnus-agent-request-article gnus-agent-retrieve-headers)
2899      ("gnus-agent" :interactive t
2900       gnus-unplugged gnus-agentize gnus-agent-batch)
2901      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2902       gnus-summary-save-article-vm)
2903      ("compface" uncompface)
2904      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2905      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2906      ("gnus-mlspl" :interactive t gnus-group-split-setup
2907       gnus-group-split-update)
2908      ("gnus-delay" gnus-delay-initialize))))
2909
2910 (eval-and-compile
2911   (unless (featurep 'xemacs)
2912     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2913
2914 (unless (and (fboundp 'base64-encode-string)
2915              (subrp (symbol-function 'base64-encode-string)))
2916   (require 'base64))
2917
2918 ;; To search articles with Namazu.
2919 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2920 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2921 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2922 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2923
2924 ;; To make nnir groups.
2925 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2926
2927 ;; To make shimbun groups.
2928 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2929
2930 ;;; gnus-sum.el thingies
2931
2932 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2933   "*The format specification of the lines in the summary buffer.
2934
2935 It works along the same lines as a normal formatting string,
2936 with some simple extensions.
2937
2938 %N   Article number, left padded with spaces (string)
2939 %S   Subject (string)
2940 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2941 %n   Name of the poster (string)
2942 %a   Extracted name of the poster (string)
2943 %A   Extracted address of the poster (string)
2944 %F   Contents of the From: header (string)
2945 %f   Contents of the From: or To: headers (string)
2946 %x   Contents of the Xref: header (string)
2947 %D   Date of the article (string)
2948 %d   Date of the article (string) in DD-MMM format
2949 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2950 %M   Message-id of the article (string)
2951 %r   References of the article (string)
2952 %c   Number of characters in the article (integer)
2953 %k   Pretty-printed version of the above (string)
2954      For example, \"1.2k\" or \"0.4M\".
2955 %L   Number of lines in the article (integer)
2956 %I   Indentation based on thread level (a string of spaces)
2957 %B   A complex trn-style thread tree (string)
2958      The variables `gnus-sum-thread-*' can be used for customization.
2959 %T   A string with two possible values: 80 spaces if the article
2960      is on thread level two or larger and 0 spaces on level one
2961 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2962 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2963 %[   Opening bracket (character, \"[\" or \"<\")
2964 %]   Closing bracket (character, \"]\" or \">\")
2965 %>   Spaces of length thread-level (string)
2966 %<   Spaces of length (- 20 thread-level) (string)
2967 %i   Article score (number)
2968 %z   Article zcore (character)
2969 %t   Number of articles under the current thread (number).
2970 %e   Whether the thread is empty or not (character).
2971 %V   Total thread score (number).
2972 %P   The line number (number).
2973 %O   Download mark (character).
2974 %*   If present, indicates desired cursor position
2975      (instead of after first colon).
2976 %u   User defined specifier.  The next character in the format string should
2977      be a letter.  Gnus will call the function gnus-user-format-function-X,
2978      where X is the letter following %u.  The function will be passed the
2979      current header as argument.  The function should return a string, which
2980      will be inserted into the summary just like information from any other
2981      summary specifier.
2982
2983 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2984 with care.  For reasons of efficiency, Gnus will compute what column
2985 these characters will end up in, and \"hard-code\" that.  This means that
2986 it is invalid to have these specs after a variable-length spec.  Well,
2987 you might not be arrested, but your summary buffer will look strange,
2988 which is bad enough.
2989
2990 The smart choice is to have these specs as far to the left as
2991 possible.
2992
2993 This restriction may disappear in later versions of Gnus.
2994
2995 General format specifiers can also be used.
2996 See Info node `(gnus)Formatting Variables'."
2997   :link '(custom-manual "(gnus)Formatting Variables")
2998   :type 'string
2999   :group 'gnus-summary-format)
3000
3001 ;;;
3002 ;;; Skeleton keymaps
3003 ;;;
3004
3005 (defun gnus-suppress-keymap (keymap)
3006   (suppress-keymap keymap)
3007   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3008     (while keys
3009       (define-key keymap (pop keys) 'undefined))))
3010
3011 (defvar gnus-article-mode-map
3012   (let ((keymap (make-sparse-keymap)))
3013     (gnus-suppress-keymap keymap)
3014     keymap))
3015 (defvar gnus-summary-mode-map
3016   (let ((keymap (make-keymap)))
3017     (gnus-suppress-keymap keymap)
3018     keymap))
3019 (defvar gnus-group-mode-map
3020   (let ((keymap (make-keymap)))
3021     (gnus-suppress-keymap keymap)
3022     keymap))
3023
3024 \f
3025
3026 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3027 ;; If you want the cursor to go somewhere else, set these two
3028 ;; functions in some startup hook to whatever you want.
3029 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3030 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3031
3032 ;;; Various macros and substs.
3033
3034 (defun gnus-header-from (header)
3035   (mail-header-from header))
3036
3037 (defmacro gnus-gethash (string hashtable)
3038   "Get hash value of STRING in HASHTABLE."
3039   `(symbol-value (intern-soft ,string ,hashtable)))
3040
3041 (defmacro gnus-gethash-safe (string hashtable)
3042   "Get hash value of STRING in HASHTABLE.
3043 Return nil if not defined."
3044   `(let ((sym (intern-soft ,string ,hashtable)))
3045      (and (boundp sym) (symbol-value sym))))
3046
3047 (defmacro gnus-sethash (string value hashtable)
3048   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3049   `(set (intern ,string ,hashtable) ,value))
3050 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3051
3052 (defmacro gnus-group-unread (group)
3053   "Get the currently computed number of unread articles in GROUP."
3054   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3055
3056 (defmacro gnus-group-entry (group)
3057   "Get the newsrc entry for GROUP."
3058   `(gnus-gethash ,group gnus-newsrc-hashtb))
3059
3060 (defmacro gnus-active (group)
3061   "Get active info on GROUP."
3062   `(gnus-gethash ,group gnus-active-hashtb))
3063
3064 (defmacro gnus-set-active (group active)
3065   "Set GROUP's active info."
3066   `(gnus-sethash ,group ,active gnus-active-hashtb))
3067
3068 ;; Info access macros.
3069
3070 (defmacro gnus-info-group (info)
3071   `(nth 0 ,info))
3072 (defmacro gnus-info-rank (info)
3073   `(nth 1 ,info))
3074 (defmacro gnus-info-read (info)
3075   `(nth 2 ,info))
3076 (defmacro gnus-info-marks (info)
3077   `(nth 3 ,info))
3078 (defmacro gnus-info-method (info)
3079   `(nth 4 ,info))
3080 (defmacro gnus-info-params (info)
3081   `(nth 5 ,info))
3082
3083 (defmacro gnus-info-level (info)
3084   `(let ((rank (gnus-info-rank ,info)))
3085      (if (consp rank)
3086          (car rank)
3087        rank)))
3088 (defmacro gnus-info-score (info)
3089   `(let ((rank (gnus-info-rank ,info)))
3090      (or (and (consp rank) (cdr rank)) 0)))
3091
3092 (defmacro gnus-info-set-group (info group)
3093   `(setcar ,info ,group))
3094 (defmacro gnus-info-set-rank (info rank)
3095   `(setcar (nthcdr 1 ,info) ,rank))
3096 (defmacro gnus-info-set-read (info read)
3097   `(setcar (nthcdr 2 ,info) ,read))
3098 (defmacro gnus-info-set-marks (info marks &optional extend)
3099   (if extend
3100       `(gnus-info-set-entry ,info ,marks 3)
3101     `(setcar (nthcdr 3 ,info) ,marks)))
3102 (defmacro gnus-info-set-method (info method &optional extend)
3103   (if extend
3104       `(gnus-info-set-entry ,info ,method 4)
3105     `(setcar (nthcdr 4 ,info) ,method)))
3106 (defmacro gnus-info-set-params (info params &optional extend)
3107   (if extend
3108       `(gnus-info-set-entry ,info ,params 5)
3109     `(setcar (nthcdr 5 ,info) ,params)))
3110
3111 (defun gnus-info-set-entry (info entry number)
3112   ;; Extend the info until we have enough elements.
3113   (while (<= (length info) number)
3114     (nconc info (list nil)))
3115   ;; Set the entry.
3116   (setcar (nthcdr number info) entry))
3117
3118 (defmacro gnus-info-set-level (info level)
3119   `(let ((rank (cdr ,info)))
3120      (if (consp (car rank))
3121          (setcar (car rank) ,level)
3122        (setcar rank ,level))))
3123 (defmacro gnus-info-set-score (info score)
3124   `(let ((rank (cdr ,info)))
3125      (if (consp (car rank))
3126          (setcdr (car rank) ,score)
3127        (setcar rank (cons (car rank) ,score)))))
3128
3129 (defmacro gnus-get-info (group)
3130   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3131
3132 ;;; Load the compatibility functions.
3133
3134 (require 'gnus-ems)
3135
3136 \f
3137 ;;;
3138 ;;; Shutdown
3139 ;;;
3140
3141 (defvar gnus-shutdown-alist nil)
3142
3143 (defun gnus-add-shutdown (function &rest symbols)
3144   "Run FUNCTION whenever one of SYMBOLS is shut down."
3145   (push (cons function symbols) gnus-shutdown-alist))
3146
3147 (defun gnus-shutdown (symbol)
3148   "Shut down everything that waits for SYMBOL."
3149   (dolist (entry gnus-shutdown-alist)
3150     (when (memq symbol (cdr entry))
3151       (funcall (car entry)))))
3152
3153 \f
3154 ;;;
3155 ;;; Gnus Utility Functions
3156 ;;;
3157
3158 (defun gnus-find-subscribed-addresses ()
3159   "Return a regexp matching the addresses of all subscribed mail groups.
3160 It consists of the `to-address' or `to-list' parameter of all groups
3161 with a `subscribed' parameter."
3162   (let (group address addresses)
3163     (dolist (entry (cdr gnus-newsrc-alist))
3164       (setq group (car entry))
3165       (when (gnus-parameter-subscribed group)
3166         (setq address (mail-strip-quoted-names
3167                        (or (gnus-group-fast-parameter group 'to-address)
3168                            (gnus-group-fast-parameter group 'to-list))))
3169         (when address
3170           (add-to-list 'addresses address))))
3171     (when addresses
3172       (list (mapconcat 'regexp-quote addresses "\\|")))))
3173
3174 (defmacro gnus-string-or (&rest strings)
3175   "Return the first element of STRINGS that is a non-blank string.
3176 STRINGS will be evaluated in normal `or' order."
3177   `(gnus-string-or-1 ',strings))
3178
3179 (defun gnus-string-or-1 (strings)
3180   (let (string)
3181     (while strings
3182       (setq string (eval (pop strings)))
3183       (if (string-match "^[ \t]*$" string)
3184           (setq string nil)
3185         (setq strings nil)))
3186     string))
3187
3188 (defun gnus-info-find-node (&optional nodename)
3189   "Find Info documentation of Gnus."
3190   (interactive)
3191   ;; Enlarge info window if needed.
3192   (let (gnus-info-buffer)
3193     (Info-goto-node
3194      (format "(%s)%s"
3195              (or gnus-info-filename
3196                  (get-language-info current-language-environment 'gnus-info)
3197                  "gnus")
3198              (or nodename
3199                  (cadr (assq major-mode gnus-info-nodes))
3200                  (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3201                       (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3202     (setq gnus-info-buffer (current-buffer))
3203     (gnus-configure-windows 'info)))
3204
3205 ;;;
3206 ;;; gnus-interactive
3207 ;;;
3208
3209 (defvar gnus-current-prefix-symbol nil
3210   "Current prefix symbol.")
3211
3212 (defvar gnus-current-prefix-symbols nil
3213   "List of current prefix symbols.")
3214
3215 (defun gnus-interactive (string &optional params)
3216   "Return a list that can be fed to `interactive'.
3217 See `interactive' for full documentation.
3218
3219 Adds the following specs:
3220
3221 y -- The current symbolic prefix.
3222 Y -- A list of the current symbolic prefix(es).
3223 A -- Article number.
3224 H -- Article header.
3225 g -- Group name."
3226   (let ((i 0)
3227         out c prompt)
3228     (while (< i (length string))
3229       (string-match ".\\([^\n]*\\)\n?" string i)
3230       (setq c (aref string i))
3231       (when (match-end 1)
3232         (setq prompt (match-string 1 string)))
3233       (setq i (match-end 0))
3234       ;; We basically emulate just about everything that
3235       ;; `interactive' does, but add the specs listed above.
3236       (push
3237        (cond
3238         ((= c ?a)
3239          (completing-read prompt obarray 'fboundp t))
3240         ((= c ?b)
3241          (read-buffer prompt (current-buffer) t))
3242         ((= c ?B)
3243          (read-buffer prompt (other-buffer (current-buffer))))
3244         ((= c ?c)
3245          (read-char))
3246         ((= c ?C)
3247          (completing-read prompt obarray 'commandp t))
3248         ((= c ?d)
3249          (point))
3250         ((= c ?D)
3251          (read-file-name prompt nil default-directory 'lambda))
3252         ((= c ?f)
3253          (read-file-name prompt nil nil 'lambda))
3254         ((= c ?F)
3255          (read-file-name prompt))
3256         ((= c ?k)
3257          (read-key-sequence prompt))
3258         ((= c ?K)
3259          (error "Not implemented spec"))
3260         ((= c ?e)
3261          (error "Not implemented spec"))
3262         ((= c ?m)
3263          (mark))
3264         ((= c ?N)
3265          (error "Not implemented spec"))
3266         ((= c ?n)
3267          (string-to-number (read-from-minibuffer prompt)))
3268         ((= c ?p)
3269          (prefix-numeric-value current-prefix-arg))
3270         ((= c ?P)
3271          current-prefix-arg)
3272         ((= c ?r)
3273          'gnus-prefix-nil)
3274         ((= c ?s)
3275          (read-string prompt))
3276         ((= c ?S)
3277          (intern (read-string prompt)))
3278         ((= c ?v)
3279          (read-variable prompt))
3280         ((= c ?x)
3281          (read-minibuffer prompt))
3282         ((= c ?x)
3283          (eval-minibuffer prompt))
3284         ;; And here the new specs come.
3285         ((= c ?y)
3286          gnus-current-prefix-symbol)
3287         ((= c ?Y)
3288          gnus-current-prefix-symbols)
3289         ((= c ?g)
3290          (gnus-group-group-name))
3291         ((= c ?A)
3292          (gnus-summary-skip-intangible)
3293          (or (get-text-property (point) 'gnus-number)
3294              (gnus-summary-last-subject)))
3295         ((= c ?H)
3296          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3297         (t
3298          (error "Non-implemented spec")))
3299        out)
3300       (cond
3301        ((= c ?r)
3302         (push (if (< (point) (mark)) (point) (mark)) out)
3303         (push (if (> (point) (mark)) (point) (mark)) out))))
3304     (setq out (delq 'gnus-prefix-nil out))
3305     (nreverse out)))
3306
3307 (defun gnus-symbolic-argument (&optional arg)
3308   "Read a symbolic argument and a command, and then execute command."
3309   (interactive "P")
3310   (let* ((in-command (this-command-keys))
3311          (command in-command)
3312          gnus-current-prefix-symbols
3313          gnus-current-prefix-symbol
3314          syms)
3315     (while (equal in-command command)
3316       (message "%s-" (key-description (this-command-keys)))
3317       (push (intern (char-to-string (read-char))) syms)
3318       (setq command (read-key-sequence nil t)))
3319     (setq gnus-current-prefix-symbols (nreverse syms)
3320           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3321     (call-interactively (key-binding command t))))
3322
3323 ;;; More various functions.
3324
3325 (defsubst gnus-check-backend-function (func group)
3326   "Check whether GROUP supports function FUNC.
3327 GROUP can either be a string (a group name) or a select method."
3328   (ignore-errors
3329     (let ((method (if (stringp group)
3330                       (car (gnus-find-method-for-group group))
3331                     group)))
3332       (unless (featurep method)
3333         (require method))
3334       (fboundp (intern (format "%s-%s" method func))))))
3335
3336 (defun gnus-group-read-only-p (&optional group)
3337   "Check whether GROUP supports editing or not.
3338 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3339 that that variable is buffer-local to the summary buffers."
3340   (let ((group (or group gnus-newsgroup-name)))
3341     (not (gnus-check-backend-function 'request-replace-article group))))
3342
3343 (defun gnus-virtual-group-p (group)
3344   "Say whether GROUP is virtual or not."
3345   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3346                         gnus-valid-select-methods)))
3347
3348 (defun gnus-news-group-p (group &optional article)
3349   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3350   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3351          t)                             ;is news of course.
3352         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3353          nil)                           ;must be mail then.
3354         ((vectorp article)              ;Has header info.
3355          (eq (gnus-request-type group (mail-header-id article)) 'news))
3356         ((null article)                 ;Hasn't header info
3357          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3358         ((< article 0)                  ;Virtual message
3359          nil)                           ;we don't know, guess mail.
3360         (t                              ;Has positive number
3361          (eq (gnus-request-type group article) 'news)))) ;use it.
3362
3363 ;; Returns a list of writable groups.
3364 (defun gnus-writable-groups ()
3365   (let ((alist gnus-newsrc-alist)
3366         groups group)
3367     (while (setq group (car (pop alist)))
3368       (unless (gnus-group-read-only-p group)
3369         (push group groups)))
3370     (nreverse groups)))
3371
3372 ;; Check whether to use long file names.
3373 (defun gnus-use-long-file-name (symbol)
3374   ;; The variable has to be set...
3375   (and gnus-use-long-file-name
3376        ;; If it isn't a list, then we return t.
3377        (or (not (listp gnus-use-long-file-name))
3378            ;; If it is a list, and the list contains `symbol', we
3379            ;; return nil.
3380            (not (memq symbol gnus-use-long-file-name)))))
3381
3382 ;; Generate a unique new group name.
3383 (defun gnus-generate-new-group-name (leaf)
3384   (let ((name leaf)
3385         (num 0))
3386     (while (gnus-group-entry name)
3387       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3388     name))
3389
3390 (defun gnus-ephemeral-group-p (group)
3391   "Say whether GROUP is ephemeral or not."
3392   (gnus-group-get-parameter group 'quit-config t))
3393
3394 (defun gnus-group-quit-config (group)
3395   "Return the quit-config of GROUP."
3396   (gnus-group-get-parameter group 'quit-config t))
3397
3398 (defun gnus-kill-ephemeral-group (group)
3399   "Remove ephemeral GROUP from relevant structures."
3400   (gnus-sethash group nil gnus-newsrc-hashtb))
3401
3402 (defun gnus-simplify-mode-line ()
3403   "Make mode lines a bit simpler."
3404   (setq mode-line-modified (cdr gnus-mode-line-modified))
3405   (when (listp mode-line-format)
3406     (make-local-variable 'mode-line-format)
3407     (setq mode-line-format (copy-sequence mode-line-format))
3408     (when (equal (nth 3 mode-line-format) "   ")
3409       (setcar (nthcdr 3 mode-line-format) " "))))
3410
3411 ;;; Servers and groups.
3412
3413 (defsubst gnus-server-add-address (method)
3414   (let ((method-name (symbol-name (car method))))
3415     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3416              (not (assq (intern (concat method-name "-address")) method))
3417              (memq 'physical-address (assq (car method)
3418                                            gnus-valid-select-methods)))
3419         (append method (list (list (intern (concat method-name "-address"))
3420                                    (nth 1 method))))
3421       method)))
3422
3423 (defsubst gnus-method-to-server (method)
3424   (catch 'server-name
3425     (setq method (or method gnus-select-method))
3426
3427     ;; Perhaps it is already in the cache.
3428     (mapc (lambda (name-method)
3429             (if (equal (cdr name-method) method)
3430                 (throw 'server-name (car name-method))))
3431           gnus-server-method-cache)
3432
3433     (mapc
3434      (lambda (server-alist)
3435        (mapc (lambda (name-method)
3436                (when (gnus-methods-equal-p (cdr name-method) method)
3437                  (unless (member name-method gnus-server-method-cache)
3438                    (push name-method gnus-server-method-cache))
3439                  (throw 'server-name (car name-method))))
3440              server-alist))
3441      (let ((alists (list gnus-server-alist
3442                          gnus-predefined-server-alist)))
3443        (if gnus-select-method
3444            (push (list (cons "native" gnus-select-method)) alists))
3445        alists))
3446
3447     (let* ((name (if (member (cadr method) '(nil ""))
3448                      (format "%s" (car method))
3449                    (format "%s:%s" (car method) (cadr method))))
3450            (name-method (cons name method)))
3451       (unless (member name-method gnus-server-method-cache)
3452         (push name-method gnus-server-method-cache))
3453       name)))
3454
3455 (defsubst gnus-server-to-method (server)
3456   "Map virtual server names to select methods."
3457   (or (and server (listp server) server)
3458       (cdr (assoc server gnus-server-method-cache))
3459       (let ((result
3460              (or
3461               ;; Perhaps this is the native server?
3462               (and (equal server "native") gnus-select-method)
3463               ;; It should be in the server alist.
3464               (cdr (assoc server gnus-server-alist))
3465               ;; It could be in the predefined server alist.
3466               (cdr (assoc server gnus-predefined-server-alist))
3467               ;; If not, we look through all the opened server
3468               ;; to see whether we can find it there.
3469               (let ((opened gnus-opened-servers))
3470                 (while (and opened
3471                             (not (equal server (format "%s:%s" (caaar opened)
3472                                                        (cadaar opened)))))
3473                   (pop opened))
3474                 (caar opened))
3475               ;; It could be a named method, search all servers
3476               (let ((servers gnus-secondary-select-methods))
3477                 (while (and servers
3478                             (not (equal server (format "%s:%s" (caar servers)
3479                                                        (cadar servers)))))
3480                   (pop servers))
3481                 (car servers))
3482               ;; This could be some sort of foreign server that I
3483               ;; simply haven't opened (yet).  Do a brute-force scan
3484               ;; of the entire gnus-newsrc-alist for the server name
3485               ;; of every method.  As a side-effect, loads the
3486               ;; gnus-server-method-cache so this only happens once,
3487               ;; if at all.
3488               (let (match)
3489                 (mapcar 
3490                  (lambda (info)
3491                    (let ((info-method (gnus-info-method info)))
3492                      (unless (stringp info-method)
3493                        (let ((info-server (gnus-method-to-server info-method)))
3494                          (when (equal server info-server)
3495                            (setq match info-method))))))
3496                  (cdr gnus-newsrc-alist))
3497                 match))))
3498         (when result
3499           (push (cons server result) gnus-server-method-cache))
3500         result)))
3501
3502 (defsubst gnus-server-get-method (group method)
3503   ;; Input either a server name, and extended server name, or a
3504   ;; select method, and return a select method.
3505   (cond ((stringp method)
3506          (gnus-server-to-method method))
3507         ((equal method gnus-select-method)
3508          gnus-select-method)
3509         ((and (stringp (car method))
3510               group)
3511          (gnus-server-extend-method group method))
3512         ((and method
3513               (not group)
3514               (equal (cadr method) ""))
3515          method)
3516         (t
3517          (gnus-server-add-address method))))
3518
3519 (defmacro gnus-method-equal (ss1 ss2)
3520   "Say whether two servers are equal."
3521   `(let ((s1 ,ss1)
3522          (s2 ,ss2))
3523      (or (equal s1 s2)
3524          (and (= (length s1) (length s2))
3525               (progn
3526                 (while (and s1 (member (car s1) s2))
3527                   (setq s1 (cdr s1)))
3528                 (null s1))))))
3529
3530 (defun gnus-methods-equal-p (m1 m2)
3531   (let ((m1 (or m1 gnus-select-method))
3532         (m2 (or m2 gnus-select-method)))
3533     (or (equal m1 m2)
3534         (and (eq (car m1) (car m2))
3535              (or (not (memq 'address (assoc (symbol-name (car m1))
3536                                             gnus-valid-select-methods)))
3537                  (equal (nth 1 m1) (nth 1 m2)))))))
3538
3539 (defun gnus-server-equal (m1 m2)
3540   "Say whether two methods are equal."
3541   (let ((m1 (cond ((null m1) gnus-select-method)
3542                   ((stringp m1) (gnus-server-to-method m1))
3543                   (t m1)))
3544         (m2 (cond ((null m2) gnus-select-method)
3545                   ((stringp m2) (gnus-server-to-method m2))
3546                   (t m2))))
3547     (gnus-method-equal m1 m2)))
3548
3549 (defun gnus-servers-using-backend (backend)
3550   "Return a list of known servers using BACKEND."
3551   (let ((opened gnus-opened-servers)
3552         out)
3553     (while opened
3554       (when (eq backend (caaar opened))
3555         (push (caar opened) out))
3556       (pop opened))
3557     out))
3558
3559 (defun gnus-archive-server-wanted-p ()
3560   "Say whether the user wants to use the archive server."
3561   (cond
3562    ((or (not gnus-message-archive-method)
3563         (not gnus-message-archive-group))
3564     nil)
3565    ((and gnus-message-archive-method gnus-message-archive-group)
3566     t)
3567    (t
3568     (let ((active (cadr (assq 'nnfolder-active-file
3569                               gnus-message-archive-method))))
3570       (and active
3571            (file-exists-p active))))))
3572
3573 (defsubst gnus-method-to-server-name (method)
3574   (concat
3575    (format "%s" (car method))
3576    (when (and
3577           (or (assoc (format "%s" (car method))
3578                      (gnus-methods-using 'address))
3579               (gnus-server-equal method gnus-message-archive-method))
3580           (nth 1 method)
3581           (not (string= (nth 1 method) "")))
3582      (concat "+" (nth 1 method)))))
3583
3584 (defsubst gnus-method-to-full-server-name (method)
3585   (format "%s+%s" (car method) (nth 1 method)))
3586
3587 (defun gnus-group-prefixed-name (group method &optional full)
3588   "Return the whole name from GROUP and METHOD.
3589 Call with full set to get the fully qualified group name (even if the
3590 server is native)."
3591   (when (stringp method)
3592     (setq method (gnus-server-to-method method)))
3593   (if (or (not method)
3594           (and (not full) (gnus-server-equal method "native"))
3595           ;;;!!! This might not be right.  We'll see...
3596           ;(string-match ":" group)
3597           )
3598       group
3599     (concat (gnus-method-to-server-name method) ":" group)))
3600
3601 (defun gnus-group-guess-prefixed-name (group)
3602   "Guess the whole name from GROUP and METHOD."
3603   (gnus-group-prefixed-name group (gnus-find-method-for-group
3604                                group)))
3605
3606 (defun gnus-group-full-name (group method)
3607   "Return the full name from GROUP and METHOD, even if the method is native."
3608   (gnus-group-prefixed-name group method t))
3609
3610 (defun gnus-group-guess-full-name (group)
3611   "Guess the full name from GROUP, even if the method is native."
3612   (if (gnus-group-prefixed-p group)
3613       group
3614     (gnus-group-full-name group (gnus-find-method-for-group group))))
3615
3616 (defun gnus-group-guess-full-name-from-command-method (group)
3617   "Guess the full name from GROUP, even if the method is native."
3618   (if (gnus-group-prefixed-p group)
3619       group
3620     (gnus-group-full-name group gnus-command-method)))
3621
3622 (defun gnus-group-real-prefix (group)
3623   "Return the prefix of the current group name."
3624   (if (stringp group)
3625       (if (string-match "^[^:]+:" group)
3626           (substring group 0 (match-end 0))
3627         "")
3628     nil))
3629
3630 (defun gnus-group-short-name (group)
3631   "Return the short group name."
3632   (let ((prefix (gnus-group-real-prefix group)))
3633     (if (< 0 (length prefix))
3634         (substring group (length prefix) nil)
3635       group)))
3636
3637 (defun gnus-group-prefixed-p (group)
3638   "Return the prefix of the current group name."
3639   (< 0 (length (gnus-group-real-prefix group))))
3640
3641 (defun gnus-summary-buffer-name (group)
3642   "Return the summary buffer name of GROUP."
3643   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3644
3645 (defun gnus-group-method (group)
3646   "Return the server or method used for selecting GROUP.
3647 You should probably use `gnus-find-method-for-group' instead."
3648   (let ((prefix (gnus-group-real-prefix group)))
3649     (if (equal prefix "")
3650         gnus-select-method
3651       (let ((servers gnus-opened-servers)
3652             (server "")
3653             backend possible found)
3654         (if (string-match "^[^\\+]+\\+" prefix)
3655             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3656                   server (substring prefix (match-end 0) (1- (length prefix))))
3657           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3658         (while servers
3659           (when (eq (caaar servers) backend)
3660             (setq possible (caar servers))
3661             (when (equal (cadaar servers) server)
3662               (setq found (caar servers))))
3663           (pop servers))
3664         (or (car (rassoc found gnus-server-alist))
3665             found
3666             (car (rassoc possible gnus-server-alist))
3667             possible
3668             (list backend server))))))
3669
3670 (defsubst gnus-native-method-p (method)
3671   "Return whether METHOD is the native select method."
3672   (gnus-method-equal method gnus-select-method))
3673
3674 (defsubst gnus-secondary-method-p (method)
3675   "Return whether METHOD is a secondary select method."
3676   (let ((methods gnus-secondary-select-methods)
3677         (gmethod (inline (gnus-server-get-method nil method))))
3678     (while (and methods
3679                 (not (gnus-method-equal
3680                       (inline (gnus-server-get-method nil (car methods)))
3681                       gmethod)))
3682       (setq methods (cdr methods)))
3683     methods))
3684
3685 (defun gnus-method-simplify (method)
3686   "Return the shortest uniquely identifying string or method for METHOD."
3687   (cond ((stringp method)
3688          method)
3689         ((gnus-native-method-p method)
3690          nil)
3691         ((gnus-secondary-method-p method)
3692          (format "%s:%s" (nth 0 method) (nth 1 method)))
3693         (t
3694          method)))
3695
3696 (defun gnus-groups-from-server (server)
3697   "Return a list of all groups that are fetched from SERVER."
3698   (let ((alist (cdr gnus-newsrc-alist))
3699         info groups)
3700     (while (setq info (pop alist))
3701       (when (gnus-server-equal (gnus-info-method info) server)
3702         (push (gnus-info-group info) groups)))
3703     (sort groups 'string<)))
3704
3705 (defun gnus-group-foreign-p (group)
3706   "Say whether a group is foreign or not."
3707   (and (not (gnus-group-native-p group))
3708        (not (gnus-group-secondary-p group))))
3709
3710 (defun gnus-group-native-p (group)
3711   "Say whether the group is native or not."
3712   (not (string-match ":" group)))
3713
3714 (defun gnus-group-secondary-p (group)
3715   "Say whether the group is secondary or not."
3716   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3717
3718 (defun gnus-parameters-get-parameter (group)
3719   "Return the group parameters for GROUP from `gnus-parameters'."
3720   (let (params-list)
3721     (dolist (elem gnus-parameters)
3722       (when (string-match (car elem) group)
3723         (setq params-list
3724               (nconc (gnus-expand-group-parameters
3725                       (car elem) (cdr elem) group)
3726                      params-list))))
3727     params-list))
3728
3729 (defun gnus-expand-group-parameter (match value group)
3730   "Use MATCH to expand VALUE in GROUP."
3731   (with-temp-buffer
3732     (insert group)
3733     (goto-char (point-min))
3734     (while (re-search-forward match nil t)
3735       (replace-match value))
3736     (buffer-string)))
3737
3738 (defun gnus-expand-group-parameters (match parameters group)
3739   "Go through PARAMETERS and expand them according to the match data."
3740   (let (new)
3741     (dolist (elem parameters)
3742       (if (and (stringp (cdr elem))
3743                (string-match "\\\\[0-9&]" (cdr elem)))
3744           (push (cons (car elem)
3745                       (gnus-expand-group-parameter match (cdr elem) group))
3746                 new)
3747         (push elem new)))
3748     new))
3749
3750 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3751   "For GROUP, return the value of SYMBOL.
3752
3753 You should call this in the `gnus-group-buffer' buffer.
3754 The function `gnus-group-find-parameter' will do that for you."
3755   ;; The speed trick:  No cons'ing and quit early.
3756   (let* ((params (funcall gnus-group-get-parameter-function group))
3757          ;; Start easy, check the "real" group parameters.
3758          (simple-results
3759           (gnus-group-parameter-value params symbol allow-list t)))
3760     (if simple-results
3761         ;; Found results; return them.
3762         (car simple-results)
3763       ;; We didn't found it there, try `gnus-parameters'.
3764       (let ((result nil)
3765             (head nil)
3766             (tail gnus-parameters))
3767         ;; A good old-fashioned non-cl loop.
3768         (while tail
3769           (setq head (car tail)
3770                 tail (cdr tail))
3771           ;; The car is regexp matching for matching the group name.
3772           (when (string-match (car head) group)
3773             ;; The cdr is the parameters.
3774             (setq result (gnus-group-parameter-value (cdr head)
3775                                                      symbol allow-list))
3776             (when result
3777               ;; Expand if necessary.
3778               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3779                   (setq result (gnus-expand-group-parameter (car head)
3780                                                             result group)))
3781               ;; Exit the loop early.
3782               (setq tail nil))))
3783         ;; Done.
3784         result))))
3785
3786 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3787   "Return the group parameters for GROUP.
3788 If SYMBOL, return the value of that symbol in the group parameters.
3789
3790 If you call this function inside a loop, consider using the faster
3791 `gnus-group-fast-parameter' instead."
3792   (save-excursion
3793     (set-buffer gnus-group-buffer)
3794     (if symbol
3795         (gnus-group-fast-parameter group symbol allow-list)
3796       (nconc
3797        (copy-sequence
3798         (funcall gnus-group-get-parameter-function group))
3799        (gnus-parameters-get-parameter group)))))
3800
3801 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3802   "Return the group parameters for GROUP.
3803 If SYMBOL, return the value of that symbol in the group parameters.
3804 Most functions should use `gnus-group-find-parameter', which
3805 also examines the topic parameters."
3806   (let ((params (gnus-info-params (gnus-get-info group))))
3807     (if symbol
3808         (gnus-group-parameter-value params symbol allow-list)
3809       params)))
3810
3811 (defun gnus-group-parameter-value (params symbol &optional
3812                                           allow-list present-p)
3813   "Return the value of SYMBOL in group PARAMS."
3814   ;; We only wish to return group parameters (dotted lists) and
3815   ;; not local variables, which may have the same names.
3816   ;; But first we handle single elements...
3817   (or (car (memq symbol params))
3818       ;; Handle alist.
3819       (let (elem)
3820         (catch 'found
3821           (while (setq elem (pop params))
3822             (when (and (consp elem)
3823                        (eq (car elem) symbol)
3824                        (or allow-list
3825                            (atom (cdr elem))))
3826               (throw 'found (if present-p (list (cdr elem))
3827                               (cdr elem)))))))))
3828
3829 (defun gnus-group-add-parameter (group param)
3830   "Add parameter PARAM to GROUP."
3831   (let ((info (gnus-get-info group)))
3832     (when info
3833       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3834       ;; Cons the new param to the old one and update.
3835       (gnus-group-set-info (cons param (gnus-info-params info))
3836                            group 'params))))
3837
3838 (defun gnus-group-set-parameter (group name value)
3839   "Set parameter NAME to VALUE in GROUP."
3840   (let ((info (gnus-get-info group)))
3841     (when info
3842       (gnus-group-remove-parameter group name)
3843       (let ((old-params (gnus-info-params info))
3844             (new-params (list (cons name value))))
3845         (while old-params
3846           (when (or (not (listp (car old-params)))
3847                     (not (eq (caar old-params) name)))
3848             (setq new-params (append new-params (list (car old-params)))))
3849           (setq old-params (cdr old-params)))
3850         (gnus-group-set-info new-params group 'params)))))
3851
3852 (defun gnus-group-remove-parameter (group name)
3853   "Remove parameter NAME from GROUP."
3854   (let ((info (gnus-get-info group)))
3855     (when info
3856       (let ((params (gnus-info-params info)))
3857         (when params
3858           (setq params (delq name params))
3859           (while (assq name params)
3860             (gnus-pull name params))
3861           (gnus-info-set-params info params))))))
3862
3863 (defun gnus-group-add-score (group &optional score)
3864   "Add SCORE to the GROUP score.
3865 If SCORE is nil, add 1 to the score of GROUP."
3866   (let ((info (gnus-get-info group)))
3867     (when info
3868       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3869
3870 (defun gnus-short-group-name (group &optional levels)
3871   "Collapse GROUP name LEVELS.
3872 Select methods are stripped and any remote host name is stripped down to
3873 just the host name."
3874   (let* ((name "")
3875          (foreign "")
3876          (depth 0)
3877          (skip 1)
3878          (levels (or levels
3879                      gnus-group-uncollapsed-levels
3880                      (progn
3881                        (while (string-match "\\." group skip)
3882                          (setq skip (match-end 0)
3883                                depth (+ depth 1)))
3884                        depth))))
3885     ;; Separate foreign select method from group name and collapse.
3886     ;; If method contains a server, collapse to non-domain server name,
3887     ;; otherwise collapse to select method.
3888     (let* ((colon (string-match ":" group))
3889            (server (and colon (substring group 0 colon)))
3890            (plus (and server (string-match "+" server))))
3891       (when server
3892         (if plus
3893             (setq foreign (substring server (+ 1 plus)
3894                                      (string-match "\\." server))
3895                   group (substring group (+ 1 colon)))
3896           (setq foreign server
3897                 group (substring group (+ 1 colon))))
3898         (setq foreign (concat foreign ":")))
3899       ;; Collapse group name leaving LEVELS uncollapsed elements
3900       (let* ((slist (split-string group "/"))
3901              (slen (length slist))
3902              (dlist (split-string group "\\."))
3903              (dlen (length dlist))
3904              glist
3905              glen
3906              gsep
3907              res)
3908         (if (> slen dlen)
3909             (setq glist slist
3910                   glen slen
3911                   gsep "/")
3912           (setq glist dlist
3913                 glen dlen
3914                 gsep "."))
3915         (setq levels (- glen levels))
3916         (dolist (g glist)
3917           (push (if (>= (decf levels) 0)
3918                     (if (zerop (length g))
3919                         ""
3920                       (substring g 0 1))
3921                   g)
3922                 res))
3923         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3924
3925 (defun gnus-narrow-to-body ()
3926   "Narrow to the body of an article."
3927   (narrow-to-region
3928    (progn
3929      (goto-char (point-min))
3930      (or (search-forward "\n\n" nil t)
3931          (point-max)))
3932    (point-max)))
3933
3934 \f
3935 ;;;
3936 ;;; Kill file handling.
3937 ;;;
3938
3939 (defun gnus-apply-kill-file ()
3940   "Apply a kill file to the current newsgroup.
3941 Returns the number of articles marked as read."
3942   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3943           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3944       (gnus-apply-kill-file-internal)
3945     0))
3946
3947 (defun gnus-kill-save-kill-buffer ()
3948   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3949     (when (get-file-buffer file)
3950       (save-excursion
3951         (set-buffer (get-file-buffer file))
3952         (when (buffer-modified-p)
3953           (save-buffer))
3954         (kill-buffer (current-buffer))))))
3955
3956 (defcustom gnus-kill-file-name "KILL"
3957   "Suffix of the kill files."
3958   :group 'gnus-score-kill
3959   :group 'gnus-score-files
3960   :type 'string)
3961
3962 (defun gnus-newsgroup-kill-file (newsgroup)
3963   "Return the name of a kill file name for NEWSGROUP.
3964 If NEWSGROUP is nil, return the global kill file name instead."
3965   (cond
3966    ;; The global KILL file is placed at top of the directory.
3967    ((or (null newsgroup)
3968         (string-equal newsgroup ""))
3969     (expand-file-name gnus-kill-file-name
3970                       gnus-kill-files-directory))
3971    ;; Append ".KILL" to newsgroup name.
3972    ((gnus-use-long-file-name 'not-kill)
3973     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3974                               "." gnus-kill-file-name)
3975                       gnus-kill-files-directory))
3976    ;; Place "KILL" under the hierarchical directory.
3977    (t
3978     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3979                               "/" gnus-kill-file-name)
3980                       gnus-kill-files-directory))))
3981
3982 ;;; Server things.
3983
3984 (defun gnus-member-of-valid (symbol group)
3985   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3986   (memq symbol (assoc
3987                 (symbol-name (car (gnus-find-method-for-group group)))
3988                 gnus-valid-select-methods)))
3989
3990 (defun gnus-method-option-p (method option)
3991   "Return non-nil if select METHOD has OPTION as a parameter."
3992   (when (stringp method)
3993     (setq method (gnus-server-to-method method)))
3994   (memq option (assoc (format "%s" (car method))
3995                       gnus-valid-select-methods)))
3996
3997 (defun gnus-similar-server-opened (method)
3998   (let ((opened gnus-opened-servers))
3999     (while (and method opened)
4000       (when (and (equal (cadr method) (cadaar opened))
4001                  (equal (car method) (caaar opened))
4002                  (not (equal method (caar opened))))
4003         (setq method nil))
4004       (pop opened))
4005     (not method)))
4006
4007 (defun gnus-server-extend-method (group method)
4008   ;; This function "extends" a virtual server.  If the server is
4009   ;; "hello", and the select method is ("hello" (my-var "something"))
4010   ;; in the group "alt.alt", this will result in a new virtual server
4011   ;; called "hello+alt.alt".
4012   (if (or (not (inline (gnus-similar-server-opened method)))
4013           (not (cddr method)))
4014       method
4015     `(,(car method) ,(concat (cadr method) "+" group)
4016       (,(intern (format "%s-address" (car method))) ,(cadr method))
4017       ,@(cddr method))))
4018
4019 (defun gnus-server-status (method)
4020   "Return the status of METHOD."
4021   (nth 1 (assoc method gnus-opened-servers)))
4022
4023 (defun gnus-group-name-to-method (group)
4024   "Guess a select method based on GROUP."
4025   (if (string-match ":" group)
4026       (let ((server (substring group 0 (match-beginning 0))))
4027         (if (string-match "\\+" server)
4028             (list (intern (substring server 0 (match-beginning 0)))
4029                   (substring server (match-end 0)))
4030           (list (intern server) "")))
4031     gnus-select-method))
4032
4033 (defun gnus-server-string (server)
4034   "Return a readable string that describes SERVER."
4035   (let* ((server (gnus-server-to-method server))
4036          (address (nth 1 server)))
4037     (if (and address
4038              (not (zerop (length address))))
4039         (format "%s using %s" address (car server))
4040       (format "%s" (car server)))))
4041
4042 (defun gnus-find-method-for-group (group &optional info)
4043   "Find the select method that GROUP uses."
4044   (or gnus-override-method
4045       (and (not group)
4046            gnus-select-method)
4047       (and (not (gnus-group-entry group));; a new group
4048            (gnus-group-name-to-method group))
4049       (let ((info (or info (gnus-get-info group)))
4050             method)
4051         (if (or (not info)
4052                 (not (setq method (gnus-info-method info)))
4053                 (equal method "native"))
4054             gnus-select-method
4055           (setq method
4056                 (cond ((stringp method)
4057                        (inline (gnus-server-to-method method)))
4058                       ((stringp (cadr method))
4059                        (inline (gnus-server-extend-method group method)))
4060                       (t
4061                        method)))
4062           (cond ((equal (cadr method) "")
4063                  method)
4064                 ((null (cadr method))
4065                  (list (car method) ""))
4066                 (t
4067                  (gnus-server-add-address method)))))))
4068
4069 (defun gnus-methods-using (feature)
4070   "Find all methods that have FEATURE."
4071   (let ((valids gnus-valid-select-methods)
4072         outs)
4073     (while valids
4074       (when (memq feature (car valids))
4075         (push (car valids) outs))
4076       (setq valids (cdr valids)))
4077     outs))
4078
4079 (eval-when-compile
4080   (autoload 'message-y-or-n-p "message" nil nil 'macro))
4081
4082 (defun gnus-read-group (prompt &optional default)
4083   "Prompt the user for a group name.
4084 Disallow invalid group names."
4085   (let ((prefix "")
4086         group)
4087     (while (not group)
4088       (when (string-match
4089              gnus-invalid-group-regexp
4090              (setq group (read-string (concat prefix prompt)
4091                                       (cons (or default "") 0)
4092                                       'gnus-group-history)))
4093         (let ((match (match-string 0 group)))
4094           ;; Might be okay (e.g. for nnimap), so ask the user:
4095           (unless (and (not (string-match "^$\\|:" match))
4096                        (message-y-or-n-p
4097                         "Proceed and create group anyway? " t
4098 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4099
4100 Usually, it's dangerous to create a group with this name, because it's not
4101 supported by all back ends and servers.  On IMAP servers it should work,
4102 though.  If you are really sure, you can proceed anyway and create the group.
4103
4104 You may customize the variable `gnus-invalid-group-regexp', which currently is
4105 set to \"" gnus-invalid-group-regexp
4106 "\", if you want to get rid of this query permanently."))
4107             (setq prefix (format "Invalid group name: \"%s\".  " group)
4108                   group nil)))))
4109     group))
4110
4111 (defun gnus-read-method (prompt)
4112   "Prompt the user for a method.
4113 Allow completion over sensible values."
4114   (let* ((open-servers
4115           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4116                   gnus-opened-servers))
4117          (valid-methods
4118           (let (methods)
4119             (dolist (method gnus-valid-select-methods)
4120               (if (or (memq 'prompt-address method)
4121                       (not (assoc (format "%s:" (car method)) open-servers)))
4122                   (push method methods)))
4123             methods))
4124          (servers
4125           (append valid-methods
4126                   open-servers
4127                   gnus-predefined-server-alist
4128                   gnus-server-alist))
4129          (method
4130           (completing-read
4131            prompt servers
4132            nil t nil 'gnus-method-history)))
4133     (cond
4134      ((equal method "")
4135       (setq method gnus-select-method))
4136      ((assoc method gnus-valid-select-methods)
4137       (let ((address (if (memq 'prompt-address
4138                                (assoc method gnus-valid-select-methods))
4139                          (read-string "Address: ")
4140                        "")))
4141         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4142             (list (intern method) address))))
4143      ((assoc method servers)
4144       method)
4145      (t
4146       (list (intern method) "")))))
4147
4148 ;;; Agent functions
4149
4150 (defun gnus-agent-method-p (method)
4151   "Say whether METHOD is covered by the agent."
4152   (or (eq (car gnus-agent-method-p-cache) method)
4153       (setq gnus-agent-method-p-cache 
4154             (cons method
4155                   (member (if (stringp method) 
4156                               method 
4157                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4158   (cdr gnus-agent-method-p-cache))
4159
4160 (defun gnus-online (method)
4161   (not
4162    (if gnus-plugged
4163        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4164      (gnus-agent-method-p method))))
4165
4166 ;;; User-level commands.
4167
4168 ;;;###autoload
4169 (defun gnus-slave-no-server (&optional arg)
4170   "Read network news as a slave, without connecting to the local server."
4171   (interactive "P")
4172   (gnus-no-server arg t))
4173
4174 ;;;###autoload
4175 (defun gnus-no-server (&optional arg slave)
4176   "Read network news.
4177 If ARG is a positive number, Gnus will use that as the startup
4178 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4179 non-nil and not a positive number, Gnus will prompt the user for the
4180 name of an NNTP server to use.
4181 As opposed to `gnus', this command will not connect to the local
4182 server."
4183   (interactive "P")
4184   (gnus-no-server-1 arg slave))
4185
4186 ;;;###autoload
4187 (defun gnus-slave (&optional arg)
4188   "Read news as a slave."
4189   (interactive "P")
4190   (gnus arg nil 'slave))
4191
4192 (defcustom gnus-frame-properties nil
4193   "The properties of the frame in which gnus is displayed. Under XEmacs,
4194 the variable `toolbar-news-frame-plist' will be refered instead."
4195   :type '(repeat (cons :format "%v"
4196                        (symbol :tag "Parameter")
4197                        (sexp :tag "Value")))
4198   :group 'gnus)
4199
4200 ;;;###autoload
4201 (defun gnus-other-frame (&optional arg display)
4202   "Pop up a frame to read news.
4203 This will call one of the Gnus commands which is specified by the user
4204 option `gnus-other-frame-function' (default `gnus') with the argument
4205 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4206 optional second argument DISPLAY should be a standard display string
4207 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4208 omitted or the function `make-frame-on-display' is not available, the
4209 current display is used."
4210   (interactive "P")
4211   (if (fboundp 'make-frame-on-display)
4212       (unless display
4213         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4214     (setq display nil))
4215   (let ((alive (gnus-alive-p)))
4216     (unless (and alive
4217                  (catch 'found
4218                    (walk-windows
4219                     (lambda (window)
4220                       (when (and (or (not display)
4221                                      (equal display
4222                                             (gnus-frame-or-window-display-name
4223                                              window)))
4224                                  (with-current-buffer (window-buffer window)
4225                                    (string-match "\\`gnus-"
4226                                                  (symbol-name major-mode))))
4227                         (gnus-select-frame-set-input-focus
4228                          (setq gnus-other-frame-object (window-frame window)))
4229                         (select-window window)
4230                         (throw 'found t)))
4231                     'ignore t)))
4232       (gnus-select-frame-set-input-focus
4233        (setq gnus-other-frame-object
4234              (if display
4235                  (make-frame-on-display display gnus-other-frame-parameters)
4236                (make-frame gnus-other-frame-parameters))))
4237       (if alive
4238           (switch-to-buffer gnus-group-buffer)
4239         (funcall gnus-other-frame-function arg)
4240         (add-hook 'gnus-exit-gnus-hook
4241                   '(lambda nil
4242                      (when (and (frame-live-p gnus-other-frame-object)
4243                                 (cdr (frame-list)))
4244                        (delete-frame gnus-other-frame-object))
4245                      (setq gnus-other-frame-object nil)))))))
4246
4247 ;;;###autoload
4248 (defun gnus (&optional arg dont-connect slave)
4249   "Read network news.
4250 If ARG is non-nil and a positive number, Gnus will use that as the
4251 startup level.  If ARG is non-nil and not a positive number, Gnus will
4252 prompt the user for the name of an NNTP server to use."
4253   (interactive "P")
4254   (unless (byte-code-function-p (symbol-function 'gnus))
4255     (message "You should byte-compile Gnus")
4256     (sit-for 2))
4257   (gnus-1 arg dont-connect slave))
4258
4259 ;; Allow redefinition of Gnus functions.
4260
4261 (gnus-ems-redefine)
4262
4263 (product-provide (provide 'gnus) 'gnus-vers)
4264
4265 ;;; gnus.el ends here