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