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