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