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