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