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