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