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