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