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