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