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