Synch to No Gnus 200601130715.
[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 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)
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   :group 'gnus-meta
1606   :type 'boolean)
1607
1608 (defcustom gnus-suppress-duplicates nil
1609   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1610   :group 'gnus-meta
1611   :type 'boolean)
1612
1613 (defcustom gnus-use-scoring t
1614   "*If non-nil, enable scoring."
1615   :group 'gnus-meta
1616   :type 'boolean)
1617
1618 (defcustom gnus-summary-prepare-exit-hook
1619   '(gnus-summary-expire-articles)
1620   "*A hook called when preparing to exit from the summary buffer.
1621 It calls `gnus-summary-expire-articles' by default."
1622   :group 'gnus-summary-exit
1623   :type 'hook)
1624
1625 (defcustom gnus-novice-user t
1626   "*Non-nil means that you are a Usenet novice.
1627 If non-nil, verbose messages may be displayed and confirmations may be
1628 required."
1629   :group 'gnus-meta
1630   :type 'boolean)
1631
1632 (defcustom gnus-expert-user nil
1633   "*Non-nil means that you will never be asked for confirmation about anything.
1634 That doesn't mean *anything* anything; particularly destructive
1635 commands will still require prompting."
1636   :group 'gnus-meta
1637   :type 'boolean)
1638
1639 (defcustom gnus-interactive-catchup t
1640   "*If non-nil, require your confirmation when catching up a group."
1641   :group 'gnus-group-select
1642   :type 'boolean)
1643
1644 (defcustom gnus-interactive-exit t
1645   "*If non-nil, require your confirmation when exiting Gnus."
1646   :group 'gnus-exit
1647   :type 'boolean)
1648
1649 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1650   "Function for extracting address components from a From header.
1651 Three pre-defined functions exist: `gnus-extract-address-components',
1652 which is the default, quite fast, and too simplistic solution,
1653 `mail-extract-address-components', which works much better, but is
1654 slower, and `std11-extract-address-components'."
1655   :group 'gnus-summary-format
1656   :type '(radio (function-item gnus-extract-address-components)
1657                 (function-item mail-extract-address-components)
1658                 (function-item std11-extract-address-components)
1659                 (function :tag "Other")))
1660
1661 (defcustom gnus-carpal nil
1662   "*If non-nil, display clickable icons."
1663   :group 'gnus-meta
1664   :type 'boolean)
1665
1666 (defcustom gnus-shell-command-separator ";"
1667   "String used to separate shell commands."
1668   :group 'gnus-files
1669   :type 'string)
1670
1671 (defcustom gnus-valid-select-methods
1672   '(("nntp" post address prompt-address physical-address)
1673     ("nnspool" post address)
1674     ("nnvirtual" post-mail virtual prompt-address)
1675     ("nnmbox" mail respool address)
1676     ("nnml" post-mail respool address)
1677     ("nnmh" mail respool address)
1678     ("nndir" post-mail prompt-address physical-address)
1679     ("nneething" none address prompt-address physical-address)
1680     ("nndoc" none address prompt-address)
1681     ("nnbabyl" mail address respool)
1682     ("nnkiboze" post virtual)
1683     ("nnsoup" post-mail address)
1684     ("nndraft" post-mail)
1685     ("nnfolder" mail respool address)
1686     ("nngateway" post-mail address prompt-address physical-address)
1687     ("nnweb" none)
1688     ("nngoogle" post)
1689     ("nnslashdot" post)
1690     ("nnultimate" none)
1691     ("nnrss" none)
1692     ("nnwfm" none)
1693     ("nnwarchive" none)
1694     ("nnlistserv" none)
1695     ("nnagent" post-mail)
1696     ("nnimap" post-mail address prompt-address physical-address)
1697     ("nnmaildir" mail respool address)
1698     ("nnnil" none))
1699   "*An alist of valid select methods.
1700 The first element of each list lists should be a string with the name
1701 of the select method.  The other elements may be the category of
1702 this method (i. e., `post', `mail', `none' or whatever) or other
1703 properties that this method has (like being respoolable).
1704 If you implement a new select method, all you should have to change is
1705 this variable.  I think."
1706   :group 'gnus-server
1707   :type '(repeat (group (string :tag "Name")
1708                         (radio-button-choice (const :format "%v " post)
1709                                              (const :format "%v " mail)
1710                                              (const :format "%v " none)
1711                                              (const post-mail))
1712                         (checklist :inline t
1713                                    (const :format "%v " address)
1714                                    (const :format "%v " prompt-address)
1715                                    (const :format "%v " physical-address)
1716                                    (const :format "%v " virtual)
1717                                    (const respool)))))
1718
1719 (defun gnus-redefine-select-method-widget ()
1720   "Recomputes the select-method widget based on the value of
1721 `gnus-valid-select-methods'."
1722   (define-widget 'gnus-select-method 'list
1723     "Widget for entering a select method."
1724     :value '(nntp "")
1725     :tag "Select Method"
1726     :args `((choice :tag "Method"
1727                     ,@(mapcar (lambda (entry)
1728                                 (list 'const :format "%v\n"
1729                                       (intern (car entry))))
1730                               gnus-valid-select-methods)
1731                     (symbol :tag "other"))
1732             (string :tag "Address")
1733             (repeat :tag "Options"
1734                     :inline t
1735                     (list :format "%v"
1736                           variable
1737                           (sexp :tag "Value"))))))
1738
1739 (gnus-redefine-select-method-widget)
1740
1741 (defcustom gnus-updated-mode-lines '(group article summary tree)
1742   "List of buffers that should update their mode lines.
1743 The list may contain the symbols `group', `article', `tree' and
1744 `summary'.  If the corresponding symbol is present, Gnus will keep
1745 that mode line updated with information that may be pertinent.
1746 If this variable is nil, screen refresh may be quicker."
1747   :group 'gnus-various
1748   :type '(set (const group)
1749               (const article)
1750               (const summary)
1751               (const tree)))
1752
1753 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1754 (defcustom gnus-mode-non-string-length nil
1755   "*Max length of mode-line non-string contents.
1756 If this is nil, Gnus will take space as is needed, leaving the rest
1757 of the mode line intact.  Note that the default of nil is unlikely
1758 to be desirable; see the manual for further details."
1759   :group 'gnus-various
1760   :type '(choice (const nil)
1761                  integer))
1762
1763 ;; There should be special validation for this.
1764 (define-widget 'gnus-email-address 'string
1765   "An email address.")
1766
1767 (gnus-define-group-parameter
1768  to-address
1769  :function-document
1770  "Return GROUP's to-address."
1771  :variable-document
1772  "*Alist of group regexps and correspondent to-addresses."
1773  :variable-group gnus-group-parameter
1774  :parameter-type '(gnus-email-address :tag "To Address")
1775  :parameter-document "\
1776 This will be used when doing followups and posts.
1777
1778 This is primarily useful in mail groups that represent closed
1779 mailing lists--mailing lists where it's expected that everybody that
1780 writes to the mailing list is subscribed to it.  Since using this
1781 parameter ensures that the mail only goes to the mailing list itself,
1782 it means that members won't receive two copies of your followups.
1783
1784 Using `to-address' will actually work whether the group is foreign or
1785 not.  Let's say there's a group on the server that is called
1786 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1787 articles from a mail-to-news gateway.  Posting directly to this group
1788 is therefore impossible--you have to send mail to the mailing list
1789 address instead.
1790
1791 The gnus-group-split mail splitting mechanism will behave as if this
1792 address was listed in gnus-group-split Addresses (see below).")
1793
1794 (gnus-define-group-parameter
1795  to-list
1796  :function-document
1797  "Return GROUP's to-list."
1798  :variable-document
1799  "*Alist of group regexps and correspondent to-lists."
1800  :variable-group gnus-group-parameter
1801  :parameter-type '(gnus-email-address :tag "To List")
1802  :parameter-document "\
1803 This address will be used when doing a `a' in the group.
1804
1805 It is totally ignored when doing a followup--except that if it is
1806 present in a news group, you'll get mail group semantics when doing
1807 `f'.
1808
1809 The gnus-group-split mail splitting mechanism will behave as if this
1810 address was listed in gnus-group-split Addresses (see below).")
1811
1812 (gnus-define-group-parameter
1813  subscribed
1814  :type bool
1815  :function-document
1816  "Return GROUP's subscription status."
1817  :variable-document
1818  "*Groups which are automatically considered subscribed."
1819  :variable-group gnus-group-parameter
1820  :parameter-type '(const :tag "Subscribed" t)
1821  :parameter-document "\
1822 Gnus assumed that you are subscribed to the To/List address.
1823
1824 When constructing a list of subscribed groups using
1825 `gnus-find-subscribed-addresses', Gnus includes the To address given
1826 above, or the list address (if the To address has not been set).")
1827
1828 (gnus-define-group-parameter
1829  auto-expire
1830  :type bool
1831  :function gnus-group-auto-expirable-p
1832  :function-document
1833  "Check whether GROUP is auto-expirable or not."
1834  :variable gnus-auto-expirable-newsgroups
1835  :variable-default nil
1836  :variable-document
1837  "*Groups in which to automatically mark read articles as expirable.
1838 If non-nil, this should be a regexp that should match all groups in
1839 which to perform auto-expiry.  This only makes sense for mail groups."
1840  :variable-group nnmail-expire
1841  :variable-type '(choice (const nil)
1842                          regexp)
1843  :parameter-type '(const :tag "Automatic Expire" t)
1844  :parameter-document
1845  "All articles that are read will be marked as expirable.")
1846
1847 (gnus-define-group-parameter
1848  total-expire
1849  :type bool
1850  :function gnus-group-total-expirable-p
1851  :function-document
1852  "Check whether GROUP is total-expirable or not."
1853  :variable gnus-total-expirable-newsgroups
1854  :variable-default nil
1855  :variable-document
1856  "*Groups in which to perform expiry of all read articles.
1857 Use with extreme caution.  All groups that match this regexp will be
1858 expiring - which means that all read articles will be deleted after
1859 \(say) one week.         (This only goes for mail groups and the like, of
1860 course.)"
1861  :variable-group nnmail-expire
1862  :variable-type '(choice (const nil)
1863                          regexp)
1864  :parameter-type '(const :tag "Total Expire" t)
1865  :parameter-document
1866  "All read articles will be put through the expiry process
1867
1868 This happens even if they are not marked as expirable.
1869 Use with caution.")
1870
1871 (gnus-define-group-parameter
1872  charset
1873  :function-document
1874  "Return the default charset of GROUP."
1875  :variable gnus-group-charset-alist
1876  :variable-default
1877  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1878    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1879    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1880    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1881    ("\\(^\\|:\\)relcom\\>" koi8-r)
1882    ("\\(^\\|:\\)fido7\\>" koi8-r)
1883    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1884    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1885    ("\\(^\\|:\\)han\\>" euc-kr)
1886    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1887    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1888    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1889  :variable-document
1890  "Alist of regexps (to match group names) and default charsets to be used when reading."
1891  :variable-group gnus-charset
1892  :variable-type '(repeat (list (regexp :tag "Group")
1893                                (symbol :tag "Charset")))
1894  :parameter-type '(symbol :tag "Charset")
1895  :parameter-document "\
1896 The default charset to use in the group.")
1897
1898 (gnus-define-group-parameter
1899  post-method
1900  :type list
1901  :function-document
1902  "Return a posting method for GROUP."
1903  :variable gnus-post-method-alist
1904  :variable-document
1905  "Alist of regexps (to match group names) and method to be used when
1906 posting an article."
1907  :variable-group gnus-group-foreign
1908  :parameter-type
1909  '(choice :tag "Posting Method"
1910           (const :tag "Use native server" native)
1911           (const :tag "Use current server" current)
1912           (list :convert-widget
1913                 (lambda (widget)
1914                   (list 'sexp :tag "Methods"
1915                         :value gnus-select-method))))
1916  :parameter-document
1917  "Posting method for this group.")
1918
1919 (gnus-define-group-parameter
1920  large-newsgroup-initial
1921  :type integer
1922  :function-document
1923  "Return GROUP's initial input of the number of articles."
1924  :variable-document
1925  "*Alist of group regexps and its initial input of the number of articles."
1926  :variable-group gnus-group-parameter
1927  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1928                           (const :tag "All" nil)
1929                           (integer))
1930  :parameter-document "\
1931
1932 This number will be prompted as the initial value of the number of
1933 articles to list when the group is a large newsgroup (see
1934 `gnus-large-newsgroup').  If it is nil, the default value is the
1935 total number of articles in the group.")
1936
1937 ;; The Gnus registry's ignored groups
1938 (gnus-define-group-parameter
1939  registry-ignore
1940  :type list
1941  :function-document
1942  "Whether this group should be ignored by the registry."
1943  :variable gnus-registry-ignored-groups
1944  :variable-default nil
1945  :variable-document
1946  "*Groups in which the registry should be turned off."
1947  :variable-group gnus-registry
1948  :variable-type '(repeat
1949                   (list
1950                    (regexp :tag "Group Name Regular Expression")
1951                    (boolean :tag "Ignored")))
1952
1953  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1954  :parameter-document
1955  "Whether the Gnus Registry should ignore this group.")
1956
1957 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1958 (defcustom gnus-install-group-spam-parameters t
1959   "*Disable the group parameters for spam detection.
1960 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1961   :version "22.1"
1962   :type 'boolean
1963   :group 'gnus-start)
1964
1965 (when gnus-install-group-spam-parameters
1966   (defvar gnus-group-spam-classification-spam t
1967     "Spam group classification (requires spam.el).
1968 This group contains spam messages.  On summary entry, unread messages
1969 will be marked as spam.  On summary exit, the specified spam
1970 processors will be invoked on spam-marked messages, then those
1971 messages will be expired, so the spam processor will only see a
1972 spam-marked message once.")
1973
1974   (defvar gnus-group-spam-classification-ham 'ask
1975     "The ham value for the spam group parameter (requires spam.el).
1976 On summary exit, the specified ham processors will be invoked on
1977 ham-marked messages.  Exercise caution, since the ham processor will
1978 see the same message more than once because there is no ham message
1979 registry.")
1980
1981   (gnus-define-group-parameter
1982    spam-contents
1983    :type list
1984    :function-document
1985    "The spam type (spam, ham, or neither) of the group."
1986    :variable gnus-spam-newsgroup-contents
1987    :variable-default nil
1988    :variable-document
1989    "*Group classification (spam, ham, or neither).  Only
1990 meaningful when spam.el is loaded.  If non-nil, this should be a
1991 list of group name regexps associated with a classification for
1992 each one.  In spam groups, new articles are marked as spam on
1993 summary entry.  There is other behavior associated with ham and
1994 no classification when spam.el is loaded - see the manual."
1995    :variable-group spam
1996    :variable-type '(repeat
1997                     (list :tag "Group contents spam/ham classification"
1998                           (regexp :tag "Group")
1999                           (choice
2000                            (variable-item gnus-group-spam-classification-spam)
2001                            (variable-item gnus-group-spam-classification-ham)
2002                            (const :tag "Unclassified" nil))))
2003
2004    :parameter-type '(list :tag "Group contents spam/ham classification"
2005                           (choice :tag "Group contents classification for spam sorting"
2006                                   (variable-item gnus-group-spam-classification-spam)
2007                                   (variable-item gnus-group-spam-classification-ham)
2008                                   (const :tag "Unclassified" nil)))
2009    :parameter-document
2010    "The spam classification (spam, ham, or neither) of this group.
2011 When a spam group is entered, all unread articles are marked as
2012 spam.  There is other behavior associated with ham and no
2013 classification when spam.el is loaded - see the manual.")
2014
2015   (gnus-define-group-parameter
2016    spam-resend-to
2017    :type list
2018    :function-document
2019    "The address to get spam resent (through spam-report-resend)."
2020    :variable gnus-spam-resend-to
2021    :variable-default nil
2022    :variable-document
2023    "The address to get spam resent (through spam-report-resend)."
2024    :variable-group spam
2025    :variable-type '(repeat
2026                     (list :tag "Group address for resending spam"
2027                           (regexp :tag "Group")
2028                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2029    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2030    :parameter-document
2031    "The address to get spam resent (through spam-report-resend).")
2032
2033   (gnus-define-group-parameter
2034    ham-resend-to
2035    :type list
2036    :function-document
2037    "The address to get ham resent (through spam-report-resend)."
2038    :variable gnus-ham-resend-to
2039    :variable-default nil
2040    :variable-document
2041    "The address to get ham resent (through spam-report-resend)."
2042    :variable-group spam
2043    :variable-type '(repeat
2044                     (list :tag "Group address for resending ham"
2045                           (regexp :tag "Group")
2046                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2047    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2048    :parameter-document
2049    "The address to get ham resent (through spam-report-resend).")
2050
2051   (defvar gnus-group-spam-exit-processor-ifile "ifile"
2052     "OBSOLETE: The ifile summary exit spam processor.")
2053
2054   (defvar gnus-group-spam-exit-processor-stat "stat"
2055     "OBSOLETE: The spam-stat summary exit spam processor.")
2056
2057   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
2058     "OBSOLETE: The Bogofilter summary exit spam processor.")
2059
2060   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
2061     "OBSOLETE: The Blacklist summary exit spam processor.")
2062
2063   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2064     "OBSOLETE: The Gmane reporting summary exit spam processor.
2065 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
2066
2067   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2068     "OBSOLETE: The spamoracle summary exit spam processor.")
2069
2070   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2071     "OBSOLETE: The ifile summary exit ham processor.
2072 Only applicable to non-spam (unclassified and ham) groups.")
2073
2074   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2075     "OBSOLETE: The Bogofilter summary exit ham processor.
2076 Only applicable to non-spam (unclassified and ham) groups.")
2077
2078   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2079     "OBSOLETE: The spam-stat summary exit ham processor.
2080 Only applicable to non-spam (unclassified and ham) groups.")
2081
2082   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2083     "OBSOLETE: The whitelist summary exit ham processor.
2084 Only applicable to non-spam (unclassified and ham) groups.")
2085
2086   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2087     "OBSOLETE: The BBDB summary exit ham processor.
2088 Only applicable to non-spam (unclassified and ham) groups.")
2089
2090   (defvar gnus-group-ham-exit-processor-copy "copy"
2091     "OBSOLETE: The ham copy exit ham processor.
2092 Only applicable to non-spam (unclassified and ham) groups.")
2093
2094   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2095     "OBSOLETE: The spamoracle summary exit ham processor.
2096 Only applicable to non-spam (unclassified and ham) groups.")
2097
2098   (gnus-define-group-parameter
2099    spam-process
2100    :type list
2101    :parameter-type
2102    '(choice
2103      :tag "Spam Summary Exit Processor"
2104      :value nil
2105      (list :tag "Spam Summary Exit Processor Choices"
2106            (set
2107             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2108             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2109             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2110             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2111             (const :tag "Spam: Resend Message"(spam spam-use-resend))
2112             (const :tag "Spam: ifile"         (spam spam-use-ifile))
2113             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2114             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2115             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2116             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2117             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2118             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2119             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2120             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2121             (const :tag "Ham: Resend Message" (ham spam-use-resend))
2122             (const :tag "Ham: ifile"          (ham spam-use-ifile))
2123             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2124             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2125             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2126             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2127             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2128             (variable-item gnus-group-spam-exit-processor-ifile)
2129             (variable-item gnus-group-spam-exit-processor-stat)
2130             (variable-item gnus-group-spam-exit-processor-bogofilter)
2131             (variable-item gnus-group-spam-exit-processor-blacklist)
2132             (variable-item gnus-group-spam-exit-processor-spamoracle)
2133             (variable-item gnus-group-spam-exit-processor-report-gmane)
2134             (variable-item gnus-group-ham-exit-processor-bogofilter)
2135             (variable-item gnus-group-ham-exit-processor-ifile)
2136             (variable-item gnus-group-ham-exit-processor-stat)
2137             (variable-item gnus-group-ham-exit-processor-whitelist)
2138             (variable-item gnus-group-ham-exit-processor-BBDB)
2139             (variable-item gnus-group-ham-exit-processor-spamoracle)
2140             (variable-item gnus-group-ham-exit-processor-copy))))
2141    :function-document
2142    "Which spam or ham processors will be applied when the summary is exited."
2143    :variable gnus-spam-process-newsgroups
2144    :variable-default nil
2145    :variable-document
2146    "*Groups in which to automatically process spam or ham articles with
2147 a backend on summary exit.  If non-nil, this should be a list of group
2148 name regexps that should match all groups in which to do automatic
2149 spam processing, associated with the appropriate processor."
2150    :variable-group spam
2151    :variable-type
2152    '(repeat :tag "Spam/Ham Processors"
2153             (list :tag "Spam Summary Exit Processor Choices"
2154                   (regexp :tag "Group Regexp")
2155                   (set
2156                    :tag "Spam/Ham Summary Exit Processor"
2157                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2158                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2159                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2160                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2161                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2162                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2163                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2164                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2165                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2166                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2167                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2168                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2169                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2170                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2171                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2172                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2173                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2174                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2175                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2176                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2177                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2178                    (variable-item gnus-group-spam-exit-processor-ifile)
2179                    (variable-item gnus-group-spam-exit-processor-stat)
2180                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2181                    (variable-item gnus-group-spam-exit-processor-blacklist)
2182                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2183                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2184                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2185                    (variable-item gnus-group-ham-exit-processor-ifile)
2186                    (variable-item gnus-group-ham-exit-processor-stat)
2187                    (variable-item gnus-group-ham-exit-processor-whitelist)
2188                    (variable-item gnus-group-ham-exit-processor-BBDB)
2189                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2190                    (variable-item gnus-group-ham-exit-processor-copy))))
2191
2192    :parameter-document
2193    "Which spam or ham processors will be applied when the summary is exited.")
2194
2195   (gnus-define-group-parameter
2196    spam-autodetect
2197    :type list
2198    :parameter-type
2199    '(boolean :tag "Spam autodetection")
2200    :function-document
2201    "Should spam be autodetected (with spam-split) in this group?"
2202    :variable gnus-spam-autodetect
2203    :variable-default nil
2204    :variable-document
2205    "*Groups in which spam should be autodetected when they are entered.
2206    Only unseen articles will be examined, unless
2207    spam-autodetect-recheck-messages is set."
2208    :variable-group spam
2209    :variable-type
2210    '(repeat
2211      :tag "Autodetection setting"
2212      (list
2213       (regexp :tag "Group Regexp")
2214       boolean))
2215    :parameter-document
2216    "Spam autodetection.
2217 Only unseen articles will be examined, unless
2218 spam-autodetect-recheck-messages is set.")
2219
2220   (gnus-define-group-parameter
2221    spam-autodetect-methods
2222    :type list
2223    :parameter-type
2224    '(choice :tag "Spam autodetection-specific methods"
2225      (const none)
2226      (const default)
2227      (set :tag "Use specific methods"
2228           (variable-item spam-use-blacklist)
2229           (variable-item spam-use-gmane-xref)
2230           (variable-item spam-use-regex-headers)
2231           (variable-item spam-use-regex-body)
2232           (variable-item spam-use-whitelist)
2233           (variable-item spam-use-BBDB)
2234           (variable-item spam-use-ifile)
2235           (variable-item spam-use-spamoracle)
2236           (variable-item spam-use-crm114)
2237           (variable-item spam-use-spamassassin)
2238           (variable-item spam-use-spamassassin-headers)
2239           (variable-item spam-use-bsfilter)
2240           (variable-item spam-use-bsfilter-headers)
2241           (variable-item spam-use-stat)
2242           (variable-item spam-use-blackholes)
2243           (variable-item spam-use-hashcash)
2244           (variable-item spam-use-bogofilter-headers)
2245           (variable-item spam-use-bogofilter)))
2246    :function-document
2247    "Methods to be used for autodetection in each group"
2248    :variable gnus-spam-autodetect-methods
2249    :variable-default nil
2250    :variable-document
2251    "*Methods for autodetecting spam per group.
2252 Requires the spam-autodetect parameter.  Only unseen articles
2253 will be examined, unless spam-autodetect-recheck-messages is
2254 set."
2255    :variable-group spam
2256    :variable-type
2257    '(repeat
2258      :tag "Autodetection methods"
2259      (list
2260       (regexp :tag "Group Regexp")
2261       (choice
2262        (const none)
2263        (const default)
2264        (set :tag "Use specific methods"
2265         (variable-item spam-use-blacklist)
2266         (variable-item spam-use-gmane-xref)
2267         (variable-item spam-use-regex-headers)
2268         (variable-item spam-use-regex-body)
2269         (variable-item spam-use-whitelist)
2270         (variable-item spam-use-BBDB)
2271         (variable-item spam-use-ifile)
2272         (variable-item spam-use-spamoracle)
2273         (variable-item spam-use-crm114)
2274         (variable-item spam-use-stat)
2275         (variable-item spam-use-blackholes)
2276         (variable-item spam-use-hashcash)
2277         (variable-item spam-use-spamassassin)
2278         (variable-item spam-use-spamassassin-headers)
2279         (variable-item spam-use-bsfilter)
2280         (variable-item spam-use-bsfilter-headers)
2281         (variable-item spam-use-bogofilter-headers)
2282         (variable-item spam-use-bogofilter)))))
2283      :parameter-document
2284    "Spam autodetection methods.
2285 Requires the spam-autodetect parameter.  Only unseen articles
2286 will be examined, unless spam-autodetect-recheck-messages is
2287 set.")
2288
2289   (gnus-define-group-parameter
2290    spam-process-destination
2291    :type list
2292    :parameter-type
2293    '(choice :tag "Destination for spam-processed articles at summary exit"
2294             (string :tag "Move to a group")
2295             (repeat :tag "Move to multiple groups"
2296                     (string :tag "Destination group"))
2297             (const :tag "Expire" nil))
2298    :function-document
2299    "Where spam-processed articles will go at summary exit."
2300    :variable gnus-spam-process-destinations
2301    :variable-default nil
2302    :variable-document
2303    "*Groups in which to explicitly send spam-processed articles to
2304 another group, or expire them (the default).  If non-nil, this should
2305 be a list of group name regexps that should match all groups in which
2306 to do spam-processed article moving, associated with the destination
2307 group or nil for explicit expiration.  This only makes sense for
2308 mail groups."
2309    :variable-group spam
2310    :variable-type
2311    '(repeat
2312      :tag "Spam-processed articles destination"
2313      (list
2314       (regexp :tag "Group Regexp")
2315       (choice
2316        :tag "Destination for spam-processed articles at summary exit"
2317        (string :tag "Move to a group")
2318        (repeat :tag "Move to multiple groups"
2319                (string :tag "Destination group"))
2320        (const :tag "Expire" nil))))
2321    :parameter-document
2322    "Where spam-processed articles will go at summary exit.")
2323
2324   (gnus-define-group-parameter
2325    ham-process-destination
2326    :type list
2327    :parameter-type
2328    '(choice
2329      :tag "Destination for ham articles at summary exit from a spam group"
2330      (string :tag "Move to a group")
2331      (repeat :tag "Move to multiple groups"
2332              (string :tag "Destination group"))
2333      (const :tag "Respool" respool)
2334      (const :tag "Do nothing" nil))
2335    :function-document
2336    "Where ham articles will go at summary exit from a spam group."
2337    :variable gnus-ham-process-destinations
2338    :variable-default nil
2339    :variable-document
2340    "*Groups in which to explicitly send ham articles to
2341 another group, or do nothing (the default).  If non-nil, this should
2342 be a list of group name regexps that should match all groups in which
2343 to do ham article moving, associated with the destination
2344 group or nil for explicit ignoring.  This only makes sense for
2345 mail groups, and only works in spam groups."
2346    :variable-group spam
2347    :variable-type
2348    '(repeat
2349      :tag "Ham articles destination"
2350      (list
2351       (regexp :tag "Group Regexp")
2352       (choice
2353        :tag "Destination for ham articles at summary exit from spam group"
2354        (string :tag "Move to a group")
2355        (repeat :tag "Move to multiple groups"
2356                 (string :tag "Destination group"))
2357        (const :tag "Respool" respool)
2358        (const :tag "Expire" nil))))
2359    :parameter-document
2360    "Where ham articles will go at summary exit from a spam group.")
2361
2362   (gnus-define-group-parameter
2363    ham-marks
2364    :type 'list
2365    :parameter-type '(list :tag "Ham mark choices"
2366                           (set
2367                            (variable-item gnus-del-mark)
2368                            (variable-item gnus-read-mark)
2369                            (variable-item gnus-ticked-mark)
2370                            (variable-item gnus-killed-mark)
2371                            (variable-item gnus-kill-file-mark)
2372                            (variable-item gnus-low-score-mark)))
2373
2374    :parameter-document
2375    "Marks considered ham (positively not spam).  Such articles will be
2376 processed as ham (non-spam) on group exit.  When nil, the global
2377 spam-ham-marks variable takes precedence."
2378    :variable-default '((".*" ((gnus-del-mark
2379                                gnus-read-mark
2380                                gnus-killed-mark
2381                                gnus-kill-file-mark
2382                                gnus-low-score-mark))))
2383    :variable-group spam
2384    :variable-document
2385    "*Groups in which to explicitly set the ham marks to some value.")
2386
2387   (gnus-define-group-parameter
2388    spam-marks
2389    :type 'list
2390    :parameter-type '(list :tag "Spam mark choices"
2391                           (set
2392                            (variable-item gnus-spam-mark)
2393                            (variable-item gnus-killed-mark)
2394                            (variable-item gnus-kill-file-mark)
2395                            (variable-item gnus-low-score-mark)))
2396
2397    :parameter-document
2398    "Marks considered spam.
2399 Such articles will be processed as spam on group exit.  When nil, the global
2400 spam-spam-marks variable takes precedence."
2401    :variable-default '((".*" ((gnus-spam-mark))))
2402    :variable-group spam
2403    :variable-document
2404    "*Groups in which to explicitly set the spam marks to some value."))
2405
2406 (defcustom gnus-group-uncollapsed-levels 1
2407   "Number of group name elements to leave alone when making a short group name."
2408   :group 'gnus-group-visual
2409   :type 'integer)
2410
2411 (defcustom gnus-group-use-permanent-levels nil
2412   "*If non-nil, once you set a level, Gnus will use this level."
2413   :group 'gnus-group-levels
2414   :type 'boolean)
2415
2416 ;; Hooks.
2417
2418 (defcustom gnus-load-hook nil
2419   "A hook run while Gnus is loaded."
2420   :group 'gnus-start
2421   :type 'hook)
2422
2423 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2424   "A hook called to apply kill files to a group.
2425 This hook is intended to apply a kill file to the selected newsgroup.
2426 The function `gnus-apply-kill-file' is called by default.
2427
2428 Since a general kill file is too heavy to use only for a few
2429 newsgroups, I recommend you to use a lighter hook function.  For
2430 example, if you'd like to apply a kill file to articles which contains
2431 a string `rmgroup' in subject in newsgroup `control', you can use the
2432 following hook:
2433
2434  (setq gnus-apply-kill-hook
2435       (list
2436         (lambda ()
2437           (cond ((string-match \"control\" gnus-newsgroup-name)
2438                  (gnus-kill \"Subject\" \"rmgroup\")
2439                  (gnus-expunge \"X\"))))))"
2440   :group 'gnus-score-kill
2441   :options '(gnus-apply-kill-file)
2442   :type 'hook)
2443
2444 (defcustom gnus-group-change-level-function nil
2445   "Function run when a group level is changed.
2446 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2447   :group 'gnus-group-levels
2448   :type '(choice (const nil)
2449                  function))
2450
2451 ;;; Face thingies.
2452
2453 (defcustom gnus-visual
2454   '(summary-highlight group-highlight article-highlight
2455                       mouse-face
2456                       summary-menu group-menu article-menu
2457                       tree-highlight menu highlight
2458                       browse-menu server-menu
2459                       page-marker tree-menu binary-menu pick-menu)
2460   "*Enable visual features.
2461 If `visual' is disabled, there will be no menus and few faces.  Most of
2462 the visual customization options below will be ignored.  Gnus will use
2463 less space and be faster as a result.
2464
2465 This variable can also be a list of visual elements to switch on.  For
2466 instance, to switch off all visual things except menus, you can say:
2467
2468    (setq gnus-visual '(menu))
2469
2470 Valid elements include `summary-highlight', `group-highlight',
2471 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2472 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2473 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2474   :group 'gnus-meta
2475   :group 'gnus-visual
2476   :type '(set (const summary-highlight)
2477               (const group-highlight)
2478               (const article-highlight)
2479               (const mouse-face)
2480               (const summary-menu)
2481               (const group-menu)
2482               (const article-menu)
2483               (const tree-highlight)
2484               (const menu)
2485               (const highlight)
2486               (const browse-menu)
2487               (const server-menu)
2488               (const page-marker)
2489               (const tree-menu)
2490               (const binary-menu)
2491               (const pick-menu)))
2492
2493 ;; Byte-compiler warning.
2494 (defvar gnus-visual)
2495 ;; Find out whether the gnus-visual TYPE is wanted.
2496 (defun gnus-visual-p (&optional type class)
2497   (and gnus-visual                      ; Has to be non-nil, at least.
2498        (if (not type)                   ; We don't care about type.
2499            gnus-visual
2500          (if (listp gnus-visual)        ; It's a list, so we check it.
2501              (or (memq type gnus-visual)
2502                  (memq class gnus-visual))
2503            t))))
2504
2505 (defcustom gnus-mouse-face
2506   (condition-case ()
2507       (if (gnus-visual-p 'mouse-face 'highlight)
2508           (if (boundp 'gnus-mouse-face)
2509               (or gnus-mouse-face 'highlight)
2510             'highlight)
2511         'default)
2512     (error 'highlight))
2513   "*Face used for group or summary buffer mouse highlighting.
2514 The line beneath the mouse pointer will be highlighted with this
2515 face."
2516   :group 'gnus-visual
2517   :type 'face)
2518
2519 (defcustom gnus-article-save-directory gnus-directory
2520   "*Name of the directory articles will be saved in (default \"~/News\")."
2521   :group 'gnus-article-saving
2522   :type 'directory)
2523
2524 (defvar gnus-plugged t
2525   "Whether Gnus is plugged or not.")
2526
2527 (defcustom gnus-agent-cache t
2528   "Controls use of the agent cache while plugged.
2529 When set, Gnus will prefer using the locally stored content rather
2530 than re-fetching it from the server.  You also need to enable
2531 `gnus-agent' for this to have any affect."
2532   :version "22.1"
2533   :group 'gnus-agent
2534   :type 'boolean)
2535
2536 (defcustom gnus-default-charset 'undecided
2537   "Default charset assumed to be used when viewing non-ASCII characters.
2538 This variable is overridden on a group-to-group basis by the
2539 `gnus-group-charset-alist' variable and is only used on groups not
2540 covered by that variable."
2541   :type 'symbol
2542   :group 'gnus-charset)
2543
2544 ;; Fixme: Doc reference to agent.
2545 (defcustom gnus-agent t
2546   "Whether we want to use the Gnus agent or not.
2547
2548 You may customize gnus-agent to disable its use.  However, some
2549 back ends have started to use the agent as a client-side cache.
2550 Disabling the agent may result in noticeable loss of performance."
2551   :version "22.1"
2552   :group 'gnus-agent
2553   :type 'boolean)
2554
2555 (defcustom gnus-other-frame-function 'gnus
2556   "Function called by the command `gnus-other-frame'."
2557   :group 'gnus-start
2558   :type '(choice (function-item gnus)
2559                  (function-item gnus-no-server)
2560                  (function-item gnus-slave)
2561                  (function-item gnus-slave-no-server)))
2562
2563 (defcustom gnus-other-frame-parameters nil
2564   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2565 This should be an alist for Emacs, or a plist for XEmacs."
2566   :group 'gnus-start
2567   :type (if (featurep 'xemacs)
2568             '(repeat (list :inline t :format "%v"
2569                            (symbol :tag "Property")
2570                            (sexp :tag "Value")))
2571           '(repeat (cons :format "%v"
2572                          (symbol :tag "Parameter")
2573                          (sexp :tag "Value")))))
2574
2575 (defcustom gnus-user-agent '(emacs gnus mime config mule)
2576   "Which information should be exposed in the User-Agent header.
2577
2578 Can be a list of symbols or a string.  Valid symbols are `gnus' (show
2579 Gnus version), `emacs' (show Emacs version) and `mime' (show SEMI,
2580 FLIM and APEL versions).  In addition to the Emacs version, you can
2581 add `codename' (show (S)XEmacs codename), `mule' (show Mule version
2582 and also Meadow version if it exists) or either `config' (show system
2583 configuration) or `type' (show system type).  If you set it to a
2584 string, be sure to use a valid format, see RFC 2616."
2585
2586   :version "22.1"
2587   :group 'gnus-message
2588   :type '(choice (list (set :format "%v" :inline t
2589                             (const gnus  :tag "Gnus version")
2590                             (const emacs :tag "Emacs version")
2591                             (choice :tag "system"
2592                                     (const type   :tag "system type")
2593                                     (const config :tag "system configuration"))
2594                             (const codename :tag "Emacs codename")
2595                             (const mime :tag "SEMI and FLIM versions")
2596                             (const mule
2597                                    :tag "Mule version (and Meadow version)")))
2598                  (string :format "%t:\n%v")))
2599
2600 ;; Convert old (< 2005-01-10) symbol type values:
2601 (when (symbolp gnus-user-agent)
2602   (setq gnus-user-agent
2603         (cond ((eq gnus-user-agent 'gnus-mime-edit)
2604                '(emacs gnus mime config mule))
2605               ((eq gnus-user-agent 'emacs-gnus-config)
2606                '(emacs gnus config))
2607               ((eq gnus-user-agent 'emacs-gnus-type)
2608                '(emacs gnus type))
2609               ((eq gnus-user-agent 'emacs-gnus)
2610                '(emacs gnus))
2611               ((eq gnus-user-agent 'gnus)
2612                '(gnus))
2613               (t gnus-user-agent)))
2614   (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2615   (sit-for 1)
2616   (if (get 'gnus-user-agent 'saved-value)
2617       (customize-save-variable 'gnus-user-agent gnus-user-agent)
2618     (gnus-message 1 "Edit your init file to make this change permanent.")
2619     (sit-for 2)))
2620
2621 \f
2622 ;;; Internal variables
2623
2624 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2625 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2626 (defvar gnus-agent-method-p-cache nil
2627   ; Reset each time gnus-agent-covered-methods is changed else
2628   ; gnus-agent-method-p may mis-report a methods status.
2629   )
2630 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2631 (defvar gnus-draft-meta-information-header "X-Draft-From")
2632 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2633 (defvar gnus-original-article-buffer " *Original Article*")
2634 (defvar gnus-newsgroup-name nil)
2635 (defvar gnus-ephemeral-servers nil)
2636 (defvar gnus-server-method-cache nil)
2637
2638 (defvar gnus-agent-fetching nil
2639   "Whether Gnus agent is in fetching mode.")
2640
2641 (defvar gnus-agent-covered-methods nil
2642   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2643
2644 (defvar gnus-command-method nil
2645   "Dynamically bound variable that says what the current back end is.")
2646
2647 (defvar gnus-current-select-method nil
2648   "The current method for selecting a newsgroup.")
2649
2650 (defvar gnus-tree-buffer "*Tree*"
2651   "Buffer where Gnus thread trees are displayed.")
2652
2653 ;; Dummy variable.
2654 (defvar gnus-use-generic-from nil)
2655
2656 ;; Variable holding the user answers to all method prompts.
2657 (defvar gnus-method-history nil)
2658
2659 ;; Variable holding the user answers to all mail method prompts.
2660 (defvar gnus-mail-method-history nil)
2661
2662 ;; Variable holding the user answers to all group prompts.
2663 (defvar gnus-group-history nil)
2664
2665 (defvar gnus-server-alist nil
2666   "List of available servers.")
2667
2668 (defcustom gnus-cache-directory
2669   (nnheader-concat gnus-directory "cache/")
2670   "*The directory where cached articles will be stored."
2671   :group 'gnus-cache
2672   :type 'directory)
2673
2674 (defvar gnus-predefined-server-alist
2675   `(("cache"
2676      nnspool "cache"
2677      (nnspool-spool-directory ,gnus-cache-directory)
2678      (nnspool-nov-directory ,gnus-cache-directory)
2679      (nnspool-active-file
2680       ,(nnheader-concat gnus-cache-directory "active"))))
2681   "List of predefined (convenience) servers.")
2682
2683 (defvar gnus-topic-indentation "");; Obsolete variable.
2684
2685 (defconst gnus-article-mark-lists
2686   '((marked . tick) (replied . reply)
2687     (expirable . expire) (killed . killed)
2688     (bookmarks . bookmark) (dormant . dormant)
2689     (scored . score) (saved . save)
2690     (cached . cache) (downloadable . download)
2691     (unsendable . unsend) (forwarded . forward)
2692     (recent . recent) (seen . seen)))
2693
2694 (defconst gnus-article-special-mark-lists
2695   '((seen range)
2696     (killed range)
2697     (bookmark tuple)
2698     (score tuple)))
2699
2700 ;; Propagate flags to server, with the following exceptions:
2701 ;; `seen' is private to each gnus installation
2702 ;; `cache' is a internal gnus flag for each gnus installation
2703 ;; `download' is a agent flag private to each gnus installation
2704 ;; `unsend' are for nndraft groups only
2705 ;; `score' is not a proper mark
2706 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2707 (defconst gnus-article-unpropagated-mark-lists
2708   '(seen cache download unsend score bookmark)
2709   "Marks that shouldn't be propagated to back ends.
2710 Typical marks are those that make no sense in a standalone back end,
2711 such as a mark that says whether an article is stored in the cache
2712 \(which doesn't make sense in a standalone back end).")
2713
2714 (defvar gnus-headers-retrieved-by nil)
2715 (defvar gnus-article-reply nil)
2716 (defvar gnus-override-method nil)
2717 (defvar gnus-opened-servers nil)
2718
2719 (defvar gnus-current-kill-article nil)
2720
2721 (defvar gnus-have-read-active-file nil)
2722
2723 (defconst gnus-maintainer
2724   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2725   "The mail address of the T-gnus maintainers.")
2726
2727 (defcustom gnus-info-filename nil
2728   "*Controls language of gnus Info.
2729 If nil and current-language-environment is Japanese, go to gnus-ja.
2730 Otherwise go to corresponding Info.
2731 This variable can be nil, gnus or gnus-ja."
2732   :group 'gnus-start
2733   :type '(choice (const nil)
2734                  (const :tag "English" gnus)
2735                  (const :tag "Japanese" gnus-ja)))
2736
2737 (defvar gnus-info-nodes
2738   '((gnus-group-mode "Group Buffer")
2739     (gnus-summary-mode "Summary Buffer")
2740     (gnus-article-mode "Article Buffer")
2741     (gnus-server-mode "Server Buffer")
2742     (gnus-browse-mode "Browse Foreign Server")
2743     (gnus-tree-mode "Tree Display"))
2744   "Alist of major modes and related Info nodes.")
2745
2746 (defvar gnus-group-buffer "*Group*")
2747 (defvar gnus-summary-buffer "*Summary*")
2748 (defvar gnus-article-buffer "*Article*")
2749 (defvar gnus-server-buffer "*Server*")
2750
2751 (defvar gnus-slave nil
2752   "Whether this Gnus is a slave or not.")
2753
2754 (defvar gnus-batch-mode nil
2755   "Whether this Gnus is running in batch mode or not.")
2756
2757 (defvar gnus-variable-list
2758   '(gnus-newsrc-options gnus-newsrc-options-n
2759                         gnus-newsrc-last-checked-date
2760                         gnus-newsrc-alist gnus-server-alist
2761                         gnus-killed-list gnus-zombie-list
2762                         gnus-topic-topology gnus-topic-alist)
2763   "Gnus variables saved in the quick startup file.")
2764
2765 (defvar gnus-product-variable-file-list
2766   (let ((version (product-version (product-find 'gnus-vers))))
2767     `(("strict-cache"
2768        ((product-version ,version)
2769         (emacs-version)
2770         (correct-string-widths))
2771        binary
2772        gnus-format-specs-compiled)
2773       ("cache"
2774        ((product-version ,version)
2775         (emacs-version)
2776         (correct-string-widths))
2777        ctext
2778        gnus-format-specs)))
2779   "Alist of the methods for checking whether the contents of the T-gnus
2780 quick startup files are valid.  One is for the byte-compiled format
2781 specifications, the other is for the source form.  Each element should
2782 be a list which looks like follows:
2783
2784 \(\"FILE_NAME\"
2785  ((VARIABLE EXPECTED_VALUE_or_NIL)
2786   (VARIABLE EXPECTED_VALUE_or_NIL)
2787   ...)
2788  CODING-SYSTEM_FOR_READING_FILE
2789  SYMBOL_OF_FORMAT_SPECS)")
2790
2791 (defcustom gnus-compile-user-specs t
2792   "If non-nil, the user-defined format specs will be byte-compiled
2793 automatically.
2794 It has an effect on the values of `gnus-*-line-format-spec'."
2795   :group 'gnus
2796   :type 'boolean)
2797
2798 (defvar gnus-newsrc-alist nil
2799   "Assoc list of read articles.
2800 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2801
2802 (defvar gnus-registry-alist nil
2803   "Assoc list of registry data.
2804 gnus-registry.el will populate this if it's loaded.")
2805
2806 (defvar gnus-newsrc-hashtb nil
2807   "Hashtable of `gnus-newsrc-alist'.")
2808
2809 (defvar gnus-killed-list nil
2810   "List of killed newsgroups.")
2811
2812 (defvar gnus-killed-hashtb nil
2813   "Hash table equivalent of `gnus-killed-list'.")
2814
2815 (defvar gnus-zombie-list nil
2816   "List of almost dead newsgroups.")
2817
2818 (defvar gnus-description-hashtb nil
2819   "Descriptions of newsgroups.")
2820
2821 (defvar gnus-list-of-killed-groups nil
2822   "List of newsgroups that have recently been killed by the user.")
2823
2824 (defvar gnus-active-hashtb nil
2825   "Hashtable of active articles.")
2826
2827 (defvar gnus-moderated-hashtb nil
2828   "Hashtable of moderated newsgroups.")
2829
2830 ;; Save window configuration.
2831 (defvar gnus-prev-winconf nil)
2832
2833 (defvar gnus-reffed-article-number nil)
2834
2835 ;;; Let the byte-compiler know that we know about this variable.
2836 (defvar rmail-default-rmail-file)
2837
2838 (defvar gnus-dead-summary nil)
2839
2840 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2841   "Regexp matching invalid groups.")
2842
2843 (defvar gnus-other-frame-object nil
2844   "A frame object which will be created by `gnus-other-frame'.")
2845
2846 ;;; End of variables.
2847
2848 ;; Define some autoload functions Gnus might use.
2849 (eval-and-compile
2850
2851   ;; This little mapcar goes through the list below and marks the
2852   ;; symbols in question as autoloaded functions.
2853   (mapcar
2854    (lambda (package)
2855      (let ((interactive (nth 1 (memq ':interactive package))))
2856        (mapcar
2857         (lambda (function)
2858           (let (keymap)
2859             (when (consp function)
2860               (setq keymap (car (memq 'keymap function)))
2861               (setq function (car function)))
2862             (unless (fboundp function)
2863               (autoload function (car package) nil interactive keymap))))
2864         (if (eq (nth 1 package) ':interactive)
2865             (nthcdr 3 package)
2866           (cdr package)))))
2867    '(("info" :interactive t Info-goto-node)
2868      ("pp" pp-to-string)
2869      ("ps-print" ps-print-preprint)
2870      ("message" :interactive t
2871       message-send-and-exit message-yank-original)
2872      ("babel" babel-as-string)
2873      ("nnmail" nnmail-split-fancy nnmail-article-group)
2874      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2875      ("rmailout" rmail-output rmail-output-to-rmail-file)
2876      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2877       rmail-show-message rmail-summary-exists
2878       rmail-select-summary rmail-update-summary)
2879      ("gnus-audio" :interactive t gnus-audio-play)
2880      ("gnus-xmas" gnus-xmas-splash)
2881      ("gnus-soup" :interactive t
2882       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2883       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2884      ("nnsoup" nnsoup-pack-replies)
2885      ("score-mode" :interactive t gnus-score-mode)
2886      ("gnus-mh" gnus-summary-save-article-folder
2887       gnus-Folder-save-name gnus-folder-save-name)
2888      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2889      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2890       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2891       gnus-demon-add-disconnection gnus-demon-add-handler
2892       gnus-demon-remove-handler)
2893      ("gnus-demon" :interactive t
2894       gnus-demon-init gnus-demon-cancel)
2895      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2896       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2897       gnus-face-from-file)
2898      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2899       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2900      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2901       gnus-nocem-unwanted-article-p)
2902      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2903       gnus-server-server-name)
2904      ("gnus-srvr" gnus-browse-foreign-server)
2905      ("gnus-cite" :interactive t
2906       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2907       gnus-article-hide-citation gnus-article-fill-cited-article
2908       gnus-article-hide-citation-in-followups)
2909      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2910       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2911       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2912      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2913       gnus-cache-possibly-remove-articles gnus-cache-request-article
2914       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2915       gnus-cache-enter-remove-article gnus-cached-article-p
2916       gnus-cache-open gnus-cache-close gnus-cache-update-article
2917       gnus-cache-articles-in-group)
2918      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2919       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2920      ("gnus-score" :interactive t
2921       gnus-summary-increase-score gnus-summary-set-score
2922       gnus-summary-raise-thread gnus-summary-raise-same-subject
2923       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2924       gnus-summary-lower-thread gnus-summary-lower-same-subject
2925       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2926       gnus-summary-current-score gnus-score-delta-default
2927       gnus-score-flush-cache gnus-score-close
2928       gnus-possibly-score-headers gnus-score-followup-article
2929       gnus-score-followup-thread)
2930      ("gnus-score"
2931       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2932       gnus-current-score-file-nondirectory gnus-score-adaptive
2933       gnus-score-find-trace gnus-score-file-name)
2934      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2935       gnus-score-customize)
2936      ("gnus-topic" :interactive t gnus-topic-mode)
2937      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2938       gnus-subscribe-topics)
2939      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2940      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2941      ("gnus-uu" :interactive t
2942       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2943       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2944       gnus-uu-mark-by-regexp gnus-uu-mark-all
2945       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2946       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2947       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2948       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2949       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2950       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2951       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2952       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2953      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2954       gnus-uu-unmark-thread)
2955      ("gnus-msg" (gnus-summary-send-map keymap)
2956       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2957      ("gnus-msg" :interactive t
2958       gnus-group-post-news gnus-group-mail gnus-group-news
2959       gnus-summary-post-news gnus-summary-news-other-window
2960       gnus-summary-followup gnus-summary-followup-with-original
2961       gnus-summary-cancel-article gnus-summary-supersede-article
2962       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2963       gnus-summary-mail-forward gnus-summary-mail-other-window
2964       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2965       gnus-summary-wide-reply gnus-summary-followup-to-mail
2966       gnus-summary-followup-to-mail-with-original gnus-bug
2967       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2968       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2969      ("gnus-picon" :interactive t gnus-treat-from-picon)
2970      ("smiley" :interactive t smiley-region)
2971      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2972      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2973       gnus-list-of-unread-articles gnus-list-of-read-articles
2974       gnus-offer-save-summaries gnus-make-thread-indent-array
2975       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2976       gnus-summary-skip-intangible gnus-summary-article-number
2977       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2978      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2979       gnus-group-list-groups gnus-group-first-unread-group
2980       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2981       gnus-group-setup-buffer gnus-group-get-new-news
2982       gnus-group-make-help-group gnus-group-update-group
2983       gnus-group-iterate gnus-group-group-name)
2984      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2985       gnus-backlog-remove-article)
2986      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2987       gnus-article-prepare gnus-article-set-window-start
2988       gnus-article-next-page gnus-article-prev-page
2989       gnus-request-article-this-buffer gnus-article-mode
2990       gnus-article-setup-buffer gnus-narrow-to-page
2991       gnus-article-delete-invisible-text gnus-treat-article)
2992      ("gnus-art" :interactive t
2993       gnus-article-hide-headers gnus-article-hide-boring-headers
2994       gnus-article-treat-overstrike
2995       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2996       gnus-article-display-x-face
2997       gnus-article-decode-HZ
2998       gnus-article-wash-html
2999       gnus-article-unsplit-urls
3000       gnus-article-hide-pem gnus-article-hide-signature
3001       gnus-article-strip-leading-blank-lines gnus-article-date-local
3002       gnus-article-date-original gnus-article-date-lapsed
3003       gnus-article-show-all-headers
3004       ;; gnus-article-show-all
3005       gnus-article-edit-mode gnus-article-edit-article
3006       gnus-article-edit-done article-decode-encoded-words
3007       gnus-start-date-timer gnus-stop-date-timer)
3008      ("gnus-int" gnus-request-type)
3009      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
3010       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3011       gnus-check-reasonable-setup)
3012      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
3013       gnus-dup-enter-articles)
3014      ("gnus-range" gnus-copy-sequence)
3015      ("gnus-eform" gnus-edit-form)
3016      ("gnus-move" :interactive t
3017       gnus-group-move-group-to-server gnus-change-server)
3018      ("gnus-logic" gnus-score-advanced)
3019      ("gnus-undo" gnus-undo-mode gnus-undo-register)
3020      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
3021       gnus-async-prefetch-article gnus-async-prefetch-remove-group
3022       gnus-async-halt-prefetch)
3023      ("gnus-offline"
3024       gnus-offline-setup)
3025      ("gnus-offline" :interactive t
3026       gnus-offline-toggle-plugged
3027       gnus-offline-set-unplugged-state
3028       gnus-offline-toggle-auto-hangup
3029       gnus-offline-toggle-on/off-send-mail
3030       gnus-offline-toggle-articles-to-fetch
3031       gnus-offline-set-interval-time
3032       gnus-offline-agent-expire)
3033      ("miee" :interactive t gnspool-get-news
3034       mail-spool-send news-spool-post)
3035      ("international/mw32misc" define-process-argument-editing
3036       general-process-argument-editing-function)
3037      ("gnus-agent" gnus-open-agent gnus-agent-get-function
3038       gnus-agent-save-active gnus-agent-method-p
3039       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3040       gnus-summary-set-agent-mark gnus-agent-save-group-info
3041       gnus-agent-request-article gnus-agent-retrieve-headers)
3042      ("gnus-agent" :interactive t
3043       gnus-unplugged gnus-agentize gnus-agent-batch)
3044      ("gnus-vm" :interactive t gnus-summary-save-in-vm
3045       gnus-summary-save-article-vm)
3046      ("compface" uncompface)
3047      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
3048      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
3049      ("gnus-mlspl" :interactive t gnus-group-split-setup
3050       gnus-group-split-update)
3051      ("gnus-delay" gnus-delay-initialize))))
3052
3053 ;; To search articles with Namazu.
3054 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
3055 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
3056 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
3057 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
3058
3059 ;; To make nnir groups.
3060 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
3061
3062 ;; To make shimbun groups.
3063 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
3064
3065 ;;; gnus-sum.el thingies
3066
3067 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
3068   "*The format specification of the lines in the summary buffer.
3069
3070 It works along the same lines as a normal formatting string,
3071 with some simple extensions.
3072
3073 %N   Article number, left padded with spaces (string)
3074 %S   Subject (string)
3075 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
3076 %n   Name of the poster (string)
3077 %a   Extracted name of the poster (string)
3078 %A   Extracted address of the poster (string)
3079 %F   Contents of the From: header (string)
3080 %f   Contents of the From: or To: headers (string)
3081 %x   Contents of the Xref: header (string)
3082 %D   Date of the article (string)
3083 %d   Date of the article (string) in DD-MMM format
3084 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
3085 %M   Message-id of the article (string)
3086 %r   References of the article (string)
3087 %c   Number of characters in the article (integer)
3088 %k   Pretty-printed version of the above (string)
3089      For example, \"1.2k\" or \"0.4M\".
3090 %L   Number of lines in the article (integer)
3091 %I   Indentation based on thread level (a string of spaces)
3092 %B   A complex trn-style thread tree (string)
3093      The variables `gnus-sum-thread-*' can be used for customization.
3094 %T   A string with two possible values: 80 spaces if the article
3095      is on thread level two or larger and 0 spaces on level one
3096 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
3097 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
3098 %[   Opening bracket (character, \"[\" or \"<\")
3099 %]   Closing bracket (character, \"]\" or \">\")
3100 %>   Spaces of length thread-level (string)
3101 %<   Spaces of length (- 20 thread-level) (string)
3102 %i   Article score (number)
3103 %z   Article zcore (character)
3104 %t   Number of articles under the current thread (number).
3105 %e   Whether the thread is empty or not (character).
3106 %V   Total thread score (number).
3107 %P   The line number (number).
3108 %O   Download mark (character).
3109 %*   If present, indicates desired cursor position
3110      (instead of after first colon).
3111 %u   User defined specifier.  The next character in the format string should
3112      be a letter.  Gnus will call the function gnus-user-format-function-X,
3113      where X is the letter following %u.  The function will be passed the
3114      current header as argument.  The function should return a string, which
3115      will be inserted into the summary just like information from any other
3116      summary specifier.
3117
3118 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3119 with care.  For reasons of efficiency, Gnus will compute what column
3120 these characters will end up in, and \"hard-code\" that.  This means that
3121 it is invalid to have these specs after a variable-length spec.  Well,
3122 you might not be arrested, but your summary buffer will look strange,
3123 which is bad enough.
3124
3125 The smart choice is to have these specs as far to the left as
3126 possible.
3127
3128 This restriction may disappear in later versions of Gnus.
3129
3130 General format specifiers can also be used.
3131 See Info node `(gnus)Formatting Variables'."
3132   :link '(custom-manual "(gnus)Formatting Variables")
3133   :type 'string
3134   :group 'gnus-summary-format)
3135
3136 ;;;
3137 ;;; Skeleton keymaps
3138 ;;;
3139
3140 (defun gnus-suppress-keymap (keymap)
3141   (suppress-keymap keymap)
3142   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3143     (while keys
3144       (define-key keymap (pop keys) 'undefined))))
3145
3146 (defvar gnus-article-mode-map
3147   (let ((keymap (make-sparse-keymap)))
3148     (gnus-suppress-keymap keymap)
3149     keymap))
3150 (defvar gnus-summary-mode-map
3151   (let ((keymap (make-keymap)))
3152     (gnus-suppress-keymap keymap)
3153     keymap))
3154 (defvar gnus-group-mode-map
3155   (let ((keymap (make-keymap)))
3156     (gnus-suppress-keymap keymap)
3157     keymap))
3158
3159 \f
3160
3161 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3162 ;; If you want the cursor to go somewhere else, set these two
3163 ;; functions in some startup hook to whatever you want.
3164 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3165 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3166
3167 ;;; Various macros and substs.
3168
3169 (defun gnus-header-from (header)
3170   (mail-header-from header))
3171
3172 (defmacro gnus-gethash (string hashtable)
3173   "Get hash value of STRING in HASHTABLE."
3174   `(symbol-value (intern-soft ,string ,hashtable)))
3175
3176 (defmacro gnus-gethash-safe (string hashtable)
3177   "Get hash value of STRING in HASHTABLE.
3178 Return nil if not defined."
3179   `(let ((sym (intern-soft ,string ,hashtable)))
3180      (and (boundp sym) (symbol-value sym))))
3181
3182 (defmacro gnus-sethash (string value hashtable)
3183   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3184   `(set (intern ,string ,hashtable) ,value))
3185 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3186
3187 (defmacro gnus-group-unread (group)
3188   "Get the currently computed number of unread articles in GROUP."
3189   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3190
3191 (defmacro gnus-group-entry (group)
3192   "Get the newsrc entry for GROUP."
3193   `(gnus-gethash ,group gnus-newsrc-hashtb))
3194
3195 (defmacro gnus-active (group)
3196   "Get active info on GROUP."
3197   `(gnus-gethash ,group gnus-active-hashtb))
3198
3199 (defmacro gnus-set-active (group active)
3200   "Set GROUP's active info."
3201   `(gnus-sethash ,group ,active gnus-active-hashtb))
3202
3203 ;; Info access macros.
3204
3205 (defmacro gnus-info-group (info)
3206   `(nth 0 ,info))
3207 (defmacro gnus-info-rank (info)
3208   `(nth 1 ,info))
3209 (defmacro gnus-info-read (info)
3210   `(nth 2 ,info))
3211 (defmacro gnus-info-marks (info)
3212   `(nth 3 ,info))
3213 (defmacro gnus-info-method (info)
3214   `(nth 4 ,info))
3215 (defmacro gnus-info-params (info)
3216   `(nth 5 ,info))
3217
3218 (defmacro gnus-info-level (info)
3219   `(let ((rank (gnus-info-rank ,info)))
3220      (if (consp rank)
3221          (car rank)
3222        rank)))
3223 (defmacro gnus-info-score (info)
3224   `(let ((rank (gnus-info-rank ,info)))
3225      (or (and (consp rank) (cdr rank)) 0)))
3226
3227 (defmacro gnus-info-set-group (info group)
3228   `(setcar ,info ,group))
3229 (defmacro gnus-info-set-rank (info rank)
3230   `(setcar (nthcdr 1 ,info) ,rank))
3231 (defmacro gnus-info-set-read (info read)
3232   `(setcar (nthcdr 2 ,info) ,read))
3233 (defmacro gnus-info-set-marks (info marks &optional extend)
3234   (if extend
3235       `(gnus-info-set-entry ,info ,marks 3)
3236     `(setcar (nthcdr 3 ,info) ,marks)))
3237 (defmacro gnus-info-set-method (info method &optional extend)
3238   (if extend
3239       `(gnus-info-set-entry ,info ,method 4)
3240     `(setcar (nthcdr 4 ,info) ,method)))
3241 (defmacro gnus-info-set-params (info params &optional extend)
3242   (if extend
3243       `(gnus-info-set-entry ,info ,params 5)
3244     `(setcar (nthcdr 5 ,info) ,params)))
3245
3246 (defun gnus-info-set-entry (info entry number)
3247   ;; Extend the info until we have enough elements.
3248   (while (<= (length info) number)
3249     (nconc info (list nil)))
3250   ;; Set the entry.
3251   (setcar (nthcdr number info) entry))
3252
3253 (defmacro gnus-info-set-level (info level)
3254   `(let ((rank (cdr ,info)))
3255      (if (consp (car rank))
3256          (setcar (car rank) ,level)
3257        (setcar rank ,level))))
3258 (defmacro gnus-info-set-score (info score)
3259   `(let ((rank (cdr ,info)))
3260      (if (consp (car rank))
3261          (setcdr (car rank) ,score)
3262        (setcar rank (cons (car rank) ,score)))))
3263
3264 (defmacro gnus-get-info (group)
3265   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3266
3267 ;;; Load the compatibility functions.
3268
3269 (require 'gnus-ems)
3270
3271 \f
3272 ;;;
3273 ;;; Shutdown
3274 ;;;
3275
3276 (defvar gnus-shutdown-alist nil)
3277
3278 (defun gnus-add-shutdown (function &rest symbols)
3279   "Run FUNCTION whenever one of SYMBOLS is shut down."
3280   (push (cons function symbols) gnus-shutdown-alist))
3281
3282 (defun gnus-shutdown (symbol)
3283   "Shut down everything that waits for SYMBOL."
3284   (dolist (entry gnus-shutdown-alist)
3285     (when (memq symbol (cdr entry))
3286       (funcall (car entry)))))
3287
3288 \f
3289 ;;;
3290 ;;; Gnus Utility Functions
3291 ;;;
3292
3293 (defun gnus-find-subscribed-addresses ()
3294   "Return a regexp matching the addresses of all subscribed mail groups.
3295 It consists of the `to-address' or `to-list' parameter of all groups
3296 with a `subscribed' parameter."
3297   (let (group address addresses)
3298     (dolist (entry (cdr gnus-newsrc-alist))
3299       (setq group (car entry))
3300       (when (gnus-parameter-subscribed group)
3301         (setq address (mail-strip-quoted-names
3302                        (or (gnus-group-fast-parameter group 'to-address)
3303                            (gnus-group-fast-parameter group 'to-list))))
3304         (when address
3305           (add-to-list 'addresses address))))
3306     (when addresses
3307       (list (mapconcat 'regexp-quote addresses "\\|")))))
3308
3309 (defmacro gnus-string-or (&rest strings)
3310   "Return the first element of STRINGS that is a non-blank string.
3311 STRINGS will be evaluated in normal `or' order."
3312   `(gnus-string-or-1 ',strings))
3313
3314 (defun gnus-string-or-1 (strings)
3315   (let (string)
3316     (while strings
3317       (setq string (eval (pop strings)))
3318       (if (string-match "^[ \t]*$" string)
3319           (setq string nil)
3320         (setq strings nil)))
3321     string))
3322
3323 (defun gnus-info-find-node (&optional nodename)
3324   "Find Info documentation of Gnus."
3325   (interactive)
3326   ;; Enlarge info window if needed.
3327   (let (gnus-info-buffer)
3328     (Info-goto-node
3329      (format "(%s)%s"
3330              (or gnus-info-filename
3331                  (get-language-info current-language-environment 'gnus-info)
3332                  "gnus")
3333              (or nodename
3334                  (cadr (assq major-mode gnus-info-nodes))
3335                  (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3336                       (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3337     (setq gnus-info-buffer (current-buffer))
3338     (gnus-configure-windows 'info)))
3339
3340 ;;;
3341 ;;; gnus-interactive
3342 ;;;
3343
3344 (defvar gnus-current-prefix-symbol nil
3345   "Current prefix symbol.")
3346
3347 (defvar gnus-current-prefix-symbols nil
3348   "List of current prefix symbols.")
3349
3350 (defun gnus-interactive (string &optional params)
3351   "Return a list that can be fed to `interactive'.
3352 See `interactive' for full documentation.
3353
3354 Adds the following specs:
3355
3356 y -- The current symbolic prefix.
3357 Y -- A list of the current symbolic prefix(es).
3358 A -- Article number.
3359 H -- Article header.
3360 g -- Group name."
3361   (let ((i 0)
3362         out c prompt)
3363     (while (< i (length string))
3364       (string-match ".\\([^\n]*\\)\n?" string i)
3365       (setq c (aref string i))
3366       (when (match-end 1)
3367         (setq prompt (match-string 1 string)))
3368       (setq i (match-end 0))
3369       ;; We basically emulate just about everything that
3370       ;; `interactive' does, but add the specs listed above.
3371       (push
3372        (cond
3373         ((= c ?a)
3374          (completing-read prompt obarray 'fboundp t))
3375         ((= c ?b)
3376          (read-buffer prompt (current-buffer) t))
3377         ((= c ?B)
3378          (read-buffer prompt (other-buffer (current-buffer))))
3379         ((= c ?c)
3380          (read-char))
3381         ((= c ?C)
3382          (completing-read prompt obarray 'commandp t))
3383         ((= c ?d)
3384          (point))
3385         ((= c ?D)
3386          (read-file-name prompt nil default-directory 'lambda))
3387         ((= c ?f)
3388          (read-file-name prompt nil nil 'lambda))
3389         ((= c ?F)
3390          (read-file-name prompt))
3391         ((= c ?k)
3392          (read-key-sequence prompt))
3393         ((= c ?K)
3394          (error "Not implemented spec"))
3395         ((= c ?e)
3396          (error "Not implemented spec"))
3397         ((= c ?m)
3398          (mark))
3399         ((= c ?N)
3400          (error "Not implemented spec"))
3401         ((= c ?n)
3402          (string-to-number (read-from-minibuffer prompt)))
3403         ((= c ?p)
3404          (prefix-numeric-value current-prefix-arg))
3405         ((= c ?P)
3406          current-prefix-arg)
3407         ((= c ?r)
3408          'gnus-prefix-nil)
3409         ((= c ?s)
3410          (read-string prompt))
3411         ((= c ?S)
3412          (intern (read-string prompt)))
3413         ((= c ?v)
3414          (read-variable prompt))
3415         ((= c ?x)
3416          (read-minibuffer prompt))
3417         ((= c ?x)
3418          (eval-minibuffer prompt))
3419         ;; And here the new specs come.
3420         ((= c ?y)
3421          gnus-current-prefix-symbol)
3422         ((= c ?Y)
3423          gnus-current-prefix-symbols)
3424         ((= c ?g)
3425          (gnus-group-group-name))
3426         ((= c ?A)
3427          (gnus-summary-skip-intangible)
3428          (or (get-text-property (point) 'gnus-number)
3429              (gnus-summary-last-subject)))
3430         ((= c ?H)
3431          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3432         (t
3433          (error "Non-implemented spec")))
3434        out)
3435       (cond
3436        ((= c ?r)
3437         (push (if (< (point) (mark)) (point) (mark)) out)
3438         (push (if (> (point) (mark)) (point) (mark)) out))))
3439     (setq out (delq 'gnus-prefix-nil out))
3440     (nreverse out)))
3441
3442 (defun gnus-symbolic-argument (&optional arg)
3443   "Read a symbolic argument and a command, and then execute command."
3444   (interactive "P")
3445   (let* ((in-command (this-command-keys))
3446          (command in-command)
3447          gnus-current-prefix-symbols
3448          gnus-current-prefix-symbol
3449          syms)
3450     (while (equal in-command command)
3451       (message "%s-" (key-description (this-command-keys)))
3452       (push (intern (char-to-string (read-char))) syms)
3453       (setq command (read-key-sequence nil t)))
3454     (setq gnus-current-prefix-symbols (nreverse syms)
3455           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3456     (call-interactively (key-binding command t))))
3457
3458 ;;; More various functions.
3459
3460 (defsubst gnus-check-backend-function (func group)
3461   "Check whether GROUP supports function FUNC.
3462 GROUP can either be a string (a group name) or a select method."
3463   (ignore-errors
3464     (let ((method (if (stringp group)
3465                       (car (gnus-find-method-for-group group))
3466                     group)))
3467       (unless (featurep method)
3468         (require method))
3469       (fboundp (intern (format "%s-%s" method func))))))
3470
3471 (defun gnus-group-read-only-p (&optional group)
3472   "Check whether GROUP supports editing or not.
3473 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3474 that that variable is buffer-local to the summary buffers."
3475   (let ((group (or group gnus-newsgroup-name)))
3476     (not (gnus-check-backend-function 'request-replace-article group))))
3477
3478 (defun gnus-virtual-group-p (group)
3479   "Say whether GROUP is virtual or not."
3480   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3481                         gnus-valid-select-methods)))
3482
3483 (defun gnus-news-group-p (group &optional article)
3484   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3485   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3486          t)                             ;is news of course.
3487         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3488          nil)                           ;must be mail then.
3489         ((vectorp article)              ;Has header info.
3490          (eq (gnus-request-type group (mail-header-id article)) 'news))
3491         ((null article)                 ;Hasn't header info
3492          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3493         ((< article 0)                  ;Virtual message
3494          nil)                           ;we don't know, guess mail.
3495         (t                              ;Has positive number
3496          (eq (gnus-request-type group article) 'news)))) ;use it.
3497
3498 ;; Returns a list of writable groups.
3499 (defun gnus-writable-groups ()
3500   (let ((alist gnus-newsrc-alist)
3501         groups group)
3502     (while (setq group (car (pop alist)))
3503       (unless (gnus-group-read-only-p group)
3504         (push group groups)))
3505     (nreverse groups)))
3506
3507 ;; Check whether to use long file names.
3508 (defun gnus-use-long-file-name (symbol)
3509   ;; The variable has to be set...
3510   (and gnus-use-long-file-name
3511        ;; If it isn't a list, then we return t.
3512        (or (not (listp gnus-use-long-file-name))
3513            ;; If it is a list, and the list contains `symbol', we
3514            ;; return nil.
3515            (not (memq symbol gnus-use-long-file-name)))))
3516
3517 ;; Generate a unique new group name.
3518 (defun gnus-generate-new-group-name (leaf)
3519   (let ((name leaf)
3520         (num 0))
3521     (while (gnus-group-entry name)
3522       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3523     name))
3524
3525 (defun gnus-ephemeral-group-p (group)
3526   "Say whether GROUP is ephemeral or not."
3527   (gnus-group-get-parameter group 'quit-config t))
3528
3529 (defun gnus-group-quit-config (group)
3530   "Return the quit-config of GROUP."
3531   (gnus-group-get-parameter group 'quit-config t))
3532
3533 (defun gnus-kill-ephemeral-group (group)
3534   "Remove ephemeral GROUP from relevant structures."
3535   (gnus-sethash group nil gnus-newsrc-hashtb))
3536
3537 (defun gnus-simplify-mode-line ()
3538   "Make mode lines a bit simpler."
3539   (setq mode-line-modified (cdr gnus-mode-line-modified))
3540   (when (listp mode-line-format)
3541     (make-local-variable 'mode-line-format)
3542     (setq mode-line-format (copy-sequence mode-line-format))
3543     (when (equal (nth 3 mode-line-format) "   ")
3544       (setcar (nthcdr 3 mode-line-format) " "))))
3545
3546 ;;; Servers and groups.
3547
3548 (defsubst gnus-server-add-address (method)
3549   (let ((method-name (symbol-name (car method))))
3550     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3551              (not (assq (intern (concat method-name "-address")) method))
3552              (memq 'physical-address (assq (car method)
3553                                            gnus-valid-select-methods)))
3554         (append method (list (list (intern (concat method-name "-address"))
3555                                    (nth 1 method))))
3556       method)))
3557
3558 (defsubst gnus-method-to-server (method)
3559   (catch 'server-name
3560     (setq method (or method gnus-select-method))
3561
3562     ;; Perhaps it is already in the cache.
3563     (mapc (lambda (name-method)
3564             (if (equal (cdr name-method) method)
3565                 (throw 'server-name (car name-method))))
3566           gnus-server-method-cache)
3567
3568     (mapc
3569      (lambda (server-alist)
3570        (mapc (lambda (name-method)
3571                (when (gnus-methods-equal-p (cdr name-method) method)
3572                  (unless (member name-method gnus-server-method-cache)
3573                    (push name-method gnus-server-method-cache))
3574                  (throw 'server-name (car name-method))))
3575              server-alist))
3576      (list gnus-server-alist
3577            gnus-predefined-server-alist))
3578
3579     (let* ((name (if (member (cadr method) '(nil ""))
3580                      (format "%s" (car method))
3581                    (format "%s:%s" (car method) (cadr method))))
3582            (name-method (cons name method)))
3583       (unless (member name-method gnus-server-method-cache)
3584         (push name-method gnus-server-method-cache))
3585       name)))
3586
3587 (defsubst gnus-server-to-method (server)
3588   "Map virtual server names to select methods."
3589   (or (and server (listp server) server)
3590       (cdr (assoc server gnus-server-method-cache))
3591       (let ((result
3592              (or
3593               ;; Perhaps this is the native server?
3594               (and (equal server "native") gnus-select-method)
3595               ;; It should be in the server alist.
3596               (cdr (assoc server gnus-server-alist))
3597               ;; It could be in the predefined server alist.
3598               (cdr (assoc server gnus-predefined-server-alist))
3599               ;; If not, we look through all the opened server
3600               ;; to see whether we can find it there.
3601               (let ((opened gnus-opened-servers))
3602                 (while (and opened
3603                             (not (equal server (format "%s:%s" (caaar opened)
3604                                                        (cadaar opened)))))
3605                   (pop opened))
3606                 (caar opened))
3607               ;; It could be a named method, search all servers
3608               (let ((servers gnus-secondary-select-methods))
3609                 (while (and servers
3610                             (not (equal server (format "%s:%s" (caar servers)
3611                                                        (cadar servers)))))
3612                   (pop servers))
3613                 (car servers))
3614               ;; This could be some sort of foreign server that I
3615               ;; simply haven't opened (yet).  Do a brute-force scan
3616               ;; of the entire gnus-newsrc-alist for the server name
3617               ;; of every method.  As a side-effect, loads the
3618               ;; gnus-server-method-cache so this only happens once,
3619               ;; if at all.
3620               (let (match)
3621                 (mapcar
3622                  (lambda (info)
3623                    (let ((info-method (gnus-info-method info)))
3624                      (unless (stringp info-method)
3625                        (let ((info-server (gnus-method-to-server info-method)))
3626                          (when (equal server info-server)
3627                            (setq match info-method))))))
3628                  (cdr gnus-newsrc-alist))
3629                 match))))
3630         (when result
3631           (push (cons server result) gnus-server-method-cache))
3632         result)))
3633
3634 (defsubst gnus-server-get-method (group method)
3635   ;; Input either a server name, and extended server name, or a
3636   ;; select method, and return a select method.
3637   (cond ((stringp method)
3638          (gnus-server-to-method method))
3639         ((equal method gnus-select-method)
3640          gnus-select-method)
3641         ((and (stringp (car method))
3642               group)
3643          (gnus-server-extend-method group method))
3644         ((and method
3645               (not group)
3646               (equal (cadr method) ""))
3647          method)
3648         (t
3649          (gnus-server-add-address method))))
3650
3651 (defmacro gnus-method-equal (ss1 ss2)
3652   "Say whether two servers are equal."
3653   `(let ((s1 ,ss1)
3654          (s2 ,ss2))
3655      (or (equal s1 s2)
3656          (and (= (length s1) (length s2))
3657               (progn
3658                 (while (and s1 (member (car s1) s2))
3659                   (setq s1 (cdr s1)))
3660                 (null s1))))))
3661
3662 (defun gnus-methods-equal-p (m1 m2)
3663   (let ((m1 (or m1 gnus-select-method))
3664         (m2 (or m2 gnus-select-method)))
3665     (or (equal m1 m2)
3666         (and (eq (car m1) (car m2))
3667              (or (not (memq 'address (assoc (symbol-name (car m1))
3668                                             gnus-valid-select-methods)))
3669                  (equal (nth 1 m1) (nth 1 m2)))))))
3670
3671 (defun gnus-server-equal (m1 m2)
3672   "Say whether two methods are equal."
3673   (let ((m1 (cond ((null m1) gnus-select-method)
3674                   ((stringp m1) (gnus-server-to-method m1))
3675                   (t m1)))
3676         (m2 (cond ((null m2) gnus-select-method)
3677                   ((stringp m2) (gnus-server-to-method m2))
3678                   (t m2))))
3679     (gnus-method-equal m1 m2)))
3680
3681 (defun gnus-servers-using-backend (backend)
3682   "Return a list of known servers using BACKEND."
3683   (let ((opened gnus-opened-servers)
3684         out)
3685     (while opened
3686       (when (eq backend (caaar opened))
3687         (push (caar opened) out))
3688       (pop opened))
3689     out))
3690
3691 (defun gnus-archive-server-wanted-p ()
3692   "Say whether the user wants to use the archive server."
3693   (cond
3694    ((or (not gnus-message-archive-method)
3695         (not gnus-message-archive-group))
3696     nil)
3697    ((and gnus-message-archive-method gnus-message-archive-group)
3698     t)
3699    (t
3700     (let ((active (cadr (assq 'nnfolder-active-file
3701                               gnus-message-archive-method))))
3702       (and active
3703            (file-exists-p active))))))
3704
3705 (defsubst gnus-method-to-server-name (method)
3706   (concat
3707    (format "%s" (car method))
3708    (when (and
3709           (or (assoc (format "%s" (car method))
3710                      (gnus-methods-using 'address))
3711               (gnus-server-equal method gnus-message-archive-method))
3712           (nth 1 method)
3713           (not (string= (nth 1 method) "")))
3714      (concat "+" (nth 1 method)))))
3715
3716 (defsubst gnus-method-to-full-server-name (method)
3717   (format "%s+%s" (car method) (nth 1 method)))
3718
3719 (defun gnus-group-prefixed-name (group method &optional full)
3720   "Return the whole name from GROUP and METHOD.
3721 Call with full set to get the fully qualified group name (even if the
3722 server is native)."
3723   (when (stringp method)
3724     (setq method (gnus-server-to-method method)))
3725   (if (or (not method)
3726           (and (not full) (gnus-server-equal method "native"))
3727           ;;;!!! This might not be right.  We'll see...
3728           ;(string-match ":" group)
3729           )
3730       group
3731     (concat (gnus-method-to-server-name method) ":" group)))
3732
3733 (defun gnus-group-guess-prefixed-name (group)
3734   "Guess the whole name from GROUP and METHOD."
3735   (gnus-group-prefixed-name group (gnus-find-method-for-group
3736                                group)))
3737
3738 (defun gnus-group-full-name (group method)
3739   "Return the full name from GROUP and METHOD, even if the method is native."
3740   (gnus-group-prefixed-name group method t))
3741
3742 (defun gnus-group-guess-full-name (group)
3743   "Guess the full name from GROUP, even if the method is native."
3744   (if (gnus-group-prefixed-p group)
3745       group
3746     (gnus-group-full-name group (gnus-find-method-for-group group))))
3747
3748 (defun gnus-group-guess-full-name-from-command-method (group)
3749   "Guess the full name from GROUP, even if the method is native."
3750   (if (gnus-group-prefixed-p group)
3751       group
3752     (gnus-group-full-name group gnus-command-method)))
3753
3754 (defun gnus-group-real-prefix (group)
3755   "Return the prefix of the current group name."
3756   (if (stringp group)
3757       (if (string-match "^[^:]+:" group)
3758           (substring group 0 (match-end 0))
3759         "")
3760     nil))
3761
3762 (defun gnus-group-short-name (group)
3763   "Return the short group name."
3764   (let ((prefix (gnus-group-real-prefix group)))
3765     (if (< 0 (length prefix))
3766         (substring group (length prefix) nil)
3767       group)))
3768
3769 (defun gnus-group-prefixed-p (group)
3770   "Return the prefix of the current group name."
3771   (< 0 (length (gnus-group-real-prefix group))))
3772
3773 (defun gnus-summary-buffer-name (group)
3774   "Return the summary buffer name of GROUP."
3775   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3776
3777 (defun gnus-group-method (group)
3778   "Return the server or method used for selecting GROUP.
3779 You should probably use `gnus-find-method-for-group' instead."
3780   (let ((prefix (gnus-group-real-prefix group)))
3781     (if (equal prefix "")
3782         gnus-select-method
3783       (let ((servers gnus-opened-servers)
3784             (server "")
3785             backend possible found)
3786         (if (string-match "^[^\\+]+\\+" prefix)
3787             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3788                   server (substring prefix (match-end 0) (1- (length prefix))))
3789           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3790         (while servers
3791           (when (eq (caaar servers) backend)
3792             (setq possible (caar servers))
3793             (when (equal (cadaar servers) server)
3794               (setq found (caar servers))))
3795           (pop servers))
3796         (or (car (rassoc found gnus-server-alist))
3797             found
3798             (car (rassoc possible gnus-server-alist))
3799             possible
3800             (list backend server))))))
3801
3802 (defsubst gnus-native-method-p (method)
3803   "Return whether METHOD is the native select method."
3804   (gnus-method-equal method gnus-select-method))
3805
3806 (defsubst gnus-secondary-method-p (method)
3807   "Return whether METHOD is a secondary select method."
3808   (let ((methods gnus-secondary-select-methods)
3809         (gmethod (inline (gnus-server-get-method nil method))))
3810     (while (and methods
3811                 (not (gnus-method-equal
3812                       (inline (gnus-server-get-method nil (car methods)))
3813                       gmethod)))
3814       (setq methods (cdr methods)))
3815     methods))
3816
3817 (defun gnus-method-simplify (method)
3818   "Return the shortest uniquely identifying string or method for METHOD."
3819   (cond ((stringp method)
3820          method)
3821         ((gnus-native-method-p method)
3822          nil)
3823         ((gnus-secondary-method-p method)
3824          (format "%s:%s" (nth 0 method) (nth 1 method)))
3825         (t
3826          method)))
3827
3828 (defun gnus-groups-from-server (server)
3829   "Return a list of all groups that are fetched from SERVER."
3830   (let ((alist (cdr gnus-newsrc-alist))
3831         info groups)
3832     (while (setq info (pop alist))
3833       (when (gnus-server-equal (gnus-info-method info) server)
3834         (push (gnus-info-group info) groups)))
3835     (sort groups 'string<)))
3836
3837 (defun gnus-group-foreign-p (group)
3838   "Say whether a group is foreign or not."
3839   (and (not (gnus-group-native-p group))
3840        (not (gnus-group-secondary-p group))))
3841
3842 (defun gnus-group-native-p (group)
3843   "Say whether the group is native or not."
3844   (not (string-match ":" group)))
3845
3846 (defun gnus-group-secondary-p (group)
3847   "Say whether the group is secondary or not."
3848   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3849
3850 (defun gnus-parameters-get-parameter (group)
3851   "Return the group parameters for GROUP from `gnus-parameters'."
3852   (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3853                               case-fold-search
3854                             gnus-parameters-case-fold-search))
3855         params-list)
3856     (dolist (elem gnus-parameters)
3857       (when (string-match (car elem) group)
3858         (setq params-list
3859               (nconc (gnus-expand-group-parameters
3860                       (car elem) (cdr elem) group)
3861                      params-list))))
3862     params-list))
3863
3864 (defun gnus-expand-group-parameter (match value group)
3865   "Use MATCH to expand VALUE in GROUP."
3866   (with-temp-buffer
3867     (insert group)
3868     (goto-char (point-min))
3869     (while (re-search-forward match nil t)
3870       (replace-match value))
3871     (buffer-string)))
3872
3873 (defun gnus-expand-group-parameters (match parameters group)
3874   "Go through PARAMETERS and expand them according to the match data."
3875   (let (new)
3876     (dolist (elem parameters)
3877       (if (and (stringp (cdr elem))
3878                (string-match "\\\\[0-9&]" (cdr elem)))
3879           (push (cons (car elem)
3880                       (gnus-expand-group-parameter match (cdr elem) group))
3881                 new)
3882         (push elem new)))
3883     new))
3884
3885 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3886   "For GROUP, return the value of SYMBOL.
3887
3888 You should call this in the `gnus-group-buffer' buffer.
3889 The function `gnus-group-find-parameter' will do that for you."
3890   ;; The speed trick:  No cons'ing and quit early.
3891   (let* ((params (funcall gnus-group-get-parameter-function group))
3892          ;; Start easy, check the "real" group parameters.
3893          (simple-results
3894           (gnus-group-parameter-value params symbol allow-list t)))
3895     (if simple-results
3896         ;; Found results; return them.
3897         (car simple-results)
3898       ;; We didn't found it there, try `gnus-parameters'.
3899       (let ((result nil)
3900             (head nil)
3901             (tail gnus-parameters))
3902         ;; A good old-fashioned non-cl loop.
3903         (while tail
3904           (setq head (car tail)
3905                 tail (cdr tail))
3906           ;; The car is regexp matching for matching the group name.
3907           (when (string-match (car head) group)
3908             ;; The cdr is the parameters.
3909             (setq result (gnus-group-parameter-value (cdr head)
3910                                                      symbol allow-list))
3911             (when result
3912               ;; Expand if necessary.
3913               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3914                   (setq result (gnus-expand-group-parameter (car head)
3915                                                             result group)))
3916               ;; Exit the loop early.
3917               (setq tail nil))))
3918         ;; Done.
3919         result))))
3920
3921 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3922   "Return the group parameters for GROUP.
3923 If SYMBOL, return the value of that symbol in the group parameters.
3924
3925 If you call this function inside a loop, consider using the faster
3926 `gnus-group-fast-parameter' instead."
3927   (save-excursion
3928     (set-buffer gnus-group-buffer)
3929     (if symbol
3930         (gnus-group-fast-parameter group symbol allow-list)
3931       (nconc
3932        (copy-sequence
3933         (funcall gnus-group-get-parameter-function group))
3934        (gnus-parameters-get-parameter group)))))
3935
3936 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3937   "Return the group parameters for GROUP.
3938 If SYMBOL, return the value of that symbol in the group parameters.
3939 Most functions should use `gnus-group-find-parameter', which
3940 also examines the topic parameters."
3941   (let ((params (gnus-info-params (gnus-get-info group))))
3942     (if symbol
3943         (gnus-group-parameter-value params symbol allow-list)
3944       params)))
3945
3946 (defun gnus-group-parameter-value (params symbol &optional
3947                                           allow-list present-p)
3948   "Return the value of SYMBOL in group PARAMS."
3949   ;; We only wish to return group parameters (dotted lists) and
3950   ;; not local variables, which may have the same names.
3951   ;; But first we handle single elements...
3952   (or (car (memq symbol params))
3953       ;; Handle alist.
3954       (let (elem)
3955         (catch 'found
3956           (while (setq elem (pop params))
3957             (when (and (consp elem)
3958                        (eq (car elem) symbol)
3959                        (or allow-list
3960                            (atom (cdr elem))))
3961               (throw 'found (if present-p (list (cdr elem))
3962                               (cdr elem)))))))))
3963
3964 (defun gnus-group-add-parameter (group param)
3965   "Add parameter PARAM to GROUP."
3966   (let ((info (gnus-get-info group)))
3967     (when info
3968       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3969       ;; Cons the new param to the old one and update.
3970       (gnus-group-set-info (cons param (gnus-info-params info))
3971                            group 'params))))
3972
3973 (defun gnus-group-set-parameter (group name value)
3974   "Set parameter NAME to VALUE in GROUP."
3975   (let ((info (gnus-get-info group)))
3976     (when info
3977       (gnus-group-remove-parameter group name)
3978       (let ((old-params (gnus-info-params info))
3979             (new-params (list (cons name value))))
3980         (while old-params
3981           (when (or (not (listp (car old-params)))
3982                     (not (eq (caar old-params) name)))
3983             (setq new-params (append new-params (list (car old-params)))))
3984           (setq old-params (cdr old-params)))
3985         (gnus-group-set-info new-params group 'params)))))
3986
3987 (defun gnus-group-remove-parameter (group name)
3988   "Remove parameter NAME from GROUP."
3989   (let ((info (gnus-get-info group)))
3990     (when info
3991       (let ((params (gnus-info-params info)))
3992         (when params
3993           (setq params (delq name params))
3994           (while (assq name params)
3995             (gnus-pull name params))
3996           (gnus-info-set-params info params))))))
3997
3998 (defun gnus-group-add-score (group &optional score)
3999   "Add SCORE to the GROUP score.
4000 If SCORE is nil, add 1 to the score of GROUP."
4001   (let ((info (gnus-get-info group)))
4002     (when info
4003       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
4004
4005 (defun gnus-short-group-name (group &optional levels)
4006   "Collapse GROUP name LEVELS.
4007 Select methods are stripped and any remote host name is stripped down to
4008 just the host name."
4009   (let* ((name "")
4010          (foreign "")
4011          (depth 0)
4012          (skip 1)
4013          (levels (or levels
4014                      gnus-group-uncollapsed-levels
4015                      (progn
4016                        (while (string-match "\\." group skip)
4017                          (setq skip (match-end 0)
4018                                depth (+ depth 1)))
4019                        depth))))
4020     ;; Separate foreign select method from group name and collapse.
4021     ;; If method contains a server, collapse to non-domain server name,
4022     ;; otherwise collapse to select method.
4023     (let* ((colon (string-match ":" group))
4024            (server (and colon (substring group 0 colon)))
4025            (plus (and server (string-match "+" server))))
4026       (when server
4027         (if plus
4028             (setq foreign (substring server (+ 1 plus)
4029                                      (string-match "\\." server))
4030                   group (substring group (+ 1 colon)))
4031           (setq foreign server
4032                 group (substring group (+ 1 colon))))
4033         (setq foreign (concat foreign ":")))
4034       ;; Collapse group name leaving LEVELS uncollapsed elements
4035       (let* ((slist (split-string group "/"))
4036              (slen (length slist))
4037              (dlist (split-string group "\\."))
4038              (dlen (length dlist))
4039              glist
4040              glen
4041              gsep
4042              res)
4043         (if (> slen dlen)
4044             (setq glist slist
4045                   glen slen
4046                   gsep "/")
4047           (setq glist dlist
4048                 glen dlen
4049                 gsep "."))
4050         (setq levels (- glen levels))
4051         (dolist (g glist)
4052           (push (if (>= (decf levels) 0)
4053                     (if (zerop (length g))
4054                         ""
4055                       (substring g 0 1))
4056                   g)
4057                 res))
4058         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4059
4060 (defun gnus-narrow-to-body ()
4061   "Narrow to the body of an article."
4062   (narrow-to-region
4063    (progn
4064      (goto-char (point-min))
4065      (or (search-forward "\n\n" nil t)
4066          (point-max)))
4067    (point-max)))
4068
4069 \f
4070 ;;;
4071 ;;; Kill file handling.
4072 ;;;
4073
4074 (defun gnus-apply-kill-file ()
4075   "Apply a kill file to the current newsgroup.
4076 Returns the number of articles marked as read."
4077   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4078           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4079       (gnus-apply-kill-file-internal)
4080     0))
4081
4082 (defun gnus-kill-save-kill-buffer ()
4083   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4084     (when (get-file-buffer file)
4085       (save-excursion
4086         (set-buffer (get-file-buffer file))
4087         (when (buffer-modified-p)
4088           (save-buffer))
4089         (kill-buffer (current-buffer))))))
4090
4091 (defcustom gnus-kill-file-name "KILL"
4092   "Suffix of the kill files."
4093   :group 'gnus-score-kill
4094   :group 'gnus-score-files
4095   :type 'string)
4096
4097 (defun gnus-newsgroup-kill-file (newsgroup)
4098   "Return the name of a kill file name for NEWSGROUP.
4099 If NEWSGROUP is nil, return the global kill file name instead."
4100   (cond
4101    ;; The global KILL file is placed at top of the directory.
4102    ((or (null newsgroup)
4103         (string-equal newsgroup ""))
4104     (expand-file-name gnus-kill-file-name
4105                       gnus-kill-files-directory))
4106    ;; Append ".KILL" to newsgroup name.
4107    ((gnus-use-long-file-name 'not-kill)
4108     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4109                               "." gnus-kill-file-name)
4110                       gnus-kill-files-directory))
4111    ;; Place "KILL" under the hierarchical directory.
4112    (t
4113     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4114                               "/" gnus-kill-file-name)
4115                       gnus-kill-files-directory))))
4116
4117 ;;; Server things.
4118
4119 (defun gnus-member-of-valid (symbol group)
4120   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4121   (memq symbol (assoc
4122                 (symbol-name (car (gnus-find-method-for-group group)))
4123                 gnus-valid-select-methods)))
4124
4125 (defun gnus-method-option-p (method option)
4126   "Return non-nil if select METHOD has OPTION as a parameter."
4127   (when (stringp method)
4128     (setq method (gnus-server-to-method method)))
4129   (memq option (assoc (format "%s" (car method))
4130                       gnus-valid-select-methods)))
4131
4132 (defun gnus-similar-server-opened (method)
4133   (let ((opened gnus-opened-servers))
4134     (while (and method opened)
4135       (when (and (equal (cadr method) (cadaar opened))
4136                  (equal (car method) (caaar opened))
4137                  (not (equal method (caar opened))))
4138         (setq method nil))
4139       (pop opened))
4140     (not method)))
4141
4142 (defun gnus-server-extend-method (group method)
4143   ;; This function "extends" a virtual server.  If the server is
4144   ;; "hello", and the select method is ("hello" (my-var "something"))
4145   ;; in the group "alt.alt", this will result in a new virtual server
4146   ;; called "hello+alt.alt".
4147   (if (or (not (inline (gnus-similar-server-opened method)))
4148           (not (cddr method)))
4149       method
4150     `(,(car method) ,(concat (cadr method) "+" group)
4151       (,(intern (format "%s-address" (car method))) ,(cadr method))
4152       ,@(cddr method))))
4153
4154 (defun gnus-server-status (method)
4155   "Return the status of METHOD."
4156   (nth 1 (assoc method gnus-opened-servers)))
4157
4158 (defun gnus-group-name-to-method (group)
4159   "Guess a select method based on GROUP."
4160   (if (string-match ":" group)
4161       (let ((server (substring group 0 (match-beginning 0))))
4162         (if (string-match "\\+" server)
4163             (list (intern (substring server 0 (match-beginning 0)))
4164                   (substring server (match-end 0)))
4165           (list (intern server) "")))
4166     gnus-select-method))
4167
4168 (defun gnus-server-string (server)
4169   "Return a readable string that describes SERVER."
4170   (let* ((server (gnus-server-to-method server))
4171          (address (nth 1 server)))
4172     (if (and address
4173              (not (zerop (length address))))
4174         (format "%s using %s" address (car server))
4175       (format "%s" (car server)))))
4176
4177 (defun gnus-find-method-for-group (group &optional info)
4178   "Find the select method that GROUP uses."
4179   (or gnus-override-method
4180       (and (not group)
4181            gnus-select-method)
4182       (and (not (gnus-group-entry group));; a new group
4183            (gnus-group-name-to-method group))
4184       (let ((info (or info (gnus-get-info group)))
4185             method)
4186         (if (or (not info)
4187                 (not (setq method (gnus-info-method info)))
4188                 (equal method "native"))
4189             gnus-select-method
4190           (setq method
4191                 (cond ((stringp method)
4192                        (inline (gnus-server-to-method method)))
4193                       ((stringp (cadr method))
4194                        (inline (gnus-server-extend-method group method)))
4195                       (t
4196                        method)))
4197           (cond ((equal (cadr method) "")
4198                  method)
4199                 ((null (cadr method))
4200                  (list (car method) ""))
4201                 (t
4202                  (gnus-server-add-address method)))))))
4203
4204 (defun gnus-methods-using (feature)
4205   "Find all methods that have FEATURE."
4206   (let ((valids gnus-valid-select-methods)
4207         outs)
4208     (while valids
4209       (when (memq feature (car valids))
4210         (push (car valids) outs))
4211       (setq valids (cdr valids)))
4212     outs))
4213
4214 (eval-and-compile
4215   (autoload 'message-y-or-n-p "message" nil nil 'macro))
4216
4217 (defun gnus-read-group (prompt &optional default)
4218   "Prompt the user for a group name.
4219 Disallow invalid group names."
4220   (let ((prefix "")
4221         group)
4222     (while (not group)
4223       (when (string-match
4224              gnus-invalid-group-regexp
4225              (setq group (read-string (concat prefix prompt)
4226                                       (cons (or default "") 0)
4227                                       'gnus-group-history)))
4228         (let ((match (match-string 0 group)))
4229           ;; Might be okay (e.g. for nnimap), so ask the user:
4230           (unless (and (not (string-match "^$\\|:" match))
4231                        (message-y-or-n-p
4232                         "Proceed and create group anyway? " t
4233 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4234
4235 Usually, it's dangerous to create a group with this name, because it's not
4236 supported by all back ends and servers.  On IMAP servers it should work,
4237 though.  If you are really sure, you can proceed anyway and create the group.
4238
4239 You may customize the variable `gnus-invalid-group-regexp', which currently is
4240 set to \"" gnus-invalid-group-regexp
4241 "\", if you want to get rid of this query permanently."))
4242             (setq prefix (format "Invalid group name: \"%s\".  " group)
4243                   group nil)))))
4244     group))
4245
4246 (defun gnus-read-method (prompt)
4247   "Prompt the user for a method.
4248 Allow completion over sensible values."
4249   (let* ((open-servers
4250           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4251                   gnus-opened-servers))
4252          (valid-methods
4253           (let (methods)
4254             (dolist (method gnus-valid-select-methods)
4255               (if (or (memq 'prompt-address method)
4256                       (not (assoc (format "%s:" (car method)) open-servers)))
4257                   (push method methods)))
4258             methods))
4259          (servers
4260           (append valid-methods
4261                   open-servers
4262                   gnus-predefined-server-alist
4263                   gnus-server-alist))
4264          (method
4265           (completing-read
4266            prompt servers
4267            nil t nil 'gnus-method-history)))
4268     (cond
4269      ((equal method "")
4270       (setq method gnus-select-method))
4271      ((assoc method gnus-valid-select-methods)
4272       (let ((address (if (memq 'prompt-address
4273                                (assoc method gnus-valid-select-methods))
4274                          (read-string "Address: ")
4275                        "")))
4276         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4277             (list (intern method) address))))
4278      ((assoc method servers)
4279       method)
4280      (t
4281       (list (intern method) "")))))
4282
4283 ;;; Agent functions
4284
4285 (defun gnus-agent-method-p (method)
4286   "Say whether METHOD is covered by the agent."
4287   (or (eq (car gnus-agent-method-p-cache) method)
4288       (setq gnus-agent-method-p-cache
4289             (cons method
4290                   (member (if (stringp method)
4291                               method
4292                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4293   (cdr gnus-agent-method-p-cache))
4294
4295 (defun gnus-online (method)
4296   (not
4297    (if gnus-plugged
4298        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4299      (gnus-agent-method-p method))))
4300
4301 ;;; User-level commands.
4302
4303 ;;;###autoload
4304 (defun gnus-slave-no-server (&optional arg)
4305   "Read network news as a slave, without connecting to the local server."
4306   (interactive "P")
4307   (gnus-no-server arg t))
4308
4309 ;;;###autoload
4310 (defun gnus-no-server (&optional arg slave)
4311   "Read network news.
4312 If ARG is a positive number, Gnus will use that as the startup
4313 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4314 non-nil and not a positive number, Gnus will prompt the user for the
4315 name of an NNTP server to use.
4316 As opposed to `gnus', this command will not connect to the local
4317 server."
4318   (interactive "P")
4319   (gnus-no-server-1 arg slave))
4320
4321 ;;;###autoload
4322 (defun gnus-slave (&optional arg)
4323   "Read news as a slave."
4324   (interactive "P")
4325   (gnus arg nil 'slave))
4326
4327 (defcustom gnus-frame-properties nil
4328   "The properties of the frame in which gnus is displayed. Under XEmacs,
4329 the variable `toolbar-news-frame-plist' will be refered instead."
4330   :type '(repeat (cons :format "%v"
4331                        (symbol :tag "Parameter")
4332                        (sexp :tag "Value")))
4333   :group 'gnus)
4334
4335 ;;;###autoload
4336 (defun gnus-other-frame (&optional arg display)
4337   "Pop up a frame to read news.
4338 This will call one of the Gnus commands which is specified by the user
4339 option `gnus-other-frame-function' (default `gnus') with the argument
4340 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4341 optional second argument DISPLAY should be a standard display string
4342 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4343 omitted or the function `make-frame-on-display' is not available, the
4344 current display is used."
4345   (interactive "P")
4346   (if (fboundp 'make-frame-on-display)
4347       (unless display
4348         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4349     (setq display nil))
4350   (let ((alive (gnus-alive-p)))
4351     (unless (and alive
4352                  (catch 'found
4353                    (walk-windows
4354                     (lambda (window)
4355                       (when (and (or (not display)
4356                                      (equal display
4357                                             (gnus-frame-or-window-display-name
4358                                              window)))
4359                                  (with-current-buffer (window-buffer window)
4360                                    (string-match "\\`gnus-"
4361                                                  (symbol-name major-mode))))
4362                         (gnus-select-frame-set-input-focus
4363                          (setq gnus-other-frame-object (window-frame window)))
4364                         (select-window window)
4365                         (throw 'found t)))
4366                     'ignore t)))
4367       (gnus-select-frame-set-input-focus
4368        (setq gnus-other-frame-object
4369              (if display
4370                  (make-frame-on-display display gnus-other-frame-parameters)
4371                (make-frame gnus-other-frame-parameters))))
4372       (if alive
4373           (switch-to-buffer gnus-group-buffer)
4374         (funcall gnus-other-frame-function arg)
4375         (add-hook 'gnus-exit-gnus-hook
4376                   '(lambda nil
4377                      (when (and (frame-live-p gnus-other-frame-object)
4378                                 (cdr (frame-list)))
4379                        (delete-frame gnus-other-frame-object))
4380                      (setq gnus-other-frame-object nil)))))))
4381
4382 ;;;###autoload
4383 (defun gnus (&optional arg dont-connect slave)
4384   "Read network news.
4385 If ARG is non-nil and a positive number, Gnus will use that as the
4386 startup level.  If ARG is non-nil and not a positive number, Gnus will
4387 prompt the user for the name of an NNTP server to use."
4388   (interactive "P")
4389   (unless (byte-code-function-p (symbol-function 'gnus))
4390     (message "You should byte-compile Gnus")
4391     (sit-for 2))
4392   (gnus-1 arg dont-connect slave))
4393
4394 ;; Allow redefinition of Gnus functions.
4395
4396 (gnus-ems-redefine)
4397
4398 (product-provide (provide 'gnus) 'gnus-vers)
4399
4400 ;;; gnus.el ends here