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