Eliminate trailing spaces.
[bpt/emacs.git] / lisp / gnus / gnus.el
CommitLineData
5e67c784 1;;; gnus.el --- a newsreader for GNU Emacs
23f87bed 2
43273f39 3;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
23f87bed 4;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
eec82323
LMI
5
6;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6748645f 7;; Lars Magne Ingebrigtsen <larsi@gnus.org>
eec82323
LMI
8;; Keywords: news, mail
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
26
27;;; Commentary:
28
29;;; Code:
30
31(eval '(run-hooks 'gnus-load-hook))
32
a36c8d02 33(eval-when-compile (require 'cl))
23f87bed 34(require 'wid-edit)
16409b0b 35(require 'mm-util)
23f87bed 36(require 'nnheader)
a36c8d02 37
eec82323
LMI
38(defgroup gnus nil
39 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
40 :group 'news
41 :group 'mail)
42
23f87bed
MB
43(defgroup gnus-format nil
44 "Dealing with formatting issues."
45 :group 'gnus)
46
16409b0b
GM
47(defgroup gnus-charset nil
48 "Group character set issues."
49 :link '(custom-manual "(gnus)Charsets")
50 :version "21.1"
51 :group 'gnus)
52
6748645f
LMI
53(defgroup gnus-cache nil
54 "Cache interface."
23f87bed
MB
55 :link '(custom-manual "(gnus)Article Caching")
56 :group 'gnus)
57
58(defgroup gnus-registry nil
59 "Article Registry."
6748645f
LMI
60 :group 'gnus)
61
eec82323
LMI
62(defgroup gnus-start nil
63 "Starting your favorite newsreader."
64 :group 'gnus)
65
66(defgroup gnus-start-server nil
67 "Server options at startup."
68 :group 'gnus-start)
69
70;; These belong to gnus-group.el.
71(defgroup gnus-group nil
72 "Group buffers."
23f87bed 73 :link '(custom-manual "(gnus)Group Buffer")
eec82323
LMI
74 :group 'gnus)
75
76(defgroup gnus-group-foreign nil
77 "Foreign groups."
78 :link '(custom-manual "(gnus)Foreign Groups")
79 :group 'gnus-group)
80
81(defgroup gnus-group-new nil
82 "Automatic subscription of new groups."
83 :group 'gnus-group)
84
85(defgroup gnus-group-levels nil
86 "Group levels."
87 :link '(custom-manual "(gnus)Group Levels")
88 :group 'gnus-group)
89
90(defgroup gnus-group-select nil
91 "Selecting a Group."
92 :link '(custom-manual "(gnus)Selecting a Group")
93 :group 'gnus-group)
94
95(defgroup gnus-group-listing nil
96 "Showing slices of the group list."
97 :link '(custom-manual "(gnus)Listing Groups")
98 :group 'gnus-group)
99
100(defgroup gnus-group-visual nil
101 "Sorting the group buffer."
102 :link '(custom-manual "(gnus)Group Buffer Format")
103 :group 'gnus-group
104 :group 'gnus-visual)
105
106(defgroup gnus-group-various nil
107 "Various group options."
108 :link '(custom-manual "(gnus)Scanning New Messages")
109 :group 'gnus-group)
110
111;; These belong to gnus-sum.el.
112(defgroup gnus-summary nil
113 "Summary buffers."
23f87bed 114 :link '(custom-manual "(gnus)Summary Buffer")
eec82323
LMI
115 :group 'gnus)
116
117(defgroup gnus-summary-exit nil
118 "Leaving summary buffers."
119 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
120 :group 'gnus-summary)
121
122(defgroup gnus-summary-marks nil
123 "Marks used in summary buffers."
124 :link '(custom-manual "(gnus)Marking Articles")
125 :group 'gnus-summary)
126
127(defgroup gnus-thread nil
128 "Ordering articles according to replies."
129 :link '(custom-manual "(gnus)Threading")
130 :group 'gnus-summary)
131
132(defgroup gnus-summary-format nil
133 "Formatting of the summary buffer."
134 :link '(custom-manual "(gnus)Summary Buffer Format")
135 :group 'gnus-summary)
136
137(defgroup gnus-summary-choose nil
138 "Choosing Articles."
139 :link '(custom-manual "(gnus)Choosing Articles")
140 :group 'gnus-summary)
141
142(defgroup gnus-summary-maneuvering nil
143 "Summary movement commands."
144 :link '(custom-manual "(gnus)Summary Maneuvering")
145 :group 'gnus-summary)
146
23f87bed
MB
147(defgroup gnus-picon nil
148 "Show pictures of people, domains, and newsgroups."
149 :group 'gnus-visual)
150
eec82323
LMI
151(defgroup gnus-summary-mail nil
152 "Mail group commands."
153 :link '(custom-manual "(gnus)Mail Group Commands")
154 :group 'gnus-summary)
155
156(defgroup gnus-summary-sort nil
157 "Sorting the summary buffer."
23f87bed 158 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
eec82323
LMI
159 :group 'gnus-summary)
160
161(defgroup gnus-summary-visual nil
162 "Highlighting and menus in the summary buffer."
163 :link '(custom-manual "(gnus)Summary Highlighting")
164 :group 'gnus-visual
165 :group 'gnus-summary)
166
167(defgroup gnus-summary-various nil
168 "Various summary buffer options."
169 :link '(custom-manual "(gnus)Various Summary Stuff")
170 :group 'gnus-summary)
171
a8151ef7
LMI
172(defgroup gnus-summary-pick nil
173 "Pick mode in the summary buffer."
174 :link '(custom-manual "(gnus)Pick and Read")
175 :prefix "gnus-pick-"
176 :group 'gnus-summary)
177
178(defgroup gnus-summary-tree nil
179 "Tree display of threads in the summary buffer."
180 :link '(custom-manual "(gnus)Tree Display")
181 :prefix "gnus-tree-"
182 :group 'gnus-summary)
183
eec82323
LMI
184;; Belongs to gnus-uu.el
185(defgroup gnus-extract-view nil
186 "Viewing extracted files."
187 :link '(custom-manual "(gnus)Viewing Files")
188 :group 'gnus-extract)
189
190;; Belongs to gnus-score.el
191(defgroup gnus-score nil
192 "Score and kill file handling."
193 :group 'gnus)
194
195(defgroup gnus-score-kill nil
196 "Kill files."
197 :group 'gnus-score)
198
199(defgroup gnus-score-adapt nil
200 "Adaptive score files."
201 :group 'gnus-score)
202
203(defgroup gnus-score-default nil
204 "Default values for score files."
205 :group 'gnus-score)
206
207(defgroup gnus-score-expire nil
208 "Expiring score rules."
209 :group 'gnus-score)
210
211(defgroup gnus-score-decay nil
212 "Decaying score rules."
213 :group 'gnus-score)
214
215(defgroup gnus-score-files nil
216 "Score and kill file names."
217 :group 'gnus-score
218 :group 'gnus-files)
219
220(defgroup gnus-score-various nil
221 "Various scoring and killing options."
222 :group 'gnus-score)
223
224;; Other
225(defgroup gnus-visual nil
23f87bed 226 "Options controlling the visual fluff."
eec82323
LMI
227 :group 'gnus
228 :group 'faces)
229
6748645f
LMI
230(defgroup gnus-agent nil
231 "Offline support for Gnus."
232 :group 'gnus)
233
eec82323
LMI
234(defgroup gnus-files nil
235 "Files used by Gnus."
236 :group 'gnus)
237
238(defgroup gnus-dribble-file nil
239 "Auto save file."
240 :link '(custom-manual "(gnus)Auto Save")
241 :group 'gnus-files)
242
243(defgroup gnus-newsrc nil
244 "Storing Gnus state."
245 :group 'gnus-files)
246
247(defgroup gnus-server nil
248 "Options related to newsservers and other servers used by Gnus."
249 :group 'gnus)
250
23f87bed
MB
251(defgroup gnus-server-visual nil
252 "Highlighting and menus in the server buffer."
253 :group 'gnus-visual
254 :group 'gnus-server)
255
eec82323
LMI
256(defgroup gnus-message '((message custom-group))
257 "Composing replies and followups in Gnus."
258 :group 'gnus)
259
260(defgroup gnus-meta nil
23f87bed 261 "Meta variables controlling major portions of Gnus.
eec82323
LMI
262In general, modifying these variables does not take affect until Gnus
263is restarted, and sometimes reloaded."
264 :group 'gnus)
265
266(defgroup gnus-various nil
267 "Other Gnus options."
268 :link '(custom-manual "(gnus)Various Various")
269 :group 'gnus)
270
16409b0b
GM
271(defgroup gnus-mime nil
272 "Variables for controlling the Gnus MIME interface."
273 :group 'gnus)
274
eec82323
LMI
275(defgroup gnus-exit nil
276 "Exiting gnus."
277 :link '(custom-manual "(gnus)Exiting Gnus")
278 :group 'gnus)
279
23f87bed
MB
280(defgroup gnus-fun nil
281 "Frivolous Gnus extensions."
282 :link '(custom-manual "(gnus)Exiting Gnus")
283 :group 'gnus)
284
285(defconst gnus-version-number "5.10.6"
eec82323
LMI
286 "Version number for this version of Gnus.")
287
288(defconst gnus-version (format "Gnus v%s" gnus-version-number)
289 "Version string for this version of Gnus.")
290
291(defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293This variable is used before `.gnus.el' is loaded, so it should
294be set in `.emacs' instead."
295 :group 'gnus-start
296 :type 'boolean)
297
298(defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
300 :group 'gnus-start
301 :type 'boolean)
302
23f87bed
MB
303(unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
305
306(unless (fboundp 'gnus-set-text-properties)
307 (defalias 'gnus-set-text-properties 'set-text-properties))
308
eec82323
LMI
309(unless (featurep 'gnus-xmas)
310 (defalias 'gnus-make-overlay 'make-overlay)
6748645f 311 (defalias 'gnus-delete-overlay 'delete-overlay)
eec82323
LMI
312 (defalias 'gnus-overlay-put 'overlay-put)
313 (defalias 'gnus-move-overlay 'move-overlay)
48df946a
DL
314 (defalias 'gnus-overlay-buffer 'overlay-buffer)
315 (defalias 'gnus-overlay-start 'overlay-start)
eec82323
LMI
316 (defalias 'gnus-overlay-end 'overlay-end)
317 (defalias 'gnus-extent-detached-p 'ignore)
318 (defalias 'gnus-extent-start-open 'ignore)
eec82323
LMI
319 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
320 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
321 (defalias 'gnus-character-to-event 'identity)
23f87bed 322 (defalias 'gnus-assq-delete-all 'assq-delete-all)
eec82323
LMI
323 (defalias 'gnus-add-text-properties 'add-text-properties)
324 (defalias 'gnus-put-text-property 'put-text-property)
16409b0b
GM
325 (defvar gnus-mode-line-image-cache t)
326 (if (fboundp 'find-image)
327 (defun gnus-mode-line-buffer-identification (line)
328 (let ((str (car-safe line)))
329 (if (and (stringp str)
330 (string-match "^Gnus:" str))
331 (progn (add-text-properties
332 0 5
333 (list 'display
334 (if (eq t gnus-mode-line-image-cache)
335 (setq gnus-mode-line-image-cache
336 (find-image
337 '((:type xpm :file "gnus-pointer.xpm"
e03eed51 338 :ascent center)
16409b0b 339 (:type xbm :file "gnus-pointer.xbm"
e03eed51 340 :ascent center))))
16409b0b 341 gnus-mode-line-image-cache)
23f87bed
MB
342 'help-echo (format
343 "This is %s, %s."
344 gnus-version (gnus-emacs-version)))
16409b0b
GM
345 str)
346 (list str))
347 line)))
348 (defalias 'gnus-mode-line-buffer-identification 'identity))
eec82323 349 (defalias 'gnus-characterp 'numberp)
6748645f
LMI
350 (defalias 'gnus-deactivate-mark 'deactivate-mark)
351 (defalias 'gnus-window-edges 'window-edges)
16409b0b 352 (defalias 'gnus-key-press-event-p 'numberp)
23f87bed
MB
353 ;;(defalias 'gnus-decode-rfc1522 'ignore)
354 )
eec82323 355
eec82323
LMI
356;; We define these group faces here to avoid the display
357;; update forced when creating new faces.
358
359(defface gnus-group-news-1-face
360 '((((class color)
361 (background dark))
23f87bed 362 (:foreground "PaleTurquoise" :bold t))
eec82323
LMI
363 (((class color)
364 (background light))
23f87bed 365 (:foreground "ForestGreen" :bold t))
eec82323
LMI
366 (t
367 ()))
368 "Level 1 newsgroup face.")
369
370(defface gnus-group-news-1-empty-face
371 '((((class color)
372 (background dark))
373 (:foreground "PaleTurquoise"))
374 (((class color)
375 (background light))
376 (:foreground "ForestGreen"))
377 (t
378 ()))
379 "Level 1 empty newsgroup face.")
380
381(defface gnus-group-news-2-face
382 '((((class color)
383 (background dark))
23f87bed 384 (:foreground "turquoise" :bold t))
eec82323
LMI
385 (((class color)
386 (background light))
23f87bed 387 (:foreground "CadetBlue4" :bold t))
eec82323
LMI
388 (t
389 ()))
390 "Level 2 newsgroup face.")
391
392(defface gnus-group-news-2-empty-face
393 '((((class color)
394 (background dark))
395 (:foreground "turquoise"))
396 (((class color)
397 (background light))
398 (:foreground "CadetBlue4"))
399 (t
400 ()))
401 "Level 2 empty newsgroup face.")
402
403(defface gnus-group-news-3-face
404 '((((class color)
405 (background dark))
23f87bed 406 (:bold t))
eec82323
LMI
407 (((class color)
408 (background light))
23f87bed 409 (:bold t))
eec82323
LMI
410 (t
411 ()))
412 "Level 3 newsgroup face.")
413
414(defface gnus-group-news-3-empty-face
415 '((((class color)
416 (background dark))
417 ())
418 (((class color)
419 (background light))
420 ())
421 (t
422 ()))
423 "Level 3 empty newsgroup face.")
424
16409b0b
GM
425(defface gnus-group-news-4-face
426 '((((class color)
427 (background dark))
23f87bed 428 (:bold t))
16409b0b
GM
429 (((class color)
430 (background light))
23f87bed 431 (:bold t))
16409b0b
GM
432 (t
433 ()))
434 "Level 4 newsgroup face.")
435
436(defface gnus-group-news-4-empty-face
437 '((((class color)
438 (background dark))
439 ())
440 (((class color)
441 (background light))
442 ())
443 (t
444 ()))
445 "Level 4 empty newsgroup face.")
446
447(defface gnus-group-news-5-face
448 '((((class color)
449 (background dark))
23f87bed 450 (:bold t))
16409b0b
GM
451 (((class color)
452 (background light))
23f87bed 453 (:bold t))
16409b0b
GM
454 (t
455 ()))
456 "Level 5 newsgroup face.")
457
458(defface gnus-group-news-5-empty-face
459 '((((class color)
460 (background dark))
461 ())
462 (((class color)
463 (background light))
464 ())
465 (t
466 ()))
467 "Level 5 empty newsgroup face.")
468
469(defface gnus-group-news-6-face
470 '((((class color)
471 (background dark))
23f87bed 472 (:bold t))
16409b0b
GM
473 (((class color)
474 (background light))
23f87bed 475 (:bold t))
16409b0b
GM
476 (t
477 ()))
478 "Level 6 newsgroup face.")
479
480(defface gnus-group-news-6-empty-face
481 '((((class color)
482 (background dark))
483 ())
484 (((class color)
485 (background light))
486 ())
487 (t
488 ()))
489 "Level 6 empty newsgroup face.")
490
eec82323
LMI
491(defface gnus-group-news-low-face
492 '((((class color)
493 (background dark))
23f87bed 494 (:foreground "DarkTurquoise" :bold t))
eec82323
LMI
495 (((class color)
496 (background light))
23f87bed 497 (:foreground "DarkGreen" :bold t))
eec82323
LMI
498 (t
499 ()))
500 "Low level newsgroup face.")
501
502(defface gnus-group-news-low-empty-face
503 '((((class color)
504 (background dark))
505 (:foreground "DarkTurquoise"))
506 (((class color)
507 (background light))
508 (:foreground "DarkGreen"))
509 (t
510 ()))
511 "Low level empty newsgroup face.")
512
513(defface gnus-group-mail-1-face
514 '((((class color)
515 (background dark))
23f87bed 516 (:foreground "aquamarine1" :bold t))
eec82323
LMI
517 (((class color)
518 (background light))
23f87bed 519 (:foreground "DeepPink3" :bold t))
eec82323 520 (t
23f87bed 521 (:bold t)))
eec82323
LMI
522 "Level 1 mailgroup face.")
523
524(defface gnus-group-mail-1-empty-face
525 '((((class color)
526 (background dark))
527 (:foreground "aquamarine1"))
528 (((class color)
529 (background light))
530 (:foreground "DeepPink3"))
531 (t
23f87bed 532 (:italic t :bold t)))
eec82323
LMI
533 "Level 1 empty mailgroup face.")
534
535(defface gnus-group-mail-2-face
536 '((((class color)
537 (background dark))
23f87bed 538 (:foreground "aquamarine2" :bold t))
eec82323
LMI
539 (((class color)
540 (background light))
23f87bed 541 (:foreground "HotPink3" :bold t))
eec82323 542 (t
23f87bed 543 (:bold t)))
eec82323
LMI
544 "Level 2 mailgroup face.")
545
546(defface gnus-group-mail-2-empty-face
547 '((((class color)
548 (background dark))
549 (:foreground "aquamarine2"))
550 (((class color)
551 (background light))
552 (:foreground "HotPink3"))
553 (t
23f87bed 554 (:bold t)))
eec82323
LMI
555 "Level 2 empty mailgroup face.")
556
557(defface gnus-group-mail-3-face
558 '((((class color)
559 (background dark))
23f87bed 560 (:foreground "aquamarine3" :bold t))
eec82323
LMI
561 (((class color)
562 (background light))
23f87bed 563 (:foreground "magenta4" :bold t))
eec82323 564 (t
23f87bed 565 (:bold t)))
eec82323
LMI
566 "Level 3 mailgroup face.")
567
568(defface gnus-group-mail-3-empty-face
569 '((((class color)
570 (background dark))
571 (:foreground "aquamarine3"))
572 (((class color)
573 (background light))
574 (:foreground "magenta4"))
575 (t
576 ()))
577 "Level 3 empty mailgroup face.")
578
579(defface gnus-group-mail-low-face
580 '((((class color)
581 (background dark))
23f87bed 582 (:foreground "aquamarine4" :bold t))
eec82323
LMI
583 (((class color)
584 (background light))
23f87bed 585 (:foreground "DeepPink4" :bold t))
eec82323 586 (t
23f87bed 587 (:bold t)))
eec82323
LMI
588 "Low level mailgroup face.")
589
590(defface gnus-group-mail-low-empty-face
591 '((((class color)
592 (background dark))
593 (:foreground "aquamarine4"))
594 (((class color)
595 (background light))
596 (:foreground "DeepPink4"))
597 (t
23f87bed 598 (:bold t)))
eec82323
LMI
599 "Low level empty mailgroup face.")
600
601;; Summary mode faces.
602
603(defface gnus-summary-selected-face '((t
604 (:underline t)))
605 "Face used for selected articles.")
606
607(defface gnus-summary-cancelled-face
608 '((((class color))
609 (:foreground "yellow" :background "black")))
610 "Face used for cancelled articles.")
611
612(defface gnus-summary-high-ticked-face
613 '((((class color)
614 (background dark))
23f87bed 615 (:foreground "pink" :bold t))
eec82323
LMI
616 (((class color)
617 (background light))
23f87bed 618 (:foreground "firebrick" :bold t))
eec82323 619 (t
23f87bed 620 (:bold t)))
eec82323
LMI
621 "Face used for high interest ticked articles.")
622
623(defface gnus-summary-low-ticked-face
624 '((((class color)
625 (background dark))
23f87bed 626 (:foreground "pink" :italic t))
eec82323
LMI
627 (((class color)
628 (background light))
23f87bed 629 (:foreground "firebrick" :italic t))
eec82323 630 (t
23f87bed 631 (:italic t)))
eec82323
LMI
632 "Face used for low interest ticked articles.")
633
634(defface gnus-summary-normal-ticked-face
635 '((((class color)
636 (background dark))
637 (:foreground "pink"))
638 (((class color)
639 (background light))
640 (:foreground "firebrick"))
641 (t
642 ()))
643 "Face used for normal interest ticked articles.")
644
645(defface gnus-summary-high-ancient-face
646 '((((class color)
647 (background dark))
23f87bed 648 (:foreground "SkyBlue" :bold t))
eec82323
LMI
649 (((class color)
650 (background light))
23f87bed 651 (:foreground "RoyalBlue" :bold t))
eec82323 652 (t
23f87bed 653 (:bold t)))
eec82323
LMI
654 "Face used for high interest ancient articles.")
655
656(defface gnus-summary-low-ancient-face
657 '((((class color)
658 (background dark))
23f87bed 659 (:foreground "SkyBlue" :italic t))
eec82323
LMI
660 (((class color)
661 (background light))
23f87bed 662 (:foreground "RoyalBlue" :italic t))
eec82323 663 (t
23f87bed 664 (:italic t)))
eec82323
LMI
665 "Face used for low interest ancient articles.")
666
667(defface gnus-summary-normal-ancient-face
668 '((((class color)
669 (background dark))
670 (:foreground "SkyBlue"))
671 (((class color)
672 (background light))
673 (:foreground "RoyalBlue"))
674 (t
675 ()))
676 "Face used for normal interest ancient articles.")
677
23f87bed
MB
678(defface gnus-summary-high-undownloaded-face
679 '((((class color)
680 (background light))
681 (:bold t :foreground "cyan4"))
682 (((class color) (background dark))
683 (:bold t :foreground "LightGray"))
684 (t (:inverse-video t :bold t)))
685 "Face used for high interest uncached articles.")
686
687(defface gnus-summary-low-undownloaded-face
688 '((((class color)
689 (background light))
690 (:italic t :foreground "cyan4" :bold nil))
691 (((class color) (background dark))
692 (:italic t :foreground "LightGray" :bold nil))
693 (t (:inverse-video t :italic t)))
694 "Face used for low interest uncached articles.")
695
696(defface gnus-summary-normal-undownloaded-face
697 '((((class color)
698 (background light))
699 (:foreground "cyan4" :bold nil))
700 (((class color) (background dark))
701 (:foreground "LightGray" :bold nil))
702 (t (:inverse-video t)))
703 "Face used for normal interest uncached articles.")
704
eec82323
LMI
705(defface gnus-summary-high-unread-face
706 '((t
23f87bed 707 (:bold t)))
eec82323
LMI
708 "Face used for high interest unread articles.")
709
710(defface gnus-summary-low-unread-face
711 '((t
23f87bed 712 (:italic t)))
eec82323
LMI
713 "Face used for low interest unread articles.")
714
715(defface gnus-summary-normal-unread-face
716 '((t
717 ()))
718 "Face used for normal interest unread articles.")
719
720(defface gnus-summary-high-read-face
721 '((((class color)
722 (background dark))
723 (:foreground "PaleGreen"
23f87bed 724 :bold t))
eec82323
LMI
725 (((class color)
726 (background light))
727 (:foreground "DarkGreen"
23f87bed 728 :bold t))
eec82323 729 (t
23f87bed 730 (:bold t)))
eec82323
LMI
731 "Face used for high interest read articles.")
732
733(defface gnus-summary-low-read-face
734 '((((class color)
735 (background dark))
736 (:foreground "PaleGreen"
23f87bed 737 :italic t))
eec82323
LMI
738 (((class color)
739 (background light))
740 (:foreground "DarkGreen"
23f87bed 741 :italic t))
eec82323 742 (t
23f87bed 743 (:italic t)))
eec82323
LMI
744 "Face used for low interest read articles.")
745
746(defface gnus-summary-normal-read-face
747 '((((class color)
748 (background dark))
749 (:foreground "PaleGreen"))
750 (((class color)
751 (background light))
752 (:foreground "DarkGreen"))
753 (t
754 ()))
755 "Face used for normal interest read articles.")
756
757
6748645f
LMI
758;;;
759;;; Gnus buffers
760;;;
761
762(defvar gnus-buffers nil)
763
764(defun gnus-get-buffer-create (name)
765 "Do the same as `get-buffer-create', but store the created buffer."
766 (or (get-buffer name)
767 (car (push (get-buffer-create name) gnus-buffers))))
768
769(defun gnus-add-buffer ()
770 "Add the current buffer to the list of Gnus buffers."
771 (push (current-buffer) gnus-buffers))
772
23f87bed
MB
773(defmacro gnus-kill-buffer (buffer)
774 "Kill BUFFER and remove from the list of Gnus buffers."
775 `(let ((buf ,buffer))
776 (when (gnus-buffer-exists-p buf)
777 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
778 (kill-buffer buf))))
779
6748645f
LMI
780(defun gnus-buffers ()
781 "Return a list of live Gnus buffers."
782 (while (and gnus-buffers
783 (not (buffer-name (car gnus-buffers))))
784 (pop gnus-buffers))
785 (let ((buffers gnus-buffers))
786 (while (cdr buffers)
787 (if (buffer-name (cadr buffers))
788 (pop buffers)
789 (setcdr buffers (cddr buffers)))))
790 gnus-buffers)
791
eec82323
LMI
792;;; Splash screen.
793
794(defvar gnus-group-buffer "*Group*")
795
796(eval-and-compile
797 (autoload 'gnus-play-jingle "gnus-audio"))
798
799(defface gnus-splash-face
800 '((((class color)
801 (background dark))
23f87bed 802 (:foreground "#888888"))
eec82323
LMI
803 (((class color)
804 (background light))
23f87bed 805 (:foreground "#888888"))
eec82323
LMI
806 (t
807 ()))
23f87bed 808 "Face for the splash screen.")
eec82323
LMI
809
810(defun gnus-splash ()
811 (save-excursion
6748645f 812 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
eec82323
LMI
813 (let ((buffer-read-only nil))
814 (erase-buffer)
815 (unless gnus-inhibit-startup-message
816 (gnus-group-startup-message)
817 (sit-for 0)
818 (when gnus-play-startup-jingle
819 (gnus-play-jingle))))))
820
821(defun gnus-indent-rigidly (start end arg)
822 "Indent rigidly using only spaces and no tabs."
823 (save-excursion
824 (save-restriction
825 (narrow-to-region start end)
a8151ef7
LMI
826 (let ((tab-width 8))
827 (indent-rigidly start end arg)
828 ;; We translate tabs into spaces -- not everybody uses
829 ;; an 8-character tab.
830 (goto-char (point-min))
831 (while (search-forward "\t" nil t)
832 (replace-match " " t t))))))
eec82323
LMI
833
834(defvar gnus-simple-splash nil)
835
23f87bed
MB
836;;(format "%02x%02x%02x" 114 66 20) "724214"
837
838(defvar gnus-logo-color-alist
839 '((flame "#cc3300" "#ff2200")
840 (pine "#c0cc93" "#f8ffb8")
841 (moss "#a1cc93" "#d2ffb8")
842 (irish "#04cc90" "#05ff97")
843 (sky "#049acc" "#05deff")
844 (tin "#6886cc" "#82b6ff")
845 (velvet "#7c68cc" "#8c82ff")
846 (grape "#b264cc" "#cf7df")
847 (labia "#cc64c2" "#fd7dff")
848 (berry "#cc6485" "#ff7db5")
849 (dino "#724214" "#1e3f03")
850 (oort "#cccccc" "#888888")
851 (storm "#666699" "#99ccff")
852 (pdino "#9999cc" "#99ccff")
853 (purp "#9999cc" "#666699")
854 (no "#000000" "#ff0000")
855 (neutral "#b4b4b4" "#878787")
856 (september "#bf9900" "#ffcc00"))
857 "Color alist used for the Gnus logo.")
858
859(defcustom gnus-logo-color-style 'oort
860 "*Color styles used for the Gnus logo."
861 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
862 gnus-logo-color-alist))
863 :group 'gnus-xmas)
864
865(defvar gnus-logo-colors
866 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
867 "Colors used for the Gnus logo.")
868
eec82323
LMI
869(defun gnus-group-startup-message (&optional x y)
870 "Insert startup message in current buffer."
871 ;; Insert the message.
872 (erase-buffer)
16409b0b
GM
873 (cond
874 ((and
875 (fboundp 'find-image)
876 (display-graphic-p)
23f87bed
MB
877 (let* ((data-directory (nnheader-find-etc-directory "gnus"))
878 (image (find-image
879 `((:type xpm :file "gnus.xpm"
880 :color-symbols
881 (("thing" . ,(car gnus-logo-colors))
882 ("shadow" . ,(cadr gnus-logo-colors))
883 ("oort" . "#eeeeee")
884 ("background" . ,(face-background 'default))))
885 (:type pbm :file "gnus.pbm"
886 ;; Account for the pbm's blackground.
887 :background ,(face-foreground 'gnus-splash-face)
888 :foreground ,(face-background 'default))
889 (:type xbm :file "gnus.xbm"
890 ;; Account for the xbm's blackground.
891 :background ,(face-foreground 'gnus-splash-face)
892 :foreground ,(face-background 'default))))))
16409b0b
GM
893 (when image
894 (let ((size (image-size image)))
895 (insert-char ?\n (max 0 (round (- (window-height)
896 (or y (cdr size)) 1) 2)))
897 (insert-char ?\ (max 0 (round (- (window-width)
898 (or x (car size))) 2)))
899 (insert-image image))
900 (setq gnus-simple-splash nil)
901 t))))
902 (t
903 (insert
904 (format " %s
eec82323
LMI
905 _ ___ _ _
906 _ ___ __ ___ __ _ ___
907 __ _ ___ __ ___
908 _ ___ _
909 _ _ __ _
910 ___ __ _
911 __ _
912 _ _ _
913 _ _ _
914 _ _ _
915 __ ___
916 _ _ _ _
917 _ _
918 _ _
919 _ _
920 _
921 __
922
923"
16409b0b
GM
924 ""))
925 ;; And then hack it.
926 (gnus-indent-rigidly (point-min) (point-max)
927 (/ (max (- (window-width) (or x 46)) 0) 2))
928 (goto-char (point-min))
929 (forward-line 1)
930 (let* ((pheight (count-lines (point-min) (point-max)))
931 (wheight (window-height))
932 (rest (- wheight pheight)))
933 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
934 ;; Fontify some.
935 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
936 (setq gnus-simple-splash t)))
eec82323
LMI
937 (goto-char (point-min))
938 (setq mode-line-buffer-identification (concat " " gnus-version))
eec82323
LMI
939 (set-buffer-modified-p t))
940
941(eval-when (load)
942 (let ((command (format "%s" this-command)))
23f87bed
MB
943 (when (string-match "gnus" command)
944 (if (string-match "gnus-other-frame" command)
945 (gnus-get-buffer-create gnus-group-buffer)
946 (gnus-splash)))))
eec82323
LMI
947
948;;; Do the rest.
949
eec82323
LMI
950(require 'gnus-util)
951(require 'nnheader)
952
23f87bed
MB
953(defcustom gnus-parameters nil
954 "Alist of group parameters.
955
956For example:
957 ((\"mail\\\\..*\" (gnus-show-threads nil)
958 (gnus-use-scoring nil)
959 (gnus-summary-line-format
960 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
961 (gcc-self . t)
962 (display . all))
963 (\"mail\\\\.me\" (gnus-use-scoring t))
964 (\"list\\\\..*\" (total-expire . t)
965 (broken-reply-to . t)))"
a08b59c9 966 :version "21.4"
23f87bed
MB
967 :group 'gnus-group-various
968 :type '(repeat (cons regexp
969 (repeat sexp))))
970
971(defvar gnus-group-parameters-more nil)
972
973(defmacro gnus-define-group-parameter (param &rest rest)
974 "Define a group parameter PARAM.
975REST is a plist of following:
976:type One of `bool', `list' or nil.
977:function The name of the function.
978:function-document The documentation of the function.
979:parameter-type The type for customizing the parameter.
980:parameter-document The documentation for the parameter.
981:variable The name of the variable.
982:variable-document The documentation for the variable.
983:variable-group The group for customizing the variable.
984:variable-type The type for customizing the variable.
985:variable-default The default value of the variable."
986 (let* ((type (plist-get rest :type))
987 (parameter-type (plist-get rest :parameter-type))
988 (parameter-document (plist-get rest :parameter-document))
989 (function (or (plist-get rest :function)
990 (intern (format "gnus-parameter-%s" param))))
991 (function-document (or (plist-get rest :function-document) ""))
992 (variable (or (plist-get rest :variable)
993 (intern (format "gnus-parameter-%s-alist" param))))
994 (variable-document (or (plist-get rest :variable-document) ""))
995 (variable-group (plist-get rest :variable-group))
996 (variable-type (or (plist-get rest :variable-type)
997 `(quote (repeat
998 (list (regexp :tag "Group")
999 ,(car (cdr parameter-type)))))))
1000 (variable-default (plist-get rest :variable-default)))
1001 (list
1002 'progn
1003 `(defcustom ,variable ,variable-default
1004 ,variable-document
1005 :group 'gnus-group-parameter
1006 :group ',variable-group
1007 :type ,variable-type)
1008 `(setq gnus-group-parameters-more
1009 (delq (assq ',param gnus-group-parameters-more)
1010 gnus-group-parameters-more))
1011 `(add-to-list 'gnus-group-parameters-more
1012 (list ',param
1013 ,parameter-type
1014 ,parameter-document))
1015 (if (eq type 'bool)
1016 `(defun ,function (name)
1017 ,function-document
1018 (let ((params (gnus-group-find-parameter name))
1019 val)
1020 (cond
1021 ((memq ',param params)
1022 t)
1023 ((setq val (assq ',param params))
1024 (cdr val))
1025 ((stringp ,variable)
1026 (string-match ,variable name))
1027 (,variable
1028 (let ((alist ,variable)
1029 elem value)
1030 (while (setq elem (pop alist))
1031 (when (and name
1032 (string-match (car elem) name))
1033 (setq alist nil
1034 value (cdr elem))))
1035 (if (consp value) (car value) value))))))
1036 `(defun ,function (name)
1037 ,function-document
1038 (and name
1039 (or (gnus-group-find-parameter name ',param ,(and type t))
1040 (let ((alist ,variable)
1041 elem value)
1042 (while (setq elem (pop alist))
1043 (when (and name
1044 (string-match (car elem) name))
1045 (setq alist nil
1046 value (cdr elem))))
1047 ,(if type
1048 'value
1049 '(if (consp value) (car value) value))))))))))
1050
eec82323
LMI
1051(defcustom gnus-home-directory "~/"
1052 "Directory variable that specifies the \"home\" directory.
35ef97a5 1053All other Gnus file and directory variables are initialized from this variable."
eec82323
LMI
1054 :group 'gnus-files
1055 :type 'directory)
1056
1057(defcustom gnus-directory (or (getenv "SAVEDIR")
1058 (nnheader-concat gnus-home-directory "News/"))
6748645f
LMI
1059 "*Directory variable from which all other Gnus file variables are derived.
1060
1061Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1062This means that other directory variables that are initialized from
1063this variable won't be set properly if you set this variable in `.gnus.el'.
1064Set this variable in `.emacs' instead."
eec82323
LMI
1065 :group 'gnus-files
1066 :type 'directory)
1067
1068(defcustom gnus-default-directory nil
1069 "*Default directory for all Gnus buffers."
1070 :group 'gnus-files
1071 :type '(choice (const :tag "current" nil)
1072 directory))
1073
1074;; Site dependent variables. These variables should be defined in
1075;; paths.el.
1076
1077(defvar gnus-default-nntp-server nil
1078 "Specify a default NNTP server.
1079This variable should be defined in paths.el, and should never be set
1080by the user.
1081If you want to change servers, you should use `gnus-select-method'.
1082See the documentation to that variable.")
1083
1084;; Don't touch this variable.
1085(defvar gnus-nntp-service "nntp"
1086 "NNTP service name (\"nntp\" or 119).
1087This is an obsolete variable, which is scarcely used. If you use an
1088nntp server for your newsgroup and want to change the port number
1089used to 899, you would say something along these lines:
1090
1091 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1092
1093(defcustom gnus-nntpserver-file "/etc/nntpserver"
1094 "A file with only the name of the nntp server in it."
1095 :group 'gnus-files
1096 :group 'gnus-server
1097 :type 'file)
1098
eec82323 1099(defun gnus-getenv-nntpserver ()
23f87bed
MB
1100 "Find default nntp server.
1101Check the NNTPSERVER environment variable and the
1102`gnus-nntpserver-file' file."
eec82323
LMI
1103 (or (getenv "NNTPSERVER")
1104 (and (file-readable-p gnus-nntpserver-file)
23f87bed 1105 (with-temp-buffer
eec82323
LMI
1106 (insert-file-contents gnus-nntpserver-file)
1107 (let ((name (buffer-string)))
23f87bed
MB
1108 (unless (string-match "\\`[ \t\n]*$" name)
1109 name))))))
eec82323
LMI
1110
1111(defcustom gnus-select-method
a36c8d02 1112 (condition-case nil
16409b0b
GM
1113 (nconc
1114 (list 'nntp (or (condition-case nil
1115 (gnus-getenv-nntpserver)
1116 (error nil))
1117 (when (and gnus-default-nntp-server
1118 (not (string= gnus-default-nntp-server "")))
1119 gnus-default-nntp-server)
1120 "news"))
1121 (if (or (null gnus-nntp-service)
1122 (equal gnus-nntp-service "nntp"))
1123 nil
1124 (list gnus-nntp-service)))
a36c8d02 1125 (error nil))
16409b0b 1126 "Default method for selecting a newsgroup.
eec82323
LMI
1127This variable should be a list, where the first element is how the
1128news is to be fetched, the second is the address.
1129
23f87bed
MB
1130For instance, if you want to get your news via \"flab.flab.edu\" using
1131NNTP, you could say:
eec82323
LMI
1132
1133\(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1134
1135If you want to use your local spool, say:
1136
1137\(setq gnus-select-method (list 'nnspool (system-name)))
1138
1139If you use this variable, you must set `gnus-nntp-server' to nil.
1140
1141There is a lot more to know about select methods and virtual servers -
1142see the manual for details."
1143 :group 'gnus-server
1144 :type 'gnus-select-method)
1145
23f87bed 1146(defcustom gnus-message-archive-method "archive"
6748645f 1147 "*Method used for archiving messages you've sent.
23f87bed 1148This should be a mail method."
eec82323
LMI
1149 :group 'gnus-server
1150 :group 'gnus-message
23f87bed
MB
1151 :type '(choice (const :tag "Default archive method" "archive")
1152 gnus-select-method))
eec82323
LMI
1153
1154(defcustom gnus-message-archive-group nil
1155 "*Name of the group in which to save the messages you've written.
1156This can either be a string; a list of strings; or an alist
1157of regexps/functions/forms to be evaluated to return a string (or a list
1158of strings). The functions are called with the name of the current
1159group (or nil) as a parameter.
1160
1161If you want to save your mail in one group and the news articles you
1162write in another group, you could say something like:
1163
1164 \(setq gnus-message-archive-group
23f87bed
MB
1165 '((if (message-news-p)
1166 \"misc-news\"
1167 \"misc-mail\")))
eec82323
LMI
1168
1169Normally the group names returned by this variable should be
1170unprefixed -- which implicitly means \"store on the archive server\".
1171However, you may wish to store the message on some other server. In
1172that case, just return a fully prefixed name of the group --
1173\"nnml+private:mail.misc\", for instance."
1174 :group 'gnus-message
1175 :type '(choice (const :tag "none" nil)
16409b0b 1176 function
6748645f 1177 sexp
eec82323
LMI
1178 string))
1179
1180(defcustom gnus-secondary-servers nil
1181 "List of NNTP servers that the user can choose between interactively.
1182To make Gnus query you for a server, you have to give `gnus' a
1183non-numeric prefix - `C-u M-x gnus', in short."
1184 :group 'gnus-server
1185 :type '(repeat string))
1186
1187(defcustom gnus-nntp-server nil
1188 "*The name of the host running the NNTP server.
1189This variable is semi-obsolete. Use the `gnus-select-method'
1190variable instead."
1191 :group 'gnus-server
1192 :type '(choice (const :tag "disable" nil)
1193 string))
1194
1195(defcustom gnus-secondary-select-methods nil
1196 "A list of secondary methods that will be used for reading news.
1197This is a list where each element is a complete select method (see
1198`gnus-select-method').
1199
23f87bed 1200If, for instance, you want to read your mail with the nnml back end,
eec82323
LMI
1201you could set this variable:
1202
1203\(setq gnus-secondary-select-methods '((nnml \"\")))"
16409b0b
GM
1204 :group 'gnus-server
1205 :type '(repeat gnus-select-method))
eec82323
LMI
1206
1207(defvar gnus-backup-default-subscribed-newsgroups
1208 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1209 "Default default new newsgroups the first time Gnus is run.
1210Should be set in paths.el, and shouldn't be touched by the user.")
1211
c625688c
GM
1212(defcustom gnus-local-domain nil
1213 "Local domain name without a host name.
1214The DOMAINNAME environment variable is used instead if it is defined.
0d54d415 1215If the function `system-name' returns the full Internet name, there is
c625688c
GM
1216no need to set this variable."
1217 :group 'gnus-message
1218 :type '(choice (const :tag "default" nil)
1219 string))
1220
eec82323
LMI
1221(defvar gnus-local-organization nil
1222 "String with a description of what organization (if any) the user belongs to.
1223Obsolete variable; use `message-user-organization' instead.")
1224
1225;; Customization variables
1226
1227(defcustom gnus-refer-article-method nil
1228 "Preferred method for fetching an article by Message-ID.
1229If you are reading news from the local spool (with nnspool), fetching
1230articles by Message-ID is painfully slow. By setting this method to an
1231nntp method, you might get acceptable results.
1232
1233The value of this variable must be a valid select method as discussed
16409b0b
GM
1234in the documentation of `gnus-select-method'.
1235
1236It can also be a list of select methods, as well as the special symbol
1237`current', which means to use the current select method. If it is a
1238list, Gnus will try all the methods in the list until it finds a match."
eec82323
LMI
1239 :group 'gnus-server
1240 :type '(choice (const :tag "default" nil)
23f87bed
MB
1241 (const current)
1242 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1243 gnus-select-method
1244 (repeat :menu-tag "Try multiple"
1245 :tag "Multiple"
23f87bed 1246 :value (current (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1247 (choice :tag "Method"
1248 (const current)
23f87bed
MB
1249 (const :tag "Google"
1250 (nnweb "refer" (nnweb-type google)))
16409b0b 1251 gnus-select-method))))
eec82323
LMI
1252
1253(defcustom gnus-group-faq-directory
1254 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
eec82323
LMI
1255 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1256 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1257 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
23f87bed 1258 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
eec82323
LMI
1259 "/ftp@rtfm.mit.edu:/pub/usenet/"
1260 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1261 "/ftp@ftp.sunet.se:/pub/usenet/"
23f87bed 1262 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
eec82323
LMI
1263 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1264 "/ftp@ftp.hk.super.net:/mirror/faqs/")
6748645f 1265 "*Directory where the group FAQs are stored.
eec82323
LMI
1266This will most commonly be on a remote machine, and the file will be
1267fetched by ange-ftp.
1268
1269This variable can also be a list of directories. In that case, the
1270first element in the list will be used by default. The others can
1271be used when being prompted for a site.
1272
1273Note that Gnus uses an aol machine as the default directory. If this
1274feels fundamentally unclean, just think of it as a way to finally get
1275something of value back from them.
1276
1277If the default site is too slow, try one of these:
1278
1279 North America: mirrors.aol.com /pub/rtfm/usenet
1280 ftp.seas.gwu.edu /pub/rtfm
1281 rtfm.mit.edu /pub/usenet
1282 Europe: ftp.uni-paderborn.de /pub/FAQ
23f87bed 1283 src.doc.ic.ac.uk /usenet/news-FAQS
eec82323 1284 ftp.sunet.se /pub/usenet
23f87bed
MB
1285 ftp.pasteur.fr /pub/FAQ
1286 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
eec82323
LMI
1287 hwarang.postech.ac.kr /pub/usenet
1288 ftp.hk.super.net /mirror/faqs"
1289 :group 'gnus-group-various
1290 :type '(choice directory
1291 (repeat directory)))
1292
23f87bed
MB
1293(defcustom gnus-group-charter-alist
1294 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1295 ("de" . (concat "http://purl.net/charta/" name ".html"))
1296 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1297 ("england" . (concat "http://england.news-admin.org/charters/" name))
1298 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1299 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1300 (gnus-replace-in-string name "europa\\." "") ".html"))
1301 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1302 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1303 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1304 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1305 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1306 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1307 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1308 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1309 (gnus-replace-in-string name "\\." "_") ".html"))
1310 ("milw" . (concat "http://usenet.mil.wi.us/"
1311 (gnus-replace-in-string name "milw\\." "") "-charter"))
1312 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1313 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1314 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1315 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1316When FORM is evaluated `name' is bound to the name of the group."
1317 :group 'gnus-group-various
1318 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1319
1320(defcustom gnus-group-fetch-control-use-browse-url nil
1321 "*Non-nil means that control messages are displayed using `browse-url'.
1322Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1323group."
1324 :group 'gnus-group-various
1325 :type 'boolean)
1326
eec82323
LMI
1327(defcustom gnus-use-cross-reference t
1328 "*Non-nil means that cross referenced articles will be marked as read.
1329If nil, ignore cross references. If t, mark articles as read in
1330subscribed newsgroups. If neither t nor nil, mark as read in all
1331newsgroups."
1332 :group 'gnus-server
1333 :type '(choice (const :tag "off" nil)
1334 (const :tag "subscribed" t)
1335 (sexp :format "all"
1336 :value always)))
1337
1338(defcustom gnus-process-mark ?#
1339 "*Process mark."
1340 :group 'gnus-group-visual
1341 :group 'gnus-summary-marks
1342 :type 'character)
1343
eec82323
LMI
1344(defcustom gnus-large-newsgroup 200
1345 "*The number of articles which indicates a large newsgroup.
1346If the number of articles in a newsgroup is greater than this value,
23f87bed
MB
1347confirmation is required for selecting the newsgroup.
1348If it is nil, no confirmation is required."
eec82323 1349 :group 'gnus-group-select
23f87bed
MB
1350 :type '(choice (const :tag "No limit" nil)
1351 integer))
eec82323
LMI
1352
1353(defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1354 "*Non-nil means that the default name of a file to save articles in is the group name.
1355If it's nil, the directory form of the group name is used instead.
1356
1357If this variable is a list, and the list contains the element
1358`not-score', long file names will not be used for score files; if it
1359contains the element `not-save', long file names will not be used for
1360saving; and if it contains the element `not-kill', long file names
1361will not be used for kill files.
1362
1363Note that the default for this variable varies according to what system
1364type you're using. On `usg-unix-v' and `xenix' this variable defaults
1365to nil while on all other systems it defaults to t."
1366 :group 'gnus-start
23f87bed
MB
1367 :type '(radio (sexp :format "Non-nil\n"
1368 :match (lambda (widget value)
1369 (and value (not (listp value))))
1370 :value t)
1371 (const nil)
1372 (checklist (const :format "%v " not-score)
1373 (const :format "%v " not-save)
1374 (const not-kill))))
eec82323
LMI
1375
1376(defcustom gnus-kill-files-directory gnus-directory
1377 "*Name of the directory where kill files will be stored (default \"~/News\")."
1378 :group 'gnus-score-files
1379 :group 'gnus-score-kill
1380 :type 'directory)
1381
1382(defcustom gnus-save-score nil
1383 "*If non-nil, save group scoring info."
1384 :group 'gnus-score-various
1385 :group 'gnus-start
1386 :type 'boolean)
1387
1388(defcustom gnus-use-undo t
1389 "*If non-nil, allow undoing in Gnus group mode buffers."
1390 :group 'gnus-meta
1391 :type 'boolean)
1392
1393(defcustom gnus-use-adaptive-scoring nil
1394 "*If non-nil, use some adaptive scoring scheme.
1395If a list, then the values `word' and `line' are meaningful. The
1396former will perform adaption on individual words in the subject
1397header while `line' will perform adaption on several headers."
1398 :group 'gnus-meta
1399 :group 'gnus-score-adapt
1400 :type '(set (const word) (const line)))
1401
1402(defcustom gnus-use-cache 'passive
1403 "*If nil, Gnus will ignore the article cache.
1404If `passive', it will allow entering (and reading) articles
1405explicitly entered into the cache. If anything else, use the
1406cache to the full extent of the law."
1407 :group 'gnus-meta
1408 :group 'gnus-cache
1409 :type '(choice (const :tag "off" nil)
1410 (const :tag "passive" passive)
1411 (const :tag "active" t)))
1412
1413(defcustom gnus-use-trees nil
1414 "*If non-nil, display a thread tree buffer."
1415 :group 'gnus-meta
1416 :type 'boolean)
1417
1418(defcustom gnus-use-grouplens nil
1419 "*If non-nil, use GroupLens ratings."
1420 :group 'gnus-meta
1421 :type 'boolean)
1422
23f87bed 1423(defcustom gnus-keep-backlog 20
eec82323
LMI
1424 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1425If it is a number N, then Gnus will only keep the last N articles
1426read. If it is neither nil nor a number, Gnus will keep all read
1427articles. This is not a good idea."
1428 :group 'gnus-meta
1429 :type '(choice (const :tag "off" nil)
1430 integer
1431 (sexp :format "all"
1432 :value t)))
1433
1434(defcustom gnus-use-nocem nil
1435 "*If non-nil, Gnus will read NoCeM cancel messages."
1436 :group 'gnus-meta
1437 :type 'boolean)
1438
1439(defcustom gnus-suppress-duplicates nil
1440 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1441 :group 'gnus-meta
1442 :type 'boolean)
1443
eec82323
LMI
1444(defcustom gnus-use-scoring t
1445 "*If non-nil, enable scoring."
1446 :group 'gnus-meta
1447 :type 'boolean)
1448
eec82323
LMI
1449(defcustom gnus-summary-prepare-exit-hook
1450 '(gnus-summary-expire-articles)
6748645f 1451 "*A hook called when preparing to exit from the summary buffer.
eec82323
LMI
1452It calls `gnus-summary-expire-articles' by default."
1453 :group 'gnus-summary-exit
1454 :type 'hook)
1455
1456(defcustom gnus-novice-user t
23f87bed 1457 "*Non-nil means that you are a Usenet novice.
eec82323
LMI
1458If non-nil, verbose messages may be displayed and confirmations may be
1459required."
1460 :group 'gnus-meta
1461 :type 'boolean)
1462
1463(defcustom gnus-expert-user nil
1464 "*Non-nil means that you will never be asked for confirmation about anything.
6748645f
LMI
1465That doesn't mean *anything* anything; particularly destructive
1466commands will still require prompting."
eec82323
LMI
1467 :group 'gnus-meta
1468 :type 'boolean)
1469
1470(defcustom gnus-interactive-catchup t
1471 "*If non-nil, require your confirmation when catching up a group."
1472 :group 'gnus-group-select
1473 :type 'boolean)
1474
1475(defcustom gnus-interactive-exit t
1476 "*If non-nil, require your confirmation when exiting Gnus."
1477 :group 'gnus-exit
1478 :type 'boolean)
1479
1480(defcustom gnus-extract-address-components 'gnus-extract-address-components
1481 "*Function for extracting address components from a From header.
1482Two pre-defined function exist: `gnus-extract-address-components',
1483which is the default, quite fast, and too simplistic solution, and
1484`mail-extract-address-components', which works much better, but is
1485slower."
1486 :group 'gnus-summary-format
1487 :type '(radio (function-item gnus-extract-address-components)
1488 (function-item mail-extract-address-components)
1489 (function :tag "Other")))
1490
1491(defcustom gnus-carpal nil
1492 "*If non-nil, display clickable icons."
1493 :group 'gnus-meta
1494 :type 'boolean)
1495
1496(defcustom gnus-shell-command-separator ";"
23f87bed 1497 "String used to separate shell commands."
eec82323
LMI
1498 :group 'gnus-files
1499 :type 'string)
1500
1501(defcustom gnus-valid-select-methods
1502 '(("nntp" post address prompt-address physical-address)
1503 ("nnspool" post address)
1504 ("nnvirtual" post-mail virtual prompt-address)
1505 ("nnmbox" mail respool address)
23f87bed 1506 ("nnml" post-mail respool address)
eec82323
LMI
1507 ("nnmh" mail respool address)
1508 ("nndir" post-mail prompt-address physical-address)
1509 ("nneething" none address prompt-address physical-address)
1510 ("nndoc" none address prompt-address)
1511 ("nnbabyl" mail address respool)
1512 ("nnkiboze" post virtual)
1513 ("nnsoup" post-mail address)
1514 ("nndraft" post-mail)
1515 ("nnfolder" mail respool address)
6748645f
LMI
1516 ("nngateway" post-mail address prompt-address physical-address)
1517 ("nnweb" none)
23f87bed 1518 ("nngoogle" post)
16409b0b
GM
1519 ("nnslashdot" post)
1520 ("nnultimate" none)
23f87bed
MB
1521 ("nnrss" none)
1522 ("nnwfm" none)
16409b0b 1523 ("nnwarchive" none)
6748645f 1524 ("nnlistserv" none)
16409b0b 1525 ("nnagent" post-mail)
23f87bed
MB
1526 ("nnimap" post-mail address prompt-address physical-address)
1527 ("nnmaildir" mail respool address)
1528 ("nnnil" none))
6748645f 1529 "*An alist of valid select methods.
eec82323
LMI
1530The first element of each list lists should be a string with the name
1531of the select method. The other elements may be the category of
1532this method (i. e., `post', `mail', `none' or whatever) or other
1533properties that this method has (like being respoolable).
1534If you implement a new select method, all you should have to change is
1535this variable. I think."
1536 :group 'gnus-server
1537 :type '(repeat (group (string :tag "Name")
1538 (radio-button-choice (const :format "%v " post)
1539 (const :format "%v " mail)
1540 (const :format "%v " none)
1541 (const post-mail))
1542 (checklist :inline t
1543 (const :format "%v " address)
1544 (const :format "%v " prompt-address)
c06fc524 1545 (const :format "%v " physical-address)
eec82323
LMI
1546 (const :format "%v " virtual)
1547 (const respool)))))
1548
16409b0b
GM
1549(defun gnus-redefine-select-method-widget ()
1550 "Recomputes the select-method widget based on the value of
1551`gnus-valid-select-methods'."
1552 (define-widget 'gnus-select-method 'list
1553 "Widget for entering a select method."
1554 :value '(nntp "")
1555 :tag "Select Method"
1556 :args `((choice :tag "Method"
1557 ,@(mapcar (lambda (entry)
1558 (list 'const :format "%v\n"
1559 (intern (car entry))))
1560 gnus-valid-select-methods)
1561 (symbol :tag "other"))
1562 (string :tag "Address")
1563 (repeat :tag "Options"
1564 :inline t
1565 (list :format "%v"
1566 variable
23f87bed 1567 (sexp :tag "Value"))))))
16409b0b
GM
1568
1569(gnus-redefine-select-method-widget)
eec82323
LMI
1570
1571(defcustom gnus-updated-mode-lines '(group article summary tree)
1572 "List of buffers that should update their mode lines.
1573The list may contain the symbols `group', `article', `tree' and
1574`summary'. If the corresponding symbol is present, Gnus will keep
1575that mode line updated with information that may be pertinent.
1576If this variable is nil, screen refresh may be quicker."
1577 :group 'gnus-various
1578 :type '(set (const group)
1579 (const article)
1580 (const summary)
1581 (const tree)))
1582
1583;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1584(defcustom gnus-mode-non-string-length nil
1585 "*Max length of mode-line non-string contents.
1586If this is nil, Gnus will take space as is needed, leaving the rest
23f87bed 1587of the mode line intact. Note that the default of nil is unlikely
eec82323
LMI
1588to be desirable; see the manual for further details."
1589 :group 'gnus-various
1590 :type '(choice (const nil)
1591 integer))
1592
23f87bed
MB
1593;; There should be special validation for this.
1594(define-widget 'gnus-email-address 'string
1595 "An email address.")
1596
1597(gnus-define-group-parameter
1598 to-address
1599 :function-document
1600 "Return GROUP's to-address."
1601 :variable-document
1602 "*Alist of group regexps and correspondent to-addresses."
e79f14a4 1603 :variable-group gnus-group-parameter
23f87bed
MB
1604 :parameter-type '(gnus-email-address :tag "To Address")
1605 :parameter-document "\
1606This will be used when doing followups and posts.
1607
1608This is primarily useful in mail groups that represent closed
1609mailing lists--mailing lists where it's expected that everybody that
1610writes to the mailing list is subscribed to it. Since using this
1611parameter ensures that the mail only goes to the mailing list itself,
1612it means that members won't receive two copies of your followups.
1613
1614Using `to-address' will actually work whether the group is foreign or
1615not. Let's say there's a group on the server that is called
1616`fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1617articles from a mail-to-news gateway. Posting directly to this group
1618is therefore impossible--you have to send mail to the mailing list
1619address instead.
1620
1621The gnus-group-split mail splitting mechanism will behave as if this
1622address was listed in gnus-group-split Addresses (see below).")
1623
1624(gnus-define-group-parameter
1625 to-list
1626 :function-document
1627 "Return GROUP's to-list."
1628 :variable-document
1629 "*Alist of group regexps and correspondent to-lists."
e79f14a4 1630 :variable-group gnus-group-parameter
23f87bed
MB
1631 :parameter-type '(gnus-email-address :tag "To List")
1632 :parameter-document "\
1633This address will be used when doing a `a' in the group.
1634
1635It is totally ignored when doing a followup--except that if it is
1636present in a news group, you'll get mail group semantics when doing
1637`f'.
1638
1639The gnus-group-split mail splitting mechanism will behave as if this
1640address was listed in gnus-group-split Addresses (see below).")
1641
1642(gnus-define-group-parameter
1643 subscribed
1644 :type bool
1645 :function-document
1646 "Return GROUP's subscription status."
1647 :variable-document
1648 "*Groups which are automatically considered subscribed."
e79f14a4 1649 :variable-group gnus-group-parameter
23f87bed
MB
1650 :parameter-type '(const :tag "Subscribed" t)
1651 :parameter-document "\
1652Gnus assumed that you are subscribed to the To/List address.
1653
1654When constructing a list of subscribed groups using
1655`gnus-find-subscribed-addresses', Gnus includes the To address given
1656above, or the list address (if the To address has not been set).")
1657
1658(gnus-define-group-parameter
1659 auto-expire
1660 :type bool
1661 :function gnus-group-auto-expirable-p
1662 :function-document
1663 "Check whether GROUP is auto-expirable or not."
1664 :variable gnus-auto-expirable-newsgroups
1665 :variable-default nil
1666 :variable-document
1667 "*Groups in which to automatically mark read articles as expirable.
eec82323
LMI
1668If non-nil, this should be a regexp that should match all groups in
1669which to perform auto-expiry. This only makes sense for mail groups."
23f87bed
MB
1670 :variable-group nnmail-expire
1671 :variable-type '(choice (const nil)
1672 regexp)
1673 :parameter-type '(const :tag "Automatic Expire" t)
1674 :parameter-document
1675 "All articles that are read will be marked as expirable.")
1676
1677(gnus-define-group-parameter
1678 total-expire
1679 :type bool
1680 :function gnus-group-total-expirable-p
1681 :function-document
1682 "Check whether GROUP is total-expirable or not."
1683 :variable gnus-total-expirable-newsgroups
1684 :variable-default nil
1685 :variable-document
1686 "*Groups in which to perform expiry of all read articles.
eec82323
LMI
1687Use with extreme caution. All groups that match this regexp will be
1688expiring - which means that all read articles will be deleted after
1689\(say) one week. (This only goes for mail groups and the like, of
1690course.)"
23f87bed
MB
1691 :variable-group nnmail-expire
1692 :variable-type '(choice (const nil)
1693 regexp)
1694 :parameter-type '(const :tag "Total Expire" t)
1695 :parameter-document
1696 "All read articles will be put through the expiry process
1697
1698This happens even if they are not marked as expirable.
1699Use with caution.")
1700
1701(gnus-define-group-parameter
1702 charset
1703 :function-document
1704 "Return the default charset of GROUP."
1705 :variable gnus-group-charset-alist
1706 :variable-default
1707 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1708 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1709 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1710 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1711 ("\\(^\\|:\\)relcom\\>" koi8-r)
1712 ("\\(^\\|:\\)fido7\\>" koi8-r)
1713 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1714 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1715 ("\\(^\\|:\\)han\\>" euc-kr)
1716 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1717 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1718 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1719 :variable-document
1720 "Alist of regexps (to match group names) and default charsets to be used when reading."
1721 :variable-group gnus-charset
1722 :variable-type '(repeat (list (regexp :tag "Group")
1723 (symbol :tag "Charset")))
1724 :parameter-type '(symbol :tag "Charset")
1725 :parameter-document "\
1726The default charset to use in the group.")
1727
1728(gnus-define-group-parameter
1729 post-method
1730 :type list
1731 :function-document
1732 "Return a posting method for GROUP."
1733 :variable gnus-post-method-alist
1734 :variable-document
1735 "Alist of regexps (to match group names) and method to be used when
1736posting an article."
1737 :variable-group gnus-group-foreign
1738 :parameter-type
1739 '(choice :tag "Posting Method"
1740 (const :tag "Use native server" native)
1741 (const :tag "Use current server" current)
1742 (list :convert-widget
1743 (lambda (widget)
1744 (list 'sexp :tag "Methods"
1745 :value gnus-select-method))))
1746 :parameter-document
1747 "Posting method for this group.")
1748
1749(gnus-define-group-parameter
1750 large-newsgroup-initial
1751 :type integer
1752 :function-document
1753 "Return GROUP's initial input of the number of articles."
1754 :variable-document
1755 "*Alist of group regexps and its initial input of the number of articles."
e79f14a4 1756 :variable-group gnus-group-parameter
23f87bed
MB
1757 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1758 (const :tag "All" nil)
1759 (integer))
1760 :parameter-document "\
1761
1762This number will be prompted as the initial value of the number of
1763articles to list when the group is a large newsgroup (see
1764`gnus-large-newsgroup'). If it is nil, the default value is the
1765total number of articles in the group.")
1766
1767;; The Gnus registry's ignored groups
1768(gnus-define-group-parameter
1769 registry-ignore
1770 :type list
1771 :function-document
1772 "Whether this group should be ignored by the registry."
1773 :variable gnus-registry-ignored-groups
1774 :variable-default nil
1775 :variable-document
1776 "*Groups in which the registry should be turned off."
1777 :variable-group gnus-registry
1778 :variable-type '(repeat
1779 (list
1780 (regexp :tag "Group Name Regular Expression")
1781 (boolean :tag "Ignored")))
1782
1783 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1784 :parameter-document
1785 "Whether the Gnus Registry should ignore this group.")
1786
1787;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1788(defcustom gnus-install-group-spam-parameters t
1789 "*Disable the group parameters for spam detection.
1790Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1791 :type 'boolean
1792 :group 'gnus-start)
1793
1794(when gnus-install-group-spam-parameters
1795 (defvar gnus-group-spam-classification-spam t
1796 "Spam group classification (requires spam.el).
1797This group contains spam messages. On summary entry, unread messages
1798will be marked as spam. On summary exit, the specified spam
1799processors will be invoked on spam-marked messages, then those
1800messages will be expired, so the spam processor will only see a
1801spam-marked message once.")
1802
1803 (defvar gnus-group-spam-classification-ham 'ask
1804 "The ham value for the spam group parameter (requires spam.el).
1805On summary exit, the specified ham processors will be invoked on
1806ham-marked messages. Exercise caution, since the ham processor will
1807see the same message more than once because there is no ham message
1808registry.")
1809
1810 (gnus-define-group-parameter
1811 spam-contents
1812 :type list
1813 :function-document
1814 "The spam type (spam, ham, or neither) of the group."
1815 :variable gnus-spam-newsgroup-contents
1816 :variable-default nil
1817 :variable-document
1818 "*Groups in which to automatically mark new articles as spam on
1819summary entry. If non-nil, this should be a list of group name
1820regexps that should match all groups in which to do automatic spam
1821tagging, associated with a classification (spam, ham, or neither).
1822This only makes sense for mail groups."
1823 :variable-group spam
1824 :variable-type '(repeat
1825 (list :tag "Group contents spam/ham classification"
1826 (regexp :tag "Group")
1827 (choice
1828 (variable-item gnus-group-spam-classification-spam)
1829 (variable-item gnus-group-spam-classification-ham)
1830 (const :tag "Unclassified" nil))))
1831
1832 :parameter-type '(list :tag "Group contents spam/ham classification"
1833 (choice :tag "Group contents classification for spam sorting"
1834 (variable-item gnus-group-spam-classification-spam)
1835 (variable-item gnus-group-spam-classification-ham)
1836 (const :tag "Unclassified" nil)))
1837 :parameter-document
1838 "The spam classification (spam, ham, or neither) of this group.
1839When a spam group is entered, all unread articles are marked as spam.")
1840
1841 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1842 "OBSOLETE: The ifile summary exit spam processor.")
1843
1844 (defvar gnus-group-spam-exit-processor-stat "stat"
1845 "OBSOLETE: The spam-stat summary exit spam processor.")
1846
1847 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1848 "OBSOLETE: The Bogofilter summary exit spam processor.")
1849
1850 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1851 "OBSOLETE: The Blacklist summary exit spam processor.")
1852
1853 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1854 "OBSOLETE: The Gmane reporting summary exit spam processor.
1855Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1856
1857 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1858 "OBSOLETE: The spamoracle summary exit spam processor.")
1859
1860 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1861 "OBSOLETE: The ifile summary exit ham processor.
1862Only applicable to non-spam (unclassified and ham) groups.")
1863
1864 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1865 "OBSOLETE: The Bogofilter summary exit ham processor.
1866Only applicable to non-spam (unclassified and ham) groups.")
1867
1868 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1869 "OBSOLETE: The spam-stat summary exit ham processor.
1870Only applicable to non-spam (unclassified and ham) groups.")
1871
1872 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1873 "OBSOLETE: The whitelist summary exit ham processor.
1874Only applicable to non-spam (unclassified and ham) groups.")
1875
1876 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1877 "OBSOLETE: The BBDB summary exit ham processor.
1878Only applicable to non-spam (unclassified and ham) groups.")
1879
1880 (defvar gnus-group-ham-exit-processor-copy "copy"
1881 "OBSOLETE: The ham copy exit ham processor.
1882Only applicable to non-spam (unclassified and ham) groups.")
1883
1884 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1885 "OBSOLETE: The spamoracle summary exit ham processor.
1886Only applicable to non-spam (unclassified and ham) groups.")
1887
1888 (gnus-define-group-parameter
1889 spam-process
1890 :type list
1891 :parameter-type
1892 '(choice
1893 :tag "Spam Summary Exit Processor"
1894 :value nil
1895 (list :tag "Spam Summary Exit Processor Choices"
1896 (set
1897 (variable-item gnus-group-spam-exit-processor-ifile)
1898 (variable-item gnus-group-spam-exit-processor-stat)
1899 (variable-item gnus-group-spam-exit-processor-bogofilter)
1900 (variable-item gnus-group-spam-exit-processor-blacklist)
1901 (variable-item gnus-group-spam-exit-processor-spamoracle)
1902 (variable-item gnus-group-spam-exit-processor-report-gmane)
1903 (variable-item gnus-group-ham-exit-processor-bogofilter)
1904 (variable-item gnus-group-ham-exit-processor-ifile)
1905 (variable-item gnus-group-ham-exit-processor-stat)
1906 (variable-item gnus-group-ham-exit-processor-whitelist)
1907 (variable-item gnus-group-ham-exit-processor-BBDB)
1908 (variable-item gnus-group-ham-exit-processor-spamoracle)
1909 (variable-item gnus-group-ham-exit-processor-copy)
1910 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1911 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1912 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1913 (const :tag "Spam: ifile" (spam spam-use-ifile))
1914 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1915 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1916 (const :tag "Ham: ifile" (ham spam-use-ifile))
1917 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1918 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1919 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1920 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1921 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1922 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1923 :function-document
1924 "Which spam or ham processors will be applied when the summary is exited."
1925 :variable gnus-spam-process-newsgroups
1926 :variable-default nil
1927 :variable-document
1928 "*Groups in which to automatically process spam or ham articles with
1929a backend on summary exit. If non-nil, this should be a list of group
1930name regexps that should match all groups in which to do automatic
1931spam processing, associated with the appropriate processor."
1932 :variable-group spam
1933 :variable-type
1934 '(repeat :tag "Spam/Ham Processors"
1935 (list :tag "Spam Summary Exit Processor Choices"
1936 (regexp :tag "Group Regexp")
1937 (set
1938 :tag "Spam/Ham Summary Exit Processor"
1939 (variable-item gnus-group-spam-exit-processor-ifile)
1940 (variable-item gnus-group-spam-exit-processor-stat)
1941 (variable-item gnus-group-spam-exit-processor-bogofilter)
1942 (variable-item gnus-group-spam-exit-processor-blacklist)
1943 (variable-item gnus-group-spam-exit-processor-spamoracle)
1944 (variable-item gnus-group-spam-exit-processor-report-gmane)
1945 (variable-item gnus-group-ham-exit-processor-bogofilter)
1946 (variable-item gnus-group-ham-exit-processor-ifile)
1947 (variable-item gnus-group-ham-exit-processor-stat)
1948 (variable-item gnus-group-ham-exit-processor-whitelist)
1949 (variable-item gnus-group-ham-exit-processor-BBDB)
1950 (variable-item gnus-group-ham-exit-processor-spamoracle)
1951 (variable-item gnus-group-ham-exit-processor-copy)
1952 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1953 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1954 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1955 (const :tag "Spam: ifile" (spam spam-use-ifile))
1956 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1957 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1958 (const :tag "Ham: ifile" (ham spam-use-ifile))
1959 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1960 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1961 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1962 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1963 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1964 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1965
1966 :parameter-document
1967 "Which spam or ham processors will be applied when the summary is exited.")
1968
1969 (gnus-define-group-parameter
1970 spam-autodetect
1971 :type list
1972 :parameter-type
1973 '(boolean :tag "Spam autodetection")
1974 :function-document
1975 "Should spam be autodetected (with spam-split) in this group?"
1976 :variable gnus-spam-autodetect
1977 :variable-default nil
1978 :variable-document
1979 "*Groups in which spam should be autodetected when they are entered.
1980 Only unseen articles will be examined, unless
1981 spam-autodetect-recheck-messages is set."
1982 :variable-group spam
1983 :variable-type
1984 '(repeat
1985 :tag "Autodetection setting"
1986 (list
1987 (regexp :tag "Group Regexp")
1988 boolean))
1989 :parameter-document
1990 "Spam autodetection.
1991Only unseen articles will be examined, unless
1992spam-autodetect-recheck-messages is set.")
1993
1994 (gnus-define-group-parameter
1995 spam-autodetect-methods
1996 :type list
1997 :parameter-type
1998 '(choice :tag "Spam autodetection-specific methods"
1999 (const none)
2000 (const default)
2001 (set :tag "Use specific methods"
2002 (variable-item spam-use-blacklist)
2003 (variable-item spam-use-regex-headers)
2004 (variable-item spam-use-regex-body)
2005 (variable-item spam-use-whitelist)
2006 (variable-item spam-use-BBDB)
2007 (variable-item spam-use-ifile)
2008 (variable-item spam-use-spamoracle)
2009 (variable-item spam-use-stat)
2010 (variable-item spam-use-blackholes)
2011 (variable-item spam-use-hashcash)
2012 (variable-item spam-use-bogofilter-headers)
2013 (variable-item spam-use-bogofilter)))
2014 :function-document
2015 "Methods to be used for autodetection in each group"
2016 :variable gnus-spam-autodetect-methods
2017 :variable-default nil
2018 :variable-document
2019 "*Methods for autodetecting spam per group.
2020Requires the spam-autodetect parameter. Only unseen articles
2021will be examined, unless spam-autodetect-recheck-messages is
2022set."
2023 :variable-group spam
2024 :variable-type
2025 '(repeat
2026 :tag "Autodetection methods"
2027 (list
2028 (regexp :tag "Group Regexp")
2029 (choice
2030 (const none)
2031 (const default)
2032 (set :tag "Use specific methods"
2033 (variable-item spam-use-blacklist)
2034 (variable-item spam-use-regex-headers)
2035 (variable-item spam-use-regex-body)
2036 (variable-item spam-use-whitelist)
2037 (variable-item spam-use-BBDB)
2038 (variable-item spam-use-ifile)
2039 (variable-item spam-use-spamoracle)
2040 (variable-item spam-use-stat)
2041 (variable-item spam-use-blackholes)
2042 (variable-item spam-use-hashcash)
2043 (variable-item spam-use-bogofilter-headers)
2044 (variable-item spam-use-bogofilter)))))
2045 :parameter-document
2046 "Spam autodetection methods.
2047Requires the spam-autodetect parameter. Only unseen articles
2048will be examined, unless spam-autodetect-recheck-messages is
2049set.")
2050
2051 (gnus-define-group-parameter
2052 spam-process-destination
2053 :type list
2054 :parameter-type
2055 '(choice :tag "Destination for spam-processed articles at summary exit"
2056 (string :tag "Move to a group")
2057 (repeat :tag "Move to multiple groups"
2058 (string :tag "Destination group"))
2059 (const :tag "Expire" nil))
2060 :function-document
2061 "Where spam-processed articles will go at summary exit."
2062 :variable gnus-spam-process-destinations
2063 :variable-default nil
2064 :variable-document
2065 "*Groups in which to explicitly send spam-processed articles to
2066another group, or expire them (the default). If non-nil, this should
2067be a list of group name regexps that should match all groups in which
2068to do spam-processed article moving, associated with the destination
2069group or nil for explicit expiration. This only makes sense for
2070mail groups."
2071 :variable-group spam
2072 :variable-type
2073 '(repeat
2074 :tag "Spam-processed articles destination"
2075 (list
2076 (regexp :tag "Group Regexp")
2077 (choice
2078 :tag "Destination for spam-processed articles at summary exit"
2079 (string :tag "Move to a group")
2080 (repeat :tag "Move to multiple groups"
2081 (string :tag "Destination group"))
2082 (const :tag "Expire" nil))))
2083 :parameter-document
2084 "Where spam-processed articles will go at summary exit.")
2085
2086 (gnus-define-group-parameter
2087 ham-process-destination
2088 :type list
2089 :parameter-type
2090 '(choice
2091 :tag "Destination for ham articles at summary exit from a spam group"
2092 (string :tag "Move to a group")
2093 (repeat :tag "Move to multiple groups"
2094 (string :tag "Destination group"))
2095 (const :tag "Respool" respool)
2096 (const :tag "Do nothing" nil))
2097 :function-document
2098 "Where ham articles will go at summary exit from a spam group."
2099 :variable gnus-ham-process-destinations
2100 :variable-default nil
2101 :variable-document
2102 "*Groups in which to explicitly send ham articles to
2103another group, or do nothing (the default). If non-nil, this should
2104be a list of group name regexps that should match all groups in which
2105to do ham article moving, associated with the destination
2106group or nil for explicit ignoring. This only makes sense for
2107mail groups, and only works in spam groups."
2108 :variable-group spam
2109 :variable-type
2110 '(repeat
2111 :tag "Ham articles destination"
2112 (list
2113 (regexp :tag "Group Regexp")
2114 (choice
2115 :tag "Destination for ham articles at summary exit from spam group"
2116 (string :tag "Move to a group")
2117 (repeat :tag "Move to multiple groups"
2118 (string :tag "Destination group"))
2119 (const :tag "Respool" respool)
2120 (const :tag "Expire" nil))))
2121 :parameter-document
2122 "Where ham articles will go at summary exit from a spam group.")
2123
2124 (gnus-define-group-parameter
2125 ham-marks
2126 :type 'list
2127 :parameter-type '(list :tag "Ham mark choices"
2128 (set
2129 (variable-item gnus-del-mark)
2130 (variable-item gnus-read-mark)
2131 (variable-item gnus-ticked-mark)
2132 (variable-item gnus-killed-mark)
2133 (variable-item gnus-kill-file-mark)
2134 (variable-item gnus-low-score-mark)))
2135
2136 :parameter-document
2137 "Marks considered ham (positively not spam). Such articles will be
2138processed as ham (non-spam) on group exit. When nil, the global
2139spam-ham-marks variable takes precedence."
2140 :variable-default '((".*" ((gnus-del-mark
2141 gnus-read-mark
2142 gnus-killed-mark
2143 gnus-kill-file-mark
2144 gnus-low-score-mark))))
2145 :variable-group spam
2146 :variable-document
2147 "*Groups in which to explicitly set the ham marks to some value.")
2148
2149 (gnus-define-group-parameter
2150 spam-marks
2151 :type 'list
2152 :parameter-type '(list :tag "Spam mark choices"
2153 (set
2154 (variable-item gnus-spam-mark)
2155 (variable-item gnus-killed-mark)
2156 (variable-item gnus-kill-file-mark)
2157 (variable-item gnus-low-score-mark)))
2158
2159 :parameter-document
2160 "Marks considered spam.
2161Such articles will be processed as spam on group exit. When nil, the global
2162spam-spam-marks variable takes precedence."
2163 :variable-default '((".*" ((gnus-spam-mark))))
2164 :variable-group spam
2165 :variable-document
2166 "*Groups in which to explicitly set the spam marks to some value."))
eec82323
LMI
2167
2168(defcustom gnus-group-uncollapsed-levels 1
2169 "Number of group name elements to leave alone when making a short group name."
2170 :group 'gnus-group-visual
2171 :type 'integer)
2172
2173(defcustom gnus-group-use-permanent-levels nil
2174 "*If non-nil, once you set a level, Gnus will use this level."
2175 :group 'gnus-group-levels
2176 :type 'boolean)
2177
2178;; Hooks.
2179
2180(defcustom gnus-load-hook nil
2181 "A hook run while Gnus is loaded."
2182 :group 'gnus-start
2183 :type 'hook)
2184
2185(defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2186 "A hook called to apply kill files to a group.
2187This hook is intended to apply a kill file to the selected newsgroup.
2188The function `gnus-apply-kill-file' is called by default.
2189
2190Since a general kill file is too heavy to use only for a few
2191newsgroups, I recommend you to use a lighter hook function. For
2192example, if you'd like to apply a kill file to articles which contains
2193a string `rmgroup' in subject in newsgroup `control', you can use the
2194following hook:
2195
2196 (setq gnus-apply-kill-hook
2197 (list
2198 (lambda ()
2199 (cond ((string-match \"control\" gnus-newsgroup-name)
2200 (gnus-kill \"Subject\" \"rmgroup\")
2201 (gnus-expunge \"X\"))))))"
2202 :group 'gnus-score-kill
2203 :options '(gnus-apply-kill-file)
2204 :type 'hook)
2205
2206(defcustom gnus-group-change-level-function nil
2207 "Function run when a group level is changed.
2208It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
16409b0b 2209 :group 'gnus-group-levels
eec82323
LMI
2210 :type 'function)
2211
2212;;; Face thingies.
2213
2214(defcustom gnus-visual
2215 '(summary-highlight group-highlight article-highlight
2216 mouse-face
2217 summary-menu group-menu article-menu
2218 tree-highlight menu highlight
2219 browse-menu server-menu
2220 page-marker tree-menu binary-menu pick-menu
2221 grouplens-menu)
6748645f 2222 "*Enable visual features.
eec82323
LMI
2223If `visual' is disabled, there will be no menus and few faces. Most of
2224the visual customization options below will be ignored. Gnus will use
2225less space and be faster as a result.
2226
2227This variable can also be a list of visual elements to switch on. For
2228instance, to switch off all visual things except menus, you can say:
2229
2230 (setq gnus-visual '(menu))
2231
2232Valid elements include `summary-highlight', `group-highlight',
2233`article-highlight', `mouse-face', `summary-menu', `group-menu',
2234`article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2235`server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2236and `grouplens-menu'."
2237 :group 'gnus-meta
2238 :group 'gnus-visual
2239 :type '(set (const summary-highlight)
2240 (const group-highlight)
2241 (const article-highlight)
2242 (const mouse-face)
2243 (const summary-menu)
2244 (const group-menu)
2245 (const article-menu)
2246 (const tree-highlight)
2247 (const menu)
2248 (const highlight)
2249 (const browse-menu)
2250 (const server-menu)
2251 (const page-marker)
2252 (const tree-menu)
2253 (const binary-menu)
2254 (const pick-menu)
2255 (const grouplens-menu)))
2256
23f87bed
MB
2257;; Byte-compiler warning.
2258(defvar gnus-visual)
2259;; Find out whether the gnus-visual TYPE is wanted.
2260(defun gnus-visual-p (&optional type class)
2261 (and gnus-visual ; Has to be non-nil, at least.
2262 (if (not type) ; We don't care about type.
2263 gnus-visual
2264 (if (listp gnus-visual) ; It's a list, so we check it.
2265 (or (memq type gnus-visual)
2266 (memq class gnus-visual))
2267 t))))
2268
eec82323
LMI
2269(defcustom gnus-mouse-face
2270 (condition-case ()
2271 (if (gnus-visual-p 'mouse-face 'highlight)
2272 (if (boundp 'gnus-mouse-face)
2273 (or gnus-mouse-face 'highlight)
2274 'highlight)
2275 'default)
2276 (error 'highlight))
6748645f 2277 "*Face used for group or summary buffer mouse highlighting.
eec82323
LMI
2278The line beneath the mouse pointer will be highlighted with this
2279face."
2280 :group 'gnus-visual
2281 :type 'face)
2282
eec82323
LMI
2283(defcustom gnus-article-save-directory gnus-directory
2284 "*Name of the directory articles will be saved in (default \"~/News\")."
2285 :group 'gnus-article-saving
2286 :type 'directory)
2287
6748645f
LMI
2288(defvar gnus-plugged t
2289 "Whether Gnus is plugged or not.")
2290
23f87bed
MB
2291(defcustom gnus-agent-cache t
2292 "Controls use of the agent cache while plugged.
2293When set, Gnus will prefer using the locally stored content rather
2294than re-fetching it from the server. You also need to enable
2295`gnus-agent' for this to have any affect."
a08b59c9 2296 :version "21.4"
23f87bed
MB
2297 :group 'gnus-agent
2298 :type 'boolean)
2299
2300(defcustom gnus-default-charset 'undecided
16409b0b
GM
2301 "Default charset assumed to be used when viewing non-ASCII characters.
2302This variable is overridden on a group-to-group basis by the
23f87bed 2303`gnus-group-charset-alist' variable and is only used on groups not
16409b0b
GM
2304covered by that variable."
2305 :type 'symbol
2306 :group 'gnus-charset)
2307
23f87bed
MB
2308;; Fixme: Doc reference to agent.
2309(defcustom gnus-agent t
2310 "Whether we want to use the Gnus agent or not.
2311
2312You may customize gnus-agent to disable its use. However, some
2313back ends have started to use the agent as a client-side cache.
2314Disabling the agent may result in noticeable loss of performance."
a08b59c9 2315 :version "21.4"
23f87bed
MB
2316 :group 'gnus-agent
2317 :type 'boolean)
2318
2319(defcustom gnus-other-frame-function 'gnus
2320 "Function called by the command `gnus-other-frame'."
2321 :group 'gnus-start
2322 :type '(choice (function-item gnus)
2323 (function-item gnus-no-server)
2324 (function-item gnus-slave)
2325 (function-item gnus-slave-no-server)))
2326
2327(defcustom gnus-other-frame-parameters nil
2328 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2329This should be an alist for Emacs, or a plist for XEmacs."
2330 :group 'gnus-start
2331 :type (if (featurep 'xemacs)
2332 '(repeat (list :inline t :format "%v"
2333 (symbol :tag "Property")
2334 (sexp :tag "Value")))
2335 '(repeat (cons :format "%v"
2336 (symbol :tag "Parameter")
2337 (sexp :tag "Value")))))
2338
2339(defcustom gnus-user-agent 'emacs-gnus-type
2340 "Which information should be exposed in the User-Agent header.
2341
2342It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2343\(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2344`emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2345`emacs-gnus' plus system type\) or a custom string. If you set it to a
2346string, be sure to use a valid format, see RFC 2616."
a08b59c9 2347 :version "21.4"
23f87bed
MB
2348 :group 'gnus-message
2349 :type '(choice
2350 (item :tag "Show Gnus and Emacs versions and system type"
2351 emacs-gnus-type)
2352 (item :tag "Show Gnus and Emacs versions and system configuration"
2353 emacs-gnus-config)
2354 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2355 (item :tag "Show only Gnus version" gnus)
2356 (string :tag "Other")))
16409b0b 2357
eec82323
LMI
2358\f
2359;;; Internal variables
2360
48df946a 2361(defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
16409b0b 2362(defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
23f87bed
MB
2363(defvar gnus-agent-method-p-cache nil
2364 ; Reset each time gnus-agent-covered-methods is changed else
2365 ; gnus-agent-method-p may mis-report a methods status.
2366 )
2367(defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2368(defvar gnus-draft-meta-information-header "X-Draft-From")
eec82323
LMI
2369(defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2370(defvar gnus-original-article-buffer " *Original Article*")
2371(defvar gnus-newsgroup-name nil)
6748645f 2372(defvar gnus-ephemeral-servers nil)
23f87bed 2373(defvar gnus-server-method-cache nil)
6748645f 2374
48df946a
DL
2375(defvar gnus-agent-fetching nil
2376 "Whether Gnus agent is in fetching mode.")
2377
23f87bed
MB
2378(defvar gnus-agent-covered-methods nil
2379 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2380
6748645f 2381(defvar gnus-command-method nil
23f87bed 2382 "Dynamically bound variable that says what the current back end is.")
eec82323
LMI
2383
2384(defvar gnus-current-select-method nil
2385 "The current method for selecting a newsgroup.")
2386
2387(defvar gnus-tree-buffer "*Tree*"
2388 "Buffer where Gnus thread trees are displayed.")
2389
2390;; Dummy variable.
2391(defvar gnus-use-generic-from nil)
2392
2393;; Variable holding the user answers to all method prompts.
2394(defvar gnus-method-history nil)
eec82323
LMI
2395
2396;; Variable holding the user answers to all mail method prompts.
2397(defvar gnus-mail-method-history nil)
2398
2399;; Variable holding the user answers to all group prompts.
2400(defvar gnus-group-history nil)
2401
2402(defvar gnus-server-alist nil
2403 "List of available servers.")
2404
6748645f
LMI
2405(defcustom gnus-cache-directory
2406 (nnheader-concat gnus-directory "cache/")
2407 "*The directory where cached articles will be stored."
2408 :group 'gnus-cache
2409 :type 'directory)
2410
eec82323
LMI
2411(defvar gnus-predefined-server-alist
2412 `(("cache"
6748645f
LMI
2413 nnspool "cache"
2414 (nnspool-spool-directory ,gnus-cache-directory)
2415 (nnspool-nov-directory ,gnus-cache-directory)
2416 (nnspool-active-file
2417 ,(nnheader-concat gnus-cache-directory "active"))))
eec82323
LMI
2418 "List of predefined (convenience) servers.")
2419
23f87bed 2420(defvar gnus-topic-indentation "") ;; Obsolete variable.
eec82323
LMI
2421
2422(defconst gnus-article-mark-lists
2423 '((marked . tick) (replied . reply)
2424 (expirable . expire) (killed . killed)
2425 (bookmarks . bookmark) (dormant . dormant)
2426 (scored . score) (saved . save)
6748645f 2427 (cached . cache) (downloadable . download)
23f87bed
MB
2428 (unsendable . unsend) (forwarded . forward)
2429 (recent . recent) (seen . seen)))
2430
2431(defconst gnus-article-special-mark-lists
2432 '((seen range)
2433 (killed range)
2434 (bookmark tuple)
2435 (score tuple)))
2436
2437;; Propagate flags to server, with the following exceptions:
2438;; `seen' is private to each gnus installation
2439;; `cache' is a internal gnus flag for each gnus installation
2440;; `download' is a agent flag private to each gnus installation
2441;; `unsend' are for nndraft groups only
2442;; `score' is not a proper mark
2443;; `bookmark': don't propagated it, or fix the bug in update-mark.
2444(defconst gnus-article-unpropagated-mark-lists
2445 '(seen cache download unsend score bookmark)
2446 "Marks that shouldn't be propagated to back ends.
2447Typical marks are those that make no sense in a standalone back end,
2448such as a mark that says whether an article is stored in the cache
2449\(which doesn't make sense in a standalone back end).")
eec82323
LMI
2450
2451(defvar gnus-headers-retrieved-by nil)
2452(defvar gnus-article-reply nil)
2453(defvar gnus-override-method nil)
2454(defvar gnus-article-check-size nil)
2455(defvar gnus-opened-servers nil)
2456
2457(defvar gnus-current-kill-article nil)
2458
2459(defvar gnus-have-read-active-file nil)
2460
2461(defconst gnus-maintainer
2462 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2463 "The mail address of the Gnus maintainers.")
2464
2465(defvar gnus-info-nodes
23f87bed
MB
2466 '((gnus-group-mode "(gnus)Group Buffer")
2467 (gnus-summary-mode "(gnus)Summary Buffer")
2468 (gnus-article-mode "(gnus)Article Buffer")
2469 (gnus-server-mode "(gnus)Server Buffer")
eec82323
LMI
2470 (gnus-browse-mode "(gnus)Browse Foreign Server")
2471 (gnus-tree-mode "(gnus)Tree Display"))
2472 "Alist of major modes and related Info nodes.")
2473
2474(defvar gnus-group-buffer "*Group*")
2475(defvar gnus-summary-buffer "*Summary*")
2476(defvar gnus-article-buffer "*Article*")
2477(defvar gnus-server-buffer "*Server*")
2478
eec82323
LMI
2479(defvar gnus-slave nil
2480 "Whether this Gnus is a slave or not.")
2481
2482(defvar gnus-batch-mode nil
2483 "Whether this Gnus is running in batch mode or not.")
2484
2485(defvar gnus-variable-list
2486 '(gnus-newsrc-options gnus-newsrc-options-n
16409b0b
GM
2487 gnus-newsrc-last-checked-date
2488 gnus-newsrc-alist gnus-server-alist
2489 gnus-killed-list gnus-zombie-list
2490 gnus-topic-topology gnus-topic-alist
2491 gnus-format-specs)
eec82323
LMI
2492 "Gnus variables saved in the quick startup file.")
2493
2494(defvar gnus-newsrc-alist nil
2495 "Assoc list of read articles.
23f87bed
MB
2496`gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2497
2498(defvar gnus-registry-alist nil
2499 "Assoc list of registry data.
2500gnus-registry.el will populate this if it's loaded.")
eec82323
LMI
2501
2502(defvar gnus-newsrc-hashtb nil
23f87bed 2503 "Hashtable of `gnus-newsrc-alist'.")
eec82323
LMI
2504
2505(defvar gnus-killed-list nil
2506 "List of killed newsgroups.")
2507
2508(defvar gnus-killed-hashtb nil
23f87bed 2509 "Hash table equivalent of `gnus-killed-list'.")
eec82323
LMI
2510
2511(defvar gnus-zombie-list nil
2512 "List of almost dead newsgroups.")
2513
2514(defvar gnus-description-hashtb nil
2515 "Descriptions of newsgroups.")
2516
2517(defvar gnus-list-of-killed-groups nil
2518 "List of newsgroups that have recently been killed by the user.")
2519
2520(defvar gnus-active-hashtb nil
2521 "Hashtable of active articles.")
2522
2523(defvar gnus-moderated-hashtb nil
2524 "Hashtable of moderated newsgroups.")
2525
2526;; Save window configuration.
2527(defvar gnus-prev-winconf nil)
2528
2529(defvar gnus-reffed-article-number nil)
2530
2531;;; Let the byte-compiler know that we know about this variable.
2532(defvar rmail-default-rmail-file)
2533
2534(defvar gnus-dead-summary nil)
2535
16409b0b
GM
2536(defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2537 "Regexp matching invalid groups.")
2538
23f87bed
MB
2539(defvar gnus-other-frame-object nil
2540 "A frame object which will be created by `gnus-other-frame'.")
2541
eec82323
LMI
2542;;; End of variables.
2543
2544;; Define some autoload functions Gnus might use.
2545(eval-and-compile
2546
2547 ;; This little mapcar goes through the list below and marks the
2548 ;; symbols in question as autoloaded functions.
2549 (mapcar
2550 (lambda (package)
2551 (let ((interactive (nth 1 (memq ':interactive package))))
2552 (mapcar
2553 (lambda (function)
2554 (let (keymap)
2555 (when (consp function)
2556 (setq keymap (car (memq 'keymap function)))
2557 (setq function (car function)))
16409b0b
GM
2558 (unless (fboundp function)
2559 (autoload function (car package) nil interactive keymap))))
eec82323 2560 (if (eq (nth 1 package) ':interactive)
16409b0b 2561 (nthcdr 3 package)
eec82323 2562 (cdr package)))))
16409b0b 2563 '(("info" :interactive t Info-goto-node)
ceaed79b 2564 ("pp" pp-to-string)
16409b0b 2565 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
eec82323 2566 ("ps-print" ps-print-preprint)
eec82323
LMI
2567 ("message" :interactive t
2568 message-send-and-exit message-yank-original)
16409b0b
GM
2569 ("babel" babel-as-string)
2570 ("nnmail" nnmail-split-fancy nnmail-article-group)
eec82323 2571 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
16409b0b 2572 ("rmailout" rmail-output rmail-output-to-rmail-file)
eec82323 2573 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
6748645f
LMI
2574 rmail-show-message rmail-summary-exists
2575 rmail-select-summary rmail-update-summary)
eec82323
LMI
2576 ("gnus-audio" :interactive t gnus-audio-play)
2577 ("gnus-xmas" gnus-xmas-splash)
2578 ("gnus-soup" :interactive t
2579 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2580 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2581 ("nnsoup" nnsoup-pack-replies)
2582 ("score-mode" :interactive t gnus-score-mode)
2583 ("gnus-mh" gnus-summary-save-article-folder
2584 gnus-Folder-save-name gnus-folder-save-name)
2585 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2586 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2587 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2588 gnus-demon-add-disconnection gnus-demon-add-handler
2589 gnus-demon-remove-handler)
2590 ("gnus-demon" :interactive t
2591 gnus-demon-init gnus-demon-cancel)
23f87bed
MB
2592 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2593 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2594 gnus-face-from-file)
eec82323
LMI
2595 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2596 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2597 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2598 gnus-nocem-unwanted-article-p)
6748645f
LMI
2599 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2600 gnus-server-server-name)
eec82323
LMI
2601 ("gnus-srvr" gnus-browse-foreign-server)
2602 ("gnus-cite" :interactive t
2603 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2604 gnus-article-hide-citation gnus-article-fill-cited-article
2605 gnus-article-hide-citation-in-followups)
2606 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2607 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
16409b0b 2608 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
eec82323
LMI
2609 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2610 gnus-cache-possibly-remove-articles gnus-cache-request-article
2611 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2612 gnus-cache-enter-remove-article gnus-cached-article-p
16409b0b
GM
2613 gnus-cache-open gnus-cache-close gnus-cache-update-article
2614 gnus-cache-articles-in-group)
2615 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2616 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2617 ("gnus-score" :interactive t
2618 gnus-summary-increase-score gnus-summary-set-score
2619 gnus-summary-raise-thread gnus-summary-raise-same-subject
2620 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2621 gnus-summary-lower-thread gnus-summary-lower-same-subject
2622 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2623 gnus-summary-current-score gnus-score-delta-default
2624 gnus-score-flush-cache gnus-score-close
2625 gnus-possibly-score-headers gnus-score-followup-article
2626 gnus-score-followup-thread)
2627 ("gnus-score"
2628 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
eec82323
LMI
2629 gnus-current-score-file-nondirectory gnus-score-adaptive
2630 gnus-score-find-trace gnus-score-file-name)
2631 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2632 ("gnus-topic" :interactive t gnus-topic-mode)
16409b0b
GM
2633 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2634 gnus-subscribe-topics)
eec82323
LMI
2635 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2636 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2637 ("gnus-uu" :interactive t
2638 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2639 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2640 gnus-uu-mark-by-regexp gnus-uu-mark-all
2641 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2642 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2643 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2644 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2645 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2646 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
6748645f 2647 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
16409b0b
GM
2648 gnus-uu-mark-over gnus-uu-post-news)
2649 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
eec82323
LMI
2650 ("gnus-msg" (gnus-summary-send-map keymap)
2651 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2652 ("gnus-msg" :interactive t
23f87bed
MB
2653 gnus-group-post-news gnus-group-mail gnus-group-news
2654 gnus-summary-post-news gnus-summary-news-other-window
eec82323
LMI
2655 gnus-summary-followup gnus-summary-followup-with-original
2656 gnus-summary-cancel-article gnus-summary-supersede-article
2657 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2658 gnus-summary-mail-forward gnus-summary-mail-other-window
2659 gnus-summary-resend-message gnus-summary-resend-bounced-mail
6748645f
LMI
2660 gnus-summary-wide-reply gnus-summary-followup-to-mail
2661 gnus-summary-followup-to-mail-with-original gnus-bug
2662 gnus-summary-wide-reply-with-original
2663 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2664 gnus-summary-post-forward)
23f87bed 2665 ("gnus-picon" :interactive t gnus-treat-from-picon)
eec82323
LMI
2666 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2667 gnus-grouplens-mode)
23f87bed 2668 ("smiley" :interactive t smiley-region)
eec82323
LMI
2669 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2670 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2671 gnus-list-of-unread-articles gnus-list-of-read-articles
2672 gnus-offer-save-summaries gnus-make-thread-indent-array
6748645f
LMI
2673 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2674 gnus-summary-skip-intangible gnus-summary-article-number
2675 gnus-data-header gnus-data-find)
eec82323
LMI
2676 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2677 gnus-group-list-groups gnus-group-first-unread-group
2678 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2679 gnus-group-setup-buffer gnus-group-get-new-news
6748645f 2680 gnus-group-make-help-group gnus-group-update-group
16409b0b 2681 gnus-group-iterate gnus-group-group-name)
eec82323
LMI
2682 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2683 gnus-backlog-remove-article)
2684 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2685 gnus-article-prepare gnus-article-set-window-start
2686 gnus-article-next-page gnus-article-prev-page
2687 gnus-request-article-this-buffer gnus-article-mode
2688 gnus-article-setup-buffer gnus-narrow-to-page
16409b0b 2689 gnus-article-delete-invisible-text gnus-treat-article)
eec82323
LMI
2690 ("gnus-art" :interactive t
2691 gnus-article-hide-headers gnus-article-hide-boring-headers
16409b0b 2692 gnus-article-treat-overstrike
eec82323
LMI
2693 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2694 gnus-article-display-x-face gnus-article-de-quoted-unreadable
16409b0b
GM
2695 gnus-article-de-base64-unreadable
2696 gnus-article-decode-HZ
2697 gnus-article-wash-html
23f87bed 2698 gnus-article-unsplit-urls
eec82323
LMI
2699 gnus-article-hide-pem gnus-article-hide-signature
2700 gnus-article-strip-leading-blank-lines gnus-article-date-local
2701 gnus-article-date-original gnus-article-date-lapsed
23f87bed 2702;; gnus-article-show-all-headers
eec82323 2703 gnus-article-edit-mode gnus-article-edit-article
16409b0b
GM
2704 gnus-article-edit-done gnus-article-decode-encoded-words
2705 gnus-start-date-timer gnus-stop-date-timer
2706 gnus-mime-view-all-parts)
eec82323
LMI
2707 ("gnus-int" gnus-request-type)
2708 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
6748645f 2709 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
eec82323
LMI
2710 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2711 gnus-dup-enter-articles)
2712 ("gnus-range" gnus-copy-sequence)
2713 ("gnus-eform" gnus-edit-form)
2714 ("gnus-move" :interactive t
2715 gnus-group-move-group-to-server gnus-change-server)
2716 ("gnus-logic" gnus-score-advanced)
2717 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2718 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2719 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2720 gnus-async-halt-prefetch)
6748645f
LMI
2721 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2722 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2723 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
23f87bed
MB
2724 gnus-summary-set-agent-mark gnus-agent-save-group-info
2725 gnus-agent-request-article gnus-agent-retrieve-headers)
6748645f
LMI
2726 ("gnus-agent" :interactive t
2727 gnus-unplugged gnus-agentize gnus-agent-batch)
eec82323 2728 ("gnus-vm" :interactive t gnus-summary-save-in-vm
6748645f 2729 gnus-summary-save-article-vm)
23f87bed
MB
2730 ("compface" uncompface)
2731 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
16409b0b
GM
2732 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2733 ("gnus-mlspl" :interactive t gnus-group-split-setup
23f87bed
MB
2734 gnus-group-split-update)
2735 ("gnus-delay" gnus-delay-initialize))))
eec82323
LMI
2736
2737;;; gnus-sum.el thingies
2738
2739
23f87bed 2740(defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323
LMI
2741 "*The format specification of the lines in the summary buffer.
2742
2743It works along the same lines as a normal formatting string,
2744with some simple extensions.
2745
2746%N Article number, left padded with spaces (string)
2747%S Subject (string)
2748%s Subject if it is at the root of a thread, and \"\" otherwise (string)
2749%n Name of the poster (string)
2750%a Extracted name of the poster (string)
2751%A Extracted address of the poster (string)
2752%F Contents of the From: header (string)
16409b0b 2753%f Contents of the From: or To: headers (string)
eec82323
LMI
2754%x Contents of the Xref: header (string)
2755%D Date of the article (string)
2756%d Date of the article (string) in DD-MMM format
23f87bed 2757%o Date of the article (string) in YYYYMMDD`T'HHMMSS format
eec82323
LMI
2758%M Message-id of the article (string)
2759%r References of the article (string)
2760%c Number of characters in the article (integer)
23f87bed
MB
2761%k Pretty-printed version of the above (string)
2762 For example, \"1.2k\" or \"0.4M\".
eec82323
LMI
2763%L Number of lines in the article (integer)
2764%I Indentation based on thread level (a string of spaces)
23f87bed
MB
2765%B A complex trn-style thread tree (string)
2766 The variables `gnus-sum-thread-*' can be used for customization.
eec82323
LMI
2767%T A string with two possible values: 80 spaces if the article
2768 is on thread level two or larger and 0 spaces on level one
2769%R \"A\" if this article has been replied to, \" \" otherwise (character)
2770%U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2771%[ Opening bracket (character, \"[\" or \"<\")
2772%] Closing bracket (character, \"]\" or \">\")
2773%> Spaces of length thread-level (string)
2774%< Spaces of length (- 20 thread-level) (string)
2775%i Article score (number)
2776%z Article zcore (character)
2777%t Number of articles under the current thread (number).
2778%e Whether the thread is empty or not (character).
2779%l GroupLens score (string).
2780%V Total thread score (number).
2781%P The line number (number).
6748645f 2782%O Download mark (character).
23f87bed
MB
2783%* If present, indicates desired cursor position
2784 (instead of after first colon).
eec82323
LMI
2785%u User defined specifier. The next character in the format string should
2786 be a letter. Gnus will call the function gnus-user-format-function-X,
2787 where X is the letter following %u. The function will be passed the
2788 current header as argument. The function should return a string, which
2789 will be inserted into the summary just like information from any other
2790 summary specifier.
2791
eec82323
LMI
2792The %U (status), %R (replied) and %z (zcore) specs have to be handled
2793with care. For reasons of efficiency, Gnus will compute what column
2794these characters will end up in, and \"hard-code\" that. This means that
16409b0b 2795it is invalid to have these specs after a variable-length spec. Well,
eec82323
LMI
2796you might not be arrested, but your summary buffer will look strange,
2797which is bad enough.
2798
23f87bed 2799The smart choice is to have these specs as far to the left as
eec82323
LMI
2800possible.
2801
23f87bed
MB
2802This restriction may disappear in later versions of Gnus.
2803
2804General format specifiers can also be used.
2805See Info node `(gnus)Formatting Variables'."
2806 :link '(custom-manual "(gnus)Formatting Variables")
eec82323
LMI
2807 :type 'string
2808 :group 'gnus-summary-format)
2809
2810;;;
2811;;; Skeleton keymaps
2812;;;
2813
2814(defun gnus-suppress-keymap (keymap)
2815 (suppress-keymap keymap)
6748645f 2816 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
eec82323
LMI
2817 (while keys
2818 (define-key keymap (pop keys) 'undefined))))
2819
2820(defvar gnus-article-mode-map
16409b0b 2821 (let ((keymap (make-sparse-keymap)))
eec82323
LMI
2822 (gnus-suppress-keymap keymap)
2823 keymap))
2824(defvar gnus-summary-mode-map
2825 (let ((keymap (make-keymap)))
2826 (gnus-suppress-keymap keymap)
2827 keymap))
2828(defvar gnus-group-mode-map
2829 (let ((keymap (make-keymap)))
2830 (gnus-suppress-keymap keymap)
2831 keymap))
2832
2833\f
2834
2835;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2836;; If you want the cursor to go somewhere else, set these two
2837;; functions in some startup hook to whatever you want.
2838(defalias 'gnus-summary-position-point 'gnus-goto-colon)
2839(defalias 'gnus-group-position-point 'gnus-goto-colon)
2840
2841;;; Various macros and substs.
2842
2843(defun gnus-header-from (header)
2844 (mail-header-from header))
2845
2846(defmacro gnus-gethash (string hashtable)
2847 "Get hash value of STRING in HASHTABLE."
2848 `(symbol-value (intern-soft ,string ,hashtable)))
2849
23f87bed
MB
2850(defmacro gnus-gethash-safe (string hashtable)
2851 "Get hash value of STRING in HASHTABLE.
2852Return nil if not defined."
2853 `(let ((sym (intern-soft ,string ,hashtable)))
2854 (and (boundp sym) (symbol-value sym))))
2855
eec82323
LMI
2856(defmacro gnus-sethash (string value hashtable)
2857 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2858 `(set (intern ,string ,hashtable) ,value))
2859(put 'gnus-sethash 'edebug-form-spec '(form form form))
2860
2861(defmacro gnus-group-unread (group)
2862 "Get the currently computed number of unread articles in GROUP."
2863 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2864
2865(defmacro gnus-group-entry (group)
2866 "Get the newsrc entry for GROUP."
2867 `(gnus-gethash ,group gnus-newsrc-hashtb))
2868
2869(defmacro gnus-active (group)
2870 "Get active info on GROUP."
2871 `(gnus-gethash ,group gnus-active-hashtb))
2872
2873(defmacro gnus-set-active (group active)
2874 "Set GROUP's active info."
2875 `(gnus-sethash ,group ,active gnus-active-hashtb))
2876
eec82323
LMI
2877;; Info access macros.
2878
2879(defmacro gnus-info-group (info)
2880 `(nth 0 ,info))
2881(defmacro gnus-info-rank (info)
2882 `(nth 1 ,info))
2883(defmacro gnus-info-read (info)
2884 `(nth 2 ,info))
2885(defmacro gnus-info-marks (info)
2886 `(nth 3 ,info))
2887(defmacro gnus-info-method (info)
2888 `(nth 4 ,info))
2889(defmacro gnus-info-params (info)
2890 `(nth 5 ,info))
2891
2892(defmacro gnus-info-level (info)
2893 `(let ((rank (gnus-info-rank ,info)))
2894 (if (consp rank)
2895 (car rank)
2896 rank)))
2897(defmacro gnus-info-score (info)
2898 `(let ((rank (gnus-info-rank ,info)))
2899 (or (and (consp rank) (cdr rank)) 0)))
2900
2901(defmacro gnus-info-set-group (info group)
2902 `(setcar ,info ,group))
2903(defmacro gnus-info-set-rank (info rank)
2904 `(setcar (nthcdr 1 ,info) ,rank))
2905(defmacro gnus-info-set-read (info read)
2906 `(setcar (nthcdr 2 ,info) ,read))
2907(defmacro gnus-info-set-marks (info marks &optional extend)
2908 (if extend
2909 `(gnus-info-set-entry ,info ,marks 3)
2910 `(setcar (nthcdr 3 ,info) ,marks)))
2911(defmacro gnus-info-set-method (info method &optional extend)
2912 (if extend
2913 `(gnus-info-set-entry ,info ,method 4)
2914 `(setcar (nthcdr 4 ,info) ,method)))
2915(defmacro gnus-info-set-params (info params &optional extend)
2916 (if extend
2917 `(gnus-info-set-entry ,info ,params 5)
2918 `(setcar (nthcdr 5 ,info) ,params)))
2919
2920(defun gnus-info-set-entry (info entry number)
2921 ;; Extend the info until we have enough elements.
2922 (while (<= (length info) number)
2923 (nconc info (list nil)))
2924 ;; Set the entry.
2925 (setcar (nthcdr number info) entry))
2926
2927(defmacro gnus-info-set-level (info level)
2928 `(let ((rank (cdr ,info)))
2929 (if (consp (car rank))
2930 (setcar (car rank) ,level)
2931 (setcar rank ,level))))
2932(defmacro gnus-info-set-score (info score)
2933 `(let ((rank (cdr ,info)))
2934 (if (consp (car rank))
2935 (setcdr (car rank) ,score)
2936 (setcar rank (cons (car rank) ,score)))))
2937
2938(defmacro gnus-get-info (group)
2939 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2940
8f688cb0 2941;;; Load the compatibility functions.
eec82323
LMI
2942
2943(require 'gnus-ems)
2944
2945\f
2946;;;
2947;;; Shutdown
2948;;;
2949
2950(defvar gnus-shutdown-alist nil)
2951
2952(defun gnus-add-shutdown (function &rest symbols)
2953 "Run FUNCTION whenever one of SYMBOLS is shut down."
2954 (push (cons function symbols) gnus-shutdown-alist))
2955
2956(defun gnus-shutdown (symbol)
2957 "Shut down everything that waits for SYMBOL."
2958 (let ((alist gnus-shutdown-alist)
2959 entry)
2960 (while (setq entry (pop alist))
2961 (when (memq symbol (cdr entry))
2962 (funcall (car entry))))))
2963
2964\f
2965;;;
2966;;; Gnus Utility Functions
2967;;;
2968
23f87bed
MB
2969(defun gnus-find-subscribed-addresses ()
2970 "Return a regexp matching the addresses of all subscribed mail groups.
2971It consists of the `to-address' or `to-list' parameter of all groups
2972with a `subscribed' parameter."
2973 (let (group address addresses)
2974 (dolist (entry (cdr gnus-newsrc-alist))
2975 (setq group (car entry))
2976 (when (gnus-parameter-subscribed group)
2977 (setq address (mail-strip-quoted-names
2978 (or (gnus-group-fast-parameter group 'to-address)
2979 (gnus-group-fast-parameter group 'to-list))))
2980 (when address
2981 (add-to-list 'addresses address))))
2982 (when addresses
2983 (list (mapconcat 'regexp-quote addresses "\\|")))))
6748645f 2984
a8151ef7
LMI
2985(defmacro gnus-string-or (&rest strings)
2986 "Return the first element of STRINGS that is a non-blank string.
2987STRINGS will be evaluated in normal `or' order."
2988 `(gnus-string-or-1 ',strings))
2989
2990(defun gnus-string-or-1 (strings)
2991 (let (string)
2992 (while strings
2993 (setq string (eval (pop strings)))
2994 (if (string-match "^[ \t]*$" string)
2995 (setq string nil)
2996 (setq strings nil)))
2997 string))
2998
eec82323
LMI
2999(defun gnus-version (&optional arg)
3000 "Version number of this version of Gnus.
3001If ARG, insert string at point."
3002 (interactive "P")
6748645f
LMI
3003 (if arg
3004 (insert (message gnus-version))
3005 (message gnus-version)))
eec82323 3006
23f87bed 3007(defun gnus-continuum-version (&optional version)
eec82323 3008 "Return VERSION as a floating point number."
23f87bed
MB
3009 (interactive)
3010 (unless version
3011 (setq version gnus-version))
eec82323
LMI
3012 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3013 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
6748645f
LMI
3014 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3015 (number (match-string 2 version))
3016 major minor least)
3017 (unless (string-match
3018 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3019 (error "Invalid version string: %s" version))
3020 (setq major (string-to-number (match-string 1 number))
3021 minor (string-to-number (match-string 2 number))
3022 least (if (match-beginning 3)
eec82323
LMI
3023 (string-to-number (match-string 3 number))
3024 0))
3025 (string-to-number
3026 (if (zerop major)
23f87bed
MB
3027 (format "%s00%02d%02d"
3028 (if (member alpha '("(ding)" "d"))
3029 "4.99"
3030 (+ 5 (* 0.02
3031 (abs
3032 (- (mm-char-int (aref (downcase alpha) 0))
3033 (mm-char-int ?t))))
3034 -0.01))
3035 minor least)
eec82323
LMI
3036 (format "%d.%02d%02d" major minor least))))))
3037
23f87bed 3038(defun gnus-info-find-node (&optional nodename)
eec82323
LMI
3039 "Find Info documentation of Gnus."
3040 (interactive)
3041 ;; Enlarge info window if needed.
3042 (let (gnus-info-buffer)
23f87bed 3043 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
eec82323
LMI
3044 (setq gnus-info-buffer (current-buffer))
3045 (gnus-configure-windows 'info)))
3046
6748645f
LMI
3047;;;
3048;;; gnus-interactive
3049;;;
3050
3051(defvar gnus-current-prefix-symbol nil
3052 "Current prefix symbol.")
3053
3054(defvar gnus-current-prefix-symbols nil
3055 "List of current prefix symbols.")
3056
3057(defun gnus-interactive (string &optional params)
3058 "Return a list that can be fed to `interactive'.
3059See `interactive' for full documentation.
3060
3061Adds the following specs:
3062
3063y -- The current symbolic prefix.
3064Y -- A list of the current symbolic prefix(es).
3065A -- Article number.
3066H -- Article header.
3067g -- Group name."
3068 (let ((i 0)
3069 out c prompt)
3070 (while (< i (length string))
3071 (string-match ".\\([^\n]*\\)\n?" string i)
3072 (setq c (aref string i))
3073 (when (match-end 1)
3074 (setq prompt (match-string 1 string)))
3075 (setq i (match-end 0))
3076 ;; We basically emulate just about everything that
3077 ;; `interactive' does, but add the specs listed above.
3078 (push
3079 (cond
3080 ((= c ?a)
3081 (completing-read prompt obarray 'fboundp t))
3082 ((= c ?b)
3083 (read-buffer prompt (current-buffer) t))
3084 ((= c ?B)
3085 (read-buffer prompt (other-buffer (current-buffer))))
3086 ((= c ?c)
3087 (read-char))
3088 ((= c ?C)
3089 (completing-read prompt obarray 'commandp t))
3090 ((= c ?d)
3091 (point))
3092 ((= c ?D)
3093 (read-file-name prompt nil default-directory 'lambda))
3094 ((= c ?f)
3095 (read-file-name prompt nil nil 'lambda))
3096 ((= c ?F)
3097 (read-file-name prompt))
3098 ((= c ?k)
3099 (read-key-sequence prompt))
3100 ((= c ?K)
3101 (error "Not implemented spec"))
3102 ((= c ?e)
3103 (error "Not implemented spec"))
3104 ((= c ?m)
3105 (mark))
3106 ((= c ?N)
3107 (error "Not implemented spec"))
3108 ((= c ?n)
3109 (string-to-number (read-from-minibuffer prompt)))
3110 ((= c ?p)
3111 (prefix-numeric-value current-prefix-arg))
3112 ((= c ?P)
3113 current-prefix-arg)
3114 ((= c ?r)
3115 'gnus-prefix-nil)
3116 ((= c ?s)
3117 (read-string prompt))
3118 ((= c ?S)
3119 (intern (read-string prompt)))
3120 ((= c ?v)
3121 (read-variable prompt))
3122 ((= c ?x)
3123 (read-minibuffer prompt))
3124 ((= c ?x)
3125 (eval-minibuffer prompt))
3126 ;; And here the new specs come.
3127 ((= c ?y)
3128 gnus-current-prefix-symbol)
3129 ((= c ?Y)
3130 gnus-current-prefix-symbols)
3131 ((= c ?g)
3132 (gnus-group-group-name))
3133 ((= c ?A)
3134 (gnus-summary-skip-intangible)
3135 (or (get-text-property (point) 'gnus-number)
3136 (gnus-summary-last-subject)))
3137 ((= c ?H)
3138 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3139 (t
3140 (error "Non-implemented spec")))
3141 out)
3142 (cond
3143 ((= c ?r)
fa066d09
GM
3144 (push (if (< (point) (mark)) (point) (mark)) out)
3145 (push (if (> (point) (mark)) (point) (mark)) out))))
6748645f
LMI
3146 (setq out (delq 'gnus-prefix-nil out))
3147 (nreverse out)))
3148
3149(defun gnus-symbolic-argument (&optional arg)
3150 "Read a symbolic argument and a command, and then execute command."
3151 (interactive "P")
3152 (let* ((in-command (this-command-keys))
3153 (command in-command)
3154 gnus-current-prefix-symbols
3155 gnus-current-prefix-symbol
3156 syms)
3157 (while (equal in-command command)
3158 (message "%s-" (key-description (this-command-keys)))
3159 (push (intern (char-to-string (read-char))) syms)
3160 (setq command (read-key-sequence nil t)))
3161 (setq gnus-current-prefix-symbols (nreverse syms)
3162 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3163 (call-interactively (key-binding command t))))
3164
eec82323
LMI
3165;;; More various functions.
3166
a36c8d02
RS
3167(defsubst gnus-check-backend-function (func group)
3168 "Check whether GROUP supports function FUNC.
3169GROUP can either be a string (a group name) or a select method."
3170 (ignore-errors
3171 (let ((method (if (stringp group)
3172 (car (gnus-find-method-for-group group))
3173 group)))
3174 (unless (featurep method)
3175 (require method))
3176 (fboundp (intern (format "%s-%s" method func))))))
3177
eec82323
LMI
3178(defun gnus-group-read-only-p (&optional group)
3179 "Check whether GROUP supports editing or not.
3180If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3181that that variable is buffer-local to the summary buffers."
3182 (let ((group (or group gnus-newsgroup-name)))
3183 (not (gnus-check-backend-function 'request-replace-article group))))
3184
eec82323
LMI
3185(defun gnus-virtual-group-p (group)
3186 "Say whether GROUP is virtual or not."
3187 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3188 gnus-valid-select-methods)))
3189
3190(defun gnus-news-group-p (group &optional article)
3191 "Return non-nil if GROUP (and ARTICLE) come from a news server."
23f87bed
MB
3192 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3193 t) ;is news of course.
3194 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3195 nil) ;must be mail then.
3196 ((vectorp article) ;Has header info.
3197 (eq (gnus-request-type group (mail-header-id article)) 'news))
3198 ((null article) ;Hasn't header info
3199 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3200 ((< article 0) ;Virtual message
3201 nil) ;we don't know, guess mail.
3202 (t ;Has positive number
3203 (eq (gnus-request-type group article) 'news)))) ;use it.
eec82323
LMI
3204
3205;; Returns a list of writable groups.
3206(defun gnus-writable-groups ()
3207 (let ((alist gnus-newsrc-alist)
3208 groups group)
3209 (while (setq group (car (pop alist)))
3210 (unless (gnus-group-read-only-p group)
3211 (push group groups)))
3212 (nreverse groups)))
3213
3214;; Check whether to use long file names.
3215(defun gnus-use-long-file-name (symbol)
3216 ;; The variable has to be set...
3217 (and gnus-use-long-file-name
3218 ;; If it isn't a list, then we return t.
3219 (or (not (listp gnus-use-long-file-name))
3220 ;; If it is a list, and the list contains `symbol', we
3221 ;; return nil.
3222 (not (memq symbol gnus-use-long-file-name)))))
3223
3224;; Generate a unique new group name.
3225(defun gnus-generate-new-group-name (leaf)
3226 (let ((name leaf)
3227 (num 0))
3228 (while (gnus-gethash name gnus-newsrc-hashtb)
3229 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3230 name))
3231
3232(defun gnus-ephemeral-group-p (group)
3233 "Say whether GROUP is ephemeral or not."
6748645f 3234 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3235
3236(defun gnus-group-quit-config (group)
3237 "Return the quit-config of GROUP."
6748645f 3238 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3239
3240(defun gnus-kill-ephemeral-group (group)
3241 "Remove ephemeral GROUP from relevant structures."
3242 (gnus-sethash group nil gnus-newsrc-hashtb))
3243
3244(defun gnus-simplify-mode-line ()
3245 "Make mode lines a bit simpler."
a8151ef7 3246 (setq mode-line-modified (cdr gnus-mode-line-modified))
eec82323
LMI
3247 (when (listp mode-line-format)
3248 (make-local-variable 'mode-line-format)
3249 (setq mode-line-format (copy-sequence mode-line-format))
3250 (when (equal (nth 3 mode-line-format) " ")
3251 (setcar (nthcdr 3 mode-line-format) " "))))
3252
3253;;; Servers and groups.
3254
3255(defsubst gnus-server-add-address (method)
3256 (let ((method-name (symbol-name (car method))))
3257 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3258 (not (assq (intern (concat method-name "-address")) method))
3259 (memq 'physical-address (assq (car method)
3260 gnus-valid-select-methods)))
3261 (append method (list (list (intern (concat method-name "-address"))
3262 (nth 1 method))))
3263 method)))
3264
23f87bed
MB
3265(defsubst gnus-server-to-method (server)
3266 "Map virtual server names to select methods."
3267 (or (and server (listp server) server)
3268 (cdr (assoc server gnus-server-method-cache))
3269 (let ((result
3270 (or
3271 ;; Perhaps this is the native server?
3272 (and (equal server "native") gnus-select-method)
3273 ;; It should be in the server alist.
3274 (cdr (assoc server gnus-server-alist))
3275 ;; It could be in the predefined server alist.
3276 (cdr (assoc server gnus-predefined-server-alist))
3277 ;; If not, we look through all the opened server
3278 ;; to see whether we can find it there.
3279 (let ((opened gnus-opened-servers))
3280 (while (and opened
3281 (not (equal server (format "%s:%s" (caaar opened)
3282 (cadaar opened)))))
3283 (pop opened))
3284 (caar opened))
3285 ;; It could be a named method, search all servers
3286 (let ((servers gnus-secondary-select-methods))
3287 (while (and servers
3288 (not (equal server (format "%s:%s" (caar servers)
3289 (cadar servers)))))
3290 (pop servers))
3291 (car servers))
3292 ;; This could be some sort of foreign server that I
3293 ;; simply haven't opened (yet). Do a brute-force scan
3294 ;; of the entire gnus-newsrc-alist for the server name
3295 ;; of every method. As a side-effect, loads the
3296 ;; gnus-server-method-cache so this only happens once,
3297 ;; if at all.
3298 (let (match)
3299 (mapcar
3300 (lambda (info)
3301 (let ((info-method (gnus-info-method info)))
3302 (unless (stringp info-method)
3303 (let ((info-server (gnus-method-to-server info-method)))
3304 (when (equal server info-server)
3305 (setq match info-method))))))
3306 (cdr gnus-newsrc-alist))
3307 match))))
3308 (when result
3309 (push (cons server result) gnus-server-method-cache))
3310 result)))
3311
3312(defsubst gnus-method-to-server (method)
3313 (catch 'server-name
3314 (setq method (or method gnus-select-method))
3315
3316 ;; Perhaps it is already in the cache.
3317 (mapc (lambda (name-method)
3318 (if (equal (cdr name-method) method)
3319 (throw 'server-name (car name-method))))
3320 gnus-server-method-cache)
3321
3322 (mapc
3323 (lambda (server-alist)
3324 (mapc (lambda (name-method)
3325 (when (gnus-methods-equal-p (cdr name-method) method)
3326 (unless (member name-method gnus-server-method-cache)
3327 (push name-method gnus-server-method-cache))
3328 (throw 'server-name (car name-method))))
3329 server-alist))
3330 (let ((alists (list gnus-server-alist
3331 gnus-predefined-server-alist)))
3332 (if gnus-select-method
3333 (push (list (cons "native" gnus-select-method)) alists))
3334 alists))
3335
3336 (let* ((name (if (member (cadr method) '(nil ""))
3337 (format "%s" (car method))
3338 (format "%s:%s" (car method) (cadr method))))
3339 (name-method (cons name method)))
3340 (unless (member name-method gnus-server-method-cache)
3341 (push name-method gnus-server-method-cache))
3342 name)))
3343
eec82323
LMI
3344(defsubst gnus-server-get-method (group method)
3345 ;; Input either a server name, and extended server name, or a
3346 ;; select method, and return a select method.
3347 (cond ((stringp method)
3348 (gnus-server-to-method method))
3349 ((equal method gnus-select-method)
3350 gnus-select-method)
6748645f
LMI
3351 ((and (stringp (car method))
3352 group)
eec82323 3353 (gnus-server-extend-method group method))
6748645f
LMI
3354 ((and method
3355 (not group)
eec82323
LMI
3356 (equal (cadr method) ""))
3357 method)
3358 (t
3359 (gnus-server-add-address method))))
3360
eec82323
LMI
3361(defmacro gnus-method-equal (ss1 ss2)
3362 "Say whether two servers are equal."
3363 `(let ((s1 ,ss1)
3364 (s2 ,ss2))
3365 (or (equal s1 s2)
3366 (and (= (length s1) (length s2))
3367 (progn
3368 (while (and s1 (member (car s1) s2))
3369 (setq s1 (cdr s1)))
3370 (null s1))))))
3371
16409b0b
GM
3372(defun gnus-methods-equal-p (m1 m2)
3373 (let ((m1 (or m1 gnus-select-method))
3374 (m2 (or m2 gnus-select-method)))
3375 (or (equal m1 m2)
3376 (and (eq (car m1) (car m2))
3377 (or (not (memq 'address (assoc (symbol-name (car m1))
3378 gnus-valid-select-methods)))
3379 (equal (nth 1 m1) (nth 1 m2)))))))
3380
eec82323
LMI
3381(defun gnus-server-equal (m1 m2)
3382 "Say whether two methods are equal."
3383 (let ((m1 (cond ((null m1) gnus-select-method)
3384 ((stringp m1) (gnus-server-to-method m1))
3385 (t m1)))
3386 (m2 (cond ((null m2) gnus-select-method)
3387 ((stringp m2) (gnus-server-to-method m2))
3388 (t m2))))
3389 (gnus-method-equal m1 m2)))
3390
3391(defun gnus-servers-using-backend (backend)
3392 "Return a list of known servers using BACKEND."
3393 (let ((opened gnus-opened-servers)
3394 out)
3395 (while opened
3396 (when (eq backend (caaar opened))
3397 (push (caar opened) out))
3398 (pop opened))
3399 out))
3400
3401(defun gnus-archive-server-wanted-p ()
3402 "Say whether the user wants to use the archive server."
3403 (cond
3404 ((or (not gnus-message-archive-method)
3405 (not gnus-message-archive-group))
3406 nil)
3407 ((and gnus-message-archive-method gnus-message-archive-group)
3408 t)
3409 (t
3410 (let ((active (cadr (assq 'nnfolder-active-file
3411 gnus-message-archive-method))))
3412 (and active
3413 (file-exists-p active))))))
3414
23f87bed
MB
3415(defsubst gnus-method-to-server-name (method)
3416 (concat
3417 (format "%s" (car method))
3418 (when (and
3419 (or (assoc (format "%s" (car method))
3420 (gnus-methods-using 'address))
3421 (gnus-server-equal method gnus-message-archive-method))
3422 (nth 1 method)
3423 (not (string= (nth 1 method) "")))
3424 (concat "+" (nth 1 method)))))
3425
3426(defsubst gnus-method-to-full-server-name (method)
3427 (format "%s+%s" (car method) (nth 1 method)))
3428
3429(defun gnus-group-prefixed-name (group method &optional full)
3430 "Return the whole name from GROUP and METHOD.
3431Call with full set to get the fully qualified group name (even if the
3432server is native)."
3433 (when (stringp method)
3434 (setq method (gnus-server-to-method method)))
6748645f 3435 (if (or (not method)
23f87bed
MB
3436 (and (not full) (gnus-server-equal method "native"))
3437 ;;;!!! This might not be right. We'll see...
3438 ;(string-match ":" group)
3439 )
eec82323 3440 group
23f87bed
MB
3441 (concat (gnus-method-to-server-name method) ":" group)))
3442
3443(defun gnus-group-guess-prefixed-name (group)
3444 "Guess the whole name from GROUP and METHOD."
3445 (gnus-group-prefixed-name group (gnus-find-method-for-group
3446 group)))
3447
3448(defun gnus-group-full-name (group method)
3449 "Return the full name from GROUP and METHOD, even if the method is native."
3450 (gnus-group-prefixed-name group method t))
3451
3452(defun gnus-group-guess-full-name (group)
3453 "Guess the full name from GROUP, even if the method is native."
3454 (if (gnus-group-prefixed-p group)
3455 group
3456 (gnus-group-full-name group (gnus-find-method-for-group group))))
3457
3458(defun gnus-group-guess-full-name-from-command-method (group)
3459 "Guess the full name from GROUP, even if the method is native."
3460 (if (gnus-group-prefixed-p group)
3461 group
3462 (gnus-group-full-name group gnus-command-method)))
eec82323
LMI
3463
3464(defun gnus-group-real-prefix (group)
3465 "Return the prefix of the current group name."
23f87bed
MB
3466 (if (stringp group)
3467 (if (string-match "^[^:]+:" group)
3468 (substring group 0 (match-end 0))
3469 "")
3470 nil))
3471
3472(defun gnus-group-short-name (group)
3473 "Return the short group name."
3474 (let ((prefix (gnus-group-real-prefix group)))
3475 (if (< 0 (length prefix))
3476 (substring group (length prefix) nil)
3477 group)))
3478
3479(defun gnus-group-prefixed-p (group)
3480 "Return the prefix of the current group name."
3481 (< 0 (length (gnus-group-real-prefix group))))
3482
3483(defun gnus-summary-buffer-name (group)
3484 "Return the summary buffer name of GROUP."
3485 (concat "*Summary " (gnus-group-decoded-name group) "*"))
eec82323
LMI
3486
3487(defun gnus-group-method (group)
3488 "Return the server or method used for selecting GROUP.
3489You should probably use `gnus-find-method-for-group' instead."
3490 (let ((prefix (gnus-group-real-prefix group)))
3491 (if (equal prefix "")
3492 gnus-select-method
3493 (let ((servers gnus-opened-servers)
3494 (server "")
3495 backend possible found)
3496 (if (string-match "^[^\\+]+\\+" prefix)
3497 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3498 server (substring prefix (match-end 0) (1- (length prefix))))
3499 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3500 (while servers
3501 (when (eq (caaar servers) backend)
3502 (setq possible (caar servers))
3503 (when (equal (cadaar servers) server)
3504 (setq found (caar servers))))
3505 (pop servers))
3506 (or (car (rassoc found gnus-server-alist))
3507 found
3508 (car (rassoc possible gnus-server-alist))
3509 possible
3510 (list backend server))))))
3511
16409b0b
GM
3512(defsubst gnus-native-method-p (method)
3513 "Return whether METHOD is the native select method."
3514 (gnus-method-equal method gnus-select-method))
3515
eec82323
LMI
3516(defsubst gnus-secondary-method-p (method)
3517 "Return whether METHOD is a secondary select method."
3518 (let ((methods gnus-secondary-select-methods)
23f87bed 3519 (gmethod (inline (gnus-server-get-method nil method))))
eec82323 3520 (while (and methods
16409b0b 3521 (not (gnus-method-equal
23f87bed 3522 (inline (gnus-server-get-method nil (car methods)))
16409b0b 3523 gmethod)))
eec82323
LMI
3524 (setq methods (cdr methods)))
3525 methods))
3526
16409b0b
GM
3527(defun gnus-method-simplify (method)
3528 "Return the shortest uniquely identifying string or method for METHOD."
3529 (cond ((stringp method)
3530 method)
3531 ((gnus-native-method-p method)
3532 nil)
3533 ((gnus-secondary-method-p method)
3534 (format "%s:%s" (nth 0 method) (nth 1 method)))
3535 (t
3536 method)))
3537
6748645f
LMI
3538(defun gnus-groups-from-server (server)
3539 "Return a list of all groups that are fetched from SERVER."
3540 (let ((alist (cdr gnus-newsrc-alist))
3541 info groups)
3542 (while (setq info (pop alist))
3543 (when (gnus-server-equal (gnus-info-method info) server)
3544 (push (gnus-info-group info) groups)))
3545 (sort groups 'string<)))
3546
eec82323
LMI
3547(defun gnus-group-foreign-p (group)
3548 "Say whether a group is foreign or not."
3549 (and (not (gnus-group-native-p group))
3550 (not (gnus-group-secondary-p group))))
3551
3552(defun gnus-group-native-p (group)
3553 "Say whether the group is native or not."
3554 (not (string-match ":" group)))
3555
3556(defun gnus-group-secondary-p (group)
3557 "Say whether the group is secondary or not."
3558 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3559
23f87bed
MB
3560(defun gnus-parameters-get-parameter (group)
3561 "Return the group parameters for GROUP from `gnus-parameters'."
3562 (let (params-list)
3563 (dolist (elem gnus-parameters)
3564 (when (string-match (car elem) group)
3565 (setq params-list
3566 (nconc (gnus-expand-group-parameters
3567 (car elem) (cdr elem) group)
3568 params-list))))
3569 params-list))
3570
3571(defun gnus-expand-group-parameter (match value group)
3572 "Use MATCH to expand VALUE in GROUP."
3573 (with-temp-buffer
3574 (insert group)
3575 (goto-char (point-min))
3576 (while (re-search-forward match nil t)
3577 (replace-match value))
3578 (buffer-string)))
3579
3580(defun gnus-expand-group-parameters (match parameters group)
3581 "Go through PARAMETERS and expand them according to the match data."
3582 (let (new)
3583 (dolist (elem parameters)
3584 (if (and (stringp (cdr elem))
3585 (string-match "\\\\[0-9&]" (cdr elem)))
3586 (push (cons (car elem)
3587 (gnus-expand-group-parameter match (cdr elem) group))
3588 new)
3589 (push elem new)))
3590 new))
3591
3592(defun gnus-group-fast-parameter (group symbol &optional allow-list)
3593 "For GROUP, return the value of SYMBOL.
3594
3595You should call this in the `gnus-group-buffer' buffer.
3596The function `gnus-group-find-parameter' will do that for you."
3597 ;; The speed trick: No cons'ing and quit early.
3598 (let* ((params (funcall gnus-group-get-parameter-function group))
3599 ;; Start easy, check the "real" group parameters.
3600 (simple-results
3601 (gnus-group-parameter-value params symbol allow-list t)))
3602 (if simple-results
3603 ;; Found results; return them.
3604 (car simple-results)
3605 ;; We didn't found it there, try `gnus-parameters'.
3606 (let ((result nil)
3607 (head nil)
3608 (tail gnus-parameters))
3609 ;; A good old-fashioned non-cl loop.
3610 (while tail
3611 (setq head (car tail)
3612 tail (cdr tail))
3613 ;; The car is regexp matching for matching the group name.
3614 (when (string-match (car head) group)
3615 ;; The cdr is the parameters.
3616 (setq result (gnus-group-parameter-value (cdr head)
3617 symbol allow-list))
3618 (when result
3619 ;; Expand if necessary.
3620 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3621 (setq result (gnus-expand-group-parameter (car head)
3622 result group)))
3623 ;; Exit the loop early.
3624 (setq tail nil))))
3625 ;; Done.
3626 result))))
3627
6748645f 3628(defun gnus-group-find-parameter (group &optional symbol allow-list)
eec82323 3629 "Return the group parameters for GROUP.
23f87bed
MB
3630If SYMBOL, return the value of that symbol in the group parameters.
3631
3632If you call this function inside a loop, consider using the faster
3633`gnus-group-fast-parameter' instead."
eec82323
LMI
3634 (save-excursion
3635 (set-buffer gnus-group-buffer)
23f87bed
MB
3636 (if symbol
3637 (gnus-group-fast-parameter group symbol allow-list)
3638 (nconc
3639 (copy-sequence
3640 (funcall gnus-group-get-parameter-function group))
3641 (gnus-parameters-get-parameter group)))))
eec82323 3642
6748645f 3643(defun gnus-group-get-parameter (group &optional symbol allow-list)
eec82323 3644 "Return the group parameters for GROUP.
6748645f
LMI
3645If SYMBOL, return the value of that symbol in the group parameters.
3646Most functions should use `gnus-group-find-parameter', which
3647also examines the topic parameters."
eec82323
LMI
3648 (let ((params (gnus-info-params (gnus-get-info group))))
3649 (if symbol
6748645f 3650 (gnus-group-parameter-value params symbol allow-list)
eec82323
LMI
3651 params)))
3652
23f87bed
MB
3653(defun gnus-group-parameter-value (params symbol &optional
3654 allow-list present-p)
eec82323 3655 "Return the value of SYMBOL in group PARAMS."
6748645f
LMI
3656 ;; We only wish to return group parameters (dotted lists) and
3657 ;; not local variables, which may have the same names.
3658 ;; But first we handle single elements...
3659 (or (car (memq symbol params))
3660 ;; Handle alist.
3661 (let (elem)
3662 (catch 'found
3663 (while (setq elem (pop params))
3664 (when (and (consp elem)
3665 (eq (car elem) symbol)
3666 (or allow-list
3667 (atom (cdr elem))))
23f87bed
MB
3668 (throw 'found (if present-p (list (cdr elem))
3669 (cdr elem)))))))))
eec82323
LMI
3670
3671(defun gnus-group-add-parameter (group param)
3672 "Add parameter PARAM to GROUP."
3673 (let ((info (gnus-get-info group)))
3674 (when info
3675 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3676 ;; Cons the new param to the old one and update.
3677 (gnus-group-set-info (cons param (gnus-info-params info))
3678 group 'params))))
3679
3680(defun gnus-group-set-parameter (group name value)
3681 "Set parameter NAME to VALUE in GROUP."
3682 (let ((info (gnus-get-info group)))
3683 (when info
3684 (gnus-group-remove-parameter group name)
3685 (let ((old-params (gnus-info-params info))
3686 (new-params (list (cons name value))))
3687 (while old-params
3688 (when (or (not (listp (car old-params)))
3689 (not (eq (caar old-params) name)))
3690 (setq new-params (append new-params (list (car old-params)))))
3691 (setq old-params (cdr old-params)))
3692 (gnus-group-set-info new-params group 'params)))))
3693
3694(defun gnus-group-remove-parameter (group name)
3695 "Remove parameter NAME from GROUP."
3696 (let ((info (gnus-get-info group)))
3697 (when info
3698 (let ((params (gnus-info-params info)))
3699 (when params
3700 (setq params (delq name params))
3701 (while (assq name params)
6748645f 3702 (gnus-pull name params))
eec82323
LMI
3703 (gnus-info-set-params info params))))))
3704
3705(defun gnus-group-add-score (group &optional score)
3706 "Add SCORE to the GROUP score.
3707If SCORE is nil, add 1 to the score of GROUP."
3708 (let ((info (gnus-get-info group)))
3709 (when info
3710 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3711
eec82323
LMI
3712(defun gnus-short-group-name (group &optional levels)
3713 "Collapse GROUP name LEVELS.
3714Select methods are stripped and any remote host name is stripped down to
3715just the host name."
6748645f
LMI
3716 (let* ((name "")
3717 (foreign "")
3718 (depth 0)
3719 (skip 1)
eec82323 3720 (levels (or levels
16409b0b 3721 gnus-group-uncollapsed-levels
eec82323
LMI
3722 (progn
3723 (while (string-match "\\." group skip)
3724 (setq skip (match-end 0)
3725 depth (+ depth 1)))
3726 depth))))
16409b0b 3727 ;; Separate foreign select method from group name and collapse.
23f87bed 3728 ;; If method contains a server, collapse to non-domain server name,
16409b0b
GM
3729 ;; otherwise collapse to select method.
3730 (let* ((colon (string-match ":" group))
3731 (server (and colon (substring group 0 colon)))
3732 (plus (and server (string-match "+" server))))
3733 (when server
3734 (if plus
3735 (setq foreign (substring server (+ 1 plus)
3736 (string-match "\\." server))
3737 group (substring group (+ 1 colon)))
3738 (setq foreign server
3739 group (substring group (+ 1 colon))))
3740 (setq foreign (concat foreign ":")))
3741 ;; Collapse group name leaving LEVELS uncollapsed elements
3742 (let* ((slist (split-string group "/"))
3743 (slen (length slist))
3744 (dlist (split-string group "\\."))
3745 (dlen (length dlist))
3746 glist
3747 glen
3748 gsep
3749 res)
3750 (if (> slen dlen)
3751 (setq glist slist
3752 glen slen
3753 gsep "/")
3754 (setq glist dlist
3755 glen dlen
3756 gsep "."))
3757 (setq levels (- glen levels))
3758 (dolist (g glist)
3759 (push (if (>= (decf levels) 0)
3760 (if (zerop (length g))
3761 ""
3762 (substring g 0 1))
3763 g)
3764 res))
3765 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
eec82323
LMI
3766
3767(defun gnus-narrow-to-body ()
3768 "Narrow to the body of an article."
3769 (narrow-to-region
3770 (progn
3771 (goto-char (point-min))
3772 (or (search-forward "\n\n" nil t)
3773 (point-max)))
3774 (point-max)))
3775
3776\f
3777;;;
3778;;; Kill file handling.
3779;;;
3780
3781(defun gnus-apply-kill-file ()
3782 "Apply a kill file to the current newsgroup.
3783Returns the number of articles marked as read."
3784 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3785 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3786 (gnus-apply-kill-file-internal)
3787 0))
3788
3789(defun gnus-kill-save-kill-buffer ()
3790 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3791 (when (get-file-buffer file)
3792 (save-excursion
3793 (set-buffer (get-file-buffer file))
3794 (when (buffer-modified-p)
3795 (save-buffer))
3796 (kill-buffer (current-buffer))))))
3797
3798(defcustom gnus-kill-file-name "KILL"
3799 "Suffix of the kill files."
3800 :group 'gnus-score-kill
3801 :group 'gnus-score-files
3802 :type 'string)
3803
3804(defun gnus-newsgroup-kill-file (newsgroup)
3805 "Return the name of a kill file name for NEWSGROUP.
3806If NEWSGROUP is nil, return the global kill file name instead."
3807 (cond
3808 ;; The global KILL file is placed at top of the directory.
3809 ((or (null newsgroup)
3810 (string-equal newsgroup ""))
3811 (expand-file-name gnus-kill-file-name
3812 gnus-kill-files-directory))
3813 ;; Append ".KILL" to newsgroup name.
3814 ((gnus-use-long-file-name 'not-kill)
3815 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3816 "." gnus-kill-file-name)
3817 gnus-kill-files-directory))
3818 ;; Place "KILL" under the hierarchical directory.
3819 (t
3820 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3821 "/" gnus-kill-file-name)
3822 gnus-kill-files-directory))))
3823
3824;;; Server things.
3825
3826(defun gnus-member-of-valid (symbol group)
3827 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3828 (memq symbol (assoc
3829 (symbol-name (car (gnus-find-method-for-group group)))
3830 gnus-valid-select-methods)))
3831
3832(defun gnus-method-option-p (method option)
3833 "Return non-nil if select METHOD has OPTION as a parameter."
3834 (when (stringp method)
3835 (setq method (gnus-server-to-method method)))
3836 (memq option (assoc (format "%s" (car method))
3837 gnus-valid-select-methods)))
3838
3839(defun gnus-similar-server-opened (method)
3840 (let ((opened gnus-opened-servers))
3841 (while (and method opened)
3842 (when (and (equal (cadr method) (cadaar opened))
16409b0b 3843 (equal (car method) (caaar opened))
eec82323
LMI
3844 (not (equal method (caar opened))))
3845 (setq method nil))
3846 (pop opened))
3847 (not method)))
3848
3849(defun gnus-server-extend-method (group method)
3850 ;; This function "extends" a virtual server. If the server is
3851 ;; "hello", and the select method is ("hello" (my-var "something"))
3852 ;; in the group "alt.alt", this will result in a new virtual server
3853 ;; called "hello+alt.alt".
3854 (if (or (not (inline (gnus-similar-server-opened method)))
3855 (not (cddr method)))
3856 method
3857 `(,(car method) ,(concat (cadr method) "+" group)
3858 (,(intern (format "%s-address" (car method))) ,(cadr method))
3859 ,@(cddr method))))
3860
3861(defun gnus-server-status (method)
3862 "Return the status of METHOD."
3863 (nth 1 (assoc method gnus-opened-servers)))
3864
3865(defun gnus-group-name-to-method (group)
3866 "Guess a select method based on GROUP."
3867 (if (string-match ":" group)
3868 (let ((server (substring group 0 (match-beginning 0))))
3869 (if (string-match "\\+" server)
3870 (list (intern (substring server 0 (match-beginning 0)))
3871 (substring server (match-end 0)))
3872 (list (intern server) "")))
3873 gnus-select-method))
3874
23f87bed
MB
3875(defun gnus-server-string (server)
3876 "Return a readable string that describes SERVER."
3877 (let* ((server (gnus-server-to-method server))
3878 (address (nth 1 server)))
3879 (if (and address
3880 (not (zerop (length address))))
3881 (format "%s using %s" address (car server))
3882 (format "%s" (car server)))))
3883
eec82323
LMI
3884(defun gnus-find-method-for-group (group &optional info)
3885 "Find the select method that GROUP uses."
3886 (or gnus-override-method
3887 (and (not group)
3888 gnus-select-method)
23f87bed 3889 (and (not (gnus-group-entry group)) ;; a new group
16409b0b 3890 (gnus-group-name-to-method group))
eec82323
LMI
3891 (let ((info (or info (gnus-get-info group)))
3892 method)
3893 (if (or (not info)
3894 (not (setq method (gnus-info-method info)))
3895 (equal method "native"))
3896 gnus-select-method
3897 (setq method
3898 (cond ((stringp method)
3899 (inline (gnus-server-to-method method)))
3900 ((stringp (cadr method))
3901 (inline (gnus-server-extend-method group method)))
3902 (t
3903 method)))
3904 (cond ((equal (cadr method) "")
3905 method)
3906 ((null (cadr method))
3907 (list (car method) ""))
3908 (t
3909 (gnus-server-add-address method)))))))
3910
eec82323
LMI
3911(defun gnus-methods-using (feature)
3912 "Find all methods that have FEATURE."
3913 (let ((valids gnus-valid-select-methods)
3914 outs)
3915 (while valids
3916 (when (memq feature (car valids))
3917 (push (car valids) outs))
3918 (setq valids (cdr valids)))
3919 outs))
3920
3921(defun gnus-read-group (prompt &optional default)
3922 "Prompt the user for a group name.
16409b0b 3923Disallow invalid group names."
eec82323
LMI
3924 (let ((prefix "")
3925 group)
3926 (while (not group)
a1506d29 3927 (when (string-match
16409b0b 3928 gnus-invalid-group-regexp
eec82323
LMI
3929 (setq group (read-string (concat prefix prompt)
3930 (cons (or default "") 0)
3931 'gnus-group-history)))
23f87bed
MB
3932 (let ((match (match-string 0 group)))
3933 ;; Might be okay (e.g. for nnimap), so ask the user:
3934 (unless (and (not (string-match "^$\\|:" match))
3935 (message-y-or-n-p
3936 "Proceed and create group anyway? " t
3937"The group name \"" group "\" contains a forbidden character: \"" match "\".
3938
3939Usually, it's dangerous to create a group with this name, because it's not
3940supported by all back ends and servers. On IMAP servers it should work,
3941though. If you are really sure, you can proceed anyway and create the group.
3942
3943You may customize the variable `gnus-invalid-group-regexp', which currently is
3944set to \"" gnus-invalid-group-regexp
3945"\", if you want to get rid of this query permanently."))
3946 (setq prefix (format "Invalid group name: \"%s\". " group)
3947 group nil)))))
eec82323
LMI
3948 group))
3949
3950(defun gnus-read-method (prompt)
3951 "Prompt the user for a method.
3952Allow completion over sensible values."
23f87bed
MB
3953 (let* ((open-servers
3954 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3955 gnus-opened-servers))
3956 (valid-methods
3957 (let (methods)
3958 (dolist (method gnus-valid-select-methods)
3959 (if (or (memq 'prompt-address method)
3960 (not (assoc (format "%s:" (car method)) open-servers)))
3961 (push method methods)))
3962 methods))
3963 (servers
3964 (append valid-methods
3965 open-servers
6748645f
LMI
3966 gnus-predefined-server-alist
3967 gnus-server-alist))
3968 (method
3969 (completing-read
3970 prompt servers
3971 nil t nil 'gnus-method-history)))
eec82323
LMI
3972 (cond
3973 ((equal method "")
3974 (setq method gnus-select-method))
3975 ((assoc method gnus-valid-select-methods)
16409b0b
GM
3976 (let ((address (if (memq 'prompt-address
3977 (assoc method gnus-valid-select-methods))
3978 (read-string "Address: ")
3979 "")))
23f87bed 3980 (or (cadr (assoc (format "%s:%s" method address) open-servers))
16409b0b 3981 (list (intern method) address))))
6748645f 3982 ((assoc method servers)
eec82323
LMI
3983 method)
3984 (t
3985 (list (intern method) "")))))
3986
23f87bed
MB
3987;;; Agent functions
3988
3989(defun gnus-agent-method-p (method)
3990 "Say whether METHOD is covered by the agent."
3991 (or (eq (car gnus-agent-method-p-cache) method)
3992 (setq gnus-agent-method-p-cache
3993 (cons method
3994 (member (if (stringp method)
3995 method
3996 (gnus-method-to-server method)) gnus-agent-covered-methods))))
3997 (cdr gnus-agent-method-p-cache))
3998
3999(defun gnus-online (method)
4000 (not
4001 (if gnus-plugged
4002 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4003 (gnus-agent-method-p method))))
4004
eec82323
LMI
4005;;; User-level commands.
4006
4007;;;###autoload
4008(defun gnus-slave-no-server (&optional arg)
23f87bed 4009 "Read network news as a slave, without connecting to the local server."
eec82323
LMI
4010 (interactive "P")
4011 (gnus-no-server arg t))
4012
4013;;;###autoload
4014(defun gnus-no-server (&optional arg slave)
4015 "Read network news.
23f87bed
MB
4016If ARG is a positive number, Gnus will use that as the startup
4017level. If ARG is nil, Gnus will be started at level 2. If ARG is
4018non-nil and not a positive number, Gnus will prompt the user for the
4019name of an NNTP server to use.
4020As opposed to `gnus', this command will not connect to the local
4021server."
eec82323
LMI
4022 (interactive "P")
4023 (gnus-no-server-1 arg slave))
4024
4025;;;###autoload
4026(defun gnus-slave (&optional arg)
4027 "Read news as a slave."
4028 (interactive "P")
4029 (gnus arg nil 'slave))
4030
4031;;;###autoload
23f87bed
MB
4032(defun gnus-other-frame (&optional arg display)
4033 "Pop up a frame to read news.
4034This will call one of the Gnus commands which is specified by the user
4035option `gnus-other-frame-function' (default `gnus') with the argument
4036ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4037optional second argument DISPLAY should be a standard display string
4038such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4039omitted or the function `make-frame-on-display' is not available, the
4040current display is used."
eec82323 4041 (interactive "P")
23f87bed
MB
4042 (if (fboundp 'make-frame-on-display)
4043 (unless display
4044 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4045 (setq display nil))
4046 (let ((alive (gnus-alive-p)))
4047 (unless (and alive
4048 (catch 'found
4049 (walk-windows
4050 (lambda (window)
4051 (when (and (or (not display)
4052 (equal display
4053 (gnus-frame-or-window-display-name
4054 window)))
4055 (with-current-buffer (window-buffer window)
4056 (string-match "\\`gnus-"
4057 (symbol-name major-mode))))
4058 (gnus-select-frame-set-input-focus
4059 (setq gnus-other-frame-object (window-frame window)))
4060 (select-window window)
4061 (throw 'found t)))
4062 'ignore t)))
4063 (gnus-select-frame-set-input-focus
4064 (setq gnus-other-frame-object
4065 (if display
4066 (make-frame-on-display display gnus-other-frame-parameters)
4067 (make-frame gnus-other-frame-parameters))))
4068 (if alive
4069 (switch-to-buffer gnus-group-buffer)
4070 (funcall gnus-other-frame-function arg)
4071 (add-hook 'gnus-exit-gnus-hook
4072 '(lambda nil
4073 (when (and (frame-live-p gnus-other-frame-object)
4074 (cdr (frame-list)))
4075 (delete-frame gnus-other-frame-object))
4076 (setq gnus-other-frame-object nil)))))))
eec82323 4077
16409b0b
GM
4078;;(setq thing ? ; this is a comment
4079;; more 'yes)
4080
eec82323
LMI
4081;;;###autoload
4082(defun gnus (&optional arg dont-connect slave)
4083 "Read network news.
4084If ARG is non-nil and a positive number, Gnus will use that as the
23f87bed 4085startup level. If ARG is non-nil and not a positive number, Gnus will
eec82323
LMI
4086prompt the user for the name of an NNTP server to use."
4087 (interactive "P")
23f87bed
MB
4088 (unless (byte-code-function-p (symbol-function 'gnus))
4089 (message "You should byte-compile Gnus")
4090 (sit-for 2))
eec82323
LMI
4091 (gnus-1 arg dont-connect slave))
4092
4093;; Allow redefinition of Gnus functions.
4094
4095(gnus-ems-redefine)
4096
4097(provide 'gnus)
4098
ab5796a9 4099;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
eec82323 4100;;; gnus.el ends here