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