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