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