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