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