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