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