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