*** empty log message ***
[gnus] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
3
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval '(run-hooks 'gnus-load-hook))
30
31 (eval-when-compile (require 'cl))
32
33 (require 'custom)
34 (eval-and-compile
35   (if (< emacs-major-version 20)
36       (require 'gnus-load)))
37 (require 'message)
38
39 (defgroup gnus nil
40   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
41   :group 'news
42   :group 'mail)
43
44 (defgroup gnus-cache nil
45   "Cache interface."
46   :group 'gnus)
47
48 (defgroup gnus-start nil
49   "Starting your favorite newsreader."
50   :group 'gnus)
51
52 (defgroup gnus-start-server nil
53   "Server options at startup."
54   :group 'gnus-start)
55
56 ;; These belong to gnus-group.el.
57 (defgroup gnus-group nil
58   "Group buffers."
59   :link '(custom-manual "(gnus)The Group Buffer")
60   :group 'gnus)
61
62 (defgroup gnus-group-foreign nil
63   "Foreign groups."
64   :link '(custom-manual "(gnus)Foreign Groups")
65   :group 'gnus-group)
66
67 (defgroup gnus-group-new nil
68   "Automatic subscription of new groups."
69   :group 'gnus-group)
70
71 (defgroup gnus-group-levels nil
72   "Group levels."
73   :link '(custom-manual "(gnus)Group Levels")
74   :group 'gnus-group)
75
76 (defgroup gnus-group-select nil
77   "Selecting a Group."
78   :link '(custom-manual "(gnus)Selecting a Group")
79   :group 'gnus-group)
80
81 (defgroup gnus-group-listing nil
82   "Showing slices of the group list."
83   :link '(custom-manual "(gnus)Listing Groups")
84   :group 'gnus-group)
85
86 (defgroup gnus-group-visual nil
87   "Sorting the group buffer."
88   :link '(custom-manual "(gnus)Group Buffer Format")
89   :group 'gnus-group
90   :group 'gnus-visual)
91
92 (defgroup gnus-group-various nil
93   "Various group options."
94   :link '(custom-manual "(gnus)Scanning New Messages")
95   :group 'gnus-group)
96
97 ;; These belong to gnus-sum.el.
98 (defgroup gnus-summary nil
99   "Summary buffers."
100   :link '(custom-manual "(gnus)The Summary Buffer")
101   :group 'gnus)
102
103 (defgroup gnus-summary-exit nil
104   "Leaving summary buffers."
105   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
106   :group 'gnus-summary)
107
108 (defgroup gnus-summary-marks nil
109   "Marks used in summary buffers."
110   :link '(custom-manual "(gnus)Marking Articles")
111   :group 'gnus-summary)
112
113 (defgroup gnus-thread nil
114   "Ordering articles according to replies."
115   :link '(custom-manual "(gnus)Threading")
116   :group 'gnus-summary)
117
118 (defgroup gnus-summary-format nil
119   "Formatting of the summary buffer."
120   :link '(custom-manual "(gnus)Summary Buffer Format")
121   :group 'gnus-summary)
122
123 (defgroup gnus-summary-choose nil
124   "Choosing Articles."
125   :link '(custom-manual "(gnus)Choosing Articles")
126   :group 'gnus-summary)
127
128 (defgroup gnus-summary-maneuvering nil
129   "Summary movement commands."
130   :link '(custom-manual "(gnus)Summary Maneuvering")
131   :group 'gnus-summary)
132
133 (defgroup gnus-summary-mail nil
134   "Mail group commands."
135   :link '(custom-manual "(gnus)Mail Group Commands")
136   :group 'gnus-summary)
137
138 (defgroup gnus-summary-sort nil
139   "Sorting the summary buffer."
140   :link '(custom-manual "(gnus)Sorting")
141   :group 'gnus-summary)
142
143 (defgroup gnus-summary-visual nil
144   "Highlighting and menus in the summary buffer."
145   :link '(custom-manual "(gnus)Summary Highlighting")
146   :group 'gnus-visual
147   :group 'gnus-summary)
148
149 (defgroup gnus-summary-various nil
150   "Various summary buffer options."
151   :link '(custom-manual "(gnus)Various Summary Stuff")
152   :group 'gnus-summary)
153
154 (defgroup gnus-summary-pick nil
155   "Pick mode in the summary buffer."
156   :link '(custom-manual "(gnus)Pick and Read")
157   :prefix "gnus-pick-"
158   :group 'gnus-summary)
159
160 (defgroup gnus-summary-tree nil
161   "Tree display of threads in the summary buffer."
162   :link '(custom-manual "(gnus)Tree Display")
163   :prefix "gnus-tree-"
164   :group 'gnus-summary)
165
166 ;; Belongs to gnus-uu.el
167 (defgroup gnus-extract-view nil
168   "Viewing extracted files."
169   :link '(custom-manual "(gnus)Viewing Files")
170   :group 'gnus-extract)
171
172 ;; Belongs to gnus-score.el
173 (defgroup gnus-score nil
174   "Score and kill file handling."
175   :group 'gnus)
176
177 (defgroup gnus-score-kill nil
178   "Kill files."
179   :group 'gnus-score)
180
181 (defgroup gnus-score-adapt nil
182   "Adaptive score files."
183   :group 'gnus-score)
184
185 (defgroup gnus-score-default nil
186   "Default values for score files."
187   :group 'gnus-score)
188
189 (defgroup gnus-score-expire nil
190   "Expiring score rules."
191   :group 'gnus-score)
192
193 (defgroup gnus-score-decay nil
194   "Decaying score rules."
195   :group 'gnus-score)
196
197 (defgroup gnus-score-files nil
198   "Score and kill file names."
199   :group 'gnus-score
200   :group 'gnus-files)
201
202 (defgroup gnus-score-various nil
203   "Various scoring and killing options."
204   :group 'gnus-score)
205
206 ;; Other
207 (defgroup gnus-visual nil
208   "Options controling the visual fluff."
209   :group 'gnus
210   :group 'faces)
211
212 (defgroup gnus-agent nil
213   "Offline support for Gnus."
214   :group 'gnus)
215
216 (defgroup gnus-files nil
217   "Files used by Gnus."
218   :group 'gnus)
219
220 (defgroup gnus-dribble-file nil
221   "Auto save file."
222   :link '(custom-manual "(gnus)Auto Save")
223   :group 'gnus-files)
224
225 (defgroup gnus-newsrc nil
226   "Storing Gnus state."
227   :group 'gnus-files)
228
229 (defgroup gnus-server nil
230   "Options related to newsservers and other servers used by Gnus."
231   :group 'gnus)
232
233 (defgroup gnus-message '((message custom-group))
234   "Composing replies and followups in Gnus."
235   :group 'gnus)
236
237 (defgroup gnus-meta nil
238   "Meta variables controling major portions of Gnus.
239 In general, modifying these variables does not take affect until Gnus
240 is restarted, and sometimes reloaded."
241   :group 'gnus)
242
243 (defgroup gnus-various nil
244   "Other Gnus options."
245   :link '(custom-manual "(gnus)Various Various")
246   :group 'gnus)
247
248 (defgroup gnus-exit nil
249   "Exiting gnus."
250   :link '(custom-manual "(gnus)Exiting Gnus")
251   :group 'gnus)
252
253 (defconst gnus-version-number "5.6.20"
254   "Version number for this version of Gnus.")
255
256 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
257   "Version string for this version of Gnus.")
258
259 (defcustom gnus-inhibit-startup-message nil
260   "If non-nil, the startup message will not be displayed.
261 This variable is used before `.gnus.el' is loaded, so it should
262 be set in `.emacs' instead."
263   :group 'gnus-start
264   :type 'boolean)
265
266 (defcustom gnus-play-startup-jingle nil
267   "If non-nil, play the Gnus jingle at startup."
268   :group 'gnus-start
269   :type 'boolean)
270
271 ;;; Kludges to help the transition from the old `custom.el'.
272
273 (unless (featurep 'gnus-xmas)
274   (defalias 'gnus-make-overlay 'make-overlay)
275   (defalias 'gnus-delete-overlay 'delete-overlay)
276   (defalias 'gnus-overlay-put 'overlay-put)
277   (defalias 'gnus-move-overlay 'move-overlay)
278   (defalias 'gnus-overlay-end 'overlay-end)
279   (defalias 'gnus-extent-detached-p 'ignore)
280   (defalias 'gnus-extent-start-open 'ignore)
281   (defalias 'gnus-set-text-properties 'set-text-properties)
282   (defalias 'gnus-group-remove-excess-properties 'ignore)
283   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
284   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
285   (defalias 'gnus-character-to-event 'identity)
286   (defalias 'gnus-add-text-properties 'add-text-properties)
287   (defalias 'gnus-put-text-property 'put-text-property)
288   (defalias 'gnus-mode-line-buffer-identification 'identity)
289   (defalias 'gnus-characterp 'numberp)
290   (defalias 'gnus-deactivate-mark 'deactivate-mark)
291   (defalias 'gnus-window-edges 'window-edges)
292   (defalias 'gnus-key-press-event-p 'numberp))
293
294 ;; We define these group faces here to avoid the display
295 ;; update forced when creating new faces.
296
297 (defface gnus-group-news-1-face
298   '((((class color)
299       (background dark))
300      (:foreground "PaleTurquoise" :bold t))
301     (((class color)
302       (background light))
303      (:foreground "ForestGreen" :bold t))
304     (t
305      ()))
306   "Level 1 newsgroup face.")
307
308 (defface gnus-group-news-1-empty-face
309   '((((class color)
310       (background dark))
311      (:foreground "PaleTurquoise"))
312     (((class color)
313       (background light))
314      (:foreground "ForestGreen"))
315     (t
316      ()))
317   "Level 1 empty newsgroup face.")
318
319 (defface gnus-group-news-2-face
320   '((((class color)
321       (background dark))
322      (:foreground "turquoise" :bold t))
323     (((class color)
324       (background light))
325      (:foreground "CadetBlue4" :bold t))
326     (t
327      ()))
328   "Level 2 newsgroup face.")
329
330 (defface gnus-group-news-2-empty-face
331   '((((class color)
332       (background dark))
333      (:foreground "turquoise"))
334     (((class color)
335       (background light))
336      (:foreground "CadetBlue4"))
337     (t
338      ()))
339   "Level 2 empty newsgroup face.")
340
341 (defface gnus-group-news-3-face
342   '((((class color)
343       (background dark))
344      (:bold t))
345     (((class color)
346       (background light))
347      (:bold t))
348     (t
349      ()))
350   "Level 3 newsgroup face.")
351
352 (defface gnus-group-news-3-empty-face
353   '((((class color)
354       (background dark))
355      ())
356     (((class color)
357       (background light))
358      ())
359     (t
360      ()))
361   "Level 3 empty newsgroup face.")
362
363 (defface gnus-group-news-low-face
364   '((((class color)
365       (background dark))
366      (:foreground "DarkTurquoise" :bold t))
367     (((class color)
368       (background light))
369      (:foreground "DarkGreen" :bold t))
370     (t
371      ()))
372   "Low level newsgroup face.")
373
374 (defface gnus-group-news-low-empty-face
375   '((((class color)
376       (background dark))
377      (:foreground "DarkTurquoise"))
378     (((class color)
379       (background light))
380      (:foreground "DarkGreen"))
381     (t
382      ()))
383   "Low level empty newsgroup face.")
384
385 (defface gnus-group-mail-1-face
386   '((((class color)
387       (background dark))
388      (:foreground "aquamarine1" :bold t))
389     (((class color)
390       (background light))
391      (:foreground "DeepPink3" :bold t))
392     (t
393      (:bold t)))
394   "Level 1 mailgroup face.")
395
396 (defface gnus-group-mail-1-empty-face
397   '((((class color)
398       (background dark))
399      (:foreground "aquamarine1"))
400     (((class color)
401       (background light))
402      (:foreground "DeepPink3"))
403     (t
404      (:italic t :bold t)))
405   "Level 1 empty mailgroup face.")
406
407 (defface gnus-group-mail-2-face
408   '((((class color)
409       (background dark))
410      (:foreground "aquamarine2" :bold t))
411     (((class color)
412       (background light))
413      (:foreground "HotPink3" :bold t))
414     (t
415      (:bold t)))
416   "Level 2 mailgroup face.")
417
418 (defface gnus-group-mail-2-empty-face
419   '((((class color)
420       (background dark))
421      (:foreground "aquamarine2"))
422     (((class color)
423       (background light))
424      (:foreground "HotPink3"))
425     (t
426      (:bold t)))
427   "Level 2 empty mailgroup face.")
428
429 (defface gnus-group-mail-3-face
430   '((((class color)
431       (background dark))
432      (:foreground "aquamarine3" :bold t))
433     (((class color)
434       (background light))
435      (:foreground "magenta4" :bold t))
436     (t
437      (:bold t)))
438   "Level 3 mailgroup face.")
439
440 (defface gnus-group-mail-3-empty-face
441   '((((class color)
442       (background dark))
443      (:foreground "aquamarine3"))
444     (((class color)
445       (background light))
446      (:foreground "magenta4"))
447     (t
448      ()))
449   "Level 3 empty mailgroup face.")
450
451 (defface gnus-group-mail-low-face
452   '((((class color)
453       (background dark))
454      (:foreground "aquamarine4" :bold t))
455     (((class color)
456       (background light))
457      (:foreground "DeepPink4" :bold t))
458     (t
459      (:bold t)))
460   "Low level mailgroup face.")
461
462 (defface gnus-group-mail-low-empty-face
463   '((((class color)
464       (background dark))
465      (:foreground "aquamarine4"))
466     (((class color)
467       (background light))
468      (:foreground "DeepPink4"))
469     (t
470      (:bold t)))
471   "Low level empty mailgroup face.")
472
473 ;; Summary mode faces.
474
475 (defface gnus-summary-selected-face '((t
476                                        (:underline t)))
477   "Face used for selected articles.")
478
479 (defface gnus-summary-cancelled-face
480   '((((class color))
481      (:foreground "yellow" :background "black")))
482   "Face used for cancelled articles.")
483
484 (defface gnus-summary-high-ticked-face
485   '((((class color)
486       (background dark))
487      (:foreground "pink" :bold t))
488     (((class color)
489       (background light))
490      (:foreground "firebrick" :bold t))
491     (t
492      (:bold t)))
493   "Face used for high interest ticked articles.")
494
495 (defface gnus-summary-low-ticked-face
496   '((((class color)
497       (background dark))
498      (:foreground "pink" :italic t))
499     (((class color)
500       (background light))
501      (:foreground "firebrick" :italic t))
502     (t
503      (:italic t)))
504   "Face used for low interest ticked articles.")
505
506 (defface gnus-summary-normal-ticked-face
507   '((((class color)
508       (background dark))
509      (:foreground "pink"))
510     (((class color)
511       (background light))
512      (:foreground "firebrick"))
513     (t
514      ()))
515   "Face used for normal interest ticked articles.")
516
517 (defface gnus-summary-high-ancient-face
518   '((((class color)
519       (background dark))
520      (:foreground "SkyBlue" :bold t))
521     (((class color)
522       (background light))
523      (:foreground "RoyalBlue" :bold t))
524     (t
525      (:bold t)))
526   "Face used for high interest ancient articles.")
527
528 (defface gnus-summary-low-ancient-face
529   '((((class color)
530       (background dark))
531      (:foreground "SkyBlue" :italic t))
532     (((class color)
533       (background light))
534      (:foreground "RoyalBlue" :italic t))
535     (t
536      (:italic t)))
537   "Face used for low interest ancient articles.")
538
539 (defface gnus-summary-normal-ancient-face
540   '((((class color)
541       (background dark))
542      (:foreground "SkyBlue"))
543     (((class color)
544       (background light))
545      (:foreground "RoyalBlue"))
546     (t
547      ()))
548   "Face used for normal interest ancient articles.")
549
550 (defface gnus-summary-high-unread-face
551   '((t
552      (:bold t)))
553   "Face used for high interest unread articles.")
554
555 (defface gnus-summary-low-unread-face
556   '((t
557      (:italic t)))
558   "Face used for low interest unread articles.")
559
560 (defface gnus-summary-normal-unread-face
561   '((t
562      ()))
563   "Face used for normal interest unread articles.")
564
565 (defface gnus-summary-high-read-face
566   '((((class color)
567       (background dark))
568      (:foreground "PaleGreen"
569                   :bold t))
570     (((class color)
571       (background light))
572      (:foreground "DarkGreen"
573                   :bold t))
574     (t
575      (:bold t)))
576   "Face used for high interest read articles.")
577
578 (defface gnus-summary-low-read-face
579   '((((class color)
580       (background dark))
581      (:foreground "PaleGreen"
582                   :italic t))
583     (((class color)
584       (background light))
585      (:foreground "DarkGreen"
586                   :italic t))
587     (t
588      (:italic t)))
589   "Face used for low interest read articles.")
590
591 (defface gnus-summary-normal-read-face
592   '((((class color)
593       (background dark))
594      (:foreground "PaleGreen"))
595     (((class color)
596       (background light))
597      (:foreground "DarkGreen"))
598     (t
599      ()))
600   "Face used for normal interest read articles.")
601
602
603 ;;; Splash screen.
604
605 (defvar gnus-group-buffer "*Group*")
606
607 (eval-and-compile
608   (autoload 'gnus-play-jingle "gnus-audio"))
609
610 (defface gnus-splash-face
611   '((((class color)
612       (background dark))
613      (:foreground "ForestGreen"))
614     (((class color)
615       (background light))
616      (:foreground "ForestGreen"))
617     (t
618      ()))
619   "Level 1 newsgroup face.")
620
621 (defun gnus-splash ()
622   (save-excursion
623     (switch-to-buffer (get-buffer-create gnus-group-buffer))
624     (let ((buffer-read-only nil))
625       (erase-buffer)
626       (unless gnus-inhibit-startup-message
627         (gnus-group-startup-message)
628         (sit-for 0)
629         (when gnus-play-startup-jingle
630           (gnus-play-jingle))))))
631
632 (defun gnus-indent-rigidly (start end arg)
633   "Indent rigidly using only spaces and no tabs."
634   (save-excursion
635     (save-restriction
636       (narrow-to-region start end)
637       (let ((tab-width 8))
638         (indent-rigidly start end arg)
639         ;; We translate tabs into spaces -- not everybody uses
640         ;; an 8-character tab.
641         (goto-char (point-min))
642         (while (search-forward "\t" nil t)
643           (replace-match "        " t t))))))
644
645 (defvar gnus-simple-splash nil)
646
647 (defun gnus-group-startup-message (&optional x y)
648   "Insert startup message in current buffer."
649   ;; Insert the message.
650   (erase-buffer)
651   (insert
652    (format "              %s
653           _    ___ _             _
654           _ ___ __ ___  __    _ ___
655           __   _     ___    __  ___
656               _           ___     _
657              _  _ __             _
658              ___   __            _
659                    __           _
660                     _      _   _
661                    _      _    _
662                       _  _    _
663                   __  ___
664                  _   _ _     _
665                 _   _
666               _    _
667              _    _
668             _
669           __
670
671 "
672            ""))
673   ;; And then hack it.
674   (gnus-indent-rigidly (point-min) (point-max)
675                        (/ (max (- (window-width) (or x 46)) 0) 2))
676   (goto-char (point-min))
677   (forward-line 1)
678   (let* ((pheight (count-lines (point-min) (point-max)))
679          (wheight (window-height))
680          (rest (- wheight pheight)))
681     (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
682   ;; Fontify some.
683   (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
684   (goto-char (point-min))
685   (setq mode-line-buffer-identification (concat " " gnus-version))
686   (setq gnus-simple-splash t)
687   (set-buffer-modified-p t))
688
689 (eval-when (load)
690   (let ((command (format "%s" this-command)))
691     (when (and (string-match "gnus" command)
692                (not (string-match "gnus-other-frame" command)))
693       (gnus-splash))))
694
695 ;;; Do the rest.
696
697 (require 'custom)
698 (require 'gnus-util)
699 (require 'nnheader)
700
701 (defcustom gnus-home-directory "~/"
702   "Directory variable that specifies the \"home\" directory.
703 All other Gnus path variables are initialized from this variable."
704   :group 'gnus-files
705   :type 'directory)
706
707 (defcustom gnus-directory (or (getenv "SAVEDIR")
708                               (nnheader-concat gnus-home-directory "News/"))
709   "*Directory variable from which all other Gnus file variables are derived.
710
711 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
712 This means that other directory variables that are initialized from
713 this variable won't be set properly if you set this variable in `.gnus.el'.
714 Set this variable in `.emacs' instead."
715   :group 'gnus-files
716   :type 'directory)
717
718 (defcustom gnus-default-directory nil
719   "*Default directory for all Gnus buffers."
720   :group 'gnus-files
721   :type '(choice (const :tag "current" nil)
722                  directory))
723
724 ;; Site dependent variables.  These variables should be defined in
725 ;; paths.el.
726
727 (defvar gnus-default-nntp-server nil
728   "Specify a default NNTP server.
729 This variable should be defined in paths.el, and should never be set
730 by the user.
731 If you want to change servers, you should use `gnus-select-method'.
732 See the documentation to that variable.")
733
734 ;; Don't touch this variable.
735 (defvar gnus-nntp-service "nntp"
736   "NNTP service name (\"nntp\" or 119).
737 This is an obsolete variable, which is scarcely used.  If you use an
738 nntp server for your newsgroup and want to change the port number
739 used to 899, you would say something along these lines:
740
741  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
742
743 (defcustom gnus-nntpserver-file "/etc/nntpserver"
744   "A file with only the name of the nntp server in it."
745   :group 'gnus-files
746   :group 'gnus-server
747   :type 'file)
748
749 ;; This function is used to check both the environment variable
750 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
751 ;; an nntp server name default.
752 (defun gnus-getenv-nntpserver ()
753   (or (getenv "NNTPSERVER")
754       (and (file-readable-p gnus-nntpserver-file)
755            (save-excursion
756              (set-buffer (get-buffer-create " *gnus nntp*"))
757              (buffer-disable-undo (current-buffer))
758              (insert-file-contents gnus-nntpserver-file)
759              (let ((name (buffer-string)))
760                (prog1
761                    (if (string-match "^[ \t\n]*$" name)
762                        nil
763                      name)
764                  (kill-buffer (current-buffer))))))))
765
766 (defcustom gnus-select-method
767   (condition-case nil
768     (nconc
769      (list 'nntp (or (condition-case nil
770                          (gnus-getenv-nntpserver)
771                        (error nil))
772                      (when (and gnus-default-nntp-server
773                                 (not (string= gnus-default-nntp-server "")))
774                        gnus-default-nntp-server)
775                      "news"))
776      (if (or (null gnus-nntp-service)
777              (equal gnus-nntp-service "nntp"))
778          nil
779        (list gnus-nntp-service)))
780     (error nil))
781   "*Default method for selecting a newsgroup.
782 This variable should be a list, where the first element is how the
783 news is to be fetched, the second is the address.
784
785 For instance, if you want to get your news via NNTP from
786 \"flab.flab.edu\", you could say:
787
788 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
789
790 If you want to use your local spool, say:
791
792 \(setq gnus-select-method (list 'nnspool (system-name)))
793
794 If you use this variable, you must set `gnus-nntp-server' to nil.
795
796 There is a lot more to know about select methods and virtual servers -
797 see the manual for details."
798   :group 'gnus-server
799   :type 'gnus-select-method)
800
801 (defcustom gnus-message-archive-method
802   `(nnfolder
803     "archive"
804     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
805     (nnfolder-active-file
806      ,(nnheader-concat message-directory "archive/active"))
807     (nnfolder-get-new-mail nil)
808     (nnfolder-inhibit-expiry t))
809   "*Method used for archiving messages you've sent.
810 This should be a mail method.
811
812 It's probably not a very effective to change this variable once you've
813 run Gnus once.  After doing that, you must edit this server from the
814 server buffer."
815   :group 'gnus-server
816   :group 'gnus-message
817   :type 'gnus-select-method)
818
819 (defcustom gnus-message-archive-group nil
820   "*Name of the group in which to save the messages you've written.
821 This can either be a string; a list of strings; or an alist
822 of regexps/functions/forms to be evaluated to return a string (or a list
823 of strings).  The functions are called with the name of the current
824 group (or nil) as a parameter.
825
826 If you want to save your mail in one group and the news articles you
827 write in another group, you could say something like:
828
829  \(setq gnus-message-archive-group
830         '((if (message-news-p)
831               \"misc-news\"
832             \"misc-mail\")))
833
834 Normally the group names returned by this variable should be
835 unprefixed -- which implicitly means \"store on the archive server\".
836 However, you may wish to store the message on some other server.  In
837 that case, just return a fully prefixed name of the group --
838 \"nnml+private:mail.misc\", for instance."
839   :group 'gnus-message
840   :type '(choice (const :tag "none" nil)
841                  string))
842
843 (defcustom gnus-secondary-servers nil
844   "List of NNTP servers that the user can choose between interactively.
845 To make Gnus query you for a server, you have to give `gnus' a
846 non-numeric prefix - `C-u M-x gnus', in short."
847   :group 'gnus-server
848   :type '(repeat string))
849
850 (defcustom gnus-nntp-server nil
851   "*The name of the host running the NNTP server.
852 This variable is semi-obsolete.  Use the `gnus-select-method'
853 variable instead."
854   :group 'gnus-server
855   :type '(choice (const :tag "disable" nil)
856                  string))
857
858 (defcustom gnus-secondary-select-methods nil
859   "A list of secondary methods that will be used for reading news.
860 This is a list where each element is a complete select method (see
861 `gnus-select-method').
862
863 If, for instance, you want to read your mail with the nnml backend,
864 you could set this variable:
865
866 \(setq gnus-secondary-select-methods '((nnml \"\")))"
867 :group 'gnus-server
868 :type '(repeat gnus-select-method))
869
870 (defvar gnus-backup-default-subscribed-newsgroups
871   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
872   "Default default new newsgroups the first time Gnus is run.
873 Should be set in paths.el, and shouldn't be touched by the user.")
874
875 (defcustom gnus-local-domain nil
876   "Local domain name without a host name.
877 The DOMAINNAME environment variable is used instead if it is defined.
878 If the `system-name' function returns the full Internet name, there is
879 no need to set this variable."
880   :group 'gnus-message
881   :type '(choice (const :tag "default" nil)
882                  string))
883
884 (defvar gnus-local-organization nil
885   "String with a description of what organization (if any) the user belongs to.
886 Obsolete variable; use `message-user-organization' instead.")
887
888 ;; Customization variables
889
890 (defcustom gnus-refer-article-method nil
891   "Preferred method for fetching an article by Message-ID.
892 If you are reading news from the local spool (with nnspool), fetching
893 articles by Message-ID is painfully slow.  By setting this method to an
894 nntp method, you might get acceptable results.
895
896 The value of this variable must be a valid select method as discussed
897 in the documentation of `gnus-select-method'."
898   :group 'gnus-server
899   :type '(choice (const :tag "default" nil)
900                  gnus-select-method))
901
902 (defcustom gnus-group-faq-directory
903   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
904     "/ftp@sunsite.auc.dk:/pub/usenet/"
905     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
906     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
907     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
908     "/ftp@rtfm.mit.edu:/pub/usenet/"
909     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
910     "/ftp@ftp.sunet.se:/pub/usenet/"
911     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
912     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
913     "/ftp@ftp.hk.super.net:/mirror/faqs/")
914   "*Directory where the group FAQs are stored.
915 This will most commonly be on a remote machine, and the file will be
916 fetched by ange-ftp.
917
918 This variable can also be a list of directories.  In that case, the
919 first element in the list will be used by default.  The others can
920 be used when being prompted for a site.
921
922 Note that Gnus uses an aol machine as the default directory.  If this
923 feels fundamentally unclean, just think of it as a way to finally get
924 something of value back from them.
925
926 If the default site is too slow, try one of these:
927
928    North America: mirrors.aol.com                /pub/rtfm/usenet
929                   ftp.seas.gwu.edu               /pub/rtfm
930                   rtfm.mit.edu                   /pub/usenet
931    Europe:        ftp.uni-paderborn.de           /pub/FAQ
932                   src.doc.ic.ac.uk               /usenet/news-FAQS
933                   ftp.sunet.se                   /pub/usenet
934                   sunsite.auc.dk                 /pub/usenet
935    Asia:          nctuccca.edu.tw                /USENET/FAQ
936                   hwarang.postech.ac.kr          /pub/usenet
937                   ftp.hk.super.net               /mirror/faqs"
938   :group 'gnus-group-various
939   :type '(choice directory
940                  (repeat directory)))
941
942 (defcustom gnus-use-cross-reference t
943   "*Non-nil means that cross referenced articles will be marked as read.
944 If nil, ignore cross references.  If t, mark articles as read in
945 subscribed newsgroups.  If neither t nor nil, mark as read in all
946 newsgroups."
947   :group 'gnus-server
948   :type '(choice (const :tag "off" nil)
949                  (const :tag "subscribed" t)
950                  (sexp :format "all"
951                        :value always)))
952
953 (defcustom gnus-process-mark ?#
954   "*Process mark."
955   :group 'gnus-group-visual
956   :group 'gnus-summary-marks
957   :type 'character)
958
959 (defcustom gnus-asynchronous nil
960   "*If non-nil, Gnus will supply backends with data needed for async article fetching."
961   :group 'gnus-asynchronous
962   :type 'boolean)
963
964 (defcustom gnus-large-newsgroup 200
965   "*The number of articles which indicates a large newsgroup.
966 If the number of articles in a newsgroup is greater than this value,
967 confirmation is required for selecting the newsgroup."
968   :group 'gnus-group-select
969   :type 'integer)
970
971 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
972   "*Non-nil means that the default name of a file to save articles in is the group name.
973 If it's nil, the directory form of the group name is used instead.
974
975 If this variable is a list, and the list contains the element
976 `not-score', long file names will not be used for score files; if it
977 contains the element `not-save', long file names will not be used for
978 saving; and if it contains the element `not-kill', long file names
979 will not be used for kill files.
980
981 Note that the default for this variable varies according to what system
982 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
983 to nil while on all other systems it defaults to t."
984   :group 'gnus-start
985   :type 'boolean)
986
987 (defcustom gnus-kill-files-directory gnus-directory
988   "*Name of the directory where kill files will be stored (default \"~/News\")."
989   :group 'gnus-score-files
990   :group 'gnus-score-kill
991   :type 'directory)
992
993 (defcustom gnus-save-score nil
994   "*If non-nil, save group scoring info."
995   :group 'gnus-score-various
996   :group 'gnus-start
997   :type 'boolean)
998
999 (defcustom gnus-use-undo t
1000   "*If non-nil, allow undoing in Gnus group mode buffers."
1001   :group 'gnus-meta
1002   :type 'boolean)
1003
1004 (defcustom gnus-use-adaptive-scoring nil
1005   "*If non-nil, use some adaptive scoring scheme.
1006 If a list, then the values `word' and `line' are meaningful.  The
1007 former will perform adaption on individual words in the subject
1008 header while `line' will perform adaption on several headers."
1009   :group 'gnus-meta
1010   :group 'gnus-score-adapt
1011   :type '(set (const word) (const line)))
1012
1013 (defcustom gnus-use-cache 'passive
1014   "*If nil, Gnus will ignore the article cache.
1015 If `passive', it will allow entering (and reading) articles
1016 explicitly entered into the cache.  If anything else, use the
1017 cache to the full extent of the law."
1018   :group 'gnus-meta
1019   :group 'gnus-cache
1020   :type '(choice (const :tag "off" nil)
1021                  (const :tag "passive" passive)
1022                  (const :tag "active" t)))
1023
1024 (defcustom gnus-use-trees nil
1025   "*If non-nil, display a thread tree buffer."
1026   :group 'gnus-meta
1027   :type 'boolean)
1028
1029 (defcustom gnus-use-grouplens nil
1030   "*If non-nil, use GroupLens ratings."
1031   :group 'gnus-meta
1032   :type 'boolean)
1033
1034 (defcustom gnus-keep-backlog nil
1035   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1036 If it is a number N, then Gnus will only keep the last N articles
1037 read.  If it is neither nil nor a number, Gnus will keep all read
1038 articles.  This is not a good idea."
1039   :group 'gnus-meta
1040   :type '(choice (const :tag "off" nil)
1041                  integer
1042                  (sexp :format "all"
1043                        :value t)))
1044
1045 (defcustom gnus-use-nocem nil
1046   "*If non-nil, Gnus will read NoCeM cancel messages."
1047   :group 'gnus-meta
1048   :type 'boolean)
1049
1050 (defcustom gnus-suppress-duplicates nil
1051   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1052   :group 'gnus-meta
1053   :type 'boolean)
1054
1055 (defcustom gnus-use-demon nil
1056   "If non-nil, Gnus might use some demons."
1057   :group 'gnus-meta
1058   :type 'boolean)
1059
1060 (defcustom gnus-use-scoring t
1061   "*If non-nil, enable scoring."
1062   :group 'gnus-meta
1063   :type 'boolean)
1064
1065 (defcustom gnus-use-picons nil
1066   "*If non-nil, display picons."
1067   :group 'gnus-meta
1068   :type 'boolean)
1069
1070 (defcustom gnus-summary-prepare-exit-hook
1071   '(gnus-summary-expire-articles)
1072   "*A hook called when preparing to exit from the summary buffer.
1073 It calls `gnus-summary-expire-articles' by default."
1074   :group 'gnus-summary-exit
1075   :type 'hook)
1076
1077 (defcustom gnus-novice-user t
1078   "*Non-nil means that you are a usenet novice.
1079 If non-nil, verbose messages may be displayed and confirmations may be
1080 required."
1081   :group 'gnus-meta
1082   :type 'boolean)
1083
1084 (defcustom gnus-expert-user nil
1085   "*Non-nil means that you will never be asked for confirmation about anything.
1086 That doesn't mean *anything* anything; particularly destructive
1087 commands will still require prompting."
1088   :group 'gnus-meta
1089   :type 'boolean)
1090
1091 (defcustom gnus-interactive-catchup t
1092   "*If non-nil, require your confirmation when catching up a group."
1093   :group 'gnus-group-select
1094   :type 'boolean)
1095
1096 (defcustom gnus-interactive-exit t
1097   "*If non-nil, require your confirmation when exiting Gnus."
1098   :group 'gnus-exit
1099   :type 'boolean)
1100
1101 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1102   "*Function for extracting address components from a From header.
1103 Two pre-defined function exist: `gnus-extract-address-components',
1104 which is the default, quite fast, and too simplistic solution, and
1105 `mail-extract-address-components', which works much better, but is
1106 slower."
1107   :group 'gnus-summary-format
1108   :type '(radio (function-item gnus-extract-address-components)
1109                 (function-item mail-extract-address-components)
1110                 (function :tag "Other")))
1111
1112 (defcustom gnus-carpal nil
1113   "*If non-nil, display clickable icons."
1114   :group 'gnus-meta
1115   :type 'boolean)
1116
1117 (defcustom gnus-shell-command-separator ";"
1118   "String used to separate to shell commands."
1119   :group 'gnus-files
1120   :type 'string)
1121
1122 (defcustom gnus-valid-select-methods
1123   '(("nntp" post address prompt-address physical-address)
1124     ("nnspool" post address)
1125     ("nnvirtual" post-mail virtual prompt-address)
1126     ("nnmbox" mail respool address)
1127     ("nnml" mail respool address)
1128     ("nnmh" mail respool address)
1129     ("nndir" post-mail prompt-address physical-address)
1130     ("nneething" none address prompt-address physical-address)
1131     ("nndoc" none address prompt-address)
1132     ("nnbabyl" mail address respool)
1133     ("nnkiboze" post virtual)
1134     ("nnsoup" post-mail address)
1135     ("nndraft" post-mail)
1136     ("nnfolder" mail respool address)
1137     ("nngateway" post-mail address prompt-address physical-address)
1138     ("nnweb" none)
1139     ("nnlistserv" none)
1140     ("nnagent" post-mail))
1141   "*An alist of valid select methods.
1142 The first element of each list lists should be a string with the name
1143 of the select method.  The other elements may be the category of
1144 this method (i. e., `post', `mail', `none' or whatever) or other
1145 properties that this method has (like being respoolable).
1146 If you implement a new select method, all you should have to change is
1147 this variable.  I think."
1148   :group 'gnus-server
1149   :type '(repeat (group (string :tag "Name")
1150                         (radio-button-choice (const :format "%v " post)
1151                                              (const :format "%v " mail)
1152                                              (const :format "%v " none)
1153                                              (const post-mail))
1154                         (checklist :inline t
1155                                    (const :format "%v " address)
1156                                    (const :format "%v " prompt-address)
1157                                    (const :format "%v " physical-address)
1158                                    (const :format "%v " virtual)
1159                                    (const respool)))))
1160
1161 (define-widget 'gnus-select-method 'list
1162   "Widget for entering a select method."
1163   :args `((choice :tag "Method"
1164                   ,@(mapcar (lambda (entry)
1165                               (list 'const :format "%v\n"
1166                                     (intern (car entry))))
1167                             gnus-valid-select-methods))
1168           (string :tag "Address")
1169           (editable-list  :inline t
1170                           (list :format "%v"
1171                                 variable
1172                                 (sexp :tag "Value")))))
1173
1174 (defcustom gnus-updated-mode-lines '(group article summary tree)
1175   "List of buffers that should update their mode lines.
1176 The list may contain the symbols `group', `article', `tree' and
1177 `summary'.  If the corresponding symbol is present, Gnus will keep
1178 that mode line updated with information that may be pertinent.
1179 If this variable is nil, screen refresh may be quicker."
1180   :group 'gnus-various
1181   :type '(set (const group)
1182               (const article)
1183               (const summary)
1184               (const tree)))
1185
1186 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1187 (defcustom gnus-mode-non-string-length nil
1188   "*Max length of mode-line non-string contents.
1189 If this is nil, Gnus will take space as is needed, leaving the rest
1190 of the modeline intact.  Note that the default of nil is unlikely
1191 to be desirable; see the manual for further details."
1192   :group 'gnus-various
1193   :type '(choice (const nil)
1194                  integer))
1195
1196 (defcustom gnus-auto-expirable-newsgroups nil
1197   "*Groups in which to automatically mark read articles as expirable.
1198 If non-nil, this should be a regexp that should match all groups in
1199 which to perform auto-expiry.  This only makes sense for mail groups."
1200   :group 'nnmail-expire
1201   :type '(choice (const nil)
1202                  regexp))
1203
1204 (defcustom gnus-total-expirable-newsgroups nil
1205   "*Groups in which to perform expiry of all read articles.
1206 Use with extreme caution.  All groups that match this regexp will be
1207 expiring - which means that all read articles will be deleted after
1208 \(say) one week.         (This only goes for mail groups and the like, of
1209 course.)"
1210   :group 'nnmail-expire
1211   :type '(choice (const nil)
1212                  regexp))
1213
1214 (defcustom gnus-group-uncollapsed-levels 1
1215   "Number of group name elements to leave alone when making a short group name."
1216   :group 'gnus-group-visual
1217   :type 'integer)
1218
1219 (defcustom gnus-group-use-permanent-levels nil
1220   "*If non-nil, once you set a level, Gnus will use this level."
1221   :group 'gnus-group-levels
1222   :type 'boolean)
1223
1224 ;; Hooks.
1225
1226 (defcustom gnus-load-hook nil
1227   "A hook run while Gnus is loaded."
1228   :group 'gnus-start
1229   :type 'hook)
1230
1231 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1232   "A hook called to apply kill files to a group.
1233 This hook is intended to apply a kill file to the selected newsgroup.
1234 The function `gnus-apply-kill-file' is called by default.
1235
1236 Since a general kill file is too heavy to use only for a few
1237 newsgroups, I recommend you to use a lighter hook function.  For
1238 example, if you'd like to apply a kill file to articles which contains
1239 a string `rmgroup' in subject in newsgroup `control', you can use the
1240 following hook:
1241
1242  (setq gnus-apply-kill-hook
1243       (list
1244         (lambda ()
1245           (cond ((string-match \"control\" gnus-newsgroup-name)
1246                  (gnus-kill \"Subject\" \"rmgroup\")
1247                  (gnus-expunge \"X\"))))))"
1248   :group 'gnus-score-kill
1249   :options '(gnus-apply-kill-file)
1250   :type 'hook)
1251
1252 (defcustom gnus-group-change-level-function nil
1253   "Function run when a group level is changed.
1254 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1255   :group 'gnus-group-level
1256   :type 'function)
1257
1258 ;;; Face thingies.
1259
1260 (defcustom gnus-visual
1261   '(summary-highlight group-highlight article-highlight
1262                       mouse-face
1263                       summary-menu group-menu article-menu
1264                       tree-highlight menu highlight
1265                       browse-menu server-menu
1266                       page-marker tree-menu binary-menu pick-menu
1267                       grouplens-menu)
1268   "*Enable visual features.
1269 If `visual' is disabled, there will be no menus and few faces.  Most of
1270 the visual customization options below will be ignored.  Gnus will use
1271 less space and be faster as a result.
1272
1273 This variable can also be a list of visual elements to switch on.  For
1274 instance, to switch off all visual things except menus, you can say:
1275
1276    (setq gnus-visual '(menu))
1277
1278 Valid elements include `summary-highlight', `group-highlight',
1279 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1280 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1281 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1282 and `grouplens-menu'."
1283   :group 'gnus-meta
1284   :group 'gnus-visual
1285   :type '(set (const summary-highlight)
1286               (const group-highlight)
1287               (const article-highlight)
1288               (const mouse-face)
1289               (const summary-menu)
1290               (const group-menu)
1291               (const article-menu)
1292               (const tree-highlight)
1293               (const menu)
1294               (const highlight)
1295               (const browse-menu)
1296               (const server-menu)
1297               (const page-marker)
1298               (const tree-menu)
1299               (const binary-menu)
1300               (const pick-menu)
1301               (const grouplens-menu)))
1302
1303 (defcustom gnus-mouse-face
1304   (condition-case ()
1305       (if (gnus-visual-p 'mouse-face 'highlight)
1306           (if (boundp 'gnus-mouse-face)
1307               (or gnus-mouse-face 'highlight)
1308             'highlight)
1309         'default)
1310     (error 'highlight))
1311   "*Face used for group or summary buffer mouse highlighting.
1312 The line beneath the mouse pointer will be highlighted with this
1313 face."
1314   :group 'gnus-visual
1315   :type 'face)
1316
1317 (defcustom gnus-article-display-hook
1318   (if (and (string-match "XEmacs" emacs-version)
1319            (featurep 'xface))
1320       '(gnus-article-hide-headers-if-wanted
1321         gnus-article-hide-boring-headers
1322         gnus-article-treat-overstrike
1323         gnus-article-maybe-highlight
1324         gnus-article-display-x-face)
1325     '(gnus-article-hide-headers-if-wanted
1326       gnus-article-hide-boring-headers
1327       gnus-article-treat-overstrike
1328       gnus-article-maybe-highlight))
1329   "*Controls how the article buffer will look.
1330
1331 If you leave the list empty, the article will appear exactly as it is
1332 stored on the disk.  The list entries will hide or highlight various
1333 parts of the article, making it easier to find the information you
1334 want."
1335   :group 'gnus-article-highlight
1336   :group 'gnus-visual
1337   :type 'hook
1338   :options '(gnus-article-add-buttons
1339              gnus-article-add-buttons-to-head
1340              gnus-article-emphasize
1341              gnus-article-fill-cited-article
1342              gnus-article-remove-cr
1343              gnus-article-de-quoted-unreadable
1344              gnus-summary-stop-page-breaking
1345              ;; gnus-summary-caesar-message
1346              ;; gnus-summary-verbose-headers
1347              gnus-summary-toggle-mime
1348              gnus-article-hide
1349              gnus-article-hide-headers
1350              gnus-article-hide-boring-headers
1351              gnus-article-hide-signature
1352              gnus-article-hide-citation
1353              gnus-article-hide-pgp
1354              gnus-article-hide-pem
1355              gnus-article-highlight
1356              gnus-article-highlight-headers
1357              gnus-article-highlight-citation
1358              gnus-article-highlight-signature
1359              gnus-article-date-ut
1360              gnus-article-date-local
1361              gnus-article-date-lapsed
1362              gnus-article-date-original
1363              gnus-article-remove-trailing-blank-lines
1364              gnus-article-strip-leading-blank-lines
1365              gnus-article-strip-multiple-blank-lines
1366              gnus-article-strip-blank-lines
1367              gnus-article-treat-overstrike
1368              gnus-article-display-x-face
1369              gnus-smiley-display))
1370
1371 (defcustom gnus-article-save-directory gnus-directory
1372   "*Name of the directory articles will be saved in (default \"~/News\")."
1373   :group 'gnus-article-saving
1374   :type 'directory)
1375
1376 (defvar gnus-plugged t
1377   "Whether Gnus is plugged or not.")
1378
1379 \f
1380 ;;; Internal variables
1381
1382 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1383 (defvar gnus-original-article-buffer " *Original Article*")
1384 (defvar gnus-newsgroup-name nil)
1385 (defvar gnus-ephemeral-servers nil)
1386
1387 (defvar gnus-agent nil
1388   "Whether we want to use the Gnus agent or not.")
1389
1390 (defvar gnus-command-method nil
1391   "Dynamically bound variable that says what the current backend is.")
1392
1393 (defvar gnus-current-select-method nil
1394   "The current method for selecting a newsgroup.")
1395
1396 (defvar gnus-tree-buffer "*Tree*"
1397   "Buffer where Gnus thread trees are displayed.")
1398
1399 ;; Dummy variable.
1400 (defvar gnus-use-generic-from nil)
1401
1402 ;; Variable holding the user answers to all method prompts.
1403 (defvar gnus-method-history nil)
1404
1405 ;; Variable holding the user answers to all mail method prompts.
1406 (defvar gnus-mail-method-history nil)
1407
1408 ;; Variable holding the user answers to all group prompts.
1409 (defvar gnus-group-history nil)
1410
1411 (defvar gnus-server-alist nil
1412   "List of available servers.")
1413
1414 (defcustom gnus-cache-directory
1415   (nnheader-concat gnus-directory "cache/")
1416   "*The directory where cached articles will be stored."
1417   :group 'gnus-cache
1418   :type 'directory)
1419
1420 (defvar gnus-predefined-server-alist
1421   `(("cache"
1422      (nnspool "cache"
1423               (nnspool-spool-directory gnus-cache-directory)
1424               (nnspool-nov-directory gnus-cache-directory)
1425               (nnspool-active-file
1426                (nnheader-concat gnus-cache-directory "active")))))
1427   "List of predefined (convenience) servers.")
1428
1429 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1430
1431 (defconst gnus-article-mark-lists
1432   '((marked . tick) (replied . reply)
1433     (expirable . expire) (killed . killed)
1434     (bookmarks . bookmark) (dormant . dormant)
1435     (scored . score) (saved . save)
1436     (cached . cache) (downloadable . download)
1437     (unsendable . unsend)))
1438
1439 (defvar gnus-headers-retrieved-by nil)
1440 (defvar gnus-article-reply nil)
1441 (defvar gnus-override-method nil)
1442 (defvar gnus-article-check-size nil)
1443 (defvar gnus-opened-servers nil)
1444
1445 (defvar gnus-current-kill-article nil)
1446
1447 (defvar gnus-have-read-active-file nil)
1448
1449 (defconst gnus-maintainer
1450   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1451   "The mail address of the Gnus maintainers.")
1452
1453 (defvar gnus-info-nodes
1454   '((gnus-group-mode "(gnus)The Group Buffer")
1455     (gnus-summary-mode "(gnus)The Summary Buffer")
1456     (gnus-article-mode "(gnus)The Article Buffer")
1457     (mime/viewer-mode "(gnus)The Article Buffer")
1458     (gnus-server-mode "(gnus)The Server Buffer")
1459     (gnus-browse-mode "(gnus)Browse Foreign Server")
1460     (gnus-tree-mode "(gnus)Tree Display"))
1461   "Alist of major modes and related Info nodes.")
1462
1463 (defvar gnus-group-buffer "*Group*")
1464 (defvar gnus-summary-buffer "*Summary*")
1465 (defvar gnus-article-buffer "*Article*")
1466 (defvar gnus-server-buffer "*Server*")
1467
1468 (defvar gnus-buffer-list nil
1469   "Gnus buffers that should be killed on exit.")
1470
1471 (defvar gnus-slave nil
1472   "Whether this Gnus is a slave or not.")
1473
1474 (defvar gnus-batch-mode nil
1475   "Whether this Gnus is running in batch mode or not.")
1476
1477 (defvar gnus-variable-list
1478   '(gnus-newsrc-options gnus-newsrc-options-n
1479     gnus-newsrc-last-checked-date
1480     gnus-newsrc-alist gnus-server-alist
1481     gnus-killed-list gnus-zombie-list
1482     gnus-topic-topology gnus-topic-alist
1483     gnus-format-specs)
1484   "Gnus variables saved in the quick startup file.")
1485
1486 (defvar gnus-newsrc-alist nil
1487   "Assoc list of read articles.
1488 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1489
1490 (defvar gnus-newsrc-hashtb nil
1491   "Hashtable of gnus-newsrc-alist.")
1492
1493 (defvar gnus-killed-list nil
1494   "List of killed newsgroups.")
1495
1496 (defvar gnus-killed-hashtb nil
1497   "Hash table equivalent of gnus-killed-list.")
1498
1499 (defvar gnus-zombie-list nil
1500   "List of almost dead newsgroups.")
1501
1502 (defvar gnus-description-hashtb nil
1503   "Descriptions of newsgroups.")
1504
1505 (defvar gnus-list-of-killed-groups nil
1506   "List of newsgroups that have recently been killed by the user.")
1507
1508 (defvar gnus-active-hashtb nil
1509   "Hashtable of active articles.")
1510
1511 (defvar gnus-moderated-hashtb nil
1512   "Hashtable of moderated newsgroups.")
1513
1514 ;; Save window configuration.
1515 (defvar gnus-prev-winconf nil)
1516
1517 (defvar gnus-reffed-article-number nil)
1518
1519 ;;; Let the byte-compiler know that we know about this variable.
1520 (defvar rmail-default-rmail-file)
1521
1522 (defvar gnus-dead-summary nil)
1523
1524 ;;; End of variables.
1525
1526 ;; Define some autoload functions Gnus might use.
1527 (eval-and-compile
1528
1529   ;; This little mapcar goes through the list below and marks the
1530   ;; symbols in question as autoloaded functions.
1531   (mapcar
1532    (lambda (package)
1533      (let ((interactive (nth 1 (memq ':interactive package))))
1534        (mapcar
1535         (lambda (function)
1536           (let (keymap)
1537             (when (consp function)
1538               (setq keymap (car (memq 'keymap function)))
1539               (setq function (car function)))
1540             (autoload function (car package) nil interactive keymap)))
1541         (if (eq (nth 1 package) ':interactive)
1542             (cdddr package)
1543           (cdr package)))))
1544    '(("metamail" metamail-buffer)
1545      ("info" Info-goto-node)
1546      ("hexl" hexl-hex-string-to-integer)
1547      ("pp" pp pp-to-string pp-eval-expression)
1548      ("ps-print" ps-print-preprint)
1549      ("mail-extr" mail-extract-address-components)
1550      ("browse-url" browse-url)
1551      ("message" :interactive t
1552       message-send-and-exit message-yank-original)
1553      ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1554      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1555      ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1556       timezone-make-sortable-date timezone-make-time-string)
1557      ("rmailout" rmail-output)
1558      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1559       rmail-show-message)
1560      ("gnus-audio" :interactive t gnus-audio-play)
1561      ("gnus-xmas" gnus-xmas-splash)
1562      ("gnus-soup" :interactive t
1563       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1564       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1565      ("nnsoup" nnsoup-pack-replies)
1566      ("score-mode" :interactive t gnus-score-mode)
1567      ("gnus-mh" gnus-summary-save-article-folder
1568       gnus-Folder-save-name gnus-folder-save-name)
1569      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1570      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1571       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1572       gnus-demon-add-disconnection gnus-demon-add-handler
1573       gnus-demon-remove-handler)
1574      ("gnus-demon" :interactive t
1575       gnus-demon-init gnus-demon-cancel)
1576      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1577       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1578      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1579       gnus-nocem-unwanted-article-p)
1580      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1581       gnus-server-server-name)
1582      ("gnus-srvr" gnus-browse-foreign-server)
1583      ("gnus-cite" :interactive t
1584       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1585       gnus-article-hide-citation gnus-article-fill-cited-article
1586       gnus-article-hide-citation-in-followups)
1587      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1588       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1589       gnus-execute gnus-expunge)
1590      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1591       gnus-cache-possibly-remove-articles gnus-cache-request-article
1592       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1593       gnus-cache-enter-remove-article gnus-cached-article-p
1594       gnus-cache-open gnus-cache-close gnus-cache-update-article)
1595       ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1596        gnus-cache-remove-article gnus-summary-insert-cached-articles)
1597       ("gnus-score" :interactive t
1598        gnus-summary-increase-score gnus-summary-set-score
1599        gnus-summary-raise-thread gnus-summary-raise-same-subject
1600        gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1601        gnus-summary-lower-thread gnus-summary-lower-same-subject
1602        gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1603        gnus-summary-current-score gnus-score-default
1604        gnus-score-flush-cache gnus-score-close
1605        gnus-possibly-score-headers gnus-score-followup-article
1606        gnus-score-followup-thread)
1607       ("gnus-score"
1608        (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1609       gnus-current-score-file-nondirectory gnus-score-adaptive
1610       gnus-score-find-trace gnus-score-file-name)
1611      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1612      ("gnus-topic" :interactive t gnus-topic-mode)
1613      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1614      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1615      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1616      ("gnus-uu" :interactive t
1617       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1618       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1619       gnus-uu-mark-by-regexp gnus-uu-mark-all
1620       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1621       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1622       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1623       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1624       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1625       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1626       gnus-uu-decode-binhex-view)
1627      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1628      ("gnus-msg" (gnus-summary-send-map keymap)
1629       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1630      ("gnus-msg" :interactive t
1631       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1632       gnus-summary-followup gnus-summary-followup-with-original
1633       gnus-summary-cancel-article gnus-summary-supersede-article
1634       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1635       gnus-summary-mail-forward gnus-summary-mail-other-window
1636       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1637       gnus-bug)
1638      ("gnus-picon" :interactive t gnus-article-display-picons
1639       gnus-group-display-picons gnus-picons-article-display-x-face
1640       gnus-picons-display-x-face)
1641      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1642       gnus-grouplens-mode)
1643      ("smiley" :interactive t gnus-smiley-display)
1644      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1645      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1646       gnus-list-of-unread-articles gnus-list-of-read-articles
1647       gnus-offer-save-summaries gnus-make-thread-indent-array
1648       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1649       gnus-summary-skip-intangible gnus-summary-article-number
1650       gnus-data-header gnus-data-find)
1651      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1652       gnus-group-list-groups gnus-group-first-unread-group
1653       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1654       gnus-group-setup-buffer gnus-group-get-new-news
1655       gnus-group-make-help-group gnus-group-update-group
1656       gnus-clear-inboxes-moved gnus-group-iterate
1657       gnus-group-group-name)
1658      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1659       gnus-backlog-remove-article)
1660      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1661       gnus-article-prepare gnus-article-set-window-start
1662       gnus-article-next-page gnus-article-prev-page
1663       gnus-request-article-this-buffer gnus-article-mode
1664       gnus-article-setup-buffer gnus-narrow-to-page
1665       gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1666      ("gnus-art" :interactive t
1667       gnus-article-hide-headers gnus-article-hide-boring-headers
1668       gnus-article-treat-overstrike gnus-article-word-wrap
1669       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1670       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1671       gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1672       gnus-article-hide-pem gnus-article-hide-signature
1673       gnus-article-strip-leading-blank-lines gnus-article-date-local
1674       gnus-article-date-original gnus-article-date-lapsed
1675       gnus-article-show-all-headers
1676       gnus-article-edit-mode gnus-article-edit-article
1677       gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1678       gnus-start-date-timer gnus-stop-date-timer)
1679      ("gnus-int" gnus-request-type)
1680      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1681       gnus-dribble-enter gnus-read-init-file)
1682      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1683       gnus-dup-enter-articles)
1684      ("gnus-range" gnus-copy-sequence)
1685      ("gnus-eform" gnus-edit-form)
1686      ("gnus-move" :interactive t
1687       gnus-group-move-group-to-server gnus-change-server)
1688      ("gnus-logic" gnus-score-advanced)
1689      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1690      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1691       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1692       gnus-async-halt-prefetch)
1693      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1694       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1695       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1696       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1697      ("gnus-agent" :interactive t
1698       gnus-unplugged gnus-agentize gnus-agent-batch)
1699      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1700       gnus-summary-save-article-vm)
1701      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1702
1703 ;;; gnus-sum.el thingies
1704
1705
1706 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1707   "*The format specification of the lines in the summary buffer.
1708
1709 It works along the same lines as a normal formatting string,
1710 with some simple extensions.
1711
1712 %N   Article number, left padded with spaces (string)
1713 %S   Subject (string)
1714 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1715 %n   Name of the poster (string)
1716 %a   Extracted name of the poster (string)
1717 %A   Extracted address of the poster (string)
1718 %F   Contents of the From: header (string)
1719 %x   Contents of the Xref: header (string)
1720 %D   Date of the article (string)
1721 %d   Date of the article (string) in DD-MMM format
1722 %M   Message-id of the article (string)
1723 %r   References of the article (string)
1724 %c   Number of characters in the article (integer)
1725 %L   Number of lines in the article (integer)
1726 %I   Indentation based on thread level (a string of spaces)
1727 %T   A string with two possible values: 80 spaces if the article
1728      is on thread level two or larger and 0 spaces on level one
1729 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1730 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1731 %[   Opening bracket (character, \"[\" or \"<\")
1732 %]   Closing bracket (character, \"]\" or \">\")
1733 %>   Spaces of length thread-level (string)
1734 %<   Spaces of length (- 20 thread-level) (string)
1735 %i   Article score (number)
1736 %z   Article zcore (character)
1737 %t   Number of articles under the current thread (number).
1738 %e   Whether the thread is empty or not (character).
1739 %l   GroupLens score (string).
1740 %V   Total thread score (number).
1741 %P   The line number (number).
1742 %O   Download mark (character).
1743 %u   User defined specifier.  The next character in the format string should
1744      be a letter.  Gnus will call the function gnus-user-format-function-X,
1745      where X is the letter following %u.  The function will be passed the
1746      current header as argument.  The function should return a string, which
1747      will be inserted into the summary just like information from any other
1748      summary specifier.
1749
1750 Text between %( and %) will be highlighted with `gnus-mouse-face'
1751 when the mouse point is placed inside the area.  There can only be one
1752 such area.
1753
1754 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1755 with care.  For reasons of efficiency, Gnus will compute what column
1756 these characters will end up in, and \"hard-code\" that.  This means that
1757 it is illegal to have these specs after a variable-length spec.  Well,
1758 you might not be arrested, but your summary buffer will look strange,
1759 which is bad enough.
1760
1761 The smart choice is to have these specs as for to the left as
1762 possible.
1763
1764 This restriction may disappear in later versions of Gnus."
1765   :type 'string
1766   :group 'gnus-summary-format)
1767
1768 ;;;
1769 ;;; Skeleton keymaps
1770 ;;;
1771
1772 (defun gnus-suppress-keymap (keymap)
1773   (suppress-keymap keymap)
1774   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1775     (while keys
1776       (define-key keymap (pop keys) 'undefined))))
1777
1778 (defvar gnus-article-mode-map
1779   (let ((keymap (make-keymap)))
1780     (gnus-suppress-keymap keymap)
1781     keymap))
1782 (defvar gnus-summary-mode-map
1783   (let ((keymap (make-keymap)))
1784     (gnus-suppress-keymap keymap)
1785     keymap))
1786 (defvar gnus-group-mode-map
1787   (let ((keymap (make-keymap)))
1788     (gnus-suppress-keymap keymap)
1789     keymap))
1790
1791 \f
1792
1793 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1794 ;; If you want the cursor to go somewhere else, set these two
1795 ;; functions in some startup hook to whatever you want.
1796 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1797 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1798
1799 ;;; Various macros and substs.
1800
1801 (defun gnus-header-from (header)
1802   (mail-header-from header))
1803
1804 (defmacro gnus-gethash (string hashtable)
1805   "Get hash value of STRING in HASHTABLE."
1806   `(symbol-value (intern-soft ,string ,hashtable)))
1807
1808 (defmacro gnus-sethash (string value hashtable)
1809   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1810   `(set (intern ,string ,hashtable) ,value))
1811 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1812
1813 (defmacro gnus-group-unread (group)
1814   "Get the currently computed number of unread articles in GROUP."
1815   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1816
1817 (defmacro gnus-group-entry (group)
1818   "Get the newsrc entry for GROUP."
1819   `(gnus-gethash ,group gnus-newsrc-hashtb))
1820
1821 (defmacro gnus-active (group)
1822   "Get active info on GROUP."
1823   `(gnus-gethash ,group gnus-active-hashtb))
1824
1825 (defmacro gnus-set-active (group active)
1826   "Set GROUP's active info."
1827   `(gnus-sethash ,group ,active gnus-active-hashtb))
1828
1829 ;; Info access macros.
1830
1831 (defmacro gnus-info-group (info)
1832   `(nth 0 ,info))
1833 (defmacro gnus-info-rank (info)
1834   `(nth 1 ,info))
1835 (defmacro gnus-info-read (info)
1836   `(nth 2 ,info))
1837 (defmacro gnus-info-marks (info)
1838   `(nth 3 ,info))
1839 (defmacro gnus-info-method (info)
1840   `(nth 4 ,info))
1841 (defmacro gnus-info-params (info)
1842   `(nth 5 ,info))
1843
1844 (defmacro gnus-info-level (info)
1845   `(let ((rank (gnus-info-rank ,info)))
1846      (if (consp rank)
1847          (car rank)
1848        rank)))
1849 (defmacro gnus-info-score (info)
1850   `(let ((rank (gnus-info-rank ,info)))
1851      (or (and (consp rank) (cdr rank)) 0)))
1852
1853 (defmacro gnus-info-set-group (info group)
1854   `(setcar ,info ,group))
1855 (defmacro gnus-info-set-rank (info rank)
1856   `(setcar (nthcdr 1 ,info) ,rank))
1857 (defmacro gnus-info-set-read (info read)
1858   `(setcar (nthcdr 2 ,info) ,read))
1859 (defmacro gnus-info-set-marks (info marks &optional extend)
1860   (if extend
1861       `(gnus-info-set-entry ,info ,marks 3)
1862     `(setcar (nthcdr 3 ,info) ,marks)))
1863 (defmacro gnus-info-set-method (info method &optional extend)
1864   (if extend
1865       `(gnus-info-set-entry ,info ,method 4)
1866     `(setcar (nthcdr 4 ,info) ,method)))
1867 (defmacro gnus-info-set-params (info params &optional extend)
1868   (if extend
1869       `(gnus-info-set-entry ,info ,params 5)
1870     `(setcar (nthcdr 5 ,info) ,params)))
1871
1872 (defun gnus-info-set-entry (info entry number)
1873   ;; Extend the info until we have enough elements.
1874   (while (<= (length info) number)
1875     (nconc info (list nil)))
1876   ;; Set the entry.
1877   (setcar (nthcdr number info) entry))
1878
1879 (defmacro gnus-info-set-level (info level)
1880   `(let ((rank (cdr ,info)))
1881      (if (consp (car rank))
1882          (setcar (car rank) ,level)
1883        (setcar rank ,level))))
1884 (defmacro gnus-info-set-score (info score)
1885   `(let ((rank (cdr ,info)))
1886      (if (consp (car rank))
1887          (setcdr (car rank) ,score)
1888        (setcar rank (cons (car rank) ,score)))))
1889
1890 (defmacro gnus-get-info (group)
1891   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1892
1893 ;; Byte-compiler warning.
1894 (defvar gnus-visual)
1895 ;; Find out whether the gnus-visual TYPE is wanted.
1896 (defun gnus-visual-p (&optional type class)
1897   (and gnus-visual                      ; Has to be non-nil, at least.
1898        (if (not type)                   ; We don't care about type.
1899            gnus-visual
1900          (if (listp gnus-visual)        ; It's a list, so we check it.
1901              (or (memq type gnus-visual)
1902                  (memq class gnus-visual))
1903            t))))
1904
1905 ;;; Load the compatability functions.
1906
1907 (require 'gnus-ems)
1908
1909 \f
1910 ;;;
1911 ;;; Shutdown
1912 ;;;
1913
1914 (defvar gnus-shutdown-alist nil)
1915
1916 (defun gnus-add-shutdown (function &rest symbols)
1917   "Run FUNCTION whenever one of SYMBOLS is shut down."
1918   (push (cons function symbols) gnus-shutdown-alist))
1919
1920 (defun gnus-shutdown (symbol)
1921   "Shut down everything that waits for SYMBOL."
1922   (let ((alist gnus-shutdown-alist)
1923         entry)
1924     (while (setq entry (pop alist))
1925       (when (memq symbol (cdr entry))
1926         (funcall (car entry))))))
1927
1928 \f
1929 ;;;
1930 ;;; Gnus Utility Functions
1931 ;;;
1932
1933 (defmacro gnus-string-or (&rest strings)
1934   "Return the first element of STRINGS that is a non-blank string.
1935 STRINGS will be evaluated in normal `or' order."
1936   `(gnus-string-or-1 ',strings))
1937
1938 (defun gnus-string-or-1 (strings)
1939   (let (string)
1940     (while strings
1941       (setq string (eval (pop strings)))
1942       (if (string-match "^[ \t]*$" string)
1943           (setq string nil)
1944         (setq strings nil)))
1945     string))
1946
1947 ;; Add the current buffer to the list of buffers to be killed on exit.
1948 (defun gnus-add-current-to-buffer-list ()
1949   (or (memq (current-buffer) gnus-buffer-list)
1950       (push (current-buffer) gnus-buffer-list)))
1951
1952 (defun gnus-version (&optional arg)
1953   "Version number of this version of Gnus.
1954 If ARG, insert string at point."
1955   (interactive "P")
1956   (let ((methods gnus-valid-select-methods)
1957         (mess gnus-version)
1958         meth)
1959     ;; Go through all the legal select methods and add their version
1960     ;; numbers to the total version string.  Only the backends that are
1961     ;; currently in use will have their message numbers taken into
1962     ;; consideration.
1963     (while methods
1964       (setq meth (intern (concat (caar methods) "-version")))
1965       (and (boundp meth)
1966            (stringp (symbol-value meth))
1967            (setq mess (concat mess "; " (symbol-value meth))))
1968       (setq methods (cdr methods)))
1969     (if arg
1970         (insert (message mess))
1971       (message mess))))
1972
1973 (defun gnus-continuum-version (version)
1974   "Return VERSION as a floating point number."
1975   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1976             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1977     (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1978            (number (match-string 2 version))
1979            major minor least)
1980       (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1981       (setq major (string-to-number (match-string 1 number)))
1982       (setq minor (string-to-number (match-string 2 number)))
1983       (setq least (if (match-beginning 3)
1984                       (string-to-number (match-string 3 number))
1985                     0))
1986       (string-to-number
1987        (if (zerop major)
1988            (format "%s00%02d%02d"
1989                    (cond
1990                     ((member alpha '("(ding)" "d")) "4.99")
1991                     ((member alpha '("September" "s")) "5.01")
1992                     ((member alpha '("Red" "r")) "5.03"))
1993                    minor least)
1994          (format "%d.%02d%02d" major minor least))))))
1995
1996 (defun gnus-info-find-node ()
1997   "Find Info documentation of Gnus."
1998   (interactive)
1999   ;; Enlarge info window if needed.
2000   (let (gnus-info-buffer)
2001     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2002     (setq gnus-info-buffer (current-buffer))
2003     (gnus-configure-windows 'info)))
2004
2005 ;;;
2006 ;;; gnus-interactive
2007 ;;;
2008
2009 (defvar gnus-current-prefix-symbol nil
2010   "Current prefix symbol.")
2011
2012 (defvar gnus-current-prefix-symbols nil
2013   "List of current prefix symbols.")
2014
2015 (defun gnus-interactive (string &optional params)
2016   "Return a list that can be fed to `interactive'.
2017 See `interactive' for full documentation.
2018
2019 Adds the following specs:
2020
2021 y -- The current symbolic prefix.
2022 Y -- A list of the current symbolic prefix(es).
2023 A -- Article number.
2024 H -- Article header.
2025 g -- Group name."
2026   (let ((i 0)
2027         out c prompt)
2028     (while (< i (length string))
2029       (string-match ".\\([^\n]*\\)\n?" string i)
2030       (setq c (aref string i))
2031       (when (match-end 1)
2032         (setq prompt (match-string 1 string)))
2033       (setq i (match-end 0))
2034       ;; We basically emulate just about everything that
2035       ;; `interactive' does, but adds the "g" and "G" specs.
2036       (push
2037        (cond
2038         ((= c ?a)
2039          (completing-read prompt obarray 'fboundp t))
2040         ((= c ?b)
2041          (read-buffer prompt (current-buffer) t))
2042         ((= c ?B)
2043          (read-buffer prompt (other-buffer (current-buffer))))
2044         ((= c ?c)
2045          (read-char))
2046         ((= c ?C)
2047          (completing-read prompt obarray 'commandp t))
2048         ((= c ?d)
2049          (point))
2050         ((= c ?D)
2051          (read-file-name prompt nil default-directory 'lambda))
2052         ((= c ?f)
2053          (read-file-name prompt nil nil 'lambda))
2054         ((= c ?F)
2055          (read-file-name prompt))
2056         ((= c ?k)
2057          (read-key-sequence prompt))
2058         ((= c ?K)
2059          (error "Not implemented spec"))
2060         ((= c ?e)
2061          (error "Not implemented spec"))
2062         ((= c ?m)
2063          (mark))
2064         ((= c ?N)
2065          (error "Not implemented spec"))
2066         ((= c ?n)
2067          (string-to-number (read-from-minibuffer prompt)))
2068         ((= c ?p)
2069          (prefix-numeric-value current-prefix-arg))
2070         ((= c ?P)
2071          current-prefix-arg)
2072         ((= c ?r)
2073          'gnus-prefix-nil)
2074         ((= c ?s)
2075          (read-string prompt))
2076         ((= c ?S)
2077          (intern (read-string prompt)))
2078         ((= c ?v)
2079          (read-variable prompt))
2080         ((= c ?x)
2081          (read-minibuffer prompt))
2082         ((= c ?x)
2083          (eval-minibuffer prompt))
2084         ;; And here the new specs come.
2085         ((= c ?y)
2086          gnus-current-prefix-symbol)
2087         ((= c ?Y)
2088          gnus-current-prefix-symbols)
2089         ((= c ?g)
2090          (gnus-group-group-name))
2091         ((= c ?A)
2092          (gnus-summary-skip-intangible)
2093          (or (get-text-property (point) 'gnus-number)
2094              (gnus-summary-last-subject)))
2095         ((= c ?H)
2096          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2097         (t
2098          (error "Non-implemented spec")))
2099        out)
2100       (cond
2101        ((= c ?r)
2102         (push (if (< (point) (mark) (point) (mark))) out)
2103         (push (if (> (point) (mark) (point) (mark))) out))))
2104     (setq out (delq 'gnus-prefix-nil out))
2105     (nreverse out)))
2106
2107 (defun gnus-symbolic-argument (&optional arg)
2108   "Read a symbolic argument and a command, and then execute command."
2109   (interactive "P")
2110   (let* ((in-command (this-command-keys))
2111          (command in-command)
2112          gnus-current-prefix-symbols
2113          gnus-current-prefix-symbol
2114          syms)
2115     (while (equal in-command command)
2116       (message "%s-" (key-description (this-command-keys)))
2117       (push (intern (char-to-string (read-char))) syms)
2118       (setq command (read-key-sequence nil t)))
2119     (setq gnus-current-prefix-symbols (nreverse syms)
2120           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2121     (call-interactively (key-binding command t))))
2122
2123 ;;; More various functions.
2124
2125 (defsubst gnus-check-backend-function (func group)
2126   "Check whether GROUP supports function FUNC.
2127 GROUP can either be a string (a group name) or a select method."
2128   (ignore-errors
2129     (let ((method (if (stringp group)
2130                       (car (gnus-find-method-for-group group))
2131                     group)))
2132       (unless (featurep method)
2133         (require method))
2134       (fboundp (intern (format "%s-%s" method func))))))
2135
2136 (defun gnus-group-read-only-p (&optional group)
2137   "Check whether GROUP supports editing or not.
2138 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2139 that that variable is buffer-local to the summary buffers."
2140   (let ((group (or group gnus-newsgroup-name)))
2141     (not (gnus-check-backend-function 'request-replace-article group))))
2142
2143 (defun gnus-group-total-expirable-p (group)
2144   "Check whether GROUP is total-expirable or not."
2145   (let ((params (gnus-group-find-parameter group))
2146         val)
2147     (cond
2148      ((memq 'total-expire params)
2149       t)
2150      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2151       (cdr val))
2152      (gnus-total-expirable-newsgroups   ; Check var.
2153       (string-match gnus-total-expirable-newsgroups group)))))
2154
2155 (defun gnus-group-auto-expirable-p (group)
2156   "Check whether GROUP is auto-expirable or not."
2157   (let ((params (gnus-group-find-parameter group))
2158         val)
2159     (cond
2160      ((memq 'auto-expire params)
2161       t)
2162      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2163       (cdr val))
2164      (gnus-auto-expirable-newsgroups    ; Check var.
2165       (string-match gnus-auto-expirable-newsgroups group)))))
2166
2167 (defun gnus-virtual-group-p (group)
2168   "Say whether GROUP is virtual or not."
2169   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2170                         gnus-valid-select-methods)))
2171
2172 (defun gnus-news-group-p (group &optional article)
2173   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2174   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2175       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2176            (eq (gnus-request-type group article) 'news))))
2177
2178 ;; Returns a list of writable groups.
2179 (defun gnus-writable-groups ()
2180   (let ((alist gnus-newsrc-alist)
2181         groups group)
2182     (while (setq group (car (pop alist)))
2183       (unless (gnus-group-read-only-p group)
2184         (push group groups)))
2185     (nreverse groups)))
2186
2187 ;; Check whether to use long file names.
2188 (defun gnus-use-long-file-name (symbol)
2189   ;; The variable has to be set...
2190   (and gnus-use-long-file-name
2191        ;; If it isn't a list, then we return t.
2192        (or (not (listp gnus-use-long-file-name))
2193            ;; If it is a list, and the list contains `symbol', we
2194            ;; return nil.
2195            (not (memq symbol gnus-use-long-file-name)))))
2196
2197 ;; Generate a unique new group name.
2198 (defun gnus-generate-new-group-name (leaf)
2199   (let ((name leaf)
2200         (num 0))
2201     (while (gnus-gethash name gnus-newsrc-hashtb)
2202       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2203     name))
2204
2205 (defun gnus-ephemeral-group-p (group)
2206   "Say whether GROUP is ephemeral or not."
2207   (gnus-group-get-parameter group 'quit-config t))
2208
2209 (defun gnus-group-quit-config (group)
2210   "Return the quit-config of GROUP."
2211   (gnus-group-get-parameter group 'quit-config t))
2212
2213 (defun gnus-kill-ephemeral-group (group)
2214   "Remove ephemeral GROUP from relevant structures."
2215   (gnus-sethash group nil gnus-newsrc-hashtb))
2216
2217 (defun gnus-simplify-mode-line ()
2218   "Make mode lines a bit simpler."
2219   (setq mode-line-modified (cdr gnus-mode-line-modified))
2220   (when (listp mode-line-format)
2221     (make-local-variable 'mode-line-format)
2222     (setq mode-line-format (copy-sequence mode-line-format))
2223     (when (equal (nth 3 mode-line-format) "   ")
2224       (setcar (nthcdr 3 mode-line-format) " "))))
2225
2226 ;;; Servers and groups.
2227
2228 (defsubst gnus-server-add-address (method)
2229   (let ((method-name (symbol-name (car method))))
2230     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2231              (not (assq (intern (concat method-name "-address")) method))
2232              (memq 'physical-address (assq (car method)
2233                                            gnus-valid-select-methods)))
2234         (append method (list (list (intern (concat method-name "-address"))
2235                                    (nth 1 method))))
2236       method)))
2237
2238 (defsubst gnus-server-get-method (group method)
2239   ;; Input either a server name, and extended server name, or a
2240   ;; select method, and return a select method.
2241   (cond ((stringp method)
2242          (gnus-server-to-method method))
2243         ((equal method gnus-select-method)
2244          gnus-select-method)
2245         ((and (stringp (car method)) group)
2246          (gnus-server-extend-method group method))
2247         ((and method (not group)
2248               (equal (cadr method) ""))
2249          method)
2250         (t
2251          (gnus-server-add-address method))))
2252
2253 (defun gnus-server-to-method (server)
2254   "Map virtual server names to select methods."
2255   (or
2256    ;; Is this a method, perhaps?
2257    (and server (listp server) server)
2258    ;; Perhaps this is the native server?
2259    (and (equal server "native") gnus-select-method)
2260    ;; It should be in the server alist.
2261    (cdr (assoc server gnus-server-alist))
2262    ;; It could be in the predefined server alist.
2263    (cdr (assoc server gnus-predefined-server-alist))
2264    ;; If not, we look through all the opened server
2265    ;; to see whether we can find it there.
2266    (let ((opened gnus-opened-servers))
2267      (while (and opened
2268                  (not (equal server (format "%s:%s" (caaar opened)
2269                                             (cadaar opened)))))
2270        (pop opened))
2271      (caar opened))))
2272
2273 (defmacro gnus-method-equal (ss1 ss2)
2274   "Say whether two servers are equal."
2275   `(let ((s1 ,ss1)
2276          (s2 ,ss2))
2277      (or (equal s1 s2)
2278          (and (= (length s1) (length s2))
2279               (progn
2280                 (while (and s1 (member (car s1) s2))
2281                   (setq s1 (cdr s1)))
2282                 (null s1))))))
2283
2284 (defun gnus-server-equal (m1 m2)
2285   "Say whether two methods are equal."
2286   (let ((m1 (cond ((null m1) gnus-select-method)
2287                   ((stringp m1) (gnus-server-to-method m1))
2288                   (t m1)))
2289         (m2 (cond ((null m2) gnus-select-method)
2290                   ((stringp m2) (gnus-server-to-method m2))
2291                   (t m2))))
2292     (gnus-method-equal m1 m2)))
2293
2294 (defun gnus-servers-using-backend (backend)
2295   "Return a list of known servers using BACKEND."
2296   (let ((opened gnus-opened-servers)
2297         out)
2298     (while opened
2299       (when (eq backend (caaar opened))
2300         (push (caar opened) out))
2301       (pop opened))
2302     out))
2303
2304 (defun gnus-archive-server-wanted-p ()
2305   "Say whether the user wants to use the archive server."
2306   (cond
2307    ((or (not gnus-message-archive-method)
2308         (not gnus-message-archive-group))
2309     nil)
2310    ((and gnus-message-archive-method gnus-message-archive-group)
2311     t)
2312    (t
2313     (let ((active (cadr (assq 'nnfolder-active-file
2314                               gnus-message-archive-method))))
2315       (and active
2316            (file-exists-p active))))))
2317
2318 (defun gnus-group-prefixed-name (group method)
2319   "Return the whole name from GROUP and METHOD."
2320   (and (stringp method) (setq method (gnus-server-to-method method)))
2321   (if (or (not method)
2322           (gnus-server-equal method "native"))
2323       group
2324     (concat (format "%s" (car method))
2325             (when (and
2326                    (or (assoc (format "%s" (car method))
2327                               (gnus-methods-using 'address))
2328                        (gnus-server-equal method gnus-message-archive-method))
2329                    (nth 1 method)
2330                    (not (string= (nth 1 method) "")))
2331               (concat "+" (nth 1 method)))
2332             ":" group)))
2333
2334 (defun gnus-group-real-prefix (group)
2335   "Return the prefix of the current group name."
2336   (if (string-match "^[^:]+:" group)
2337       (substring group 0 (match-end 0))
2338     ""))
2339
2340 (defun gnus-group-method (group)
2341   "Return the server or method used for selecting GROUP.
2342 You should probably use `gnus-find-method-for-group' instead."
2343   (let ((prefix (gnus-group-real-prefix group)))
2344     (if (equal prefix "")
2345         gnus-select-method
2346       (let ((servers gnus-opened-servers)
2347             (server "")
2348             backend possible found)
2349         (if (string-match "^[^\\+]+\\+" prefix)
2350             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2351                   server (substring prefix (match-end 0) (1- (length prefix))))
2352           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2353         (while servers
2354           (when (eq (caaar servers) backend)
2355             (setq possible (caar servers))
2356             (when (equal (cadaar servers) server)
2357               (setq found (caar servers))))
2358           (pop servers))
2359         (or (car (rassoc found gnus-server-alist))
2360             found
2361             (car (rassoc possible gnus-server-alist))
2362             possible
2363             (list backend server))))))
2364
2365 (defsubst gnus-secondary-method-p (method)
2366   "Return whether METHOD is a secondary select method."
2367   (let ((methods gnus-secondary-select-methods)
2368         (gmethod (gnus-server-get-method nil method)))
2369     (while (and methods
2370                 (not (equal (gnus-server-get-method nil (car methods))
2371                             gmethod)))
2372       (setq methods (cdr methods)))
2373     methods))
2374
2375 (defun gnus-groups-from-server (server)
2376   "Return a list of all groups that are fetched from SERVER."
2377   (let ((alist (cdr gnus-newsrc-alist))
2378         info groups)
2379     (while (setq info (pop alist))
2380       (when (gnus-server-equal (gnus-info-method info) server)
2381         (push (gnus-info-group info) groups)))
2382     (sort groups 'string<)))
2383
2384 (defun gnus-group-foreign-p (group)
2385   "Say whether a group is foreign or not."
2386   (and (not (gnus-group-native-p group))
2387        (not (gnus-group-secondary-p group))))
2388
2389 (defun gnus-group-native-p (group)
2390   "Say whether the group is native or not."
2391   (not (string-match ":" group)))
2392
2393 (defun gnus-group-secondary-p (group)
2394   "Say whether the group is secondary or not."
2395   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2396
2397 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2398   "Return the group parameters for GROUP.
2399 If SYMBOL, return the value of that symbol in the group parameters."
2400   (save-excursion
2401     (set-buffer gnus-group-buffer)
2402     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2403       (if symbol
2404           (gnus-group-parameter-value parameters symbol allow-list)
2405         parameters))))
2406
2407 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2408   "Return the group parameters for GROUP.
2409 If SYMBOL, return the value of that symbol in the group parameters.
2410 Most functions should use `gnus-group-find-parameter', which
2411 also examines the topic parameters."
2412   (let ((params (gnus-info-params (gnus-get-info group))))
2413     (if symbol
2414         (gnus-group-parameter-value params symbol allow-list)
2415       params)))
2416
2417 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2418   "Return the value of SYMBOL in group PARAMS."
2419   ;; We only wish to return group parameters (dotted lists) and
2420   ;; not local variables, which may have the same names.
2421   ;; But first we handle single elements...
2422   (or (car (memq symbol params))
2423       ;; Handle alist.
2424       (let (elem)
2425         (catch 'found
2426           (while (setq elem (pop params))
2427             (when (and (consp elem)
2428                        (eq (car elem) symbol)
2429                        (or allow-list
2430                            (atom (cdr elem))))
2431               (throw 'found (cdr elem))))))))
2432
2433 (defun gnus-group-add-parameter (group param)
2434   "Add parameter PARAM to GROUP."
2435   (let ((info (gnus-get-info group)))
2436     (when info
2437       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2438       ;; Cons the new param to the old one and update.
2439       (gnus-group-set-info (cons param (gnus-info-params info))
2440                            group 'params))))
2441
2442 (defun gnus-group-set-parameter (group name value)
2443   "Set parameter NAME to VALUE in GROUP."
2444   (let ((info (gnus-get-info group)))
2445     (when info
2446       (gnus-group-remove-parameter group name)
2447       (let ((old-params (gnus-info-params info))
2448             (new-params (list (cons name value))))
2449         (while old-params
2450           (when (or (not (listp (car old-params)))
2451                     (not (eq (caar old-params) name)))
2452             (setq new-params (append new-params (list (car old-params)))))
2453           (setq old-params (cdr old-params)))
2454         (gnus-group-set-info new-params group 'params)))))
2455
2456 (defun gnus-group-remove-parameter (group name)
2457   "Remove parameter NAME from GROUP."
2458   (let ((info (gnus-get-info group)))
2459     (when info
2460       (let ((params (gnus-info-params info)))
2461         (when params
2462           (setq params (delq name params))
2463           (while (assq name params)
2464             (gnus-pull name params))
2465           (gnus-info-set-params info params))))))
2466
2467 (defun gnus-group-add-score (group &optional score)
2468   "Add SCORE to the GROUP score.
2469 If SCORE is nil, add 1 to the score of GROUP."
2470   (let ((info (gnus-get-info group)))
2471     (when info
2472       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2473
2474 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2475 (defun gnus-short-group-name (group &optional levels)
2476   "Collapse GROUP name LEVELS.
2477 Select methods are stripped and any remote host name is stripped down to
2478 just the host name."
2479   (let* ((name "")
2480          (foreign "")
2481          (depth 0)
2482          (skip 1)
2483          (levels (or levels
2484                      (progn
2485                        (while (string-match "\\." group skip)
2486                          (setq skip (match-end 0)
2487                                depth (+ depth 1)))
2488                        depth))))
2489     ;; separate foreign select method from group name and collapse.
2490     ;; if method contains a server, collapse to non-domain server name,
2491     ;; otherwise collapse to select method
2492     (when (string-match ":" group)
2493       (cond ((string-match "+" group)
2494              (let* ((plus (string-match "+" group))
2495                     (colon (string-match ":" group (or plus 0)))
2496                     (dot (string-match "\\." group)))
2497                (setq foreign (concat
2498                               (substring group (+ 1 plus)
2499                                          (cond ((null dot) colon)
2500                                                ((< colon dot) colon)
2501                                                ((< dot colon) dot)))
2502                               ":")
2503                      group (substring group (+ 1 colon)))))
2504             (t
2505              (let* ((colon (string-match ":" group)))
2506                (setq foreign (concat (substring group 0 (+ 1 colon)))
2507                      group (substring group (+ 1 colon)))))))
2508     ;; collapse group name leaving LEVELS uncollapsed elements
2509     (while group
2510       (if (and (string-match "\\." group) (> levels 0))
2511           (setq name (concat name (substring group 0 1))
2512                 group (substring group (match-end 0))
2513                 levels (- levels 1)
2514                 name (concat name "."))
2515         (setq name (concat foreign name group)
2516               group nil)))
2517     name))
2518
2519 (defun gnus-narrow-to-body ()
2520   "Narrow to the body of an article."
2521   (narrow-to-region
2522    (progn
2523      (goto-char (point-min))
2524      (or (search-forward "\n\n" nil t)
2525          (point-max)))
2526    (point-max)))
2527
2528 \f
2529 ;;;
2530 ;;; Kill file handling.
2531 ;;;
2532
2533 (defun gnus-apply-kill-file ()
2534   "Apply a kill file to the current newsgroup.
2535 Returns the number of articles marked as read."
2536   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2537           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2538       (gnus-apply-kill-file-internal)
2539     0))
2540
2541 (defun gnus-kill-save-kill-buffer ()
2542   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2543     (when (get-file-buffer file)
2544       (save-excursion
2545         (set-buffer (get-file-buffer file))
2546         (when (buffer-modified-p)
2547           (save-buffer))
2548         (kill-buffer (current-buffer))))))
2549
2550 (defcustom gnus-kill-file-name "KILL"
2551   "Suffix of the kill files."
2552   :group 'gnus-score-kill
2553   :group 'gnus-score-files
2554   :type 'string)
2555
2556 (defun gnus-newsgroup-kill-file (newsgroup)
2557   "Return the name of a kill file name for NEWSGROUP.
2558 If NEWSGROUP is nil, return the global kill file name instead."
2559   (cond
2560    ;; The global KILL file is placed at top of the directory.
2561    ((or (null newsgroup)
2562         (string-equal newsgroup ""))
2563     (expand-file-name gnus-kill-file-name
2564                       gnus-kill-files-directory))
2565    ;; Append ".KILL" to newsgroup name.
2566    ((gnus-use-long-file-name 'not-kill)
2567     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2568                               "." gnus-kill-file-name)
2569                       gnus-kill-files-directory))
2570    ;; Place "KILL" under the hierarchical directory.
2571    (t
2572     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2573                               "/" gnus-kill-file-name)
2574                       gnus-kill-files-directory))))
2575
2576 ;;; Server things.
2577
2578 (defun gnus-member-of-valid (symbol group)
2579   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2580   (memq symbol (assoc
2581                 (symbol-name (car (gnus-find-method-for-group group)))
2582                 gnus-valid-select-methods)))
2583
2584 (defun gnus-method-option-p (method option)
2585   "Return non-nil if select METHOD has OPTION as a parameter."
2586   (when (stringp method)
2587     (setq method (gnus-server-to-method method)))
2588   (memq option (assoc (format "%s" (car method))
2589                       gnus-valid-select-methods)))
2590
2591 (defun gnus-similar-server-opened (method)
2592   (let ((opened gnus-opened-servers))
2593     (while (and method opened)
2594       (when (and (equal (cadr method) (cadaar opened))
2595                  (not (equal method (caar opened))))
2596         (setq method nil))
2597       (pop opened))
2598     (not method)))
2599
2600 (defun gnus-server-extend-method (group method)
2601   ;; This function "extends" a virtual server.  If the server is
2602   ;; "hello", and the select method is ("hello" (my-var "something"))
2603   ;; in the group "alt.alt", this will result in a new virtual server
2604   ;; called "hello+alt.alt".
2605   (if (or (not (inline (gnus-similar-server-opened method)))
2606           (not (cddr method)))
2607       method
2608     `(,(car method) ,(concat (cadr method) "+" group)
2609       (,(intern (format "%s-address" (car method))) ,(cadr method))
2610       ,@(cddr method))))
2611
2612 (defun gnus-server-status (method)
2613   "Return the status of METHOD."
2614   (nth 1 (assoc method gnus-opened-servers)))
2615
2616 (defun gnus-group-name-to-method (group)
2617   "Guess a select method based on GROUP."
2618   (if (string-match ":" group)
2619       (let ((server (substring group 0 (match-beginning 0))))
2620         (if (string-match "\\+" server)
2621             (list (intern (substring server 0 (match-beginning 0)))
2622                   (substring server (match-end 0)))
2623           (list (intern server) "")))
2624     gnus-select-method))
2625
2626 (defun gnus-find-method-for-group (group &optional info)
2627   "Find the select method that GROUP uses."
2628   (or gnus-override-method
2629       (and (not group)
2630            gnus-select-method)
2631       (let ((info (or info (gnus-get-info group)))
2632             method)
2633         (if (or (not info)
2634                 (not (setq method (gnus-info-method info)))
2635                 (equal method "native"))
2636             gnus-select-method
2637           (setq method
2638                 (cond ((stringp method)
2639                        (inline (gnus-server-to-method method)))
2640                       ((stringp (cadr method))
2641                        (inline (gnus-server-extend-method group method)))
2642                       (t
2643                        method)))
2644           (cond ((equal (cadr method) "")
2645                  method)
2646                 ((null (cadr method))
2647                  (list (car method) ""))
2648                 (t
2649                  (gnus-server-add-address method)))))))
2650
2651 (defun gnus-methods-using (feature)
2652   "Find all methods that have FEATURE."
2653   (let ((valids gnus-valid-select-methods)
2654         outs)
2655     (while valids
2656       (when (memq feature (car valids))
2657         (push (car valids) outs))
2658       (setq valids (cdr valids)))
2659     outs))
2660
2661 (defun gnus-read-group (prompt &optional default)
2662   "Prompt the user for a group name.
2663 Disallow illegal group names."
2664   (let ((prefix "")
2665         group)
2666     (while (not group)
2667       (when (string-match
2668              "[: `'\"/]\\|^$"
2669              (setq group (read-string (concat prefix prompt)
2670                                       (cons (or default "") 0)
2671                                       'gnus-group-history)))
2672         (setq prefix (format "Illegal group name: \"%s\".  " group)
2673               group nil)))
2674     group))
2675
2676 (defun gnus-read-method (prompt)
2677   "Prompt the user for a method.
2678 Allow completion over sensible values."
2679   (let ((method
2680          (completing-read
2681           prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2682                          gnus-server-alist)
2683           nil t nil 'gnus-method-history)))
2684     (cond
2685      ((equal method "")
2686       (setq method gnus-select-method))
2687      ((assoc method gnus-valid-select-methods)
2688       (list (intern method)
2689             (if (memq 'prompt-address
2690                       (assoc method gnus-valid-select-methods))
2691                 (read-string "Address: ")
2692               "")))
2693      ((assoc method gnus-server-alist)
2694       method)
2695      (t
2696       (list (intern method) "")))))
2697
2698 ;;; User-level commands.
2699
2700 ;;;###autoload
2701 (defun gnus-slave-no-server (&optional arg)
2702   "Read network news as a slave, without connecting to local server."
2703   (interactive "P")
2704   (gnus-no-server arg t))
2705
2706 ;;;###autoload
2707 (defun gnus-no-server (&optional arg slave)
2708   "Read network news.
2709 If ARG is a positive number, Gnus will use that as the
2710 startup level.  If ARG is nil, Gnus will be started at level 2.
2711 If ARG is non-nil and not a positive number, Gnus will
2712 prompt the user for the name of an NNTP server to use.
2713 As opposed to `gnus', this command will not connect to the local server."
2714   (interactive "P")
2715   (gnus-no-server-1 arg slave))
2716
2717 ;;;###autoload
2718 (defun gnus-slave (&optional arg)
2719   "Read news as a slave."
2720   (interactive "P")
2721   (gnus arg nil 'slave))
2722
2723 ;;;###autoload
2724 (defun gnus-other-frame (&optional arg)
2725   "Pop up a frame to read news."
2726   (interactive "P")
2727   (let ((window (get-buffer-window gnus-group-buffer)))
2728     (cond (window
2729            (select-frame (window-frame window)))
2730           ((= (length (frame-list)) 1)
2731            (select-frame (make-frame)))
2732           (t
2733            (other-frame 1))))
2734   (gnus arg))
2735
2736 ;;;###autoload
2737 (defun gnus (&optional arg dont-connect slave)
2738   "Read network news.
2739 If ARG is non-nil and a positive number, Gnus will use that as the
2740 startup level.  If ARG is non-nil and not a positive number, Gnus will
2741 prompt the user for the name of an NNTP server to use."
2742   (interactive "P")
2743   (gnus-1 arg dont-connect slave))
2744
2745 ;; Allow redefinition of Gnus functions.
2746
2747 (gnus-ems-redefine)
2748
2749 (provide 'gnus)
2750
2751 ;;; gnus.el ends here