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