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