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