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