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