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