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