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