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