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