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