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