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