(gnus-invalid-group-regexp): New variable.
[gnus] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
4
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval '(run-hooks 'gnus-load-hook))
31
32 (eval-when-compile (require 'cl))
33 (require 'mm-util)
34
35 (require 'message)
36
37 (defgroup gnus nil
38   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
39   :group 'news
40   :group 'mail)
41
42 (defgroup gnus-charset nil
43   "Group character set issues."
44   :link '(custom-manual "(gnus)Charsets")
45   :group 'gnus)
46
47 (defgroup gnus-cache nil
48   "Cache interface."
49   :group 'gnus)
50
51 (defgroup gnus-start nil
52   "Starting your favorite newsreader."
53   :group 'gnus)
54
55 (defgroup gnus-start-server nil
56   "Server options at startup."
57   :group 'gnus-start)
58
59 ;; These belong to gnus-group.el.
60 (defgroup gnus-group nil
61   "Group buffers."
62   :link '(custom-manual "(gnus)The Group Buffer")
63   :group 'gnus)
64
65 (defgroup gnus-group-foreign nil
66   "Foreign groups."
67   :link '(custom-manual "(gnus)Foreign Groups")
68   :group 'gnus-group)
69
70 (defgroup gnus-group-new nil
71   "Automatic subscription of new groups."
72   :group 'gnus-group)
73
74 (defgroup gnus-group-levels nil
75   "Group levels."
76   :link '(custom-manual "(gnus)Group Levels")
77   :group 'gnus-group)
78
79 (defgroup gnus-group-select nil
80   "Selecting a Group."
81   :link '(custom-manual "(gnus)Selecting a Group")
82   :group 'gnus-group)
83
84 (defgroup gnus-group-listing nil
85   "Showing slices of the group list."
86   :link '(custom-manual "(gnus)Listing Groups")
87   :group 'gnus-group)
88
89 (defgroup gnus-group-visual nil
90   "Sorting the group buffer."
91   :link '(custom-manual "(gnus)Group Buffer Format")
92   :group 'gnus-group
93   :group 'gnus-visual)
94
95 (defgroup gnus-group-various nil
96   "Various group options."
97   :link '(custom-manual "(gnus)Scanning New Messages")
98   :group 'gnus-group)
99
100 ;; These belong to gnus-sum.el.
101 (defgroup gnus-summary nil
102   "Summary buffers."
103   :link '(custom-manual "(gnus)The Summary Buffer")
104   :group 'gnus)
105
106 (defgroup gnus-summary-exit nil
107   "Leaving summary buffers."
108   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
109   :group 'gnus-summary)
110
111 (defgroup gnus-summary-marks nil
112   "Marks used in summary buffers."
113   :link '(custom-manual "(gnus)Marking Articles")
114   :group 'gnus-summary)
115
116 (defgroup gnus-thread nil
117   "Ordering articles according to replies."
118   :link '(custom-manual "(gnus)Threading")
119   :group 'gnus-summary)
120
121 (defgroup gnus-summary-format nil
122   "Formatting of the summary buffer."
123   :link '(custom-manual "(gnus)Summary Buffer Format")
124   :group 'gnus-summary)
125
126 (defgroup gnus-summary-choose nil
127   "Choosing Articles."
128   :link '(custom-manual "(gnus)Choosing Articles")
129   :group 'gnus-summary)
130
131 (defgroup gnus-summary-maneuvering nil
132   "Summary movement commands."
133   :link '(custom-manual "(gnus)Summary Maneuvering")
134   :group 'gnus-summary)
135
136 (defgroup gnus-summary-mail nil
137   "Mail group commands."
138   :link '(custom-manual "(gnus)Mail Group Commands")
139   :group 'gnus-summary)
140
141 (defgroup gnus-summary-sort nil
142   "Sorting the summary buffer."
143   :link '(custom-manual "(gnus)Sorting")
144   :group 'gnus-summary)
145
146 (defgroup gnus-summary-visual nil
147   "Highlighting and menus in the summary buffer."
148   :link '(custom-manual "(gnus)Summary Highlighting")
149   :group 'gnus-visual
150   :group 'gnus-summary)
151
152 (defgroup gnus-summary-various nil
153   "Various summary buffer options."
154   :link '(custom-manual "(gnus)Various Summary Stuff")
155   :group 'gnus-summary)
156
157 (defgroup gnus-summary-pick nil
158   "Pick mode in the summary buffer."
159   :link '(custom-manual "(gnus)Pick and Read")
160   :prefix "gnus-pick-"
161   :group 'gnus-summary)
162
163 (defgroup gnus-summary-tree nil
164   "Tree display of threads in the summary buffer."
165   :link '(custom-manual "(gnus)Tree Display")
166   :prefix "gnus-tree-"
167   :group 'gnus-summary)
168
169 ;; Belongs to gnus-uu.el
170 (defgroup gnus-extract-view nil
171   "Viewing extracted files."
172   :link '(custom-manual "(gnus)Viewing Files")
173   :group 'gnus-extract)
174
175 ;; Belongs to gnus-score.el
176 (defgroup gnus-score nil
177   "Score and kill file handling."
178   :group 'gnus)
179
180 (defgroup gnus-score-kill nil
181   "Kill files."
182   :group 'gnus-score)
183
184 (defgroup gnus-score-adapt nil
185   "Adaptive score files."
186   :group 'gnus-score)
187
188 (defgroup gnus-score-default nil
189   "Default values for score files."
190   :group 'gnus-score)
191
192 (defgroup gnus-score-expire nil
193   "Expiring score rules."
194   :group 'gnus-score)
195
196 (defgroup gnus-score-decay nil
197   "Decaying score rules."
198   :group 'gnus-score)
199
200 (defgroup gnus-score-files nil
201   "Score and kill file names."
202   :group 'gnus-score
203   :group 'gnus-files)
204
205 (defgroup gnus-score-various nil
206   "Various scoring and killing options."
207   :group 'gnus-score)
208
209 ;; Other
210 (defgroup gnus-visual nil
211   "Options controling the visual fluff."
212   :group 'gnus
213   :group 'faces)
214
215 (defgroup gnus-agent nil
216   "Offline support for Gnus."
217   :group 'gnus)
218
219 (defgroup gnus-files nil
220   "Files used by Gnus."
221   :group 'gnus)
222
223 (defgroup gnus-dribble-file nil
224   "Auto save file."
225   :link '(custom-manual "(gnus)Auto Save")
226   :group 'gnus-files)
227
228 (defgroup gnus-newsrc nil
229   "Storing Gnus state."
230   :group 'gnus-files)
231
232 (defgroup gnus-server nil
233   "Options related to newsservers and other servers used by Gnus."
234   :group 'gnus)
235
236 (defgroup gnus-message '((message custom-group))
237   "Composing replies and followups in Gnus."
238   :group 'gnus)
239
240 (defgroup gnus-meta nil
241   "Meta variables controling major portions of Gnus.
242 In general, modifying these variables does not take affect until Gnus
243 is restarted, and sometimes reloaded."
244   :group 'gnus)
245
246 (defgroup gnus-various nil
247   "Other Gnus options."
248   :link '(custom-manual "(gnus)Various Various")
249   :group 'gnus)
250
251 (defgroup gnus-mime nil
252   "Variables for controlling the Gnus MIME interface."
253   :group 'gnus)
254
255 (defgroup gnus-exit nil
256   "Exiting gnus."
257   :link '(custom-manual "(gnus)Exiting Gnus")
258   :group 'gnus)
259
260 (defconst gnus-version-number "5.8.8"
261   "Version number for this version of Gnus.")
262
263 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
264   "Version string for this version of Gnus.")
265
266 (defcustom gnus-inhibit-startup-message nil
267   "If non-nil, the startup message will not be displayed.
268 This variable is used before `.gnus.el' is loaded, so it should
269 be set in `.emacs' instead."
270   :group 'gnus-start
271   :type 'boolean)
272
273 (defcustom gnus-play-startup-jingle nil
274   "If non-nil, play the Gnus jingle at startup."
275   :group 'gnus-start
276   :type 'boolean)
277
278 (unless (featurep 'gnus-xmas)
279   (defalias 'gnus-make-overlay 'make-overlay)
280   (defalias 'gnus-delete-overlay 'delete-overlay)
281   (defalias 'gnus-overlay-put 'overlay-put)
282   (defalias 'gnus-move-overlay 'move-overlay)
283   (defalias 'gnus-overlay-end 'overlay-end)
284   (defalias 'gnus-extent-detached-p 'ignore)
285   (defalias 'gnus-extent-start-open 'ignore)
286   (defalias 'gnus-set-text-properties 'set-text-properties)
287   (defalias 'gnus-group-remove-excess-properties 'ignore)
288   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
289   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
290   (defalias 'gnus-character-to-event 'identity)
291   (defalias 'gnus-add-text-properties 'add-text-properties)
292   (defalias 'gnus-put-text-property 'put-text-property)
293   (defalias 'gnus-mode-line-buffer-identification 'identity)
294   (defalias 'gnus-characterp 'numberp)
295   (defalias 'gnus-deactivate-mark 'deactivate-mark)
296   (defalias 'gnus-window-edges 'window-edges)
297   (defalias 'gnus-key-press-event-p 'numberp)
298   (defalias 'gnus-decode-rfc1522 'ignore))
299
300 ;; We define these group faces here to avoid the display
301 ;; update forced when creating new faces.
302
303 (defface gnus-group-news-1-face
304   '((((class color)
305       (background dark))
306      (:foreground "PaleTurquoise" :bold t))
307     (((class color)
308       (background light))
309      (:foreground "ForestGreen" :bold t))
310     (t
311      ()))
312   "Level 1 newsgroup face.")
313
314 (defface gnus-group-news-1-empty-face
315   '((((class color)
316       (background dark))
317      (:foreground "PaleTurquoise"))
318     (((class color)
319       (background light))
320      (:foreground "ForestGreen"))
321     (t
322      ()))
323   "Level 1 empty newsgroup face.")
324
325 (defface gnus-group-news-2-face
326   '((((class color)
327       (background dark))
328      (:foreground "turquoise" :bold t))
329     (((class color)
330       (background light))
331      (:foreground "CadetBlue4" :bold t))
332     (t
333      ()))
334   "Level 2 newsgroup face.")
335
336 (defface gnus-group-news-2-empty-face
337   '((((class color)
338       (background dark))
339      (:foreground "turquoise"))
340     (((class color)
341       (background light))
342      (:foreground "CadetBlue4"))
343     (t
344      ()))
345   "Level 2 empty newsgroup face.")
346
347 (defface gnus-group-news-3-face
348   '((((class color)
349       (background dark))
350      (:bold t))
351     (((class color)
352       (background light))
353      (:bold t))
354     (t
355      ()))
356   "Level 3 newsgroup face.")
357
358 (defface gnus-group-news-3-empty-face
359   '((((class color)
360       (background dark))
361      ())
362     (((class color)
363       (background light))
364      ())
365     (t
366      ()))
367   "Level 3 empty newsgroup face.")
368
369 (defface gnus-group-news-4-face
370   '((((class color)
371       (background dark))
372      (:bold t))
373     (((class color)
374       (background light))
375      (:bold t))
376     (t
377      ()))
378   "Level 4 newsgroup face.")
379
380 (defface gnus-group-news-4-empty-face
381   '((((class color)
382       (background dark))
383      ())
384     (((class color)
385       (background light))
386      ())
387     (t
388      ()))
389   "Level 4 empty newsgroup face.")
390
391 (defface gnus-group-news-5-face
392   '((((class color)
393       (background dark))
394      (:bold t))
395     (((class color)
396       (background light))
397      (:bold t))
398     (t
399      ()))
400   "Level 5 newsgroup face.")
401
402 (defface gnus-group-news-5-empty-face
403   '((((class color)
404       (background dark))
405      ())
406     (((class color)
407       (background light))
408      ())
409     (t
410      ()))
411   "Level 5 empty newsgroup face.")
412
413 (defface gnus-group-news-6-face
414   '((((class color)
415       (background dark))
416      (:bold t))
417     (((class color)
418       (background light))
419      (:bold t))
420     (t
421      ()))
422   "Level 6 newsgroup face.")
423
424 (defface gnus-group-news-6-empty-face
425   '((((class color)
426       (background dark))
427      ())
428     (((class color)
429       (background light))
430      ())
431     (t
432      ()))
433   "Level 6 empty newsgroup face.")
434
435 (defface gnus-group-news-low-face
436   '((((class color)
437       (background dark))
438      (:foreground "DarkTurquoise" :bold t))
439     (((class color)
440       (background light))
441      (:foreground "DarkGreen" :bold t))
442     (t
443      ()))
444   "Low level newsgroup face.")
445
446 (defface gnus-group-news-low-empty-face
447   '((((class color)
448       (background dark))
449      (:foreground "DarkTurquoise"))
450     (((class color)
451       (background light))
452      (:foreground "DarkGreen"))
453     (t
454      ()))
455   "Low level empty newsgroup face.")
456
457 (defface gnus-group-mail-1-face
458   '((((class color)
459       (background dark))
460      (:foreground "aquamarine1" :bold t))
461     (((class color)
462       (background light))
463      (:foreground "DeepPink3" :bold t))
464     (t
465      (:bold t)))
466   "Level 1 mailgroup face.")
467
468 (defface gnus-group-mail-1-empty-face
469   '((((class color)
470       (background dark))
471      (:foreground "aquamarine1"))
472     (((class color)
473       (background light))
474      (:foreground "DeepPink3"))
475     (t
476      (:italic t :bold t)))
477   "Level 1 empty mailgroup face.")
478
479 (defface gnus-group-mail-2-face
480   '((((class color)
481       (background dark))
482      (:foreground "aquamarine2" :bold t))
483     (((class color)
484       (background light))
485      (:foreground "HotPink3" :bold t))
486     (t
487      (:bold t)))
488   "Level 2 mailgroup face.")
489
490 (defface gnus-group-mail-2-empty-face
491   '((((class color)
492       (background dark))
493      (:foreground "aquamarine2"))
494     (((class color)
495       (background light))
496      (:foreground "HotPink3"))
497     (t
498      (:bold t)))
499   "Level 2 empty mailgroup face.")
500
501 (defface gnus-group-mail-3-face
502   '((((class color)
503       (background dark))
504      (:foreground "aquamarine3" :bold t))
505     (((class color)
506       (background light))
507      (:foreground "magenta4" :bold t))
508     (t
509      (:bold t)))
510   "Level 3 mailgroup face.")
511
512 (defface gnus-group-mail-3-empty-face
513   '((((class color)
514       (background dark))
515      (:foreground "aquamarine3"))
516     (((class color)
517       (background light))
518      (:foreground "magenta4"))
519     (t
520      ()))
521   "Level 3 empty mailgroup face.")
522
523 (defface gnus-group-mail-low-face
524   '((((class color)
525       (background dark))
526      (:foreground "aquamarine4" :bold t))
527     (((class color)
528       (background light))
529      (:foreground "DeepPink4" :bold t))
530     (t
531      (:bold t)))
532   "Low level mailgroup face.")
533
534 (defface gnus-group-mail-low-empty-face
535   '((((class color)
536       (background dark))
537      (:foreground "aquamarine4"))
538     (((class color)
539       (background light))
540      (:foreground "DeepPink4"))
541     (t
542      (:bold t)))
543   "Low level empty mailgroup face.")
544
545 ;; Summary mode faces.
546
547 (defface gnus-summary-selected-face '((t
548                                        (:underline t)))
549   "Face used for selected articles.")
550
551 (defface gnus-summary-cancelled-face
552   '((((class color))
553      (:foreground "yellow" :background "black")))
554   "Face used for cancelled articles.")
555
556 (defface gnus-summary-high-ticked-face
557   '((((class color)
558       (background dark))
559      (:foreground "pink" :bold t))
560     (((class color)
561       (background light))
562      (:foreground "firebrick" :bold t))
563     (t
564      (:bold t)))
565   "Face used for high interest ticked articles.")
566
567 (defface gnus-summary-low-ticked-face
568   '((((class color)
569       (background dark))
570      (:foreground "pink" :italic t))
571     (((class color)
572       (background light))
573      (:foreground "firebrick" :italic t))
574     (t
575      (:italic t)))
576   "Face used for low interest ticked articles.")
577
578 (defface gnus-summary-normal-ticked-face
579   '((((class color)
580       (background dark))
581      (:foreground "pink"))
582     (((class color)
583       (background light))
584      (:foreground "firebrick"))
585     (t
586      ()))
587   "Face used for normal interest ticked articles.")
588
589 (defface gnus-summary-high-ancient-face
590   '((((class color)
591       (background dark))
592      (:foreground "SkyBlue" :bold t))
593     (((class color)
594       (background light))
595      (:foreground "RoyalBlue" :bold t))
596     (t
597      (:bold t)))
598   "Face used for high interest ancient articles.")
599
600 (defface gnus-summary-low-ancient-face
601   '((((class color)
602       (background dark))
603      (:foreground "SkyBlue" :italic t))
604     (((class color)
605       (background light))
606      (:foreground "RoyalBlue" :italic t))
607     (t
608      (:italic t)))
609   "Face used for low interest ancient articles.")
610
611 (defface gnus-summary-normal-ancient-face
612   '((((class color)
613       (background dark))
614      (:foreground "SkyBlue"))
615     (((class color)
616       (background light))
617      (:foreground "RoyalBlue"))
618     (t
619      ()))
620   "Face used for normal interest ancient articles.")
621
622 (defface gnus-summary-high-unread-face
623   '((t
624      (:bold t)))
625   "Face used for high interest unread articles.")
626
627 (defface gnus-summary-low-unread-face
628   '((t
629      (:italic t)))
630   "Face used for low interest unread articles.")
631
632 (defface gnus-summary-normal-unread-face
633   '((t
634      ()))
635   "Face used for normal interest unread articles.")
636
637 (defface gnus-summary-high-read-face
638   '((((class color)
639       (background dark))
640      (:foreground "PaleGreen"
641                   :bold t))
642     (((class color)
643       (background light))
644      (:foreground "DarkGreen"
645                   :bold t))
646     (t
647      (:bold t)))
648   "Face used for high interest read articles.")
649
650 (defface gnus-summary-low-read-face
651   '((((class color)
652       (background dark))
653      (:foreground "PaleGreen"
654                   :italic t))
655     (((class color)
656       (background light))
657      (:foreground "DarkGreen"
658                   :italic t))
659     (t
660      (:italic t)))
661   "Face used for low interest read articles.")
662
663 (defface gnus-summary-normal-read-face
664   '((((class color)
665       (background dark))
666      (:foreground "PaleGreen"))
667     (((class color)
668       (background light))
669      (:foreground "DarkGreen"))
670     (t
671      ()))
672   "Face used for normal interest read articles.")
673
674
675 ;;;
676 ;;; Gnus buffers
677 ;;;
678
679 (defvar gnus-buffers nil)
680
681 (defun gnus-get-buffer-create (name)
682   "Do the same as `get-buffer-create', but store the created buffer."
683   (or (get-buffer name)
684       (car (push (get-buffer-create name) gnus-buffers))))
685
686 (defun gnus-add-buffer ()
687   "Add the current buffer to the list of Gnus buffers."
688   (push (current-buffer) gnus-buffers))
689
690 (defun gnus-buffers ()
691   "Return a list of live Gnus buffers."
692   (while (and gnus-buffers
693               (not (buffer-name (car gnus-buffers))))
694     (pop gnus-buffers))
695   (let ((buffers gnus-buffers))
696     (while (cdr buffers)
697       (if (buffer-name (cadr buffers))
698           (pop buffers)
699         (setcdr buffers (cddr buffers)))))
700   gnus-buffers)
701
702 ;;; Splash screen.
703
704 (defvar gnus-group-buffer "*Group*")
705
706 (eval-and-compile
707   (autoload 'gnus-play-jingle "gnus-audio"))
708
709 (defface gnus-splash-face
710   '((((class color)
711       (background dark))
712      (:foreground "Brown"))
713     (((class color)
714       (background light))
715      (:foreground "Brown"))
716     (t
717      ()))
718   "Face of the splash screen.")
719
720 (defun gnus-splash ()
721   (save-excursion
722     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
723     (let ((buffer-read-only nil))
724       (erase-buffer)
725       (unless gnus-inhibit-startup-message
726         (gnus-group-startup-message)
727         (sit-for 0)
728         (when gnus-play-startup-jingle
729           (gnus-play-jingle))))))
730
731 (defun gnus-indent-rigidly (start end arg)
732   "Indent rigidly using only spaces and no tabs."
733   (save-excursion
734     (save-restriction
735       (narrow-to-region start end)
736       (let ((tab-width 8))
737         (indent-rigidly start end arg)
738         ;; We translate tabs into spaces -- not everybody uses
739         ;; an 8-character tab.
740         (goto-char (point-min))
741         (while (search-forward "\t" nil t)
742           (replace-match "        " t t))))))
743
744 (defvar gnus-simple-splash nil)
745
746 (defun gnus-group-startup-message (&optional x y)
747   "Insert startup message in current buffer."
748   ;; Insert the message.
749   (erase-buffer)
750   (cond
751    ((and (fboundp 'find-image)
752          (display-graphic-p)
753          (let ((image (find-image '((:type xpm :file "gnus.xpm")
754                                     (:type xbm :file "gnus.xbm")))))
755            (when image
756              (newline)                  ; Have somewhere for cursor to
757                                         ; go, not stretched over image.
758              (insert-image image)
759              (goto-char (point-min))
760              (while (not (eobp))
761                (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
762                                     ?\ ))
763                (forward-line 1))
764              (setq gnus-simple-splash nil)
765              t))))
766    (t
767     (insert
768      (format "              %s
769           _    ___ _             _
770           _ ___ __ ___  __    _ ___
771           __   _     ___    __  ___
772               _           ___     _
773              _  _ __             _
774              ___   __            _
775                    __           _
776                     _      _   _
777                    _      _    _
778                       _  _    _
779                   __  ___
780                  _   _ _     _
781                 _   _
782               _    _
783              _    _
784             _
785           __
786
787 "
788              ""))
789     ;; And then hack it.
790     (gnus-indent-rigidly (point-min) (point-max)
791                          (/ (max (- (window-width) (or x 46)) 0) 2))
792     (goto-char (point-min))
793     (forward-line 1)
794     (let* ((pheight (count-lines (point-min) (point-max)))
795            (wheight (window-height))
796            (rest (- wheight pheight)))
797       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
798     ;; Fontify some.
799     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
800     (setq gnus-simple-splash t)))
801   (goto-char (point-min))
802   (setq mode-line-buffer-identification (concat " " gnus-version))
803   (set-buffer-modified-p t))
804
805 (eval-when (load)
806   (let ((command (format "%s" this-command)))
807     (if (and (string-match "gnus" command)
808              (not (string-match "gnus-other-frame" command)))
809         (gnus-splash)
810       (gnus-get-buffer-create gnus-group-buffer))))
811
812 ;;; Do the rest.
813
814 (require 'custom)
815 (require 'gnus-util)
816 (require 'nnheader)
817
818 (defcustom gnus-home-directory "~/"
819   "Directory variable that specifies the \"home\" directory.
820 All other Gnus path variables are initialized from this variable."
821   :group 'gnus-files
822   :type 'directory)
823
824 (defcustom gnus-directory (or (getenv "SAVEDIR")
825                               (nnheader-concat gnus-home-directory "News/"))
826   "*Directory variable from which all other Gnus file variables are derived.
827
828 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
829 This means that other directory variables that are initialized from
830 this variable won't be set properly if you set this variable in `.gnus.el'.
831 Set this variable in `.emacs' instead."
832   :group 'gnus-files
833   :type 'directory)
834
835 (defcustom gnus-default-directory nil
836   "*Default directory for all Gnus buffers."
837   :group 'gnus-files
838   :type '(choice (const :tag "current" nil)
839                  directory))
840
841 ;; Site dependent variables.  These variables should be defined in
842 ;; paths.el.
843
844 (defvar gnus-default-nntp-server nil
845   "Specify a default NNTP server.
846 This variable should be defined in paths.el, and should never be set
847 by the user.
848 If you want to change servers, you should use `gnus-select-method'.
849 See the documentation to that variable.")
850
851 ;; Don't touch this variable.
852 (defvar gnus-nntp-service "nntp"
853   "NNTP service name (\"nntp\" or 119).
854 This is an obsolete variable, which is scarcely used.  If you use an
855 nntp server for your newsgroup and want to change the port number
856 used to 899, you would say something along these lines:
857
858  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
859
860 (defcustom gnus-nntpserver-file "/etc/nntpserver"
861   "A file with only the name of the nntp server in it."
862   :group 'gnus-files
863   :group 'gnus-server
864   :type 'file)
865
866 ;; This function is used to check both the environment variable
867 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
868 ;; an nntp server name default.
869 (defun gnus-getenv-nntpserver ()
870   (or (getenv "NNTPSERVER")
871       (and (file-readable-p gnus-nntpserver-file)
872            (save-excursion
873              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
874              (insert-file-contents gnus-nntpserver-file)
875              (let ((name (buffer-string)))
876                (prog1
877                    (if (string-match "\\'[ \t\n]*$" name)
878                        nil
879                      name)
880                  (kill-buffer (current-buffer))))))))
881
882 (defcustom gnus-select-method
883   (condition-case nil
884       (nconc
885        (list 'nntp (or (condition-case nil
886                            (gnus-getenv-nntpserver)
887                          (error nil))
888                        (when (and gnus-default-nntp-server
889                                   (not (string= gnus-default-nntp-server "")))
890                          gnus-default-nntp-server)
891                        "news"))
892        (if (or (null gnus-nntp-service)
893                (equal gnus-nntp-service "nntp"))
894            nil
895          (list gnus-nntp-service)))
896     (error nil))
897   "Default method for selecting a newsgroup.
898 This variable should be a list, where the first element is how the
899 news is to be fetched, the second is the address.
900
901 For instance, if you want to get your news via NNTP from
902 \"flab.flab.edu\", you could say:
903
904 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
905
906 If you want to use your local spool, say:
907
908 \(setq gnus-select-method (list 'nnspool (system-name)))
909
910 If you use this variable, you must set `gnus-nntp-server' to nil.
911
912 There is a lot more to know about select methods and virtual servers -
913 see the manual for details."
914   :group 'gnus-server
915   :type 'gnus-select-method)
916
917 (defcustom gnus-message-archive-method
918   `(nnfolder
919     "archive"
920     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
921     (nnfolder-active-file
922      ,(nnheader-concat message-directory "archive/active"))
923     (nnfolder-get-new-mail nil)
924     (nnfolder-inhibit-expiry t))
925   "*Method used for archiving messages you've sent.
926 This should be a mail method.
927
928 It's probably not very effective to change this variable once you've
929 run Gnus once.  After doing that, you must edit this server from the
930 server buffer."
931   :group 'gnus-server
932   :group 'gnus-message
933   :type 'gnus-select-method)
934
935 (defcustom gnus-message-archive-group nil
936   "*Name of the group in which to save the messages you've written.
937 This can either be a string; a list of strings; or an alist
938 of regexps/functions/forms to be evaluated to return a string (or a list
939 of strings).  The functions are called with the name of the current
940 group (or nil) as a parameter.
941
942 If you want to save your mail in one group and the news articles you
943 write in another group, you could say something like:
944
945  \(setq gnus-message-archive-group
946         '((if (message-news-p)
947               \"misc-news\"
948             \"misc-mail\")))
949
950 Normally the group names returned by this variable should be
951 unprefixed -- which implicitly means \"store on the archive server\".
952 However, you may wish to store the message on some other server.  In
953 that case, just return a fully prefixed name of the group --
954 \"nnml+private:mail.misc\", for instance."
955   :group 'gnus-message
956   :type '(choice (const :tag "none" nil)
957                  function
958                  sexp
959                  string))
960
961 (defcustom gnus-secondary-servers nil
962   "List of NNTP servers that the user can choose between interactively.
963 To make Gnus query you for a server, you have to give `gnus' a
964 non-numeric prefix - `C-u M-x gnus', in short."
965   :group 'gnus-server
966   :type '(repeat string))
967
968 (defcustom gnus-nntp-server nil
969   "*The name of the host running the NNTP server.
970 This variable is semi-obsolete.  Use the `gnus-select-method'
971 variable instead."
972   :group 'gnus-server
973   :type '(choice (const :tag "disable" nil)
974                  string))
975
976 (defcustom gnus-secondary-select-methods nil
977   "A list of secondary methods that will be used for reading news.
978 This is a list where each element is a complete select method (see
979 `gnus-select-method').
980
981 If, for instance, you want to read your mail with the nnml backend,
982 you could set this variable:
983
984 \(setq gnus-secondary-select-methods '((nnml \"\")))"
985   :group 'gnus-server
986   :type '(repeat gnus-select-method))
987
988 (defvar gnus-backup-default-subscribed-newsgroups
989   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
990   "Default default new newsgroups the first time Gnus is run.
991 Should be set in paths.el, and shouldn't be touched by the user.")
992
993 (defcustom gnus-local-domain nil
994   "Local domain name without a host name.
995 The DOMAINNAME environment variable is used instead if it is defined.
996 If the `system-name' function returns the full Internet name, there is
997 no need to set this variable."
998   :group 'gnus-message
999   :type '(choice (const :tag "default" nil)
1000                  string))
1001
1002 (defvar gnus-local-organization nil
1003   "String with a description of what organization (if any) the user belongs to.
1004 Obsolete variable; use `message-user-organization' instead.")
1005
1006 ;; Customization variables
1007
1008 (defcustom gnus-refer-article-method nil
1009   "Preferred method for fetching an article by Message-ID.
1010 If you are reading news from the local spool (with nnspool), fetching
1011 articles by Message-ID is painfully slow.  By setting this method to an
1012 nntp method, you might get acceptable results.
1013
1014 The value of this variable must be a valid select method as discussed
1015 in the documentation of `gnus-select-method'.
1016
1017 It can also be a list of select methods, as well as the special symbol
1018 `current', which means to use the current select method.  If it is a
1019 list, Gnus will try all the methods in the list until it finds a match."
1020   :group 'gnus-server
1021   :type '(choice (const :tag "default" nil)
1022                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1023                  gnus-select-method
1024                  (repeat :menu-tag "Try multiple"
1025                          :tag "Multiple"
1026                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1027                          (choice :tag "Method"
1028                                  (const current)
1029                                  (const :tag "DejaNews"
1030                                         (nnweb "refer" (nnweb-type dejanews)))
1031                                  gnus-select-method))))
1032
1033 (defcustom gnus-group-faq-directory
1034   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1035     "/ftp@sunsite.auc.dk:/pub/usenet/"
1036     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1037     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1038     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1039     "/ftp@rtfm.mit.edu:/pub/usenet/"
1040     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1041     "/ftp@ftp.sunet.se:/pub/usenet/"
1042     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1043     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1044     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1045   "*Directory where the group FAQs are stored.
1046 This will most commonly be on a remote machine, and the file will be
1047 fetched by ange-ftp.
1048
1049 This variable can also be a list of directories.  In that case, the
1050 first element in the list will be used by default.  The others can
1051 be used when being prompted for a site.
1052
1053 Note that Gnus uses an aol machine as the default directory.  If this
1054 feels fundamentally unclean, just think of it as a way to finally get
1055 something of value back from them.
1056
1057 If the default site is too slow, try one of these:
1058
1059    North America: mirrors.aol.com                /pub/rtfm/usenet
1060                   ftp.seas.gwu.edu               /pub/rtfm
1061                   rtfm.mit.edu                   /pub/usenet
1062    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1063                   src.doc.ic.ac.uk               /usenet/news-FAQS
1064                   ftp.sunet.se                   /pub/usenet
1065                   sunsite.auc.dk                 /pub/usenet
1066    Asia:          nctuccca.edu.tw                /USENET/FAQ
1067                   hwarang.postech.ac.kr          /pub/usenet
1068                   ftp.hk.super.net               /mirror/faqs"
1069   :group 'gnus-group-various
1070   :type '(choice directory
1071                  (repeat directory)))
1072
1073 (defcustom gnus-use-cross-reference t
1074   "*Non-nil means that cross referenced articles will be marked as read.
1075 If nil, ignore cross references.  If t, mark articles as read in
1076 subscribed newsgroups.  If neither t nor nil, mark as read in all
1077 newsgroups."
1078   :group 'gnus-server
1079   :type '(choice (const :tag "off" nil)
1080                  (const :tag "subscribed" t)
1081                  (sexp :format "all"
1082                        :value always)))
1083
1084 (defcustom gnus-process-mark ?#
1085   "*Process mark."
1086   :group 'gnus-group-visual
1087   :group 'gnus-summary-marks
1088   :type 'character)
1089
1090 (defcustom gnus-large-newsgroup 200
1091   "*The number of articles which indicates a large newsgroup.
1092 If the number of articles in a newsgroup is greater than this value,
1093 confirmation is required for selecting the newsgroup."
1094   :group 'gnus-group-select
1095   :type 'integer)
1096
1097 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1098   "*Non-nil means that the default name of a file to save articles in is the group name.
1099 If it's nil, the directory form of the group name is used instead.
1100
1101 If this variable is a list, and the list contains the element
1102 `not-score', long file names will not be used for score files; if it
1103 contains the element `not-save', long file names will not be used for
1104 saving; and if it contains the element `not-kill', long file names
1105 will not be used for kill files.
1106
1107 Note that the default for this variable varies according to what system
1108 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1109 to nil while on all other systems it defaults to t."
1110   :group 'gnus-start
1111   :type 'boolean)
1112
1113 (defcustom gnus-kill-files-directory gnus-directory
1114   "*Name of the directory where kill files will be stored (default \"~/News\")."
1115   :group 'gnus-score-files
1116   :group 'gnus-score-kill
1117   :type 'directory)
1118
1119 (defcustom gnus-save-score nil
1120   "*If non-nil, save group scoring info."
1121   :group 'gnus-score-various
1122   :group 'gnus-start
1123   :type 'boolean)
1124
1125 (defcustom gnus-use-undo t
1126   "*If non-nil, allow undoing in Gnus group mode buffers."
1127   :group 'gnus-meta
1128   :type 'boolean)
1129
1130 (defcustom gnus-use-adaptive-scoring nil
1131   "*If non-nil, use some adaptive scoring scheme.
1132 If a list, then the values `word' and `line' are meaningful.  The
1133 former will perform adaption on individual words in the subject
1134 header while `line' will perform adaption on several headers."
1135   :group 'gnus-meta
1136   :group 'gnus-score-adapt
1137   :type '(set (const word) (const line)))
1138
1139 (defcustom gnus-use-cache 'passive
1140   "*If nil, Gnus will ignore the article cache.
1141 If `passive', it will allow entering (and reading) articles
1142 explicitly entered into the cache.  If anything else, use the
1143 cache to the full extent of the law."
1144   :group 'gnus-meta
1145   :group 'gnus-cache
1146   :type '(choice (const :tag "off" nil)
1147                  (const :tag "passive" passive)
1148                  (const :tag "active" t)))
1149
1150 (defcustom gnus-use-trees nil
1151   "*If non-nil, display a thread tree buffer."
1152   :group 'gnus-meta
1153   :type 'boolean)
1154
1155 (defcustom gnus-use-grouplens nil
1156   "*If non-nil, use GroupLens ratings."
1157   :group 'gnus-meta
1158   :type 'boolean)
1159
1160 (defcustom gnus-keep-backlog nil
1161   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1162 If it is a number N, then Gnus will only keep the last N articles
1163 read.  If it is neither nil nor a number, Gnus will keep all read
1164 articles.  This is not a good idea."
1165   :group 'gnus-meta
1166   :type '(choice (const :tag "off" nil)
1167                  integer
1168                  (sexp :format "all"
1169                        :value t)))
1170
1171 (defcustom gnus-use-nocem nil
1172   "*If non-nil, Gnus will read NoCeM cancel messages."
1173   :group 'gnus-meta
1174   :type 'boolean)
1175
1176 (defcustom gnus-suppress-duplicates nil
1177   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1178   :group 'gnus-meta
1179   :type 'boolean)
1180
1181 (defcustom gnus-use-scoring t
1182   "*If non-nil, enable scoring."
1183   :group 'gnus-meta
1184   :type 'boolean)
1185
1186 (defcustom gnus-use-picons nil
1187   "*If non-nil, display picons in a frame of their own."
1188   :group 'gnus-meta
1189   :type 'boolean)
1190
1191 (defcustom gnus-summary-prepare-exit-hook
1192   '(gnus-summary-expire-articles)
1193   "*A hook called when preparing to exit from the summary buffer.
1194 It calls `gnus-summary-expire-articles' by default."
1195   :group 'gnus-summary-exit
1196   :type 'hook)
1197
1198 (defcustom gnus-novice-user t
1199   "*Non-nil means that you are a usenet novice.
1200 If non-nil, verbose messages may be displayed and confirmations may be
1201 required."
1202   :group 'gnus-meta
1203   :type 'boolean)
1204
1205 (defcustom gnus-expert-user nil
1206   "*Non-nil means that you will never be asked for confirmation about anything.
1207 That doesn't mean *anything* anything; particularly destructive
1208 commands will still require prompting."
1209   :group 'gnus-meta
1210   :type 'boolean)
1211
1212 (defcustom gnus-interactive-catchup t
1213   "*If non-nil, require your confirmation when catching up a group."
1214   :group 'gnus-group-select
1215   :type 'boolean)
1216
1217 (defcustom gnus-interactive-exit t
1218   "*If non-nil, require your confirmation when exiting Gnus."
1219   :group 'gnus-exit
1220   :type 'boolean)
1221
1222 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1223   "*Function for extracting address components from a From header.
1224 Two pre-defined function exist: `gnus-extract-address-components',
1225 which is the default, quite fast, and too simplistic solution, and
1226 `mail-extract-address-components', which works much better, but is
1227 slower."
1228   :group 'gnus-summary-format
1229   :type '(radio (function-item gnus-extract-address-components)
1230                 (function-item mail-extract-address-components)
1231                 (function :tag "Other")))
1232
1233 (defcustom gnus-carpal nil
1234   "*If non-nil, display clickable icons."
1235   :group 'gnus-meta
1236   :type 'boolean)
1237
1238 (defcustom gnus-shell-command-separator ";"
1239   "String used to separate to shell commands."
1240   :group 'gnus-files
1241   :type 'string)
1242
1243 (defcustom gnus-valid-select-methods
1244   '(("nntp" post address prompt-address physical-address)
1245     ("nnspool" post address)
1246     ("nnvirtual" post-mail virtual prompt-address)
1247     ("nnmbox" mail respool address)
1248     ("nnml" mail respool address)
1249     ("nnmh" mail respool address)
1250     ("nndir" post-mail prompt-address physical-address)
1251     ("nneething" none address prompt-address physical-address)
1252     ("nndoc" none address prompt-address)
1253     ("nnbabyl" mail address respool)
1254     ("nnkiboze" post virtual)
1255     ("nnsoup" post-mail address)
1256     ("nndraft" post-mail)
1257     ("nnfolder" mail respool address)
1258     ("nngateway" post-mail address prompt-address physical-address)
1259     ("nnweb" none)
1260     ("nnslashdot" post)
1261     ("nnultimate" none)
1262     ("nnwarchive" none)
1263     ("nnlistserv" none)
1264     ("nnagent" post-mail)
1265     ("nnimap" post-mail address prompt-address physical-address))
1266   "*An alist of valid select methods.
1267 The first element of each list lists should be a string with the name
1268 of the select method.  The other elements may be the category of
1269 this method (i. e., `post', `mail', `none' or whatever) or other
1270 properties that this method has (like being respoolable).
1271 If you implement a new select method, all you should have to change is
1272 this variable.  I think."
1273   :group 'gnus-server
1274   :type '(repeat (group (string :tag "Name")
1275                         (radio-button-choice (const :format "%v " post)
1276                                              (const :format "%v " mail)
1277                                              (const :format "%v " none)
1278                                              (const post-mail))
1279                         (checklist :inline t
1280                                    (const :format "%v " address)
1281                                    (const :format "%v " prompt-address)
1282                                    (const :format "%v " physical-address)
1283                                    (const :format "%v " virtual)
1284                                    (const respool)))))
1285
1286 (defun gnus-redefine-select-method-widget ()
1287   "Recomputes the select-method widget based on the value of
1288 `gnus-valid-select-methods'."
1289   (define-widget 'gnus-select-method 'list
1290     "Widget for entering a select method."
1291     :value '(nntp "")
1292     :tag "Select Method"
1293     :args `((choice :tag "Method"
1294                     ,@(mapcar (lambda (entry)
1295                                 (list 'const :format "%v\n"
1296                                       (intern (car entry))))
1297                               gnus-valid-select-methods)
1298                     (symbol :tag "other"))
1299             (string :tag "Address")
1300             (repeat :tag "Options"
1301                     :inline t
1302                     (list :format "%v"
1303                           variable
1304                           (sexp :tag "Value"))))
1305     ))
1306
1307 (gnus-redefine-select-method-widget)
1308
1309 (defcustom gnus-updated-mode-lines '(group article summary tree)
1310   "List of buffers that should update their mode lines.
1311 The list may contain the symbols `group', `article', `tree' and
1312 `summary'.  If the corresponding symbol is present, Gnus will keep
1313 that mode line updated with information that may be pertinent.
1314 If this variable is nil, screen refresh may be quicker."
1315   :group 'gnus-various
1316   :type '(set (const group)
1317               (const article)
1318               (const summary)
1319               (const tree)))
1320
1321 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1322 (defcustom gnus-mode-non-string-length nil
1323   "*Max length of mode-line non-string contents.
1324 If this is nil, Gnus will take space as is needed, leaving the rest
1325 of the modeline intact.  Note that the default of nil is unlikely
1326 to be desirable; see the manual for further details."
1327   :group 'gnus-various
1328   :type '(choice (const nil)
1329                  integer))
1330
1331 (defcustom gnus-auto-expirable-newsgroups nil
1332   "*Groups in which to automatically mark read articles as expirable.
1333 If non-nil, this should be a regexp that should match all groups in
1334 which to perform auto-expiry.  This only makes sense for mail groups."
1335   :group 'nnmail-expire
1336   :type '(choice (const nil)
1337                  regexp))
1338
1339 (defcustom gnus-total-expirable-newsgroups nil
1340   "*Groups in which to perform expiry of all read articles.
1341 Use with extreme caution.  All groups that match this regexp will be
1342 expiring - which means that all read articles will be deleted after
1343 \(say) one week.         (This only goes for mail groups and the like, of
1344 course.)"
1345   :group 'nnmail-expire
1346   :type '(choice (const nil)
1347                  regexp))
1348
1349 (defcustom gnus-group-uncollapsed-levels 1
1350   "Number of group name elements to leave alone when making a short group name."
1351   :group 'gnus-group-visual
1352   :type 'integer)
1353
1354 (defcustom gnus-group-use-permanent-levels nil
1355   "*If non-nil, once you set a level, Gnus will use this level."
1356   :group 'gnus-group-levels
1357   :type 'boolean)
1358
1359 ;; Hooks.
1360
1361 (defcustom gnus-load-hook nil
1362   "A hook run while Gnus is loaded."
1363   :group 'gnus-start
1364   :type 'hook)
1365
1366 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1367   "A hook called to apply kill files to a group.
1368 This hook is intended to apply a kill file to the selected newsgroup.
1369 The function `gnus-apply-kill-file' is called by default.
1370
1371 Since a general kill file is too heavy to use only for a few
1372 newsgroups, I recommend you to use a lighter hook function.  For
1373 example, if you'd like to apply a kill file to articles which contains
1374 a string `rmgroup' in subject in newsgroup `control', you can use the
1375 following hook:
1376
1377  (setq gnus-apply-kill-hook
1378       (list
1379         (lambda ()
1380           (cond ((string-match \"control\" gnus-newsgroup-name)
1381                  (gnus-kill \"Subject\" \"rmgroup\")
1382                  (gnus-expunge \"X\"))))))"
1383   :group 'gnus-score-kill
1384   :options '(gnus-apply-kill-file)
1385   :type 'hook)
1386
1387 (defcustom gnus-group-change-level-function nil
1388   "Function run when a group level is changed.
1389 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1390   :group 'gnus-group-levels
1391   :type 'function)
1392
1393 ;;; Face thingies.
1394
1395 (defcustom gnus-visual
1396   '(summary-highlight group-highlight article-highlight
1397                       mouse-face
1398                       summary-menu group-menu article-menu
1399                       tree-highlight menu highlight
1400                       browse-menu server-menu
1401                       page-marker tree-menu binary-menu pick-menu
1402                       grouplens-menu)
1403   "*Enable visual features.
1404 If `visual' is disabled, there will be no menus and few faces.  Most of
1405 the visual customization options below will be ignored.  Gnus will use
1406 less space and be faster as a result.
1407
1408 This variable can also be a list of visual elements to switch on.  For
1409 instance, to switch off all visual things except menus, you can say:
1410
1411    (setq gnus-visual '(menu))
1412
1413 Valid elements include `summary-highlight', `group-highlight',
1414 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1415 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1416 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1417 and `grouplens-menu'."
1418   :group 'gnus-meta
1419   :group 'gnus-visual
1420   :type '(set (const summary-highlight)
1421               (const group-highlight)
1422               (const article-highlight)
1423               (const mouse-face)
1424               (const summary-menu)
1425               (const group-menu)
1426               (const article-menu)
1427               (const tree-highlight)
1428               (const menu)
1429               (const highlight)
1430               (const browse-menu)
1431               (const server-menu)
1432               (const page-marker)
1433               (const tree-menu)
1434               (const binary-menu)
1435               (const pick-menu)
1436               (const grouplens-menu)))
1437
1438 (defcustom gnus-mouse-face
1439   (condition-case ()
1440       (if (gnus-visual-p 'mouse-face 'highlight)
1441           (if (boundp 'gnus-mouse-face)
1442               (or gnus-mouse-face 'highlight)
1443             'highlight)
1444         'default)
1445     (error 'highlight))
1446   "*Face used for group or summary buffer mouse highlighting.
1447 The line beneath the mouse pointer will be highlighted with this
1448 face."
1449   :group 'gnus-visual
1450   :type 'face)
1451
1452 (defcustom gnus-article-save-directory gnus-directory
1453   "*Name of the directory articles will be saved in (default \"~/News\")."
1454   :group 'gnus-article-saving
1455   :type 'directory)
1456
1457 (defvar gnus-plugged t
1458   "Whether Gnus is plugged or not.")
1459
1460 (defcustom gnus-default-charset 'iso-8859-1
1461   "Default charset assumed to be used when viewing non-ASCII characters.
1462 This variable is overridden on a group-to-group basis by the
1463 gnus-group-charset-alist variable and is only used on groups not
1464 covered by that variable."
1465   :type 'symbol
1466   :group 'gnus-charset)
1467
1468 (defcustom gnus-default-posting-charset nil
1469   "Default charset assumed to be used when posting non-ASCII characters.
1470 This variable is overridden on a group-to-group basis by the
1471 gnus-group-posting-charset-alist variable and is only used on groups not
1472 covered by that variable.
1473 If nil, no default charset is assumed when posting."
1474   :type 'symbol
1475   :group 'gnus-charset)
1476
1477 \f
1478 ;;; Internal variables
1479
1480 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1481 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1482 (defvar gnus-original-article-buffer " *Original Article*")
1483 (defvar gnus-newsgroup-name nil)
1484 (defvar gnus-ephemeral-servers nil)
1485
1486 (defvar gnus-agent nil
1487   "Whether we want to use the Gnus agent or not.")
1488
1489 (defvar gnus-command-method nil
1490   "Dynamically bound variable that says what the current backend is.")
1491
1492 (defvar gnus-current-select-method nil
1493   "The current method for selecting a newsgroup.")
1494
1495 (defvar gnus-tree-buffer "*Tree*"
1496   "Buffer where Gnus thread trees are displayed.")
1497
1498 ;; Dummy variable.
1499 (defvar gnus-use-generic-from nil)
1500
1501 ;; Variable holding the user answers to all method prompts.
1502 (defvar gnus-method-history nil)
1503
1504 ;; Variable holding the user answers to all mail method prompts.
1505 (defvar gnus-mail-method-history nil)
1506
1507 ;; Variable holding the user answers to all group prompts.
1508 (defvar gnus-group-history nil)
1509
1510 (defvar gnus-server-alist nil
1511   "List of available servers.")
1512
1513 (defcustom gnus-cache-directory
1514   (nnheader-concat gnus-directory "cache/")
1515   "*The directory where cached articles will be stored."
1516   :group 'gnus-cache
1517   :type 'directory)
1518
1519 (defvar gnus-predefined-server-alist
1520   `(("cache"
1521      nnspool "cache"
1522      (nnspool-spool-directory ,gnus-cache-directory)
1523      (nnspool-nov-directory ,gnus-cache-directory)
1524      (nnspool-active-file
1525       ,(nnheader-concat gnus-cache-directory "active"))))
1526   "List of predefined (convenience) servers.")
1527
1528 (defvar gnus-topic-indentation "");; Obsolete variable.
1529
1530 (defconst gnus-article-mark-lists
1531   '((marked . tick) (replied . reply)
1532     (expirable . expire) (killed . killed)
1533     (bookmarks . bookmark) (dormant . dormant)
1534     (scored . score) (saved . save)
1535     (cached . cache) (downloadable . download)
1536     (unsendable . unsend)))
1537
1538 (defvar gnus-headers-retrieved-by nil)
1539 (defvar gnus-article-reply nil)
1540 (defvar gnus-override-method nil)
1541 (defvar gnus-article-check-size nil)
1542 (defvar gnus-opened-servers nil)
1543
1544 (defvar gnus-current-kill-article nil)
1545
1546 (defvar gnus-have-read-active-file nil)
1547
1548 (defconst gnus-maintainer
1549   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1550   "The mail address of the Gnus maintainers.")
1551
1552 (defvar gnus-info-nodes
1553   '((gnus-group-mode "(gnus)The Group Buffer")
1554     (gnus-summary-mode "(gnus)The Summary Buffer")
1555     (gnus-article-mode "(gnus)The Article Buffer")
1556     (gnus-server-mode "(gnus)The Server Buffer")
1557     (gnus-browse-mode "(gnus)Browse Foreign Server")
1558     (gnus-tree-mode "(gnus)Tree Display"))
1559   "Alist of major modes and related Info nodes.")
1560
1561 (defvar gnus-group-buffer "*Group*")
1562 (defvar gnus-summary-buffer "*Summary*")
1563 (defvar gnus-article-buffer "*Article*")
1564 (defvar gnus-server-buffer "*Server*")
1565
1566 (defvar gnus-slave nil
1567   "Whether this Gnus is a slave or not.")
1568
1569 (defvar gnus-batch-mode nil
1570   "Whether this Gnus is running in batch mode or not.")
1571
1572 (defvar gnus-variable-list
1573   '(gnus-newsrc-options gnus-newsrc-options-n
1574                         gnus-newsrc-last-checked-date
1575                         gnus-newsrc-alist gnus-server-alist
1576                         gnus-killed-list gnus-zombie-list
1577                         gnus-topic-topology gnus-topic-alist
1578                         gnus-format-specs)
1579   "Gnus variables saved in the quick startup file.")
1580
1581 (defvar gnus-newsrc-alist nil
1582   "Assoc list of read articles.
1583 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1584
1585 (defvar gnus-newsrc-hashtb nil
1586   "Hashtable of gnus-newsrc-alist.")
1587
1588 (defvar gnus-killed-list nil
1589   "List of killed newsgroups.")
1590
1591 (defvar gnus-killed-hashtb nil
1592   "Hash table equivalent of gnus-killed-list.")
1593
1594 (defvar gnus-zombie-list nil
1595   "List of almost dead newsgroups.")
1596
1597 (defvar gnus-description-hashtb nil
1598   "Descriptions of newsgroups.")
1599
1600 (defvar gnus-list-of-killed-groups nil
1601   "List of newsgroups that have recently been killed by the user.")
1602
1603 (defvar gnus-active-hashtb nil
1604   "Hashtable of active articles.")
1605
1606 (defvar gnus-moderated-hashtb nil
1607   "Hashtable of moderated newsgroups.")
1608
1609 ;; Save window configuration.
1610 (defvar gnus-prev-winconf nil)
1611
1612 (defvar gnus-reffed-article-number nil)
1613
1614 ;;; Let the byte-compiler know that we know about this variable.
1615 (defvar rmail-default-rmail-file)
1616
1617 (defvar gnus-dead-summary nil)
1618
1619 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1620   "Regexp matching invalid groups.")
1621
1622 ;;; End of variables.
1623
1624 ;; Define some autoload functions Gnus might use.
1625 (eval-and-compile
1626
1627   ;; This little mapcar goes through the list below and marks the
1628   ;; symbols in question as autoloaded functions.
1629   (mapcar
1630    (lambda (package)
1631      (let ((interactive (nth 1 (memq ':interactive package))))
1632        (mapcar
1633         (lambda (function)
1634           (let (keymap)
1635             (when (consp function)
1636               (setq keymap (car (memq 'keymap function)))
1637               (setq function (car function)))
1638             (unless (fboundp function)
1639               (autoload function (car package) nil interactive keymap))))
1640         (if (eq (nth 1 package) ':interactive)
1641             (nthcdr 3 package)
1642           (cdr package)))))
1643    '(("info" :interactive t Info-goto-node)
1644      ("pp" pp pp-to-string pp-eval-expression)
1645      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1646      ("ps-print" ps-print-preprint)
1647      ("browse-url" :interactive t browse-url)
1648      ("message" :interactive t
1649       message-send-and-exit message-yank-original)
1650      ("babel" babel-as-string)
1651      ("nnmail" nnmail-split-fancy nnmail-article-group)
1652      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1653      ("rmailout" rmail-output rmail-output-to-rmail-file)
1654      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1655       rmail-show-message rmail-summary-exists
1656       rmail-select-summary rmail-update-summary)
1657      ("gnus-audio" :interactive t gnus-audio-play)
1658      ("gnus-xmas" gnus-xmas-splash)
1659      ("gnus-soup" :interactive t
1660       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1661       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1662      ("nnsoup" nnsoup-pack-replies)
1663      ("score-mode" :interactive t gnus-score-mode)
1664      ("gnus-mh" gnus-summary-save-article-folder
1665       gnus-Folder-save-name gnus-folder-save-name)
1666      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1667      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1668       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1669       gnus-demon-add-disconnection gnus-demon-add-handler
1670       gnus-demon-remove-handler)
1671      ("gnus-demon" :interactive t
1672       gnus-demon-init gnus-demon-cancel)
1673      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1674       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1675      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1676       gnus-nocem-unwanted-article-p)
1677      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1678       gnus-server-server-name)
1679      ("gnus-srvr" gnus-browse-foreign-server)
1680      ("gnus-cite" :interactive t
1681       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1682       gnus-article-hide-citation gnus-article-fill-cited-article
1683       gnus-article-hide-citation-in-followups)
1684      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1685       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1686       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1687      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1688       gnus-cache-possibly-remove-articles gnus-cache-request-article
1689       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1690       gnus-cache-enter-remove-article gnus-cached-article-p
1691       gnus-cache-open gnus-cache-close gnus-cache-update-article
1692       gnus-cache-articles-in-group)
1693      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1694       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1695      ("gnus-score" :interactive t
1696       gnus-summary-increase-score gnus-summary-set-score
1697       gnus-summary-raise-thread gnus-summary-raise-same-subject
1698       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1699       gnus-summary-lower-thread gnus-summary-lower-same-subject
1700       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1701       gnus-summary-current-score gnus-score-delta-default
1702       gnus-score-flush-cache gnus-score-close
1703       gnus-possibly-score-headers gnus-score-followup-article
1704       gnus-score-followup-thread)
1705      ("gnus-score"
1706       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1707       gnus-current-score-file-nondirectory gnus-score-adaptive
1708       gnus-score-find-trace gnus-score-file-name)
1709      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1710      ("gnus-topic" :interactive t gnus-topic-mode)
1711      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1712       gnus-subscribe-topics)
1713      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1714      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1715      ("gnus-uu" :interactive t
1716       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1717       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1718       gnus-uu-mark-by-regexp gnus-uu-mark-all
1719       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1720       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1721       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1722       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1723       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1724       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1725       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1726       gnus-uu-mark-over gnus-uu-post-news)
1727      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1728      ("gnus-msg" (gnus-summary-send-map keymap)
1729       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1730      ("gnus-msg" :interactive t
1731       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1732       gnus-summary-followup gnus-summary-followup-with-original
1733       gnus-summary-cancel-article gnus-summary-supersede-article
1734       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1735       gnus-summary-mail-forward gnus-summary-mail-other-window
1736       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1737       gnus-summary-wide-reply gnus-summary-followup-to-mail
1738       gnus-summary-followup-to-mail-with-original gnus-bug
1739       gnus-summary-wide-reply-with-original
1740       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1741       gnus-summary-post-forward)
1742      ("gnus-picon" :interactive t gnus-article-display-picons
1743       gnus-group-display-picons gnus-picons-article-display-x-face
1744       gnus-picons-display-x-face)
1745      ("gnus-picon" gnus-picons-buffer-name)
1746      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1747       gnus-grouplens-mode)
1748      ("smiley" :interactive t gnus-smiley-display)
1749      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1750      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1751       gnus-list-of-unread-articles gnus-list-of-read-articles
1752       gnus-offer-save-summaries gnus-make-thread-indent-array
1753       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1754       gnus-summary-skip-intangible gnus-summary-article-number
1755       gnus-data-header gnus-data-find)
1756      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1757       gnus-group-list-groups gnus-group-first-unread-group
1758       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1759       gnus-group-setup-buffer gnus-group-get-new-news
1760       gnus-group-make-help-group gnus-group-update-group
1761       gnus-group-iterate gnus-group-group-name)
1762      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1763       gnus-backlog-remove-article)
1764      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1765       gnus-article-prepare gnus-article-set-window-start
1766       gnus-article-next-page gnus-article-prev-page
1767       gnus-request-article-this-buffer gnus-article-mode
1768       gnus-article-setup-buffer gnus-narrow-to-page
1769       gnus-article-delete-invisible-text gnus-treat-article)
1770      ("gnus-art" :interactive t
1771       gnus-article-hide-headers gnus-article-hide-boring-headers
1772       gnus-article-treat-overstrike
1773       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1774       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1775       gnus-article-de-base64-unreadable
1776       gnus-article-decode-HZ
1777       gnus-article-wash-html
1778       gnus-article-hide-pgp
1779       gnus-article-hide-pem gnus-article-hide-signature
1780       gnus-article-strip-leading-blank-lines gnus-article-date-local
1781       gnus-article-date-original gnus-article-date-lapsed
1782       gnus-article-show-all-headers
1783       gnus-article-edit-mode gnus-article-edit-article
1784       gnus-article-edit-done gnus-article-decode-encoded-words
1785       gnus-start-date-timer gnus-stop-date-timer
1786       gnus-mime-view-all-parts)
1787      ("gnus-int" gnus-request-type)
1788      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1789       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1790      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1791       gnus-dup-enter-articles)
1792      ("gnus-range" gnus-copy-sequence)
1793      ("gnus-eform" gnus-edit-form)
1794      ("gnus-move" :interactive t
1795       gnus-group-move-group-to-server gnus-change-server)
1796      ("gnus-logic" gnus-score-advanced)
1797      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1798      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1799       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1800       gnus-async-halt-prefetch)
1801      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1802       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1803       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1804       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1805      ("gnus-agent" :interactive t
1806       gnus-unplugged gnus-agentize gnus-agent-batch)
1807      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1808       gnus-summary-save-article-vm)
1809      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1810      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1811      ("gnus-mlspl" :interactive t gnus-group-split-setup
1812       gnus-group-split-update))))
1813
1814 ;;; gnus-sum.el thingies
1815
1816
1817 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1818   "*The format specification of the lines in the summary buffer.
1819
1820 It works along the same lines as a normal formatting string,
1821 with some simple extensions.
1822
1823 %N   Article number, left padded with spaces (string)
1824 %S   Subject (string)
1825 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1826 %n   Name of the poster (string)
1827 %a   Extracted name of the poster (string)
1828 %A   Extracted address of the poster (string)
1829 %F   Contents of the From: header (string)
1830 %f   Contents of the From: or To: headers (string)
1831 %x   Contents of the Xref: header (string)
1832 %D   Date of the article (string)
1833 %d   Date of the article (string) in DD-MMM format
1834 %M   Message-id of the article (string)
1835 %r   References of the article (string)
1836 %c   Number of characters in the article (integer)
1837 %L   Number of lines in the article (integer)
1838 %I   Indentation based on thread level (a string of spaces)
1839 %T   A string with two possible values: 80 spaces if the article
1840      is on thread level two or larger and 0 spaces on level one
1841 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1842 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1843 %[   Opening bracket (character, \"[\" or \"<\")
1844 %]   Closing bracket (character, \"]\" or \">\")
1845 %>   Spaces of length thread-level (string)
1846 %<   Spaces of length (- 20 thread-level) (string)
1847 %i   Article score (number)
1848 %z   Article zcore (character)
1849 %t   Number of articles under the current thread (number).
1850 %e   Whether the thread is empty or not (character).
1851 %l   GroupLens score (string).
1852 %V   Total thread score (number).
1853 %P   The line number (number).
1854 %O   Download mark (character).
1855 %u   User defined specifier.  The next character in the format string should
1856      be a letter.  Gnus will call the function gnus-user-format-function-X,
1857      where X is the letter following %u.  The function will be passed the
1858      current header as argument.  The function should return a string, which
1859      will be inserted into the summary just like information from any other
1860      summary specifier.
1861
1862 Text between %( and %) will be highlighted with `gnus-mouse-face'
1863 when the mouse point is placed inside the area.  There can only be one
1864 such area.
1865
1866 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1867 with care.  For reasons of efficiency, Gnus will compute what column
1868 these characters will end up in, and \"hard-code\" that.  This means that
1869 it is invalid to have these specs after a variable-length spec.  Well,
1870 you might not be arrested, but your summary buffer will look strange,
1871 which is bad enough.
1872
1873 The smart choice is to have these specs as for to the left as
1874 possible.
1875
1876 This restriction may disappear in later versions of Gnus."
1877   :type 'string
1878   :group 'gnus-summary-format)
1879
1880 ;;;
1881 ;;; Skeleton keymaps
1882 ;;;
1883
1884 (defun gnus-suppress-keymap (keymap)
1885   (suppress-keymap keymap)
1886   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1887     (while keys
1888       (define-key keymap (pop keys) 'undefined))))
1889
1890 (defvar gnus-article-mode-map
1891   (let ((keymap (make-sparse-keymap)))
1892     (gnus-suppress-keymap keymap)
1893     keymap))
1894 (defvar gnus-summary-mode-map
1895   (let ((keymap (make-keymap)))
1896     (gnus-suppress-keymap keymap)
1897     keymap))
1898 (defvar gnus-group-mode-map
1899   (let ((keymap (make-keymap)))
1900     (gnus-suppress-keymap keymap)
1901     keymap))
1902
1903 \f
1904
1905 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1906 ;; If you want the cursor to go somewhere else, set these two
1907 ;; functions in some startup hook to whatever you want.
1908 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1909 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1910
1911 ;;; Various macros and substs.
1912
1913 (defun gnus-header-from (header)
1914   (mail-header-from header))
1915
1916 (defmacro gnus-gethash (string hashtable)
1917   "Get hash value of STRING in HASHTABLE."
1918   `(symbol-value (intern-soft ,string ,hashtable)))
1919
1920 (defmacro gnus-sethash (string value hashtable)
1921   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1922   `(set (intern ,string ,hashtable) ,value))
1923 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1924
1925 (defmacro gnus-group-unread (group)
1926   "Get the currently computed number of unread articles in GROUP."
1927   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))