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