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