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