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