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