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