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