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