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