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