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