Synch with `t-gnus-6_14'.
[elisp/gnus.git-] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
4
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
8 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
9 ;; Keywords: news, mail
10
11 ;; This file is part of GNU Emacs.
12
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
17
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
27
28 ;;; Commentary:
29
30 ;;; Code:
31
32 (eval '(run-hooks 'gnus-load-hook))
33
34 (eval-when-compile (require 'cl))
35 (eval-when-compile (require 'static))
36
37 (require 'gnus-vers)
38 (require 'message)
39
40 (defgroup gnus nil
41   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42   :group 'news
43   :group 'mail)
44
45 (defgroup gnus-charset nil
46   "Group character set issues."
47   :link '(custom-manual "(gnus)Charsets")
48   :group 'gnus)
49
50 (defgroup gnus-cache nil
51   "Cache interface."
52   :group 'gnus)
53
54 (defgroup gnus-start nil
55   "Starting your favorite newsreader."
56   :group 'gnus)
57
58 (defgroup gnus-start-server nil
59   "Server options at startup."
60   :group 'gnus-start)
61
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
64   "Group buffers."
65   :link '(custom-manual "(gnus)The Group Buffer")
66   :group 'gnus)
67
68 (defgroup gnus-group-foreign nil
69   "Foreign groups."
70   :link '(custom-manual "(gnus)Foreign Groups")
71   :group 'gnus-group)
72
73 (defgroup gnus-group-new nil
74   "Automatic subscription of new groups."
75   :group 'gnus-group)
76
77 (defgroup gnus-group-levels nil
78   "Group levels."
79   :link '(custom-manual "(gnus)Group Levels")
80   :group 'gnus-group)
81
82 (defgroup gnus-group-select nil
83   "Selecting a Group."
84   :link '(custom-manual "(gnus)Selecting a Group")
85   :group 'gnus-group)
86
87 (defgroup gnus-group-listing nil
88   "Showing slices of the group list."
89   :link '(custom-manual "(gnus)Listing Groups")
90   :group 'gnus-group)
91
92 (defgroup gnus-group-visual nil
93   "Sorting the group buffer."
94   :link '(custom-manual "(gnus)Group Buffer Format")
95   :group 'gnus-group
96   :group 'gnus-visual)
97
98 (defgroup gnus-group-various nil
99   "Various group options."
100   :link '(custom-manual "(gnus)Scanning New Messages")
101   :group 'gnus-group)
102
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
105   "Summary buffers."
106   :link '(custom-manual "(gnus)The Summary Buffer")
107   :group 'gnus)
108
109 (defgroup gnus-summary-exit nil
110   "Leaving summary buffers."
111   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112   :group 'gnus-summary)
113
114 (defgroup gnus-summary-marks nil
115   "Marks used in summary buffers."
116   :link '(custom-manual "(gnus)Marking Articles")
117   :group 'gnus-summary)
118
119 (defgroup gnus-thread nil
120   "Ordering articles according to replies."
121   :link '(custom-manual "(gnus)Threading")
122   :group 'gnus-summary)
123
124 (defgroup gnus-summary-format nil
125   "Formatting of the summary buffer."
126   :link '(custom-manual "(gnus)Summary Buffer Format")
127   :group 'gnus-summary)
128
129 (defgroup gnus-summary-choose nil
130   "Choosing Articles."
131   :link '(custom-manual "(gnus)Choosing Articles")
132   :group 'gnus-summary)
133
134 (defgroup gnus-summary-maneuvering nil
135   "Summary movement commands."
136   :link '(custom-manual "(gnus)Summary Maneuvering")
137   :group 'gnus-summary)
138
139 (defgroup gnus-summary-mail nil
140   "Mail group commands."
141   :link '(custom-manual "(gnus)Mail Group Commands")
142   :group 'gnus-summary)
143
144 (defgroup gnus-summary-sort nil
145   "Sorting the summary buffer."
146   :link '(custom-manual "(gnus)Sorting")
147   :group 'gnus-summary)
148
149 (defgroup gnus-summary-visual nil
150   "Highlighting and menus in the summary buffer."
151   :link '(custom-manual "(gnus)Summary Highlighting")
152   :group 'gnus-visual
153   :group 'gnus-summary)
154
155 (defgroup gnus-summary-various nil
156   "Various summary buffer options."
157   :link '(custom-manual "(gnus)Various Summary Stuff")
158   :group 'gnus-summary)
159
160 (defgroup gnus-summary-pick nil
161   "Pick mode in the summary buffer."
162   :link '(custom-manual "(gnus)Pick and Read")
163   :prefix "gnus-pick-"
164   :group 'gnus-summary)
165
166 (defgroup gnus-summary-tree nil
167   "Tree display of threads in the summary buffer."
168   :link '(custom-manual "(gnus)Tree Display")
169   :prefix "gnus-tree-"
170   :group 'gnus-summary)
171
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174   "Viewing extracted files."
175   :link '(custom-manual "(gnus)Viewing Files")
176   :group 'gnus-extract)
177
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180   "Score and kill file handling."
181   :group 'gnus)
182
183 (defgroup gnus-score-kill nil
184   "Kill files."
185   :group 'gnus-score)
186
187 (defgroup gnus-score-adapt nil
188   "Adaptive score files."
189   :group 'gnus-score)
190
191 (defgroup gnus-score-default nil
192   "Default values for score files."
193   :group 'gnus-score)
194
195 (defgroup gnus-score-expire nil
196   "Expiring score rules."
197   :group 'gnus-score)
198
199 (defgroup gnus-score-decay nil
200   "Decaying score rules."
201   :group 'gnus-score)
202
203 (defgroup gnus-score-files nil
204   "Score and kill file names."
205   :group 'gnus-score
206   :group 'gnus-files)
207
208 (defgroup gnus-score-various nil
209   "Various scoring and killing options."
210   :group 'gnus-score)
211
212 ;; Other
213 (defgroup gnus-visual nil
214   "Options controling the visual fluff."
215   :group 'gnus
216   :group 'faces)
217
218 (defgroup gnus-agent nil
219   "Offline support for Gnus."
220   :group 'gnus)
221
222 (defgroup gnus-files nil
223   "Files used by Gnus."
224   :group 'gnus)
225
226 (defgroup gnus-dribble-file nil
227   "Auto save file."
228   :link '(custom-manual "(gnus)Auto Save")
229   :group 'gnus-files)
230
231 (defgroup gnus-newsrc nil
232   "Storing Gnus state."
233   :group 'gnus-files)
234
235 (defgroup gnus-server nil
236   "Options related to newsservers and other servers used by Gnus."
237   :group 'gnus)
238
239 (defgroup gnus-message '((message custom-group))
240   "Composing replies and followups in Gnus."
241   :group 'gnus)
242
243 (defgroup gnus-meta nil
244   "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
247   :group 'gnus)
248
249 (defgroup gnus-various nil
250   "Other Gnus options."
251   :link '(custom-manual "(gnus)Various Various")
252   :group 'gnus)
253
254 (defgroup gnus-mime nil
255   "Variables for controlling the Gnus MIME interface."
256   :group 'gnus)
257
258 (defgroup gnus-exit nil
259   "Exiting gnus."
260   :link '(custom-manual "(gnus)Exiting Gnus")
261   :group 'gnus)
262
263 (defcustom gnus-inhibit-startup-message nil
264   "If non-nil, the startup message will not be displayed.
265 This variable is used before `.gnus.el' is loaded, so it should
266 be set in `.emacs' instead."
267   :group 'gnus-start
268   :type 'boolean)
269
270 (defcustom gnus-play-startup-jingle nil
271   "If non-nil, play the Gnus jingle at startup."
272   :group 'gnus-start
273   :type 'boolean)
274
275 (unless (featurep 'gnus-xmas)
276   (defalias 'gnus-make-overlay 'make-overlay)
277   (defalias 'gnus-delete-overlay 'delete-overlay)
278   (defalias 'gnus-overlay-put 'overlay-put)
279   (defalias 'gnus-move-overlay 'move-overlay)
280   (defalias 'gnus-overlay-end 'overlay-end)
281   (defalias 'gnus-extent-detached-p 'ignore)
282   (defalias 'gnus-extent-start-open 'ignore)
283   (defalias 'gnus-set-text-properties 'set-text-properties)
284   (defalias 'gnus-group-remove-excess-properties 'ignore)
285   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
286   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
287   (defalias 'gnus-character-to-event 'identity)
288   (defalias 'gnus-add-text-properties 'add-text-properties)
289   (defalias 'gnus-put-text-property 'put-text-property)
290   (defvar gnus-mode-line-image-cache t)
291   (if (fboundp 'find-image)
292       (defun gnus-mode-line-buffer-identification (line)
293         (let ((str (car-safe line)))
294           (if (and (stringp str)
295                    (string-match "^Gnus:" str))
296               (progn (add-text-properties
297                       0 5
298                       (list 'display
299                             (if (eq t gnus-mode-line-image-cache)
300                                 (setq gnus-mode-line-image-cache
301                                       (find-image
302                                        '((:type xpm :file "gnus-pointer.xpm"
303                                                 :ascent 100)
304                                          (:type xbm :file "gnus-pointer.xbm"
305                                                 :ascent 100))))
306                               gnus-mode-line-image-cache)
307                             'help-echo "This is Gnus")
308                       str)
309                      (list str))
310             line)))
311     (defalias 'gnus-mode-line-buffer-identification 'identity))
312   (defalias 'gnus-characterp 'numberp)
313   (defalias 'gnus-deactivate-mark 'deactivate-mark)
314   (defalias 'gnus-window-edges 'window-edges)
315   (defalias 'gnus-key-press-event-p 'numberp)
316   (defalias 'gnus-decode-rfc1522 'ignore))
317
318 ;; We define these group faces here to avoid the display
319 ;; update forced when creating new faces.
320
321 (defface gnus-group-news-1-face
322   '((((class color)
323       (background dark))
324      (:foreground "PaleTurquoise" :bold t))
325     (((class color)
326       (background light))
327      (:foreground "ForestGreen" :bold t))
328     (t
329      ()))
330   "Level 1 newsgroup face.")
331
332 (defface gnus-group-news-1-empty-face
333   '((((class color)
334       (background dark))
335      (:foreground "PaleTurquoise"))
336     (((class color)
337       (background light))
338      (:foreground "ForestGreen"))
339     (t
340      ()))
341   "Level 1 empty newsgroup face.")
342
343 (defface gnus-group-news-2-face
344   '((((class color)
345       (background dark))
346      (:foreground "turquoise" :bold t))
347     (((class color)
348       (background light))
349      (:foreground "CadetBlue4" :bold t))
350     (t
351      ()))
352   "Level 2 newsgroup face.")
353
354 (defface gnus-group-news-2-empty-face
355   '((((class color)
356       (background dark))
357      (:foreground "turquoise"))
358     (((class color)
359       (background light))
360      (:foreground "CadetBlue4"))
361     (t
362      ()))
363   "Level 2 empty newsgroup face.")
364
365 (defface gnus-group-news-3-face
366   '((((class color)
367       (background dark))
368      (:bold t))
369     (((class color)
370       (background light))
371      (:bold t))
372     (t
373      ()))
374   "Level 3 newsgroup face.")
375
376 (defface gnus-group-news-3-empty-face
377   '((((class color)
378       (background dark))
379      ())
380     (((class color)
381       (background light))
382      ())
383     (t
384      ()))
385   "Level 3 empty newsgroup face.")
386
387 (defface gnus-group-news-4-face
388   '((((class color)
389       (background dark))
390      (:bold t))
391     (((class color)
392       (background light))
393      (:bold t))
394     (t
395      ()))
396   "Level 4 newsgroup face.")
397
398 (defface gnus-group-news-4-empty-face
399   '((((class color)
400       (background dark))
401      ())
402     (((class color)
403       (background light))
404      ())
405     (t
406      ()))
407   "Level 4 empty newsgroup face.")
408
409 (defface gnus-group-news-5-face
410   '((((class color)
411       (background dark))
412      (:bold t))
413     (((class color)
414       (background light))
415      (:bold t))
416     (t
417      ()))
418   "Level 5 newsgroup face.")
419
420 (defface gnus-group-news-5-empty-face
421   '((((class color)
422       (background dark))
423      ())
424     (((class color)
425       (background light))
426      ())
427     (t
428      ()))
429   "Level 5 empty newsgroup face.")
430
431 (defface gnus-group-news-6-face
432   '((((class color)
433       (background dark))
434      (:bold t))
435     (((class color)
436       (background light))
437      (:bold t))
438     (t
439      ()))
440   "Level 6 newsgroup face.")
441
442 (defface gnus-group-news-6-empty-face
443   '((((class color)
444       (background dark))
445      ())
446     (((class color)
447       (background light))
448      ())
449     (t
450      ()))
451   "Level 6 empty newsgroup face.")
452
453 (defface gnus-group-news-low-face
454   '((((class color)
455       (background dark))
456      (:foreground "DarkTurquoise" :bold t))
457     (((class color)
458       (background light))
459      (:foreground "DarkGreen" :bold t))
460     (t
461      ()))
462   "Low level newsgroup face.")
463
464 (defface gnus-group-news-low-empty-face
465   '((((class color)
466       (background dark))
467      (:foreground "DarkTurquoise"))
468     (((class color)
469       (background light))
470      (:foreground "DarkGreen"))
471     (t
472      ()))
473   "Low level empty newsgroup face.")
474
475 (defface gnus-group-mail-1-face
476   '((((class color)
477       (background dark))
478      (:foreground "aquamarine1" :bold t))
479     (((class color)
480       (background light))
481      (:foreground "DeepPink3" :bold t))
482     (t
483      (:bold t)))
484   "Level 1 mailgroup face.")
485
486 (defface gnus-group-mail-1-empty-face
487   '((((class color)
488       (background dark))
489      (:foreground "aquamarine1"))
490     (((class color)
491       (background light))
492      (:foreground "DeepPink3"))
493     (t
494      (:italic t :bold t)))
495   "Level 1 empty mailgroup face.")
496
497 (defface gnus-group-mail-2-face
498   '((((class color)
499       (background dark))
500      (:foreground "aquamarine2" :bold t))
501     (((class color)
502       (background light))
503      (:foreground "HotPink3" :bold t))
504     (t
505      (:bold t)))
506   "Level 2 mailgroup face.")
507
508 (defface gnus-group-mail-2-empty-face
509   '((((class color)
510       (background dark))
511      (:foreground "aquamarine2"))
512     (((class color)
513       (background light))
514      (:foreground "HotPink3"))
515     (t
516      (:bold t)))
517   "Level 2 empty mailgroup face.")
518
519 (defface gnus-group-mail-3-face
520   '((((class color)
521       (background dark))
522      (:foreground "aquamarine3" :bold t))
523     (((class color)
524       (background light))
525      (:foreground "magenta4" :bold t))
526     (t
527      (:bold t)))
528   "Level 3 mailgroup face.")
529
530 (defface gnus-group-mail-3-empty-face
531   '((((class color)
532       (background dark))
533      (:foreground "aquamarine3"))
534     (((class color)
535       (background light))
536      (:foreground "magenta4"))
537     (t
538      ()))
539   "Level 3 empty mailgroup face.")
540
541 (defface gnus-group-mail-low-face
542   '((((class color)
543       (background dark))
544      (:foreground "aquamarine4" :bold t))
545     (((class color)
546       (background light))
547      (:foreground "DeepPink4" :bold t))
548     (t
549      (:bold t)))
550   "Low level mailgroup face.")
551
552 (defface gnus-group-mail-low-empty-face
553   '((((class color)
554       (background dark))
555      (:foreground "aquamarine4"))
556     (((class color)
557       (background light))
558      (:foreground "DeepPink4"))
559     (t
560      (:bold t)))
561   "Low level empty mailgroup face.")
562
563 ;; Summary mode faces.
564
565 (defface gnus-summary-selected-face '((t
566                                        (:underline t)))
567   "Face used for selected articles.")
568
569 (defface gnus-summary-cancelled-face
570   '((((class color))
571      (:foreground "yellow" :background "black")))
572   "Face used for cancelled articles.")
573
574 (defface gnus-summary-high-ticked-face
575   '((((class color)
576       (background dark))
577      (:foreground "pink" :bold t))
578     (((class color)
579       (background light))
580      (:foreground "firebrick" :bold t))
581     (t
582      (:bold t)))
583   "Face used for high interest ticked articles.")
584
585 (defface gnus-summary-low-ticked-face
586   '((((class color)
587       (background dark))
588      (:foreground "pink" :italic t))
589     (((class color)
590       (background light))
591      (:foreground "firebrick" :italic t))
592     (t
593      (:italic t)))
594   "Face used for low interest ticked articles.")
595
596 (defface gnus-summary-normal-ticked-face
597   '((((class color)
598       (background dark))
599      (:foreground "pink"))
600     (((class color)
601       (background light))
602      (:foreground "firebrick"))
603     (t
604      ()))
605   "Face used for normal interest ticked articles.")
606
607 (defface gnus-summary-high-ancient-face
608   '((((class color)
609       (background dark))
610      (:foreground "SkyBlue" :bold t))
611     (((class color)
612       (background light))
613      (:foreground "RoyalBlue" :bold t))
614     (t
615      (:bold t)))
616   "Face used for high interest ancient articles.")
617
618 (defface gnus-summary-low-ancient-face
619   '((((class color)
620       (background dark))
621      (:foreground "SkyBlue" :italic t))
622     (((class color)
623       (background light))
624      (:foreground "RoyalBlue" :italic t))
625     (t
626      (:italic t)))
627   "Face used for low interest ancient articles.")
628
629 (defface gnus-summary-normal-ancient-face
630   '((((class color)
631       (background dark))
632      (:foreground "SkyBlue"))
633     (((class color)
634       (background light))
635      (:foreground "RoyalBlue"))
636     (t
637      ()))
638   "Face used for normal interest ancient articles.")
639
640 (defface gnus-summary-high-unread-face
641   '((t
642      (:bold t)))
643   "Face used for high interest unread articles.")
644
645 (defface gnus-summary-low-unread-face
646   '((t
647      (:italic t)))
648   "Face used for low interest unread articles.")
649
650 (defface gnus-summary-normal-unread-face
651   '((t
652      ()))
653   "Face used for normal interest unread articles.")
654
655 (defface gnus-summary-incorporated-face
656   '((t
657      ()))
658   "Face used for incorporated articles.")
659
660 (defface gnus-summary-high-read-face
661   '((((class color)
662       (background dark))
663      (:foreground "PaleGreen"
664                   :bold t))
665     (((class color)
666       (background light))
667      (:foreground "DarkGreen"
668                   :bold t))
669     (t
670      (:bold t)))
671   "Face used for high interest read articles.")
672
673 (defface gnus-summary-low-read-face
674   '((((class color)
675       (background dark))
676      (:foreground "PaleGreen"
677                   :italic t))
678     (((class color)
679       (background light))
680      (:foreground "DarkGreen"
681                   :italic t))
682     (t
683      (:italic t)))
684   "Face used for low interest read articles.")
685
686 (defface gnus-summary-normal-read-face
687   '((((class color)
688       (background dark))
689      (:foreground "PaleGreen"))
690     (((class color)
691       (background light))
692      (:foreground "DarkGreen"))
693     (t
694      ()))
695   "Face used for normal interest read articles.")
696
697
698 ;;;
699 ;;; Gnus buffers
700 ;;;
701
702 (defvar gnus-buffers nil)
703
704 (defun gnus-get-buffer-create (name)
705   "Do the same as `get-buffer-create', but store the created buffer."
706   (or (get-buffer name)
707       (car (push (get-buffer-create name) gnus-buffers))))
708
709 (defun gnus-add-buffer ()
710   "Add the current buffer to the list of Gnus buffers."
711   (push (current-buffer) gnus-buffers))
712
713 (defun gnus-buffers ()
714   "Return a list of live Gnus buffers."
715   (while (and gnus-buffers
716               (not (buffer-name (car gnus-buffers))))
717     (pop gnus-buffers))
718   (let ((buffers gnus-buffers))
719     (while (cdr buffers)
720       (if (buffer-name (cadr buffers))
721           (pop buffers)
722         (setcdr buffers (cddr buffers)))))
723   gnus-buffers)
724
725 ;;; Splash screen.
726
727 (defvar gnus-group-buffer "*Group*")
728
729 (eval-and-compile
730   (autoload 'gnus-play-jingle "gnus-audio"))
731
732 (defface gnus-splash-face
733   '((((class color)
734       (background dark))
735      (:foreground "Brown"))
736     (((class color)
737       (background light))
738      (:foreground "Brown"))
739     (t
740      ()))
741   "Face of the splash screen.")
742
743 (defun gnus-splash ()
744   (save-excursion
745     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
746     (let ((buffer-read-only nil))
747       (erase-buffer)
748       (unless gnus-inhibit-startup-message
749         (gnus-group-startup-message)
750         (sit-for 0)
751         (when gnus-play-startup-jingle
752           (gnus-play-jingle))))))
753
754 (defun gnus-indent-rigidly (start end arg)
755   "Indent rigidly using only spaces and no tabs."
756   (save-excursion
757     (save-restriction
758       (narrow-to-region start end)
759       (let ((tab-width 8))
760         (indent-rigidly start end arg)
761         ;; We translate tabs into spaces -- not everybody uses
762         ;; an 8-character tab.
763         (goto-char (point-min))
764         (while (search-forward "\t" nil t)
765           (replace-match "        " t t))))))
766
767 (defvar gnus-simple-splash nil)
768
769 (defun gnus-group-startup-message (&optional x y)
770   "Insert startup message in current buffer."
771   ;; Insert the message.
772   (erase-buffer)
773   (cond
774    ((and (fboundp 'find-image)
775          (display-graphic-p)
776          (let ((image
777                 (find-image
778                  `((:type xpm :file "gnus.xpm"
779                           :color-symbols
780                           (("thing" . "#724214")
781                            ("shadow" . "#1e3f03")
782                            ("background" . ,(face-background 'default))))
783                    (:type xbm :file "gnus.xbm"
784                           :foreground ,(face-foreground 'gnus-splash-face)
785                           :background ,(face-background 'default))))))
786            (when image
787              (insert-image image)
788              (goto-char (point-min))
789              (insert-char
790               ?\ ;; space
791               (max 0 (let ((cw (frame-char-width)))
792                        (/ (+ (- (* (window-width) cw) 271) cw) 2 cw))))
793              (goto-char (point-min))
794              (insert gnus-product-name " " gnus-version-number
795                      (if (zerop (string-to-number gnus-revision-number))
796                          ""
797                        (concat " (r" gnus-revision-number ")"))
798                      " based on " gnus-original-product-name " v"
799                      gnus-original-version-number "\n")
800              (goto-char (point-min))
801              (put-text-property (point) (gnus-point-at-eol)
802                                 'face 'gnus-splash-face)
803              (insert-char ?\ ;; space
804                           (max 0 (/ (- (window-width) (gnus-point-at-eol)) 2)))
805              (forward-line 1)
806              (insert-char
807               ?\n (max 0
808                        (let ((ch (frame-char-height)))
809                          (/ (+ (- (* (1- (window-height)) ch) 273) ch) 2 ch))))
810              (setq gnus-simple-splash nil)
811              t))))
812    (t
813     (insert "
814           _    ___ _             _
815           _ ___ __ ___  __    _ ___
816           __   _     ___    __  ___
817               _           ___     _
818              _  _ __             _
819              ___   __            _
820                    __           _
821                     _      _   _
822                    _      _    _
823                       _  _    _
824                   __  ___
825                  _   _ _     _
826                 _   _
827               _    _
828              _    _
829             _
830           __
831
832 "
833             )
834     (goto-char (point-min))
835     (insert gnus-product-name " " gnus-version-number
836             (if (zerop (string-to-number gnus-revision-number))
837                 ""
838               (concat " (r" gnus-revision-number ")"))
839             " based on " gnus-original-product-name " v"
840             gnus-original-version-number)
841     (goto-char (point-min))
842     (insert-char ?\ ; space
843                  (max 0 (/ (- (window-width) (gnus-point-at-eol)) 2)))
844     (forward-line 1)
845     ;; And then hack it.
846     (gnus-indent-rigidly (point) (point-max)
847                          (/ (max (- (window-width) (or x 46)) 0) 2))
848     (goto-char (point-min))
849     (forward-line 1)
850     (let* ((pheight (count-lines (point-min) (point-max)))
851            (wheight (window-height))
852            (rest (- wheight pheight)))
853       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
854     ;; Fontify some.
855     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
856     (setq gnus-simple-splash t)))
857   (goto-char (point-min))
858   (setq mode-line-buffer-identification (concat " " gnus-version))
859   (set-buffer-modified-p t))
860
861 (eval-when (load)
862   (let ((command (format "%s" this-command)))
863     (if (and (string-match "gnus" command)
864              (not (string-match "gnus-other-frame" command)))
865         (gnus-splash)
866       (gnus-get-buffer-create gnus-group-buffer))))
867
868 ;;; Do the rest.
869
870 (require 'custom)
871 (require 'gnus-util)
872 (require 'nnheader)
873
874 (defcustom gnus-home-directory "~/"
875   "Directory variable that specifies the \"home\" directory.
876 All other Gnus path variables are initialized from this variable."
877   :group 'gnus-files
878   :type 'directory)
879
880 (defcustom gnus-directory (or (getenv "SAVEDIR")
881                               (nnheader-concat gnus-home-directory "News/"))
882   "*Directory variable from which all other Gnus file variables are derived.
883
884 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
885 This means that other directory variables that are initialized from
886 this variable won't be set properly if you set this variable in `.gnus.el'.
887 Set this variable in `.emacs' instead."
888   :group 'gnus-files
889   :type 'directory)
890
891 (defcustom gnus-default-directory nil
892   "*Default directory for all Gnus buffers."
893   :group 'gnus-files
894   :type '(choice (const :tag "current" nil)
895                  directory))
896
897 ;; Site dependent variables.  These variables should be defined in
898 ;; paths.el.
899
900 (defvar gnus-default-nntp-server nil
901   "Specify a default NNTP server.
902 This variable should be defined in paths.el, and should never be set
903 by the user.
904 If you want to change servers, you should use `gnus-select-method'.
905 See the documentation to that variable.")
906
907 ;; Don't touch this variable.
908 (defvar gnus-nntp-service "nntp"
909   "NNTP service name (\"nntp\" or 119).
910 This is an obsolete variable, which is scarcely used.  If you use an
911 nntp server for your newsgroup and want to change the port number
912 used to 899, you would say something along these lines:
913
914  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
915
916 (defcustom gnus-nntpserver-file "/etc/nntpserver"
917   "A file with only the name of the nntp server in it."
918   :group 'gnus-files
919   :group 'gnus-server
920   :type 'file)
921
922 ;; This function is used to check both the environment variable
923 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
924 ;; an nntp server name default.
925 (defun gnus-getenv-nntpserver ()
926   (or (getenv "NNTPSERVER")
927       (and (file-readable-p gnus-nntpserver-file)
928            (save-excursion
929              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
930              (insert-file-contents gnus-nntpserver-file)
931              (let ((name (buffer-string)))
932                (prog1
933                    (if (string-match "\\'[ \t\n]*$" name)
934                        nil
935                      name)
936                  (kill-buffer (current-buffer))))))))
937
938 (defcustom gnus-select-method
939   (condition-case nil
940       (nconc
941        (list 'nntp (or (condition-case nil
942                            (gnus-getenv-nntpserver)
943                          (error nil))
944                        (when (and gnus-default-nntp-server
945                                   (not (string= gnus-default-nntp-server "")))
946                          gnus-default-nntp-server)
947                        "news"))
948        (if (or (null gnus-nntp-service)
949                (equal gnus-nntp-service "nntp"))
950            nil
951          (list gnus-nntp-service)))
952     (error nil))
953   "Default method for selecting a newsgroup.
954 This variable should be a list, where the first element is how the
955 news is to be fetched, the second is the address.
956
957 For instance, if you want to get your news via NNTP from
958 \"flab.flab.edu\", you could say:
959
960 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
961
962 If you want to use your local spool, say:
963
964 \(setq gnus-select-method (list 'nnspool (system-name)))
965
966 If you use this variable, you must set `gnus-nntp-server' to nil.
967
968 There is a lot more to know about select methods and virtual servers -
969 see the manual for details."
970   :group 'gnus-server
971   :type 'gnus-select-method)
972
973 (defcustom gnus-message-archive-method
974   `(nnfolder
975     "archive"
976     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
977     (nnfolder-active-file
978      ,(nnheader-concat message-directory "archive/active"))
979     (nnfolder-get-new-mail nil)
980     (nnfolder-inhibit-expiry t))
981   "*Method used for archiving messages you've sent.
982 This should be a mail method.
983
984 It's probably not very effective to change this variable once you've
985 run Gnus once.  After doing that, you must edit this server from the
986 server buffer."
987   :group 'gnus-server
988   :group 'gnus-message
989   :type 'gnus-select-method)
990
991 (defcustom gnus-message-archive-group nil
992   "*Name of the group in which to save the messages you've written.
993 This can either be a string; a list of strings; or an alist
994 of regexps/functions/forms to be evaluated to return a string (or a list
995 of strings).  The functions are called with the name of the current
996 group (or nil) as a parameter.
997
998 If you want to save your mail in one group and the news articles you
999 write in another group, you could say something like:
1000
1001  \(setq gnus-message-archive-group
1002         '((if (message-news-p)
1003               \"misc-news\"
1004             \"misc-mail\")))
1005
1006 Normally the group names returned by this variable should be
1007 unprefixed -- which implicitly means \"store on the archive server\".
1008 However, you may wish to store the message on some other server.  In
1009 that case, just return a fully prefixed name of the group --
1010 \"nnml+private:mail.misc\", for instance."
1011   :group 'gnus-message
1012   :type '(choice (const :tag "none" nil)
1013                  function
1014                  sexp
1015                  string))
1016
1017 (defcustom gnus-secondary-servers nil
1018   "List of NNTP servers that the user can choose between interactively.
1019 To make Gnus query you for a server, you have to give `gnus' a
1020 non-numeric prefix - `C-u M-x gnus', in short."
1021   :group 'gnus-server
1022   :type '(repeat string))
1023
1024 (defcustom gnus-nntp-server nil
1025   "*The name of the host running the NNTP server.
1026 This variable is semi-obsolete.  Use the `gnus-select-method'
1027 variable instead."
1028   :group 'gnus-server
1029   :type '(choice (const :tag "disable" nil)
1030                  string))
1031
1032 (defcustom gnus-secondary-select-methods nil
1033   "A list of secondary methods that will be used for reading news.
1034 This is a list where each element is a complete select method (see
1035 `gnus-select-method').
1036
1037 If, for instance, you want to read your mail with the nnml backend,
1038 you could set this variable:
1039
1040 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1041   :group 'gnus-server
1042   :type '(repeat gnus-select-method))
1043
1044 (defvar gnus-backup-default-subscribed-newsgroups
1045   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1046   "Default default new newsgroups the first time Gnus is run.
1047 Should be set in paths.el, and shouldn't be touched by the user.")
1048
1049 (defcustom gnus-local-domain nil
1050   "Local domain name without a host name.
1051 The DOMAINNAME environment variable is used instead if it is defined.
1052 If the `system-name' function returns the full Internet name, there is
1053 no need to set this variable."
1054   :group 'gnus-message
1055   :type '(choice (const :tag "default" nil)
1056                  string))
1057
1058 (defvar gnus-local-organization nil
1059   "String with a description of what organization (if any) the user belongs to.
1060 Obsolete variable; use `message-user-organization' instead.")
1061
1062 ;; Customization variables
1063
1064 (defcustom gnus-refer-article-method nil
1065   "Preferred method for fetching an article by Message-ID.
1066 If you are reading news from the local spool (with nnspool), fetching
1067 articles by Message-ID is painfully slow.  By setting this method to an
1068 nntp method, you might get acceptable results.
1069
1070 The value of this variable must be a valid select method as discussed
1071 in the documentation of `gnus-select-method'.
1072
1073 It can also be a list of select methods, as well as the special symbol
1074 `current', which means to use the current select method.  If it is a
1075 list, Gnus will try all the methods in the list until it finds a match."
1076   :group 'gnus-server
1077   :type '(choice (const :tag "default" nil)
1078                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1079                  gnus-select-method
1080                  (repeat :menu-tag "Try multiple"
1081                          :tag "Multiple"
1082                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1083                          (choice :tag "Method"
1084                                  (const current)
1085                                  (const :tag "DejaNews"
1086                                         (nnweb "refer" (nnweb-type dejanews)))
1087                                  gnus-select-method))))
1088
1089 (defcustom gnus-group-faq-directory
1090   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1091     "/ftp@sunsite.auc.dk:/pub/usenet/"
1092     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1093     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1094     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1095     "/ftp@rtfm.mit.edu:/pub/usenet/"
1096     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1097     "/ftp@ftp.sunet.se:/pub/usenet/"
1098     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1099     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1100     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1101   "*Directory where the group FAQs are stored.
1102 This will most commonly be on a remote machine, and the file will be
1103 fetched by ange-ftp.
1104
1105 This variable can also be a list of directories.  In that case, the
1106 first element in the list will be used by default.  The others can
1107 be used when being prompted for a site.
1108
1109 Note that Gnus uses an aol machine as the default directory.  If this
1110 feels fundamentally unclean, just think of it as a way to finally get
1111 something of value back from them.
1112
1113 If the default site is too slow, try one of these:
1114
1115    North America: mirrors.aol.com                /pub/rtfm/usenet
1116                   ftp.seas.gwu.edu               /pub/rtfm
1117                   rtfm.mit.edu                   /pub/usenet
1118    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1119                   src.doc.ic.ac.uk               /usenet/news-FAQS
1120                   ftp.sunet.se                   /pub/usenet
1121                   sunsite.auc.dk                 /pub/usenet
1122    Asia:          nctuccca.edu.tw                /USENET/FAQ
1123                   hwarang.postech.ac.kr          /pub/usenet
1124                   ftp.hk.super.net               /mirror/faqs"
1125   :group 'gnus-group-various
1126   :type '(choice directory
1127                  (repeat directory)))
1128
1129 (defcustom gnus-use-cross-reference t
1130   "*Non-nil means that cross referenced articles will be marked as read.
1131 If nil, ignore cross references.  If t, mark articles as read in
1132 subscribed newsgroups.  If neither t nor nil, mark as read in all
1133 newsgroups."
1134   :group 'gnus-server
1135   :type '(choice (const :tag "off" nil)
1136                  (const :tag "subscribed" t)
1137                  (sexp :format "all"
1138                        :value always)))
1139
1140 (defcustom gnus-process-mark ?#
1141   "*Process mark."
1142   :group 'gnus-group-visual
1143   :group 'gnus-summary-marks
1144   :type 'character)
1145
1146 (defcustom gnus-large-newsgroup 200
1147   "*The number of articles which indicates a large newsgroup.
1148 If the number of articles in a newsgroup is greater than this value,
1149 confirmation is required for selecting the newsgroup."
1150   :group 'gnus-group-select
1151   :type 'integer)
1152
1153 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1154   "*Non-nil means that the default name of a file to save articles in is the group name.
1155 If it's nil, the directory form of the group name is used instead.
1156
1157 If this variable is a list, and the list contains the element
1158 `not-score', long file names will not be used for score files; if it
1159 contains the element `not-save', long file names will not be used for
1160 saving; and if it contains the element `not-kill', long file names
1161 will not be used for kill files.
1162
1163 Note that the default for this variable varies according to what system
1164 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1165 to nil while on all other systems it defaults to t."
1166   :group 'gnus-start
1167   :type 'boolean)
1168
1169 (defcustom gnus-kill-files-directory gnus-directory
1170   "*Name of the directory where kill files will be stored (default \"~/News\")."
1171   :group 'gnus-score-files
1172   :group 'gnus-score-kill
1173   :type 'directory)
1174
1175 (defcustom gnus-save-score nil
1176   "*If non-nil, save group scoring info."
1177   :group 'gnus-score-various
1178   :group 'gnus-start
1179   :type 'boolean)
1180
1181 (defcustom gnus-use-undo t
1182   "*If non-nil, allow undoing in Gnus group mode buffers."
1183   :group 'gnus-meta
1184   :type 'boolean)
1185
1186 (defcustom gnus-use-adaptive-scoring nil
1187   "*If non-nil, use some adaptive scoring scheme.
1188 If a list, then the values `word' and `line' are meaningful.  The
1189 former will perform adaption on individual words in the subject
1190 header while `line' will perform adaption on several headers."
1191   :group 'gnus-meta
1192   :group 'gnus-score-adapt
1193   :type '(set (const word) (const line)))
1194
1195 (defcustom gnus-use-cache 'passive
1196   "*If nil, Gnus will ignore the article cache.
1197 If `passive', it will allow entering (and reading) articles
1198 explicitly entered into the cache.  If anything else, use the
1199 cache to the full extent of the law."
1200   :group 'gnus-meta
1201   :group 'gnus-cache
1202   :type '(choice (const :tag "off" nil)
1203                  (const :tag "passive" passive)
1204                  (const :tag "active" t)))
1205
1206 (defcustom gnus-use-trees nil
1207   "*If non-nil, display a thread tree buffer."
1208   :group 'gnus-meta
1209   :type 'boolean)
1210
1211 (defcustom gnus-use-grouplens nil
1212   "*If non-nil, use GroupLens ratings."
1213   :group 'gnus-meta
1214   :type 'boolean)
1215
1216 (defcustom gnus-keep-backlog nil
1217   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1218 If it is a number N, then Gnus will only keep the last N articles
1219 read.  If it is neither nil nor a number, Gnus will keep all read
1220 articles.  This is not a good idea."
1221   :group 'gnus-meta
1222   :type '(choice (const :tag "off" nil)
1223                  integer
1224                  (sexp :format "all"
1225                        :value t)))
1226
1227 (defcustom gnus-use-nocem nil
1228   "*If non-nil, Gnus will read NoCeM cancel messages."
1229   :group 'gnus-meta
1230   :type 'boolean)
1231
1232 (defcustom gnus-suppress-duplicates nil
1233   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1234   :group 'gnus-meta
1235   :type 'boolean)
1236
1237 (defcustom gnus-use-scoring t
1238   "*If non-nil, enable scoring."
1239   :group 'gnus-meta
1240   :type 'boolean)
1241
1242 (defcustom gnus-use-picons nil
1243   "*If non-nil, display picons in a frame of their own."
1244   :group 'gnus-meta
1245   :type 'boolean)
1246
1247 (defcustom gnus-summary-prepare-exit-hook
1248   '(gnus-summary-expire-articles)
1249   "*A hook called when preparing to exit from the summary buffer.
1250 It calls `gnus-summary-expire-articles' by default."
1251   :group 'gnus-summary-exit
1252   :type 'hook)
1253
1254 (defcustom gnus-novice-user t
1255   "*Non-nil means that you are a usenet novice.
1256 If non-nil, verbose messages may be displayed and confirmations may be
1257 required."
1258   :group 'gnus-meta
1259   :type 'boolean)
1260
1261 (defcustom gnus-expert-user nil
1262   "*Non-nil means that you will never be asked for confirmation about anything.
1263 That doesn't mean *anything* anything; particularly destructive
1264 commands will still require prompting."
1265   :group 'gnus-meta
1266   :type 'boolean)
1267
1268 (defcustom gnus-interactive-catchup t
1269   "*If non-nil, require your confirmation when catching up a group."
1270   :group 'gnus-group-select
1271   :type 'boolean)
1272
1273 (defcustom gnus-interactive-exit t
1274   "*If non-nil, require your confirmation when exiting Gnus."
1275   :group 'gnus-exit
1276   :type 'boolean)
1277
1278 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1279   "*Function for extracting address components from a From header.
1280 Two pre-defined function exist: `gnus-extract-address-components',
1281 which is the default, quite fast, and too simplistic solution, and
1282 `mail-extract-address-components', which works much better, but is
1283 slower."
1284   :group 'gnus-summary-format
1285   :type '(radio (function-item gnus-extract-address-components)
1286                 (function-item mail-extract-address-components)
1287                 (function-item std11-extract-address-components)
1288                 (function :tag "Other")))
1289
1290 (defcustom gnus-carpal nil
1291   "*If non-nil, display clickable icons."
1292   :group 'gnus-meta
1293   :type 'boolean)
1294
1295 (defcustom gnus-shell-command-separator ";"
1296   "String used to separate to shell commands."
1297   :group 'gnus-files
1298   :type 'string)
1299
1300 (defcustom gnus-valid-select-methods
1301   '(("nntp" post address prompt-address physical-address)
1302     ("nnspool" post address)
1303     ("nnvirtual" post-mail virtual prompt-address)
1304     ("nnmbox" mail respool address)
1305     ("nnml" mail respool address)
1306     ("nnmh" mail respool address)
1307     ("nndir" post-mail prompt-address physical-address)
1308     ("nneething" none address prompt-address physical-address)
1309     ("nndoc" none address prompt-address)
1310     ("nnbabyl" mail address respool)
1311     ("nnkiboze" post virtual)
1312     ("nnsoup" post-mail address)
1313     ("nndraft" post-mail)
1314     ("nnfolder" mail respool address)
1315     ("nngateway" post-mail address prompt-address physical-address)
1316     ("nnweb" none)
1317     ("nnslashdot" post)
1318     ("nnultimate" none)
1319     ("nnwarchive" none)
1320     ("nnlistserv" none)
1321     ("nnagent" post-mail)
1322     ("nnimap" post-mail address prompt-address physical-address))
1323   "*An alist of valid select methods.
1324 The first element of each list lists should be a string with the name
1325 of the select method.  The other elements may be the category of
1326 this method (i. e., `post', `mail', `none' or whatever) or other
1327 properties that this method has (like being respoolable).
1328 If you implement a new select method, all you should have to change is
1329 this variable.  I think."
1330   :group 'gnus-server
1331   :type '(repeat (group (string :tag "Name")
1332                         (radio-button-choice (const :format "%v " post)
1333                                              (const :format "%v " mail)
1334                                              (const :format "%v " none)
1335                                              (const post-mail))
1336                         (checklist :inline t
1337                                    (const :format "%v " address)
1338                                    (const :format "%v " prompt-address)
1339                                    (const :format "%v " physical-address)
1340                                    (const :format "%v " virtual)
1341                                    (const respool)))))
1342
1343 (defun gnus-redefine-select-method-widget ()
1344   "Recomputes the select-method widget based on the value of
1345 `gnus-valid-select-methods'."
1346   (define-widget 'gnus-select-method 'list
1347     "Widget for entering a select method."
1348     :value '(nntp "")
1349     :tag "Select Method"
1350     :args `((choice :tag "Method"
1351                     ,@(mapcar (lambda (entry)
1352                                 (list 'const :format "%v\n"
1353                                       (intern (car entry))))
1354                               gnus-valid-select-methods)
1355                     (symbol :tag "other"))
1356             (string :tag "Address")
1357             (repeat :tag "Options"
1358                     :inline t
1359                     (list :format "%v"
1360                           variable
1361                           (sexp :tag "Value"))))
1362     ))
1363
1364 (gnus-redefine-select-method-widget)
1365
1366 (defcustom gnus-updated-mode-lines '(group article summary tree)
1367   "List of buffers that should update their mode lines.
1368 The list may contain the symbols `group', `article', `tree' and
1369 `summary'.  If the corresponding symbol is present, Gnus will keep
1370 that mode line updated with information that may be pertinent.
1371 If this variable is nil, screen refresh may be quicker."
1372   :group 'gnus-various
1373   :type '(set (const group)
1374               (const article)
1375               (const summary)
1376               (const tree)))
1377
1378 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1379 (defcustom gnus-mode-non-string-length nil
1380   "*Max length of mode-line non-string contents.
1381 If this is nil, Gnus will take space as is needed, leaving the rest
1382 of the modeline intact.  Note that the default of nil is unlikely
1383 to be desirable; see the manual for further details."
1384   :group 'gnus-various
1385   :type '(choice (const nil)
1386                  integer))
1387
1388 (defcustom gnus-auto-expirable-newsgroups nil
1389   "*Groups in which to automatically mark read articles as expirable.
1390 If non-nil, this should be a regexp that should match all groups in
1391 which to perform auto-expiry.  This only makes sense for mail groups."
1392   :group 'nnmail-expire
1393   :type '(choice (const nil)
1394                  regexp))
1395
1396 (defcustom gnus-total-expirable-newsgroups nil
1397   "*Groups in which to perform expiry of all read articles.
1398 Use with extreme caution.  All groups that match this regexp will be
1399 expiring - which means that all read articles will be deleted after
1400 \(say) one week.         (This only goes for mail groups and the like, of
1401 course.)"
1402   :group 'nnmail-expire
1403   :type '(choice (const nil)
1404                  regexp))
1405
1406 (defcustom gnus-group-uncollapsed-levels 1
1407   "Number of group name elements to leave alone when making a short group name."
1408   :group 'gnus-group-visual
1409   :type 'integer)
1410
1411 (defcustom gnus-group-use-permanent-levels nil
1412   "*If non-nil, once you set a level, Gnus will use this level."
1413   :group 'gnus-group-levels
1414   :type 'boolean)
1415
1416 ;; Hooks.
1417
1418 (defcustom gnus-load-hook nil
1419   "A hook run while Gnus is loaded."
1420   :group 'gnus-start
1421   :type 'hook)
1422
1423 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1424   "A hook called to apply kill files to a group.
1425 This hook is intended to apply a kill file to the selected newsgroup.
1426 The function `gnus-apply-kill-file' is called by default.
1427
1428 Since a general kill file is too heavy to use only for a few
1429 newsgroups, I recommend you to use a lighter hook function.  For
1430 example, if you'd like to apply a kill file to articles which contains
1431 a string `rmgroup' in subject in newsgroup `control', you can use the
1432 following hook:
1433
1434  (setq gnus-apply-kill-hook
1435       (list
1436         (lambda ()
1437           (cond ((string-match \"control\" gnus-newsgroup-name)
1438                  (gnus-kill \"Subject\" \"rmgroup\")
1439                  (gnus-expunge \"X\"))))))"
1440   :group 'gnus-score-kill
1441   :options '(gnus-apply-kill-file)
1442   :type 'hook)
1443
1444 (defcustom gnus-group-change-level-function nil
1445   "Function run when a group level is changed.
1446 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1447   :group 'gnus-group-levels
1448   :type 'function)
1449
1450 ;;; Face thingies.
1451
1452 (defcustom gnus-visual
1453   '(summary-highlight group-highlight article-highlight
1454                       mouse-face
1455                       summary-menu group-menu article-menu
1456                       tree-highlight menu highlight
1457                       browse-menu server-menu
1458                       page-marker tree-menu binary-menu pick-menu
1459                       grouplens-menu)
1460   "*Enable visual features.
1461 If `visual' is disabled, there will be no menus and few faces.  Most of
1462 the visual customization options below will be ignored.  Gnus will use
1463 less space and be faster as a result.
1464
1465 This variable can also be a list of visual elements to switch on.  For
1466 instance, to switch off all visual things except menus, you can say:
1467
1468    (setq gnus-visual '(menu))
1469
1470 Valid elements include `summary-highlight', `group-highlight',
1471 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1472 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1473 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1474 and `grouplens-menu'."
1475   :group 'gnus-meta
1476   :group 'gnus-visual
1477   :type '(set (const summary-highlight)
1478               (const group-highlight)
1479               (const article-highlight)
1480               (const mouse-face)
1481               (const summary-menu)
1482               (const group-menu)
1483               (const article-menu)
1484               (const tree-highlight)
1485               (const menu)
1486               (const highlight)
1487               (const browse-menu)
1488               (const server-menu)
1489               (const page-marker)
1490               (const tree-menu)
1491               (const binary-menu)
1492               (const pick-menu)
1493               (const grouplens-menu)))
1494
1495 (defcustom gnus-mouse-face
1496   (condition-case ()
1497       (if (gnus-visual-p 'mouse-face 'highlight)
1498           (if (boundp 'gnus-mouse-face)
1499               (or gnus-mouse-face 'highlight)
1500             'highlight)
1501         'default)
1502     (error 'highlight))
1503   "*Face used for group or summary buffer mouse highlighting.
1504 The line beneath the mouse pointer will be highlighted with this
1505 face."
1506   :group 'gnus-visual
1507   :type 'face)
1508
1509 (defcustom gnus-article-save-directory gnus-directory
1510   "*Name of the directory articles will be saved in (default \"~/News\")."
1511   :group 'gnus-article-saving
1512   :type 'directory)
1513
1514 (defvar gnus-plugged t
1515   "Whether Gnus is plugged or not.")
1516
1517 (defcustom gnus-default-charset 'iso-8859-1
1518   "Default charset assumed to be used when viewing non-ASCII characters.
1519 This variable is overridden on a group-to-group basis by the
1520 gnus-group-charset-alist variable and is only used on groups not
1521 covered by that variable."
1522   :type 'symbol
1523   :group 'gnus-charset)
1524
1525 (defcustom gnus-default-posting-charset nil
1526   "Default charset assumed to be used when posting non-ASCII characters.
1527 This variable is overridden on a group-to-group basis by the
1528 gnus-group-posting-charset-alist variable and is only used on groups not
1529 covered by that variable.
1530 If nil, no default charset is assumed when posting."
1531   :type 'symbol
1532   :group 'gnus-charset)
1533
1534 \f
1535 ;;; Internal variables
1536
1537 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1538 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1539 (defvar gnus-original-article-buffer " *Original Article*")
1540 (defvar gnus-newsgroup-name nil)
1541 (defvar gnus-ephemeral-servers nil)
1542
1543 (defvar gnus-agent nil
1544   "Whether we want to use the Gnus agent or not.")
1545
1546 (defvar gnus-command-method nil
1547   "Dynamically bound variable that says what the current backend is.")
1548
1549 (defvar gnus-current-select-method nil
1550   "The current method for selecting a newsgroup.")
1551
1552 (defvar gnus-tree-buffer "*Tree*"
1553   "Buffer where Gnus thread trees are displayed.")
1554
1555 ;; Dummy variable.
1556 (defvar gnus-use-generic-from nil)
1557
1558 ;; Variable holding the user answers to all method prompts.
1559 (defvar gnus-method-history nil)
1560
1561 ;; Variable holding the user answers to all mail method prompts.
1562 (defvar gnus-mail-method-history nil)
1563
1564 ;; Variable holding the user answers to all group prompts.
1565 (defvar gnus-group-history nil)
1566
1567 (defvar gnus-server-alist nil
1568   "List of available servers.")
1569
1570 (defcustom gnus-cache-directory
1571   (nnheader-concat gnus-directory "cache/")
1572   "*The directory where cached articles will be stored."
1573   :group 'gnus-cache
1574   :type 'directory)
1575
1576 (defvar gnus-predefined-server-alist
1577   `(("cache"
1578      nnspool "cache"
1579      (nnspool-spool-directory ,gnus-cache-directory)
1580      (nnspool-nov-directory ,gnus-cache-directory)
1581      (nnspool-active-file
1582       ,(nnheader-concat gnus-cache-directory "active"))))
1583   "List of predefined (convenience) servers.")
1584
1585 (defvar gnus-topic-indentation "");; Obsolete variable.
1586
1587 (defconst gnus-article-mark-lists
1588   '((marked . tick) (replied . reply)
1589     (expirable . expire) (killed . killed)
1590     (bookmarks . bookmark) (dormant . dormant)
1591     (scored . score) (saved . save)
1592     (cached . cache) (downloadable . download)
1593     (unsendable . unsend)))
1594
1595 (defvar gnus-headers-retrieved-by nil)
1596 (defvar gnus-article-reply nil)
1597 (defvar gnus-override-method nil)
1598 (defvar gnus-article-check-size nil)
1599 (defvar gnus-opened-servers nil)
1600
1601 (defvar gnus-current-kill-article nil)
1602
1603 (defvar gnus-have-read-active-file nil)
1604
1605 (defconst gnus-maintainer
1606   "semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (T-gnus Bugfixing Girls + Boys)"
1607   "The mail address of the T-gnus maintainers.")
1608
1609 (defcustom gnus-info-filename nil
1610   "*Controls language of gnus Info.
1611 If nil and current-language-environment is Japanese, go to gnus-ja.
1612 Otherwise go to corresponding Info.
1613 This variable can be nil, gnus or gnus-ja."
1614   :group 'gnus-start
1615   :type '(choice (const nil)
1616                  (const :tag "English" gnus)
1617                  (const :tag "Japanese" gnus-ja)))
1618
1619 (defvar gnus-info-nodes
1620   '((gnus-group-mode "The Group Buffer")
1621     (gnus-summary-mode "The Summary Buffer")
1622     (gnus-article-mode "The Article Buffer")
1623     (gnus-server-mode "The Server Buffer")
1624     (gnus-browse-mode "Browse Foreign Server")
1625     (gnus-tree-mode "Tree Display"))
1626   "Alist of major modes and related Info nodes.")
1627
1628 (defvar gnus-group-buffer "*Group*")
1629 (defvar gnus-summary-buffer "*Summary*")
1630 (defvar gnus-article-buffer "*Article*")
1631 (defvar gnus-server-buffer "*Server*")
1632
1633 (defvar gnus-slave nil
1634   "Whether this Gnus is a slave or not.")
1635
1636 (defvar gnus-batch-mode nil
1637   "Whether this Gnus is running in batch mode or not.")
1638
1639 (defvar gnus-variable-list
1640   '(gnus-newsrc-options gnus-newsrc-options-n
1641                         gnus-newsrc-last-checked-date
1642                         gnus-newsrc-alist gnus-server-alist
1643                         gnus-killed-list gnus-zombie-list
1644                         gnus-topic-topology gnus-topic-alist)
1645   "Gnus variables saved in the quick startup file.")
1646
1647 (defvar gnus-product-variable-file-list
1648   (let ((version (product-version (product-find 'gnus-vers)))
1649         (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1650     `(("strict-cache" ((product-version ,version) (emacs-version))
1651        binary
1652        gnus-format-specs-compiled)
1653       ("cache" ((product-version ,version))
1654        ,codesys
1655        gnus-format-specs)))
1656   "Gnus variables are saved in the produce depend quick startup files.")
1657
1658 (defcustom gnus-compile-user-specs t
1659   "If non-nil, the user-defined format specs will be byte-compiled
1660 automatically.
1661 It has an effect on the values of `gnus-*-line-format-spec'."
1662   :group 'gnus
1663   :type 'boolean)
1664
1665 (defvar gnus-newsrc-alist nil
1666   "Assoc list of read articles.
1667 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1668
1669 (defvar gnus-newsrc-hashtb nil
1670   "Hashtable of gnus-newsrc-alist.")
1671
1672 (defvar gnus-killed-list nil
1673   "List of killed newsgroups.")
1674
1675 (defvar gnus-killed-hashtb nil
1676   "Hash table equivalent of gnus-killed-list.")
1677
1678 (defvar gnus-zombie-list nil
1679   "List of almost dead newsgroups.")
1680
1681 (defvar gnus-description-hashtb nil
1682   "Descriptions of newsgroups.")
1683
1684 (defvar gnus-list-of-killed-groups nil
1685   "List of newsgroups that have recently been killed by the user.")
1686
1687 (defvar gnus-active-hashtb nil
1688   "Hashtable of active articles.")
1689
1690 (defvar gnus-moderated-hashtb nil
1691   "Hashtable of moderated newsgroups.")
1692
1693 ;; Save window configuration.
1694 (defvar gnus-prev-winconf nil)
1695
1696 (defvar gnus-reffed-article-number nil)
1697
1698 ;;; Let the byte-compiler know that we know about this variable.
1699 (defvar rmail-default-rmail-file)
1700
1701 (defvar gnus-dead-summary nil)
1702
1703 (defvar gnus-article-display-hook nil
1704   "Controls how the article buffer will look.  This is an obsolete variable;
1705 use the article treating faculties instead.  Is is described in Info node
1706 `Customizing Articles'.")
1707
1708 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1709   "Regexp matching invalid groups.")
1710
1711 ;;; End of variables.
1712
1713 ;; Define some autoload functions Gnus might use.
1714 (eval-and-compile
1715
1716   ;; This little mapcar goes through the list below and marks the
1717   ;; symbols in question as autoloaded functions.
1718   (mapcar
1719    (lambda (package)
1720      (let ((interactive (nth 1 (memq ':interactive package))))
1721        (mapcar
1722         (lambda (function)
1723           (let (keymap)
1724             (when (consp function)
1725               (setq keymap (car (memq 'keymap function)))
1726               (setq function (car function)))
1727             (unless (fboundp function)
1728               (autoload function (car package) nil interactive keymap))))
1729         (if (eq (nth 1 package) ':interactive)
1730             (nthcdr 3 package)
1731           (cdr package)))))
1732    '(("info" :interactive t Info-goto-node)
1733      ("pp" pp pp-to-string pp-eval-expression)
1734      ("ps-print" ps-print-preprint)
1735      ("browse-url" :interactive t browse-url)
1736      ("message" :interactive t
1737       message-send-and-exit message-yank-original)
1738      ("babel" babel-as-string)
1739      ("nnmail" nnmail-split-fancy nnmail-article-group)
1740      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1741      ("rmailout" rmail-output rmail-output-to-rmail-file)
1742      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1743       rmail-show-message rmail-summary-exists
1744       rmail-select-summary rmail-update-summary)
1745      ("gnus-audio" :interactive t gnus-audio-play)
1746      ("gnus-xmas" gnus-xmas-splash)
1747      ("gnus-soup" :interactive t
1748       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1749       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1750      ("nnsoup" nnsoup-pack-replies)
1751      ("score-mode" :interactive t gnus-score-mode)
1752      ("gnus-mh" gnus-summary-save-article-folder
1753       gnus-Folder-save-name gnus-folder-save-name)
1754      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1755      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1756       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1757       gnus-demon-add-disconnection gnus-demon-add-handler
1758       gnus-demon-remove-handler)
1759      ("gnus-demon" :interactive t
1760       gnus-demon-init gnus-demon-cancel)
1761      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1762       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1763      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1764       gnus-nocem-unwanted-article-p)
1765      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1766       gnus-server-server-name)
1767      ("gnus-srvr" gnus-browse-foreign-server)
1768      ("gnus-cite" :interactive t
1769       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1770       gnus-article-hide-citation gnus-article-fill-cited-article
1771       gnus-article-hide-citation-in-followups)
1772      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1773       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1774       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1775      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1776       gnus-cache-possibly-remove-articles gnus-cache-request-article
1777       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1778       gnus-cache-enter-remove-article gnus-cached-article-p
1779       gnus-cache-open gnus-cache-close gnus-cache-update-article
1780       gnus-cache-articles-in-group)
1781      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1782       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1783      ("gnus-score" :interactive t
1784       gnus-summary-increase-score gnus-summary-set-score
1785       gnus-summary-raise-thread gnus-summary-raise-same-subject
1786       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1787       gnus-summary-lower-thread gnus-summary-lower-same-subject
1788       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1789       gnus-summary-current-score gnus-score-delta-default
1790       gnus-score-flush-cache gnus-score-close
1791       gnus-possibly-score-headers gnus-score-followup-article
1792       gnus-score-followup-thread)
1793      ("gnus-score"
1794       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1795       gnus-current-score-file-nondirectory gnus-score-adaptive
1796       gnus-score-find-trace gnus-score-file-name)
1797      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
1798       gnus-score-customize)
1799      ("gnus-topic" :interactive t gnus-topic-mode)
1800      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1801       gnus-subscribe-topics)
1802      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1803      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1804      ("gnus-uu" :interactive t
1805       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1806       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1807       gnus-uu-mark-by-regexp gnus-uu-mark-all
1808       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1809       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1810       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1811       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1812       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1813       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1814       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1815       gnus-uu-mark-over gnus-uu-post-news)
1816      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1817       gnus-uu-unmark-thread)
1818      ("gnus-msg" (gnus-summary-send-map keymap)
1819       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
1820      ("gnus-msg" :interactive t
1821       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1822       gnus-summary-followup gnus-summary-followup-with-original
1823       gnus-summary-cancel-article gnus-summary-supersede-article
1824       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1825       gnus-summary-mail-forward gnus-summary-mail-other-window
1826       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1827       gnus-summary-wide-reply gnus-summary-followup-to-mail
1828       gnus-summary-followup-to-mail-with-original gnus-bug
1829       gnus-summary-wide-reply-with-original
1830       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1831       gnus-summary-post-forward)
1832      ("gnus-picon" :interactive t gnus-article-display-picons
1833       gnus-group-display-picons)
1834      ("gnus-picon" gnus-picons-buffer-name)
1835      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1836       gnus-grouplens-mode)
1837      ("smiley" :interactive t gnus-smiley-display)
1838      ("smiley" smiley-toggle-buffer)
1839      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1840      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1841       gnus-list-of-unread-articles gnus-list-of-read-articles
1842       gnus-offer-save-summaries gnus-make-thread-indent-array
1843       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1844       gnus-summary-skip-intangible gnus-summary-article-number
1845       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
1846      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1847       gnus-group-list-groups gnus-group-first-unread-group
1848       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1849       gnus-group-setup-buffer gnus-group-get-new-news
1850       gnus-group-make-help-group gnus-group-update-group
1851       gnus-group-iterate gnus-group-group-name)
1852      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1853       gnus-backlog-remove-article)
1854      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1855       gnus-article-prepare gnus-article-set-window-start
1856       gnus-article-next-page gnus-article-prev-page
1857       gnus-request-article-this-buffer gnus-article-mode
1858       gnus-article-setup-buffer gnus-narrow-to-page
1859       gnus-article-delete-invisible-text gnus-treat-article)
1860      ("gnus-art" :interactive t
1861       gnus-article-hide-headers gnus-article-hide-boring-headers
1862       gnus-article-treat-overstrike
1863       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1864       gnus-article-display-x-face
1865       gnus-article-decode-HZ
1866       gnus-article-wash-html
1867       gnus-article-hide-pgp
1868       gnus-article-hide-pem gnus-article-hide-signature
1869       gnus-article-strip-leading-blank-lines gnus-article-date-local
1870       gnus-article-date-original gnus-article-date-lapsed
1871       gnus-article-show-all-headers gnus-article-show-all
1872       gnus-article-edit-mode gnus-article-edit-article
1873       gnus-article-edit-done article-decode-encoded-words
1874       gnus-start-date-timer gnus-stop-date-timer
1875       gnus-article-toggle-headers)
1876      ("gnus-int" gnus-request-type)
1877      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1878       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1879      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1880       gnus-dup-enter-articles)
1881      ("gnus-range" gnus-copy-sequence)
1882      ("gnus-eform" gnus-edit-form)
1883      ("gnus-move" :interactive t
1884       gnus-group-move-group-to-server gnus-change-server)
1885      ("gnus-logic" gnus-score-advanced)
1886      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1887      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1888       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1889       gnus-async-halt-prefetch)
1890      ("gnus-offline"
1891       gnus-offline-setup)
1892      ("gnus-offline" :interactive t
1893       gnus-offline-toggle-plugged
1894       gnus-offline-set-unplugged-state
1895       gnus-offline-toggle-auto-hangup
1896       gnus-offline-toggle-on/off-send-mail
1897       gnus-offline-toggle-articles-to-fetch
1898       gnus-offline-set-interval-time
1899       gnus-offline-agent-expire)
1900      ("miee" :interactive t gnspool-get-news
1901       mail-spool-send news-spool-post)
1902      ("international/mw32misc" define-process-argument-editing
1903       general-process-argument-editing-function)
1904      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1905       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1906       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1907       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1908      ("gnus-agent" :interactive t
1909       gnus-unplugged gnus-agentize gnus-agent-batch)
1910      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1911       gnus-summary-save-article-vm)
1912      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1913      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1914      ("gnus-mlspl" :interactive t gnus-group-split-setup
1915       gnus-group-split-update))))
1916
1917 (eval-and-compile
1918   (unless (featurep 'xemacs)
1919     (autoload 'gnus-smiley-display "gnus-bitmap" nil t)
1920     (autoload 'smiley-toggle-buffer "gnus-bitmap")
1921     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
1922
1923 ;;; gnus-sum.el thingies
1924
1925
1926 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1927   "*The format specification of the lines in the summary buffer.
1928
1929 It works along the same lines as a normal formatting string,
1930 with some simple extensions.
1931
1932 %N   Article number, left padded with spaces (string)
1933 %S   Subject (string)
1934 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1935 %n   Name of the poster (string)
1936 %a   Extracted name of the poster (string)
1937 %A   Extracted address of the poster (string)
1938 %F   Contents of the From: header (string)
1939 %f   Contents of the From: or To: headers (string)
1940 %x   Contents of the Xref: header (string)
1941 %D   Date of the article (string)
1942 %d   Date of the article (string) in DD-MMM format
1943 %M   Message-id of the article (string)
1944 %r   References of the article (string)
1945 %c   Number of characters in the article (integer)
1946 %L   Number of lines in the article (integer)
1947 %I   Indentation based on thread level (a string of spaces)
1948 %T   A string with two possible values: 80 spaces if the article
1949      is on thread level two or larger and 0 spaces on level one
1950 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1951 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1952 %[   Opening bracket (character, \"[\" or \"<\")
1953 %]   Closing bracket (character, \"]\" or \">\")
1954 %>   Spaces of length thread-level (string)
1955 %<   Spaces of length (- 20 thread-level) (string)
1956 %i   Article score (number)
1957 %z   Article zcore (character)
1958 %t   Number of articles under the current thread (number).
1959 %e   Whether the thread is empty or not (character).
1960 %l   GroupLens score (string).
1961 %V   Total thread score (number).
1962 %P   The line number (number).
1963 %O   Download mark (character).
1964 %u   User defined specifier.  The next character in the format string should
1965      be a letter.  Gnus will call the function gnus-user-format-function-X,
1966      where X is the letter following %u.  The function will be passed the
1967      current header as argument.  The function should return a string, which
1968      will be inserted into the summary just like information from any other
1969      summary specifier.
1970
1971 Text between %( and %) will be highlighted with `gnus-mouse-face'
1972 when the mouse point is placed inside the area.  There can only be one
1973 such area.
1974
1975 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1976 with care.  For reasons of efficiency, Gnus will compute what column
1977 these characters will end up in, and \"hard-code\" that.  This means that
1978 it is invalid to have these specs after a variable-length spec.  Well,
1979 you might not be arrested, but your summary buffer will look strange,
1980 which is bad enough.
1981
1982 The smart choice is to have these specs as for to the left as
1983 possible.
1984
1985 This restriction may disappear in later versions of Gnus."
1986   :type 'string
1987   :group 'gnus-summary-format)
1988
1989 ;;;
1990 ;;; Skeleton keymaps
1991 ;;;
1992
1993 (defun gnus-suppress-keymap (keymap)
1994   (suppress-keymap keymap)
1995   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1996     (while keys
1997       (define-key keymap (pop keys) 'undefined))))
1998
1999 (defvar gnus-article-mode-map
2000   (let ((keymap (make-sparse-keymap)))
2001     (gnus-suppress-keymap keymap)
2002     keymap))
2003 (defvar gnus-summary-mode-map
2004   (let ((keymap (make-keymap)))
2005     (gnus-suppress-keymap keymap)
2006     keymap))
2007 (defvar gnus-group-mode-map
2008   (let ((keymap (make-keymap)))
2009     (gnus-suppress-keymap keymap)
2010     keymap))
2011
2012 \f
2013
2014 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2015 ;; If you want the cursor to go somewhere else, set these two
2016 ;; functions in some startup hook to whatever you want.
2017 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2018 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2019
2020 ;;; Various macros and substs.
2021
2022 (defun gnus-header-from (header)
2023   (mail-header-from header))
2024
2025 (defmacro gnus-gethash (string hashtable)
2026   "Get hash value of STRING in HASHTABLE."
2027   `(symbol-value (intern-soft ,string ,hashtable)))
2028
2029 (defmacro gnus-sethash (string value hashtable)
2030   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2031   `(set (intern ,string ,hashtable) ,value))
2032 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2033
2034 (defmacro gnus-group-unread (group)
2035   "Get the currently computed number of unread articles in GROUP."
2036   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2037
2038 (defmacro gnus-group-entry (group)
2039   "Get the newsrc entry for GROUP."
2040   `(gnus-gethash ,group gnus-newsrc-hashtb))
2041
2042 (defmacro gnus-active (group)
2043   "Get active info on GROUP."
2044   `(gnus-gethash ,group gnus-active-hashtb))
2045
2046 (defmacro gnus-set-active (group active)
2047   "Set GROUP's active info."
2048   `(gnus-sethash ,group ,active gnus-active-hashtb))
2049
2050 ;; Info access macros.
2051
2052 (defmacro gnus-info-group (info)
2053   `(nth 0 ,info))
2054 (defmacro gnus-info-rank (info)
2055   `(nth 1 ,info))
2056 (defmacro gnus-info-read (info)
2057   `(nth 2 ,info))
2058 (defmacro gnus-info-marks (info)
2059   `(nth 3 ,info))
2060 (defmacro gnus-info-method (info)
2061   `(nth 4 ,info))
2062 (defmacro gnus-info-params (info)
2063   `(nth 5 ,info))
2064
2065 (defmacro gnus-info-level (info)
2066   `(let ((rank (gnus-info-rank ,info)))
2067      (if (consp rank)
2068          (car rank)
2069        rank)))
2070 (defmacro gnus-info-score (info)
2071   `(let ((rank (gnus-info-rank ,info)))
2072      (or (and (consp rank) (cdr rank)) 0)))
2073
2074 (defmacro gnus-info-set-group (info group)
2075   `(setcar ,info ,group))
2076 (defmacro gnus-info-set-rank (info rank)
2077   `(setcar (nthcdr 1 ,info) ,rank))
2078 (defmacro gnus-info-set-read (info read)
2079   `(setcar (nthcdr 2 ,info) ,read))
2080 (defmacro gnus-info-set-marks (info marks &optional extend)
2081   (if extend
2082       `(gnus-info-set-entry ,info ,marks 3)
2083     `(setcar (nthcdr 3 ,info) ,marks)))
2084 (defmacro gnus-info-set-method (info method &optional extend)
2085   (if extend
2086       `(gnus-info-set-entry ,info ,method 4)
2087     `(setcar (nthcdr 4 ,info) ,method)))
2088 (defmacro gnus-info-set-params (info params &optional extend)
2089   (if extend
2090       `(gnus-info-set-entry ,info ,params 5)
2091     `(setcar (nthcdr 5 ,info) ,params)))
2092
2093 (defun gnus-info-set-entry (info entry number)
2094   ;; Extend the info until we have enough elements.
2095   (while (<= (length info) number)
2096     (nconc info (list nil)))
2097   ;; Set the entry.
2098   (setcar (nthcdr number info) entry))
2099
2100 (defmacro gnus-info-set-level (info level)
2101   `(let ((rank (cdr ,info)))
2102      (if (consp (car rank))
2103          (setcar (car rank) ,level)
2104        (setcar rank ,level))))
2105 (defmacro gnus-info-set-score (info score)
2106   `(let ((rank (cdr ,info)))
2107      (if (consp (car rank))
2108          (setcdr (car rank) ,score)
2109        (setcar rank (cons (car rank) ,score)))))
2110
2111 (defmacro gnus-get-info (group)
2112   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2113
2114 ;; Byte-compiler warning.
2115 (defvar gnus-visual)
2116 ;; Find out whether the gnus-visual TYPE is wanted.
2117 (defun gnus-visual-p (&optional type class)
2118   (and gnus-visual                      ; Has to be non-nil, at least.
2119        (if (not type)                   ; We don't care about type.
2120            gnus-visual
2121          (if (listp gnus-visual)        ; It's a list, so we check it.
2122              (or (memq type gnus-visual)
2123                  (memq class gnus-visual))
2124            t))))
2125
2126 ;;; Load the compatability functions.
2127
2128 (require 'gnus-ems)
2129
2130 \f
2131 ;;;
2132 ;;; Shutdown
2133 ;;;
2134
2135 (defvar gnus-shutdown-alist nil)
2136
2137 (defun gnus-add-shutdown (function &rest symbols)
2138   "Run FUNCTION whenever one of SYMBOLS is shut down."
2139   (push (cons function symbols) gnus-shutdown-alist))
2140
2141 (defun gnus-shutdown (symbol)
2142   "Shut down everything that waits for SYMBOL."
2143   (let ((alist gnus-shutdown-alist)
2144         entry)
2145     (while (setq entry (pop alist))
2146       (when (memq symbol (cdr entry))
2147         (funcall (car entry))))))
2148
2149 \f
2150 ;;;
2151 ;;; Gnus Utility Functions
2152 ;;;
2153
2154
2155 (defmacro gnus-string-or (&rest strings)
2156   "Return the first element of STRINGS that is a non-blank string.
2157 STRINGS will be evaluated in normal `or' order."
2158   `(gnus-string-or-1 ',strings))
2159
2160 (defun gnus-string-or-1 (strings)
2161   (let (string)
2162     (while strings
2163       (setq string (eval (pop strings)))
2164       (if (string-match "^[ \t]*$" string)
2165           (setq string nil)
2166         (setq strings nil)))
2167     string))
2168
2169 (defun gnus-info-find-node ()
2170   "Find Info documentation of Gnus."
2171   (interactive)
2172   ;; Enlarge info window if needed.
2173   (let (gnus-info-buffer)
2174     (Info-goto-node
2175      (format "(%s)%s"
2176              (or gnus-info-filename
2177                  (get-language-info current-language-environment 'gnus-info)
2178                  "gnus")
2179              (cadr (assq major-mode gnus-info-nodes))))
2180     (setq gnus-info-buffer (current-buffer))
2181     (gnus-configure-windows 'info)))
2182
2183 ;;;
2184 ;;; gnus-interactive
2185 ;;;
2186
2187 (defvar gnus-current-prefix-symbol nil
2188   "Current prefix symbol.")
2189
2190 (defvar gnus-current-prefix-symbols nil
2191   "List of current prefix symbols.")
2192
2193 (defun gnus-interactive (string &optional params)
2194   "Return a list that can be fed to `interactive'.
2195 See `interactive' for full documentation.
2196
2197 Adds the following specs:
2198
2199 y -- The current symbolic prefix.
2200 Y -- A list of the current symbolic prefix(es).
2201 A -- Article number.
2202 H -- Article header.
2203 g -- Group name."
2204   (let ((i 0)
2205         out c prompt)
2206     (while (< i (length string))
2207       (string-match ".\\([^\n]*\\)\n?" string i)
2208       (setq c (aref string i))
2209       (when (match-end 1)
2210         (setq prompt (match-string 1 string)))
2211       (setq i (match-end 0))
2212       ;; We basically emulate just about everything that
2213       ;; `interactive' does, but add the specs listed above.
2214       (push
2215        (cond
2216         ((= c ?a)
2217          (completing-read prompt obarray 'fboundp t))
2218         ((= c ?b)
2219          (read-buffer prompt (current-buffer) t))
2220         ((= c ?B)
2221          (read-buffer prompt (other-buffer (current-buffer))))
2222         ((= c ?c)
2223          (read-char))
2224         ((= c ?C)
2225          (completing-read prompt obarray 'commandp t))
2226         ((= c ?d)
2227          (point))
2228         ((= c ?D)
2229          (read-file-name prompt nil default-directory 'lambda))
2230         ((= c ?f)
2231          (read-file-name prompt nil nil 'lambda))
2232         ((= c ?F)
2233          (read-file-name prompt))
2234         ((= c ?k)
2235          (read-key-sequence prompt))
2236         ((= c ?K)
2237          (error "Not implemented spec"))
2238         ((= c ?e)
2239          (error "Not implemented spec"))
2240         ((= c ?m)
2241          (mark))
2242         ((= c ?N)
2243          (error "Not implemented spec"))
2244         ((= c ?n)
2245          (string-to-number (read-from-minibuffer prompt)))
2246         ((= c ?p)
2247          (prefix-numeric-value current-prefix-arg))
2248         ((= c ?P)
2249          current-prefix-arg)
2250         ((= c ?r)
2251          'gnus-prefix-nil)
2252         ((= c ?s)
2253          (read-string prompt))
2254         ((= c ?S)
2255          (intern (read-string prompt)))
2256         ((= c ?v)
2257          (read-variable prompt))
2258         ((= c ?x)
2259          (read-minibuffer prompt))
2260         ((= c ?x)
2261          (eval-minibuffer prompt))
2262         ;; And here the new specs come.
2263         ((= c ?y)
2264          gnus-current-prefix-symbol)
2265         ((= c ?Y)
2266          gnus-current-prefix-symbols)
2267         ((= c ?g)
2268          (gnus-group-group-name))
2269         ((= c ?A)
2270          (gnus-summary-skip-intangible)
2271          (or (get-text-property (point) 'gnus-number)
2272              (gnus-summary-last-subject)))
2273         ((= c ?H)
2274          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2275         (t
2276          (error "Non-implemented spec")))
2277        out)
2278       (cond
2279        ((= c ?r)
2280         (push (if (< (point) (mark) (point) (mark))) out)
2281         (push (if (> (point) (mark) (point) (mark))) out))))
2282     (setq out (delq 'gnus-prefix-nil out))
2283     (nreverse out)))
2284
2285 (defun gnus-symbolic-argument (&optional arg)
2286   "Read a symbolic argument and a command, and then execute command."
2287   (interactive "P")
2288   (let* ((in-command (this-command-keys))
2289          (command in-command)
2290          gnus-current-prefix-symbols
2291          gnus-current-prefix-symbol
2292          syms)
2293     (while (equal in-command command)
2294       (message "%s-" (key-description (this-command-keys)))
2295       (push (intern (char-to-string (read-char))) syms)
2296       (setq command (read-key-sequence nil t)))
2297     (setq gnus-current-prefix-symbols (nreverse syms)
2298           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2299     (call-interactively (key-binding command t))))
2300
2301 ;;; More various functions.
2302
2303 (defsubst gnus-check-backend-function (func group)
2304   "Check whether GROUP supports function FUNC.
2305 GROUP can either be a string (a group name) or a select method."
2306   (ignore-errors
2307     (let ((method (if (stringp group)
2308                       (car (gnus-find-method-for-group group))
2309                     group)))
2310       (unless (featurep method)
2311         (require method))
2312       (fboundp (intern (format "%s-%s" method func))))))
2313
2314 (defun gnus-group-read-only-p (&optional group)
2315   "Check whether GROUP supports editing or not.
2316 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2317 that that variable is buffer-local to the summary buffers."
2318   (let ((group (or group gnus-newsgroup-name)))
2319     (not (gnus-check-backend-function 'request-replace-article group))))
2320
2321 (defun gnus-group-total-expirable-p (group)
2322   "Check whether GROUP is total-expirable or not."
2323   (let ((params (gnus-group-find-parameter group))
2324         val)
2325     (cond
2326      ((memq 'total-expire params)
2327       t)
2328      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2329       (cdr val))
2330      (gnus-total-expirable-newsgroups   ; Check var.
2331       (string-match gnus-total-expirable-newsgroups group)))))
2332
2333 (defun gnus-group-auto-expirable-p (group)
2334   "Check whether GROUP is auto-expirable or not."
2335   (let ((params (gnus-group-find-parameter group))
2336         val)
2337     (cond
2338      ((memq 'auto-expire params)
2339       t)
2340      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2341       (cdr val))
2342      (gnus-auto-expirable-newsgroups    ; Check var.
2343       (string-match gnus-auto-expirable-newsgroups group)))))
2344
2345 (defun gnus-virtual-group-p (group)
2346   "Say whether GROUP is virtual or not."
2347   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2348                         gnus-valid-select-methods)))
2349
2350 (defun gnus-news-group-p (group &optional article)
2351   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2352   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2353       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2354            (if (or (null article)
2355                    (not (< article 0)))
2356                (eq (gnus-request-type group article) 'news)
2357              (if (not (vectorp article))
2358                  nil
2359                ;; It's a real article.
2360                (eq (gnus-request-type group (mail-header-id article))
2361                    'news))))))
2362
2363 ;; Returns a list of writable groups.
2364 (defun gnus-writable-groups ()
2365   (let ((alist gnus-newsrc-alist)
2366         groups group)
2367     (while (setq group (car (pop alist)))
2368       (unless (gnus-group-read-only-p group)
2369         (push group groups)))
2370     (nreverse groups)))
2371
2372 ;; Check whether to use long file names.
2373 (defun gnus-use-long-file-name (symbol)
2374   ;; The variable has to be set...
2375   (and gnus-use-long-file-name
2376        ;; If it isn't a list, then we return t.
2377        (or (not (listp gnus-use-long-file-name))
2378            ;; If it is a list, and the list contains `symbol', we
2379            ;; return nil.
2380            (not (memq symbol gnus-use-long-file-name)))))
2381
2382 ;; Generate a unique new group name.
2383 (defun gnus-generate-new-group-name (leaf)
2384   (let ((name leaf)
2385         (num 0))
2386     (while (gnus-gethash name gnus-newsrc-hashtb)
2387       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2388     name))
2389
2390 (defun gnus-ephemeral-group-p (group)
2391   "Say whether GROUP is ephemeral or not."
2392   (gnus-group-get-parameter group 'quit-config t))
2393
2394 (defun gnus-group-quit-config (group)
2395   "Return the quit-config of GROUP."
2396   (gnus-group-get-parameter group 'quit-config t))
2397
2398 (defun gnus-kill-ephemeral-group (group)
2399   "Remove ephemeral GROUP from relevant structures."
2400   (gnus-sethash group nil gnus-newsrc-hashtb))
2401
2402 (defun gnus-simplify-mode-line ()
2403   "Make mode lines a bit simpler."
2404   (setq mode-line-modified (cdr gnus-mode-line-modified))
2405   (when (listp mode-line-format)
2406     (make-local-variable 'mode-line-format)
2407     (setq mode-line-format (copy-sequence mode-line-format))
2408     (when (equal (nth 3 mode-line-format) "   ")
2409       (setcar (nthcdr 3 mode-line-format) " "))))
2410
2411 ;;; Servers and groups.
2412
2413 (defsubst gnus-server-add-address (method)
2414   (let ((method-name (symbol-name (car method))))
2415     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2416              (not (assq (intern (concat method-name "-address")) method))
2417              (memq 'physical-address (assq (car method)
2418                                            gnus-valid-select-methods)))
2419         (append method (list (list (intern (concat method-name "-address"))
2420                                    (nth 1 method))))
2421       method)))
2422
2423 (defsubst gnus-server-get-method (group method)
2424   ;; Input either a server name, and extended server name, or a
2425   ;; select method, and return a select method.
2426   (cond ((stringp method)
2427          (gnus-server-to-method method))
2428         ((equal method gnus-select-method)
2429          gnus-select-method)
2430         ((and (stringp (car method))
2431               group)
2432          (gnus-server-extend-method group method))
2433         ((and method
2434               (not group)
2435               (equal (cadr method) ""))
2436          method)
2437         (t
2438          (gnus-server-add-address method))))
2439
2440 (defun gnus-server-to-method (server)
2441   "Map virtual server names to select methods."
2442   (or
2443    ;; Is this a method, perhaps?
2444    (and server (listp server) server)
2445    ;; Perhaps this is the native server?
2446    (and (equal server "native") gnus-select-method)
2447    ;; It should be in the server alist.
2448    (cdr (assoc server gnus-server-alist))
2449    ;; It could be in the predefined server alist.
2450    (cdr (assoc server gnus-predefined-server-alist))
2451    ;; If not, we look through all the opened server
2452    ;; to see whether we can find it there.
2453    (let ((opened gnus-opened-servers))
2454      (while (and opened
2455                  (not (equal server (format "%s:%s" (caaar opened)
2456                                             (cadaar opened)))))
2457        (pop opened))
2458      (caar opened))
2459    ;; It could be a named method, search all servers
2460    (let ((servers gnus-secondary-select-methods))
2461      (while (and servers
2462                  (not (equal server (format "%s:%s" (caar servers)
2463                                             (cadar servers)))))
2464        (pop servers))
2465      (car servers))))
2466
2467 (defmacro gnus-method-equal (ss1 ss2)
2468   "Say whether two servers are equal."
2469   `(let ((s1 ,ss1)
2470          (s2 ,ss2))
2471      (or (equal s1 s2)
2472          (and (= (length s1) (length s2))
2473               (progn
2474                 (while (and s1 (member (car s1) s2))
2475                   (setq s1 (cdr s1)))
2476                 (null s1))))))
2477
2478 (defun gnus-methods-equal-p (m1 m2)
2479   (let ((m1 (or m1 gnus-select-method))
2480         (m2 (or m2 gnus-select-method)))
2481     (or (equal m1 m2)
2482         (and (eq (car m1) (car m2))
2483              (or (not (memq 'address (assoc (symbol-name (car m1))
2484                                             gnus-valid-select-methods)))
2485                  (equal (nth 1 m1) (nth 1 m2)))))))
2486
2487 (defun gnus-server-equal (m1 m2)
2488   "Say whether two methods are equal."
2489   (let ((m1 (cond ((null m1) gnus-select-method)
2490                   ((stringp m1) (gnus-server-to-method m1))
2491                   (t m1)))
2492         (m2 (cond ((null m2) gnus-select-method)
2493                   ((stringp m2) (gnus-server-to-method m2))
2494                   (t m2))))
2495     (gnus-method-equal m1 m2)))
2496
2497 (defun gnus-servers-using-backend (backend)
2498   "Return a list of known servers using BACKEND."
2499   (let ((opened gnus-opened-servers)
2500         out)
2501     (while opened
2502       (when (eq backend (caaar opened))
2503         (push (caar opened) out))
2504       (pop opened))
2505     out))
2506
2507 (defun gnus-archive-server-wanted-p ()
2508   "Say whether the user wants to use the archive server."
2509   (cond
2510    ((or (not gnus-message-archive-method)
2511         (not gnus-message-archive-group))
2512     nil)
2513    ((and gnus-message-archive-method gnus-message-archive-group)
2514     t)
2515    (t
2516     (let ((active (cadr (assq 'nnfolder-active-file
2517                               gnus-message-archive-method))))
2518       (and active
2519            (file-exists-p active))))))
2520
2521 (defun gnus-group-prefixed-name (group method)
2522   "Return the whole name from GROUP and METHOD."
2523   (and (stringp method) (setq method (gnus-server-to-method method)))
2524   (if (or (not method)
2525           (gnus-server-equal method "native"))
2526       group
2527     (concat (format "%s" (car method))
2528             (when (and
2529                    (or (assoc (format "%s" (car method))
2530                               (gnus-methods-using 'address))
2531                        (gnus-server-equal method gnus-message-archive-method))
2532                    (nth 1 method)
2533                    (not (string= (nth 1 method) "")))
2534               (concat "+" (nth 1 method)))
2535             ":" group)))
2536
2537 (defun gnus-group-real-prefix (group)
2538   "Return the prefix of the current group name."
2539   (if (string-match "^[^:]+:" group)
2540       (substring group 0 (match-end 0))
2541     ""))
2542
2543 (defun gnus-group-method (group)
2544   "Return the server or method used for selecting GROUP.
2545 You should probably use `gnus-find-method-for-group' instead."
2546   (let ((prefix (gnus-group-real-prefix group)))
2547     (if (equal prefix "")
2548         gnus-select-method
2549       (let ((servers gnus-opened-servers)
2550             (server "")
2551             backend possible found)
2552         (if (string-match "^[^\\+]+\\+" prefix)
2553             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2554                   server (substring prefix (match-end 0) (1- (length prefix))))
2555           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2556         (while servers
2557           (when (eq (caaar servers) backend)
2558             (setq possible (caar servers))
2559             (when (equal (cadaar servers) server)
2560               (setq found (caar servers))))
2561           (pop servers))
2562         (or (car (rassoc found gnus-server-alist))
2563             found
2564             (car (rassoc possible gnus-server-alist))
2565             possible
2566             (list backend server))))))
2567
2568 (defsubst gnus-native-method-p (method)
2569   "Return whether METHOD is the native select method."
2570   (gnus-method-equal method gnus-select-method))
2571
2572 (defsubst gnus-secondary-method-p (method)
2573   "Return whether METHOD is a secondary select method."
2574   (let ((methods gnus-secondary-select-methods)
2575         (gmethod (gnus-server-get-method nil method)))
2576     (while (and methods
2577                 (not (gnus-method-equal
2578                       (gnus-server-get-method nil (car methods))
2579                       gmethod)))
2580       (setq methods (cdr methods)))
2581     methods))
2582
2583 (defun gnus-method-simplify (method)
2584   "Return the shortest uniquely identifying string or method for METHOD."
2585   (cond ((stringp method)
2586          method)
2587         ((gnus-native-method-p method)
2588          nil)
2589         ((gnus-secondary-method-p method)
2590          (format "%s:%s" (nth 0 method) (nth 1 method)))
2591         (t
2592          method)))
2593
2594 (defun gnus-groups-from-server (server)
2595   "Return a list of all groups that are fetched from SERVER."
2596   (let ((alist (cdr gnus-newsrc-alist))
2597         info groups)
2598     (while (setq info (pop alist))
2599       (when (gnus-server-equal (gnus-info-method info) server)
2600         (push (gnus-info-group info) groups)))
2601     (sort groups 'string<)))
2602
2603 (defun gnus-group-foreign-p (group)
2604   "Say whether a group is foreign or not."
2605   (and (not (gnus-group-native-p group))
2606        (not (gnus-group-secondary-p group))))
2607
2608 (defun gnus-group-native-p (group)
2609   "Say whether the group is native or not."
2610   (not (string-match ":" group)))
2611
2612 (defun gnus-group-secondary-p (group)
2613   "Say whether the group is secondary or not."
2614   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2615
2616 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2617   "Return the group parameters for GROUP.
2618 If SYMBOL, return the value of that symbol in the group parameters."
2619   (save-excursion
2620     (set-buffer gnus-group-buffer)
2621     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2622       (if symbol
2623           (gnus-group-parameter-value parameters symbol allow-list)
2624         parameters))))
2625
2626 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2627   "Return the group parameters for GROUP.
2628 If SYMBOL, return the value of that symbol in the group parameters.
2629 Most functions should use `gnus-group-find-parameter', which
2630 also examines the topic parameters."
2631   (let ((params (gnus-info-params (gnus-get-info group))))
2632     (if symbol
2633         (gnus-group-parameter-value params symbol allow-list)
2634       params)))
2635
2636 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2637   "Return the value of SYMBOL in group PARAMS."
2638   ;; We only wish to return group parameters (dotted lists) and
2639   ;; not local variables, which may have the same names.
2640   ;; But first we handle single elements...
2641   (or (car (memq symbol params))
2642       ;; Handle alist.
2643       (let (elem)
2644         (catch 'found
2645           (while (setq elem (pop params))
2646             (when (and (consp elem)
2647                        (eq (car elem) symbol)
2648                        (or allow-list
2649                            (atom (cdr elem))))
2650               (throw 'found (cdr elem))))))))
2651
2652 (defun gnus-group-add-parameter (group param)
2653   "Add parameter PARAM to GROUP."
2654   (let ((info (gnus-get-info group)))
2655     (when info
2656       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2657       ;; Cons the new param to the old one and update.
2658       (gnus-group-set-info (cons param (gnus-info-params info))
2659                            group 'params))))
2660
2661 (defun gnus-group-set-parameter (group name value)
2662   "Set parameter NAME to VALUE in GROUP."
2663   (let ((info (gnus-get-info group)))
2664     (when info
2665       (gnus-group-remove-parameter group name)
2666       (let ((old-params (gnus-info-params info))
2667             (new-params (list (cons name value))))
2668         (while old-params
2669           (when (or (not (listp (car old-params)))
2670                     (not (eq (caar old-params) name)))
2671             (setq new-params (append new-params (list (car old-params)))))
2672           (setq old-params (cdr old-params)))
2673         (gnus-group-set-info new-params group 'params)))))
2674
2675 (defun gnus-group-remove-parameter (group name)
2676   "Remove parameter NAME from GROUP."
2677   (let ((info (gnus-get-info group)))
2678     (when info
2679       (let ((params (gnus-info-params info)))
2680         (when params
2681           (setq params (delq name params))
2682           (while (assq name params)
2683             (gnus-pull name params))
2684           (gnus-info-set-params info params))))))
2685
2686 (defun gnus-group-add-score (group &optional score)
2687   "Add SCORE to the GROUP score.
2688 If SCORE is nil, add 1 to the score of GROUP."
2689   (let ((info (gnus-get-info group)))
2690     (when info
2691       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2692
2693 (defun gnus-short-group-name (group &optional levels)
2694   "Collapse GROUP name LEVELS.
2695 Select methods are stripped and any remote host name is stripped down to
2696 just the host name."
2697   (let* ((name "")
2698          (foreign "")
2699          (depth 0)
2700          (skip 1)
2701          (levels (or levels
2702                      gnus-group-uncollapsed-levels
2703                      (progn
2704                        (while (string-match "\\." group skip)
2705                          (setq skip (match-end 0)
2706                                depth (+ depth 1)))
2707                        depth))))
2708     ;; Separate foreign select method from group name and collapse.
2709     ;; If method contains a server, collapse to non-domain server name,
2710     ;; otherwise collapse to select method.
2711     (let* ((colon (string-match ":" group))
2712            (server (and colon (substring group 0 colon)))
2713            (plus (and server (string-match "+" server))))
2714       (when server
2715         (if plus
2716             (setq foreign (substring server (+ 1 plus)
2717                                      (string-match "\\." server))
2718                   group (substring group (+ 1 colon)))
2719           (setq foreign server
2720                 group (substring group (+ 1 colon))))
2721         (setq foreign (concat foreign ":")))
2722       ;; Collapse group name leaving LEVELS uncollapsed elements
2723       (let* ((glist (split-string group "\\."))
2724              (glen (length glist))
2725              res)
2726         (setq levels (- glen levels))
2727         (dolist (g glist)
2728           (push (if (>= (decf levels) 0)
2729                     (if (zerop (length g))
2730                         ""
2731                       (substring g 0 1))
2732                   g)
2733                 res))
2734         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2735
2736 (defun gnus-narrow-to-body ()
2737   "Narrow to the body of an article."
2738   (narrow-to-region
2739    (progn
2740      (goto-char (point-min))
2741      (or (search-forward "\n\n" nil t)
2742          (point-max)))
2743    (point-max)))
2744
2745 \f
2746 ;;;
2747 ;;; Kill file handling.
2748 ;;;
2749
2750 (defun gnus-apply-kill-file ()
2751   "Apply a kill file to the current newsgroup.
2752 Returns the number of articles marked as read."
2753   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2754           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2755       (gnus-apply-kill-file-internal)
2756     0))
2757
2758 (defun gnus-kill-save-kill-buffer ()
2759   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2760     (when (get-file-buffer file)
2761       (save-excursion
2762         (set-buffer (get-file-buffer file))
2763         (when (buffer-modified-p)
2764           (save-buffer))
2765         (kill-buffer (current-buffer))))))
2766
2767 (defcustom gnus-kill-file-name "KILL"
2768   "Suffix of the kill files."
2769   :group 'gnus-score-kill
2770   :group 'gnus-score-files
2771   :type 'string)
2772
2773 (defun gnus-newsgroup-kill-file (newsgroup)
2774   "Return the name of a kill file name for NEWSGROUP.
2775 If NEWSGROUP is nil, return the global kill file name instead."
2776   (cond
2777    ;; The global KILL file is placed at top of the directory.
2778    ((or (null newsgroup)
2779         (string-equal newsgroup ""))
2780     (expand-file-name gnus-kill-file-name
2781                       gnus-kill-files-directory))
2782    ;; Append ".KILL" to newsgroup name.
2783    ((gnus-use-long-file-name 'not-kill)
2784     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2785                               "." gnus-kill-file-name)
2786                       gnus-kill-files-directory))
2787    ;; Place "KILL" under the hierarchical directory.
2788    (t
2789     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2790                               "/" gnus-kill-file-name)
2791                       gnus-kill-files-directory))))
2792
2793 ;;; Server things.
2794
2795 (defun gnus-member-of-valid (symbol group)
2796   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2797   (memq symbol (assoc
2798                 (symbol-name (car (gnus-find-method-for-group group)))
2799                 gnus-valid-select-methods)))
2800
2801 (defun gnus-method-option-p (method option)
2802   "Return non-nil if select METHOD has OPTION as a parameter."
2803   (when (stringp method)
2804     (setq method (gnus-server-to-method method)))
2805   (memq option (assoc (format "%s" (car method))
2806                       gnus-valid-select-methods)))
2807
2808 (defun gnus-similar-server-opened (method)
2809   (let ((opened gnus-opened-servers))
2810     (while (and method opened)
2811       (when (and (equal (cadr method) (cadaar opened))
2812                  (equal (car method) (caaar opened))
2813                  (not (equal method (caar opened))))
2814         (setq method nil))
2815       (pop opened))
2816     (not method)))
2817
2818 (defun gnus-server-extend-method (group method)
2819   ;; This function "extends" a virtual server.  If the server is
2820   ;; "hello", and the select method is ("hello" (my-var "something"))
2821   ;; in the group "alt.alt", this will result in a new virtual server
2822   ;; called "hello+alt.alt".
2823   (if (or (not (inline (gnus-similar-server-opened method)))
2824           (not (cddr method)))
2825       method
2826     `(,(car method) ,(concat (cadr method) "+" group)
2827       (,(intern (format "%s-address" (car method))) ,(cadr method))
2828       ,@(cddr method))))
2829
2830 (defun gnus-server-status (method)
2831   "Return the status of METHOD."
2832   (nth 1 (assoc method gnus-opened-servers)))
2833
2834 (defun gnus-group-name-to-method (group)
2835   "Guess a select method based on GROUP."
2836   (if (string-match ":" group)
2837       (let ((server (substring group 0 (match-beginning 0))))
2838         (if (string-match "\\+" server)
2839             (list (intern (substring server 0 (match-beginning 0)))
2840                   (substring server (match-end 0)))
2841           (list (intern server) "")))
2842     gnus-select-method))
2843
2844 (defun gnus-find-method-for-group (group &optional info)
2845   "Find the select method that GROUP uses."
2846   (or gnus-override-method
2847       (and (not group)
2848            gnus-select-method)
2849       (and (not (gnus-group-entry group));; a new group
2850            (gnus-group-name-to-method group))
2851       (let ((info (or info (gnus-get-info group)))
2852             method)
2853         (if (or (not info)
2854                 (not (setq method (gnus-info-method info)))
2855                 (equal method "native"))
2856             gnus-select-method
2857           (setq method
2858                 (cond ((stringp method)
2859                        (inline (gnus-server-to-method method)))
2860                       ((stringp (cadr method))
2861                        (inline (gnus-server-extend-method group method)))
2862                       (t
2863                        method)))
2864           (cond ((equal (cadr method) "")
2865                  method)
2866                 ((null (cadr method))
2867                  (list (car method) ""))
2868                 (t
2869                  (gnus-server-add-address method)))))))
2870
2871 (defun gnus-methods-using (feature)
2872   "Find all methods that have FEATURE."
2873   (let ((valids gnus-valid-select-methods)
2874         outs)
2875     (while valids
2876       (when (memq feature (car valids))
2877         (push (car valids) outs))
2878       (setq valids (cdr valids)))
2879     outs))
2880
2881 (defun gnus-read-group (prompt &optional default)
2882   "Prompt the user for a group name.
2883 Disallow invalid group names."
2884   (let ((prefix "")
2885         group)
2886     (while (not group)
2887       (when (string-match 
2888              gnus-invalid-group-regexp
2889              (setq group (read-string (concat prefix prompt)
2890                                       (cons (or default "") 0)
2891                                       'gnus-group-history)))
2892         (setq prefix (format "Invalid group name: \"%s\".  " group)
2893               group nil)))
2894     group))
2895
2896 (defun gnus-read-method (prompt)
2897   "Prompt the user for a method.
2898 Allow completion over sensible values."
2899   (let* ((servers
2900           (append gnus-valid-select-methods
2901                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2902                                                     (cadar i))))
2903                           gnus-opened-servers)
2904                   gnus-predefined-server-alist
2905                   gnus-server-alist))
2906          (method
2907           (completing-read
2908            prompt servers
2909            nil t nil 'gnus-method-history)))
2910     (cond
2911      ((equal method "")
2912       (setq method gnus-select-method))
2913      ((assoc method gnus-valid-select-methods)
2914       (let ((address (if (memq 'prompt-address
2915                                (assoc method gnus-valid-select-methods))
2916                          (read-string "Address: ")
2917                        "")))
2918         (or (let ((opened gnus-opened-servers))
2919               (while (and opened
2920                           (not (equal (format "%s:%s" method address)
2921                                       (format "%s:%s" (caaar opened)
2922                                               (cadaar opened)))))
2923                 (pop opened))
2924               (caar opened))
2925             (list (intern method) address))))
2926      ((assoc method servers)
2927       method)
2928      (t
2929       (list (intern method) "")))))
2930
2931 ;;; User-level commands.
2932
2933 ;;;###autoload
2934 (defun gnus-slave-no-server (&optional arg)
2935   "Read network news as a slave, without connecting to local server."
2936   (interactive "P")
2937   (gnus-no-server arg t))
2938
2939 ;;;###autoload
2940 (defun gnus-no-server (&optional arg slave)
2941   "Read network news.
2942 If ARG is a positive number, Gnus will use that as the
2943 startup level.  If ARG is nil, Gnus will be started at level 2.
2944 If ARG is non-nil and not a positive number, Gnus will
2945 prompt the user for the name of an NNTP server to use.
2946 As opposed to `gnus', this command will not connect to the local server."
2947   (interactive "P")
2948   (gnus-no-server-1 arg slave))
2949
2950 ;;;###autoload
2951 (defun gnus-slave (&optional arg)
2952   "Read news as a slave."
2953   (interactive "P")
2954   (gnus arg nil 'slave))
2955
2956 (defcustom gnus-frame-properties nil
2957   "The properties of the frame in which gnus is displayed. Under XEmacs,
2958 the variable `toolbar-news-frame-plist' will be refered instead."
2959   :type '(repeat (cons :format "%v"
2960                        (symbol :tag "Parameter")
2961                        (sexp :tag "Value")))
2962   :group 'gnus)
2963
2964 (defvar gnus-frame nil
2965   "The frame in which gnus is displayed. It is not used under XEmacs.")
2966
2967 ;;;###autoload
2968 (defun gnus-other-frame (&optional arg)
2969   "Pop up a frame to read news."
2970   (interactive "P")
2971   (static-if (featurep 'xemacs)
2972       (let ((toolbar-news-use-separate-frame t))
2973         (toolbar-gnus))
2974     (if (frame-live-p gnus-frame)
2975         (raise-frame gnus-frame)
2976       (setq gnus-frame (make-frame gnus-frame-properties))
2977       (if (and (gnus-buffer-live-p gnus-group-buffer)
2978                (save-current-buffer
2979                  (set-buffer gnus-group-buffer)
2980                  (eq 'gnus-group-mode major-mode)))
2981           (progn
2982             (select-frame gnus-frame)
2983             (switch-to-buffer gnus-group-buffer))
2984         (add-hook 'gnus-exit-gnus-hook
2985                   (lambda ()
2986                     (when (and (frame-live-p gnus-frame)
2987                                (cdr (frame-list)))
2988                       (delete-frame gnus-frame))
2989                     (setq gnus-frame nil)))
2990         (select-frame gnus-frame)
2991         (gnus arg)))))
2992
2993 ;;;###autoload
2994 (defun gnus (&optional arg dont-connect slave)
2995   "Read network news.
2996 If ARG is non-nil and a positive number, Gnus will use that as the
2997 startup level.  If ARG is non-nil and not a positive number, Gnus will
2998 prompt the user for the name of an NNTP server to use."
2999   (interactive "P")
3000   (gnus-1 arg dont-connect slave))
3001
3002 ;; Allow redefinition of Gnus functions.
3003
3004 (gnus-ems-redefine)
3005
3006 (product-provide (provide 'gnus) 'gnus-vers)
3007
3008 ;;; gnus.el ends here