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