Revision: miles@gnu.org--gnu-2004/emacs--cvs-trunk--0--patch-523
[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)))"
966 :group 'gnus-group-various
967 :type '(repeat (cons regexp
968 (repeat sexp))))
969
970(defvar gnus-group-parameters-more nil)
971
972(defmacro gnus-define-group-parameter (param &rest rest)
973 "Define a group parameter PARAM.
974REST is a plist of following:
975:type One of `bool', `list' or nil.
976:function The name of the function.
977:function-document The documentation of the function.
978:parameter-type The type for customizing the parameter.
979:parameter-document The documentation for the parameter.
980:variable The name of the variable.
981:variable-document The documentation for the variable.
982:variable-group The group for customizing the variable.
983:variable-type The type for customizing the variable.
984:variable-default The default value of the variable."
985 (let* ((type (plist-get rest :type))
986 (parameter-type (plist-get rest :parameter-type))
987 (parameter-document (plist-get rest :parameter-document))
988 (function (or (plist-get rest :function)
989 (intern (format "gnus-parameter-%s" param))))
990 (function-document (or (plist-get rest :function-document) ""))
991 (variable (or (plist-get rest :variable)
992 (intern (format "gnus-parameter-%s-alist" param))))
993 (variable-document (or (plist-get rest :variable-document) ""))
994 (variable-group (plist-get rest :variable-group))
995 (variable-type (or (plist-get rest :variable-type)
996 `(quote (repeat
997 (list (regexp :tag "Group")
998 ,(car (cdr parameter-type)))))))
999 (variable-default (plist-get rest :variable-default)))
1000 (list
1001 'progn
1002 `(defcustom ,variable ,variable-default
1003 ,variable-document
1004 :group 'gnus-group-parameter
1005 :group ',variable-group
1006 :type ,variable-type)
1007 `(setq gnus-group-parameters-more
1008 (delq (assq ',param gnus-group-parameters-more)
1009 gnus-group-parameters-more))
1010 `(add-to-list 'gnus-group-parameters-more
1011 (list ',param
1012 ,parameter-type
1013 ,parameter-document))
1014 (if (eq type 'bool)
1015 `(defun ,function (name)
1016 ,function-document
1017 (let ((params (gnus-group-find-parameter name))
1018 val)
1019 (cond
1020 ((memq ',param params)
1021 t)
1022 ((setq val (assq ',param params))
1023 (cdr val))
1024 ((stringp ,variable)
1025 (string-match ,variable name))
1026 (,variable
1027 (let ((alist ,variable)
1028 elem value)
1029 (while (setq elem (pop alist))
1030 (when (and name
1031 (string-match (car elem) name))
1032 (setq alist nil
1033 value (cdr elem))))
1034 (if (consp value) (car value) value))))))
1035 `(defun ,function (name)
1036 ,function-document
1037 (and name
1038 (or (gnus-group-find-parameter name ',param ,(and type t))
1039 (let ((alist ,variable)
1040 elem value)
1041 (while (setq elem (pop alist))
1042 (when (and name
1043 (string-match (car elem) name))
1044 (setq alist nil
1045 value (cdr elem))))
1046 ,(if type
1047 'value
1048 '(if (consp value) (car value) value))))))))))
1049
eec82323
LMI
1050(defcustom gnus-home-directory "~/"
1051 "Directory variable that specifies the \"home\" directory.
35ef97a5 1052All other Gnus file and directory variables are initialized from this variable."
eec82323
LMI
1053 :group 'gnus-files
1054 :type 'directory)
1055
1056(defcustom gnus-directory (or (getenv "SAVEDIR")
1057 (nnheader-concat gnus-home-directory "News/"))
6748645f
LMI
1058 "*Directory variable from which all other Gnus file variables are derived.
1059
1060Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1061This means that other directory variables that are initialized from
1062this variable won't be set properly if you set this variable in `.gnus.el'.
1063Set this variable in `.emacs' instead."
eec82323
LMI
1064 :group 'gnus-files
1065 :type 'directory)
1066
1067(defcustom gnus-default-directory nil
1068 "*Default directory for all Gnus buffers."
1069 :group 'gnus-files
1070 :type '(choice (const :tag "current" nil)
1071 directory))
1072
1073;; Site dependent variables. These variables should be defined in
1074;; paths.el.
1075
1076(defvar gnus-default-nntp-server nil
1077 "Specify a default NNTP server.
1078This variable should be defined in paths.el, and should never be set
1079by the user.
1080If you want to change servers, you should use `gnus-select-method'.
1081See the documentation to that variable.")
1082
1083;; Don't touch this variable.
1084(defvar gnus-nntp-service "nntp"
1085 "NNTP service name (\"nntp\" or 119).
1086This is an obsolete variable, which is scarcely used. If you use an
1087nntp server for your newsgroup and want to change the port number
1088used to 899, you would say something along these lines:
1089
1090 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1091
1092(defcustom gnus-nntpserver-file "/etc/nntpserver"
1093 "A file with only the name of the nntp server in it."
1094 :group 'gnus-files
1095 :group 'gnus-server
1096 :type 'file)
1097
eec82323 1098(defun gnus-getenv-nntpserver ()
23f87bed
MB
1099 "Find default nntp server.
1100Check the NNTPSERVER environment variable and the
1101`gnus-nntpserver-file' file."
eec82323
LMI
1102 (or (getenv "NNTPSERVER")
1103 (and (file-readable-p gnus-nntpserver-file)
23f87bed 1104 (with-temp-buffer
eec82323
LMI
1105 (insert-file-contents gnus-nntpserver-file)
1106 (let ((name (buffer-string)))
23f87bed
MB
1107 (unless (string-match "\\`[ \t\n]*$" name)
1108 name))))))
eec82323
LMI
1109
1110(defcustom gnus-select-method
a36c8d02 1111 (condition-case nil
16409b0b
GM
1112 (nconc
1113 (list 'nntp (or (condition-case nil
1114 (gnus-getenv-nntpserver)
1115 (error nil))
1116 (when (and gnus-default-nntp-server
1117 (not (string= gnus-default-nntp-server "")))
1118 gnus-default-nntp-server)
1119 "news"))
1120 (if (or (null gnus-nntp-service)
1121 (equal gnus-nntp-service "nntp"))
1122 nil
1123 (list gnus-nntp-service)))
a36c8d02 1124 (error nil))
16409b0b 1125 "Default method for selecting a newsgroup.
eec82323
LMI
1126This variable should be a list, where the first element is how the
1127news is to be fetched, the second is the address.
1128
23f87bed
MB
1129For instance, if you want to get your news via \"flab.flab.edu\" using
1130NNTP, you could say:
eec82323
LMI
1131
1132\(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1133
1134If you want to use your local spool, say:
1135
1136\(setq gnus-select-method (list 'nnspool (system-name)))
1137
1138If you use this variable, you must set `gnus-nntp-server' to nil.
1139
1140There is a lot more to know about select methods and virtual servers -
1141see the manual for details."
1142 :group 'gnus-server
1143 :type 'gnus-select-method)
1144
23f87bed 1145(defcustom gnus-message-archive-method "archive"
6748645f 1146 "*Method used for archiving messages you've sent.
23f87bed 1147This should be a mail method."
eec82323
LMI
1148 :group 'gnus-server
1149 :group 'gnus-message
23f87bed
MB
1150 :type '(choice (const :tag "Default archive method" "archive")
1151 gnus-select-method))
eec82323
LMI
1152
1153(defcustom gnus-message-archive-group nil
1154 "*Name of the group in which to save the messages you've written.
1155This can either be a string; a list of strings; or an alist
1156of regexps/functions/forms to be evaluated to return a string (or a list
1157of strings). The functions are called with the name of the current
1158group (or nil) as a parameter.
1159
1160If you want to save your mail in one group and the news articles you
1161write in another group, you could say something like:
1162
1163 \(setq gnus-message-archive-group
23f87bed
MB
1164 '((if (message-news-p)
1165 \"misc-news\"
1166 \"misc-mail\")))
eec82323
LMI
1167
1168Normally the group names returned by this variable should be
1169unprefixed -- which implicitly means \"store on the archive server\".
1170However, you may wish to store the message on some other server. In
1171that case, just return a fully prefixed name of the group --
1172\"nnml+private:mail.misc\", for instance."
1173 :group 'gnus-message
1174 :type '(choice (const :tag "none" nil)
16409b0b 1175 function
6748645f 1176 sexp
eec82323
LMI
1177 string))
1178
1179(defcustom gnus-secondary-servers nil
1180 "List of NNTP servers that the user can choose between interactively.
1181To make Gnus query you for a server, you have to give `gnus' a
1182non-numeric prefix - `C-u M-x gnus', in short."
1183 :group 'gnus-server
1184 :type '(repeat string))
1185
1186(defcustom gnus-nntp-server nil
1187 "*The name of the host running the NNTP server.
1188This variable is semi-obsolete. Use the `gnus-select-method'
1189variable instead."
1190 :group 'gnus-server
1191 :type '(choice (const :tag "disable" nil)
1192 string))
1193
1194(defcustom gnus-secondary-select-methods nil
1195 "A list of secondary methods that will be used for reading news.
1196This is a list where each element is a complete select method (see
1197`gnus-select-method').
1198
23f87bed 1199If, for instance, you want to read your mail with the nnml back end,
eec82323
LMI
1200you could set this variable:
1201
1202\(setq gnus-secondary-select-methods '((nnml \"\")))"
16409b0b
GM
1203 :group 'gnus-server
1204 :type '(repeat gnus-select-method))
eec82323
LMI
1205
1206(defvar gnus-backup-default-subscribed-newsgroups
1207 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1208 "Default default new newsgroups the first time Gnus is run.
1209Should be set in paths.el, and shouldn't be touched by the user.")
1210
c625688c
GM
1211(defcustom gnus-local-domain nil
1212 "Local domain name without a host name.
1213The DOMAINNAME environment variable is used instead if it is defined.
0d54d415 1214If the function `system-name' returns the full Internet name, there is
c625688c
GM
1215no need to set this variable."
1216 :group 'gnus-message
1217 :type '(choice (const :tag "default" nil)
1218 string))
1219
eec82323
LMI
1220(defvar gnus-local-organization nil
1221 "String with a description of what organization (if any) the user belongs to.
1222Obsolete variable; use `message-user-organization' instead.")
1223
1224;; Customization variables
1225
1226(defcustom gnus-refer-article-method nil
1227 "Preferred method for fetching an article by Message-ID.
1228If you are reading news from the local spool (with nnspool), fetching
1229articles by Message-ID is painfully slow. By setting this method to an
1230nntp method, you might get acceptable results.
1231
1232The value of this variable must be a valid select method as discussed
16409b0b
GM
1233in the documentation of `gnus-select-method'.
1234
1235It can also be a list of select methods, as well as the special symbol
1236`current', which means to use the current select method. If it is a
1237list, Gnus will try all the methods in the list until it finds a match."
eec82323
LMI
1238 :group 'gnus-server
1239 :type '(choice (const :tag "default" nil)
23f87bed
MB
1240 (const current)
1241 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1242 gnus-select-method
1243 (repeat :menu-tag "Try multiple"
1244 :tag "Multiple"
23f87bed 1245 :value (current (nnweb "refer" (nnweb-type google)))
16409b0b
GM
1246 (choice :tag "Method"
1247 (const current)
23f87bed
MB
1248 (const :tag "Google"
1249 (nnweb "refer" (nnweb-type google)))
16409b0b 1250 gnus-select-method))))
eec82323
LMI
1251
1252(defcustom gnus-group-faq-directory
1253 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
eec82323
LMI
1254 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1255 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1256 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
23f87bed 1257 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
eec82323
LMI
1258 "/ftp@rtfm.mit.edu:/pub/usenet/"
1259 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1260 "/ftp@ftp.sunet.se:/pub/usenet/"
23f87bed 1261 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
eec82323
LMI
1262 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1263 "/ftp@ftp.hk.super.net:/mirror/faqs/")
6748645f 1264 "*Directory where the group FAQs are stored.
eec82323
LMI
1265This will most commonly be on a remote machine, and the file will be
1266fetched by ange-ftp.
1267
1268This variable can also be a list of directories. In that case, the
1269first element in the list will be used by default. The others can
1270be used when being prompted for a site.
1271
1272Note that Gnus uses an aol machine as the default directory. If this
1273feels fundamentally unclean, just think of it as a way to finally get
1274something of value back from them.
1275
1276If the default site is too slow, try one of these:
1277
1278 North America: mirrors.aol.com /pub/rtfm/usenet
1279 ftp.seas.gwu.edu /pub/rtfm
1280 rtfm.mit.edu /pub/usenet
1281 Europe: ftp.uni-paderborn.de /pub/FAQ
23f87bed 1282 src.doc.ic.ac.uk /usenet/news-FAQS
eec82323 1283 ftp.sunet.se /pub/usenet
23f87bed
MB
1284 ftp.pasteur.fr /pub/FAQ
1285 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
eec82323
LMI
1286 hwarang.postech.ac.kr /pub/usenet
1287 ftp.hk.super.net /mirror/faqs"
1288 :group 'gnus-group-various
1289 :type '(choice directory
1290 (repeat directory)))
1291
23f87bed
MB
1292(defcustom gnus-group-charter-alist
1293 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1294 ("de" . (concat "http://purl.net/charta/" name ".html"))
1295 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1296 ("england" . (concat "http://england.news-admin.org/charters/" name))
1297 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1298 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1299 (gnus-replace-in-string name "europa\\." "") ".html"))
1300 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1301 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1302 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1303 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1304 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1305 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1306 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1307 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1308 (gnus-replace-in-string name "\\." "_") ".html"))
1309 ("milw" . (concat "http://usenet.mil.wi.us/"
1310 (gnus-replace-in-string name "milw\\." "") "-charter"))
1311 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1312 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1313 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1314 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1315When FORM is evaluated `name' is bound to the name of the group."
1316 :group 'gnus-group-various
1317 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1318
1319(defcustom gnus-group-fetch-control-use-browse-url nil
1320 "*Non-nil means that control messages are displayed using `browse-url'.
1321Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1322group."
1323 :group 'gnus-group-various
1324 :type 'boolean)
1325
eec82323
LMI
1326(defcustom gnus-use-cross-reference t
1327 "*Non-nil means that cross referenced articles will be marked as read.
1328If nil, ignore cross references. If t, mark articles as read in
1329subscribed newsgroups. If neither t nor nil, mark as read in all
1330newsgroups."
1331 :group 'gnus-server
1332 :type '(choice (const :tag "off" nil)
1333 (const :tag "subscribed" t)
1334 (sexp :format "all"
1335 :value always)))
1336
1337(defcustom gnus-process-mark ?#
1338 "*Process mark."
1339 :group 'gnus-group-visual
1340 :group 'gnus-summary-marks
1341 :type 'character)
1342
eec82323
LMI
1343(defcustom gnus-large-newsgroup 200
1344 "*The number of articles which indicates a large newsgroup.
1345If the number of articles in a newsgroup is greater than this value,
23f87bed
MB
1346confirmation is required for selecting the newsgroup.
1347If it is nil, no confirmation is required."
eec82323 1348 :group 'gnus-group-select
23f87bed
MB
1349 :type '(choice (const :tag "No limit" nil)
1350 integer))
eec82323
LMI
1351
1352(defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1353 "*Non-nil means that the default name of a file to save articles in is the group name.
1354If it's nil, the directory form of the group name is used instead.
1355
1356If this variable is a list, and the list contains the element
1357`not-score', long file names will not be used for score files; if it
1358contains the element `not-save', long file names will not be used for
1359saving; and if it contains the element `not-kill', long file names
1360will not be used for kill files.
1361
1362Note that the default for this variable varies according to what system
1363type you're using. On `usg-unix-v' and `xenix' this variable defaults
1364to nil while on all other systems it defaults to t."
1365 :group 'gnus-start
23f87bed
MB
1366 :type '(radio (sexp :format "Non-nil\n"
1367 :match (lambda (widget value)
1368 (and value (not (listp value))))
1369 :value t)
1370 (const nil)
1371 (checklist (const :format "%v " not-score)
1372 (const :format "%v " not-save)
1373 (const not-kill))))
eec82323
LMI
1374
1375(defcustom gnus-kill-files-directory gnus-directory
1376 "*Name of the directory where kill files will be stored (default \"~/News\")."
1377 :group 'gnus-score-files
1378 :group 'gnus-score-kill
1379 :type 'directory)
1380
1381(defcustom gnus-save-score nil
1382 "*If non-nil, save group scoring info."
1383 :group 'gnus-score-various
1384 :group 'gnus-start
1385 :type 'boolean)
1386
1387(defcustom gnus-use-undo t
1388 "*If non-nil, allow undoing in Gnus group mode buffers."
1389 :group 'gnus-meta
1390 :type 'boolean)
1391
1392(defcustom gnus-use-adaptive-scoring nil
1393 "*If non-nil, use some adaptive scoring scheme.
1394If a list, then the values `word' and `line' are meaningful. The
1395former will perform adaption on individual words in the subject
1396header while `line' will perform adaption on several headers."
1397 :group 'gnus-meta
1398 :group 'gnus-score-adapt
1399 :type '(set (const word) (const line)))
1400
1401(defcustom gnus-use-cache 'passive
1402 "*If nil, Gnus will ignore the article cache.
1403If `passive', it will allow entering (and reading) articles
1404explicitly entered into the cache. If anything else, use the
1405cache to the full extent of the law."
1406 :group 'gnus-meta
1407 :group 'gnus-cache
1408 :type '(choice (const :tag "off" nil)
1409 (const :tag "passive" passive)
1410 (const :tag "active" t)))
1411
1412(defcustom gnus-use-trees nil
1413 "*If non-nil, display a thread tree buffer."
1414 :group 'gnus-meta
1415 :type 'boolean)
1416
1417(defcustom gnus-use-grouplens nil
1418 "*If non-nil, use GroupLens ratings."
1419 :group 'gnus-meta
1420 :type 'boolean)
1421
23f87bed 1422(defcustom gnus-keep-backlog 20
eec82323
LMI
1423 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1424If it is a number N, then Gnus will only keep the last N articles
1425read. If it is neither nil nor a number, Gnus will keep all read
1426articles. This is not a good idea."
1427 :group 'gnus-meta
1428 :type '(choice (const :tag "off" nil)
1429 integer
1430 (sexp :format "all"
1431 :value t)))
1432
1433(defcustom gnus-use-nocem nil
1434 "*If non-nil, Gnus will read NoCeM cancel messages."
1435 :group 'gnus-meta
1436 :type 'boolean)
1437
1438(defcustom gnus-suppress-duplicates nil
1439 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1440 :group 'gnus-meta
1441 :type 'boolean)
1442
eec82323
LMI
1443(defcustom gnus-use-scoring t
1444 "*If non-nil, enable scoring."
1445 :group 'gnus-meta
1446 :type 'boolean)
1447
eec82323
LMI
1448(defcustom gnus-summary-prepare-exit-hook
1449 '(gnus-summary-expire-articles)
6748645f 1450 "*A hook called when preparing to exit from the summary buffer.
eec82323
LMI
1451It calls `gnus-summary-expire-articles' by default."
1452 :group 'gnus-summary-exit
1453 :type 'hook)
1454
1455(defcustom gnus-novice-user t
23f87bed 1456 "*Non-nil means that you are a Usenet novice.
eec82323
LMI
1457If non-nil, verbose messages may be displayed and confirmations may be
1458required."
1459 :group 'gnus-meta
1460 :type 'boolean)
1461
1462(defcustom gnus-expert-user nil
1463 "*Non-nil means that you will never be asked for confirmation about anything.
6748645f
LMI
1464That doesn't mean *anything* anything; particularly destructive
1465commands will still require prompting."
eec82323
LMI
1466 :group 'gnus-meta
1467 :type 'boolean)
1468
1469(defcustom gnus-interactive-catchup t
1470 "*If non-nil, require your confirmation when catching up a group."
1471 :group 'gnus-group-select
1472 :type 'boolean)
1473
1474(defcustom gnus-interactive-exit t
1475 "*If non-nil, require your confirmation when exiting Gnus."
1476 :group 'gnus-exit
1477 :type 'boolean)
1478
1479(defcustom gnus-extract-address-components 'gnus-extract-address-components
1480 "*Function for extracting address components from a From header.
1481Two pre-defined function exist: `gnus-extract-address-components',
1482which is the default, quite fast, and too simplistic solution, and
1483`mail-extract-address-components', which works much better, but is
1484slower."
1485 :group 'gnus-summary-format
1486 :type '(radio (function-item gnus-extract-address-components)
1487 (function-item mail-extract-address-components)
1488 (function :tag "Other")))
1489
1490(defcustom gnus-carpal nil
1491 "*If non-nil, display clickable icons."
1492 :group 'gnus-meta
1493 :type 'boolean)
1494
1495(defcustom gnus-shell-command-separator ";"
23f87bed 1496 "String used to separate shell commands."
eec82323
LMI
1497 :group 'gnus-files
1498 :type 'string)
1499
1500(defcustom gnus-valid-select-methods
1501 '(("nntp" post address prompt-address physical-address)
1502 ("nnspool" post address)
1503 ("nnvirtual" post-mail virtual prompt-address)
1504 ("nnmbox" mail respool address)
23f87bed 1505 ("nnml" post-mail respool address)
eec82323
LMI
1506 ("nnmh" mail respool address)
1507 ("nndir" post-mail prompt-address physical-address)
1508 ("nneething" none address prompt-address physical-address)
1509 ("nndoc" none address prompt-address)
1510 ("nnbabyl" mail address respool)
1511 ("nnkiboze" post virtual)
1512 ("nnsoup" post-mail address)
1513 ("nndraft" post-mail)
1514 ("nnfolder" mail respool address)
6748645f
LMI
1515 ("nngateway" post-mail address prompt-address physical-address)
1516 ("nnweb" none)
23f87bed 1517 ("nngoogle" post)
16409b0b
GM
1518 ("nnslashdot" post)
1519 ("nnultimate" none)
23f87bed
MB
1520 ("nnrss" none)
1521 ("nnwfm" none)
16409b0b 1522 ("nnwarchive" none)
6748645f 1523 ("nnlistserv" none)
16409b0b 1524 ("nnagent" post-mail)
23f87bed
MB
1525 ("nnimap" post-mail address prompt-address physical-address)
1526 ("nnmaildir" mail respool address)
1527 ("nnnil" none))
6748645f 1528 "*An alist of valid select methods.
eec82323
LMI
1529The first element of each list lists should be a string with the name
1530of the select method. The other elements may be the category of
1531this method (i. e., `post', `mail', `none' or whatever) or other
1532properties that this method has (like being respoolable).
1533If you implement a new select method, all you should have to change is
1534this variable. I think."
1535 :group 'gnus-server
1536 :type '(repeat (group (string :tag "Name")
1537 (radio-button-choice (const :format "%v " post)
1538 (const :format "%v " mail)
1539 (const :format "%v " none)
1540 (const post-mail))
1541 (checklist :inline t
1542 (const :format "%v " address)
1543 (const :format "%v " prompt-address)
c06fc524 1544 (const :format "%v " physical-address)
eec82323
LMI
1545 (const :format "%v " virtual)
1546 (const respool)))))
1547
16409b0b
GM
1548(defun gnus-redefine-select-method-widget ()
1549 "Recomputes the select-method widget based on the value of
1550`gnus-valid-select-methods'."
1551 (define-widget 'gnus-select-method 'list
1552 "Widget for entering a select method."
1553 :value '(nntp "")
1554 :tag "Select Method"
1555 :args `((choice :tag "Method"
1556 ,@(mapcar (lambda (entry)
1557 (list 'const :format "%v\n"
1558 (intern (car entry))))
1559 gnus-valid-select-methods)
1560 (symbol :tag "other"))
1561 (string :tag "Address")
1562 (repeat :tag "Options"
1563 :inline t
1564 (list :format "%v"
1565 variable
23f87bed 1566 (sexp :tag "Value"))))))
16409b0b
GM
1567
1568(gnus-redefine-select-method-widget)
eec82323
LMI
1569
1570(defcustom gnus-updated-mode-lines '(group article summary tree)
1571 "List of buffers that should update their mode lines.
1572The list may contain the symbols `group', `article', `tree' and
1573`summary'. If the corresponding symbol is present, Gnus will keep
1574that mode line updated with information that may be pertinent.
1575If this variable is nil, screen refresh may be quicker."
1576 :group 'gnus-various
1577 :type '(set (const group)
1578 (const article)
1579 (const summary)
1580 (const tree)))
1581
1582;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1583(defcustom gnus-mode-non-string-length nil
1584 "*Max length of mode-line non-string contents.
1585If this is nil, Gnus will take space as is needed, leaving the rest
23f87bed 1586of the mode line intact. Note that the default of nil is unlikely
eec82323
LMI
1587to be desirable; see the manual for further details."
1588 :group 'gnus-various
1589 :type '(choice (const nil)
1590 integer))
1591
23f87bed
MB
1592;; There should be special validation for this.
1593(define-widget 'gnus-email-address 'string
1594 "An email address.")
1595
1596(gnus-define-group-parameter
1597 to-address
1598 :function-document
1599 "Return GROUP's to-address."
1600 :variable-document
1601 "*Alist of group regexps and correspondent to-addresses."
1602 :parameter-type '(gnus-email-address :tag "To Address")
1603 :parameter-document "\
1604This will be used when doing followups and posts.
1605
1606This is primarily useful in mail groups that represent closed
1607mailing lists--mailing lists where it's expected that everybody that
1608writes to the mailing list is subscribed to it. Since using this
1609parameter ensures that the mail only goes to the mailing list itself,
1610it means that members won't receive two copies of your followups.
1611
1612Using `to-address' will actually work whether the group is foreign or
1613not. Let's say there's a group on the server that is called
1614`fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1615articles from a mail-to-news gateway. Posting directly to this group
1616is therefore impossible--you have to send mail to the mailing list
1617address instead.
1618
1619The gnus-group-split mail splitting mechanism will behave as if this
1620address was listed in gnus-group-split Addresses (see below).")
1621
1622(gnus-define-group-parameter
1623 to-list
1624 :function-document
1625 "Return GROUP's to-list."
1626 :variable-document
1627 "*Alist of group regexps and correspondent to-lists."
1628 :parameter-type '(gnus-email-address :tag "To List")
1629 :parameter-document "\
1630This address will be used when doing a `a' in the group.
1631
1632It is totally ignored when doing a followup--except that if it is
1633present in a news group, you'll get mail group semantics when doing
1634`f'.
1635
1636The gnus-group-split mail splitting mechanism will behave as if this
1637address was listed in gnus-group-split Addresses (see below).")
1638
1639(gnus-define-group-parameter
1640 subscribed
1641 :type bool
1642 :function-document
1643 "Return GROUP's subscription status."
1644 :variable-document
1645 "*Groups which are automatically considered subscribed."
1646 :parameter-type '(const :tag "Subscribed" t)
1647 :parameter-document "\
1648Gnus assumed that you are subscribed to the To/List address.
1649
1650When constructing a list of subscribed groups using
1651`gnus-find-subscribed-addresses', Gnus includes the To address given
1652above, or the list address (if the To address has not been set).")
1653
1654(gnus-define-group-parameter
1655 auto-expire
1656 :type bool
1657 :function gnus-group-auto-expirable-p
1658 :function-document
1659 "Check whether GROUP is auto-expirable or not."
1660 :variable gnus-auto-expirable-newsgroups
1661 :variable-default nil
1662 :variable-document
1663 "*Groups in which to automatically mark read articles as expirable.
eec82323
LMI
1664If non-nil, this should be a regexp that should match all groups in
1665which to perform auto-expiry. This only makes sense for mail groups."
23f87bed
MB
1666 :variable-group nnmail-expire
1667 :variable-type '(choice (const nil)
1668 regexp)
1669 :parameter-type '(const :tag "Automatic Expire" t)
1670 :parameter-document
1671 "All articles that are read will be marked as expirable.")
1672
1673(gnus-define-group-parameter
1674 total-expire
1675 :type bool
1676 :function gnus-group-total-expirable-p
1677 :function-document
1678 "Check whether GROUP is total-expirable or not."
1679 :variable gnus-total-expirable-newsgroups
1680 :variable-default nil
1681 :variable-document
1682 "*Groups in which to perform expiry of all read articles.
eec82323
LMI
1683Use with extreme caution. All groups that match this regexp will be
1684expiring - which means that all read articles will be deleted after
1685\(say) one week. (This only goes for mail groups and the like, of
1686course.)"
23f87bed
MB
1687 :variable-group nnmail-expire
1688 :variable-type '(choice (const nil)
1689 regexp)
1690 :parameter-type '(const :tag "Total Expire" t)
1691 :parameter-document
1692 "All read articles will be put through the expiry process
1693
1694This happens even if they are not marked as expirable.
1695Use with caution.")
1696
1697(gnus-define-group-parameter
1698 charset
1699 :function-document
1700 "Return the default charset of GROUP."
1701 :variable gnus-group-charset-alist
1702 :variable-default
1703 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1704 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1705 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1706 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1707 ("\\(^\\|:\\)relcom\\>" koi8-r)
1708 ("\\(^\\|:\\)fido7\\>" koi8-r)
1709 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1710 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1711 ("\\(^\\|:\\)han\\>" euc-kr)
1712 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1713 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1714 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1715 :variable-document
1716 "Alist of regexps (to match group names) and default charsets to be used when reading."
1717 :variable-group gnus-charset
1718 :variable-type '(repeat (list (regexp :tag "Group")
1719 (symbol :tag "Charset")))
1720 :parameter-type '(symbol :tag "Charset")
1721 :parameter-document "\
1722The default charset to use in the group.")
1723
1724(gnus-define-group-parameter
1725 post-method
1726 :type list
1727 :function-document
1728 "Return a posting method for GROUP."
1729 :variable gnus-post-method-alist
1730 :variable-document
1731 "Alist of regexps (to match group names) and method to be used when
1732posting an article."
1733 :variable-group gnus-group-foreign
1734 :parameter-type
1735 '(choice :tag "Posting Method"
1736 (const :tag "Use native server" native)
1737 (const :tag "Use current server" current)
1738 (list :convert-widget
1739 (lambda (widget)
1740 (list 'sexp :tag "Methods"
1741 :value gnus-select-method))))
1742 :parameter-document
1743 "Posting method for this group.")
1744
1745(gnus-define-group-parameter
1746 large-newsgroup-initial
1747 :type integer
1748 :function-document
1749 "Return GROUP's initial input of the number of articles."
1750 :variable-document
1751 "*Alist of group regexps and its initial input of the number of articles."
1752 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1753 (const :tag "All" nil)
1754 (integer))
1755 :parameter-document "\
1756
1757This number will be prompted as the initial value of the number of
1758articles to list when the group is a large newsgroup (see
1759`gnus-large-newsgroup'). If it is nil, the default value is the
1760total number of articles in the group.")
1761
1762;; The Gnus registry's ignored groups
1763(gnus-define-group-parameter
1764 registry-ignore
1765 :type list
1766 :function-document
1767 "Whether this group should be ignored by the registry."
1768 :variable gnus-registry-ignored-groups
1769 :variable-default nil
1770 :variable-document
1771 "*Groups in which the registry should be turned off."
1772 :variable-group gnus-registry
1773 :variable-type '(repeat
1774 (list
1775 (regexp :tag "Group Name Regular Expression")
1776 (boolean :tag "Ignored")))
1777
1778 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1779 :parameter-document
1780 "Whether the Gnus Registry should ignore this group.")
1781
1782;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1783(defcustom gnus-install-group-spam-parameters t
1784 "*Disable the group parameters for spam detection.
1785Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1786 :type 'boolean
1787 :group 'gnus-start)
1788
1789(when gnus-install-group-spam-parameters
1790 (defvar gnus-group-spam-classification-spam t
1791 "Spam group classification (requires spam.el).
1792This group contains spam messages. On summary entry, unread messages
1793will be marked as spam. On summary exit, the specified spam
1794processors will be invoked on spam-marked messages, then those
1795messages will be expired, so the spam processor will only see a
1796spam-marked message once.")
1797
1798 (defvar gnus-group-spam-classification-ham 'ask
1799 "The ham value for the spam group parameter (requires spam.el).
1800On summary exit, the specified ham processors will be invoked on
1801ham-marked messages. Exercise caution, since the ham processor will
1802see the same message more than once because there is no ham message
1803registry.")
1804
1805 (gnus-define-group-parameter
1806 spam-contents
1807 :type list
1808 :function-document
1809 "The spam type (spam, ham, or neither) of the group."
1810 :variable gnus-spam-newsgroup-contents
1811 :variable-default nil
1812 :variable-document
1813 "*Groups in which to automatically mark new articles as spam on
1814summary entry. If non-nil, this should be a list of group name
1815regexps that should match all groups in which to do automatic spam
1816tagging, associated with a classification (spam, ham, or neither).
1817This only makes sense for mail groups."
1818 :variable-group spam
1819 :variable-type '(repeat
1820 (list :tag "Group contents spam/ham classification"
1821 (regexp :tag "Group")
1822 (choice
1823 (variable-item gnus-group-spam-classification-spam)
1824 (variable-item gnus-group-spam-classification-ham)
1825 (const :tag "Unclassified" nil))))
1826
1827 :parameter-type '(list :tag "Group contents spam/ham classification"
1828 (choice :tag "Group contents classification for spam sorting"
1829 (variable-item gnus-group-spam-classification-spam)
1830 (variable-item gnus-group-spam-classification-ham)
1831 (const :tag "Unclassified" nil)))
1832 :parameter-document
1833 "The spam classification (spam, ham, or neither) of this group.
1834When a spam group is entered, all unread articles are marked as spam.")
1835
1836 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1837 "OBSOLETE: The ifile summary exit spam processor.")
1838
1839 (defvar gnus-group-spam-exit-processor-stat "stat"
1840 "OBSOLETE: The spam-stat summary exit spam processor.")
1841
1842 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1843 "OBSOLETE: The Bogofilter summary exit spam processor.")
1844
1845 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1846 "OBSOLETE: The Blacklist summary exit spam processor.")
1847
1848 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1849 "OBSOLETE: The Gmane reporting summary exit spam processor.
1850Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1851
1852 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1853 "OBSOLETE: The spamoracle summary exit spam processor.")
1854
1855 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1856 "OBSOLETE: The ifile summary exit ham processor.
1857Only applicable to non-spam (unclassified and ham) groups.")
1858
1859 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1860 "OBSOLETE: The Bogofilter summary exit ham processor.
1861Only applicable to non-spam (unclassified and ham) groups.")
1862
1863 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1864 "OBSOLETE: The spam-stat summary exit ham processor.
1865Only applicable to non-spam (unclassified and ham) groups.")
1866
1867 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1868 "OBSOLETE: The whitelist summary exit ham processor.
1869Only applicable to non-spam (unclassified and ham) groups.")
1870
1871 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1872 "OBSOLETE: The BBDB summary exit ham processor.
1873Only applicable to non-spam (unclassified and ham) groups.")
1874
1875 (defvar gnus-group-ham-exit-processor-copy "copy"
1876 "OBSOLETE: The ham copy exit ham processor.
1877Only applicable to non-spam (unclassified and ham) groups.")
1878
1879 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1880 "OBSOLETE: The spamoracle summary exit ham processor.
1881Only applicable to non-spam (unclassified and ham) groups.")
1882
1883 (gnus-define-group-parameter
1884 spam-process
1885 :type list
1886 :parameter-type
1887 '(choice
1888 :tag "Spam Summary Exit Processor"
1889 :value nil
1890 (list :tag "Spam Summary Exit Processor Choices"
1891 (set
1892 (variable-item gnus-group-spam-exit-processor-ifile)
1893 (variable-item gnus-group-spam-exit-processor-stat)
1894 (variable-item gnus-group-spam-exit-processor-bogofilter)
1895 (variable-item gnus-group-spam-exit-processor-blacklist)
1896 (variable-item gnus-group-spam-exit-processor-spamoracle)
1897 (variable-item gnus-group-spam-exit-processor-report-gmane)
1898 (variable-item gnus-group-ham-exit-processor-bogofilter)
1899 (variable-item gnus-group-ham-exit-processor-ifile)
1900 (variable-item gnus-group-ham-exit-processor-stat)
1901 (variable-item gnus-group-ham-exit-processor-whitelist)
1902 (variable-item gnus-group-ham-exit-processor-BBDB)
1903 (variable-item gnus-group-ham-exit-processor-spamoracle)
1904 (variable-item gnus-group-ham-exit-processor-copy)
1905 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1906 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1907 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1908 (const :tag "Spam: ifile" (spam spam-use-ifile))
1909 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1910 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1911 (const :tag "Ham: ifile" (ham spam-use-ifile))
1912 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1913 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1914 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1915 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1916 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1917 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1918 :function-document
1919 "Which spam or ham processors will be applied when the summary is exited."
1920 :variable gnus-spam-process-newsgroups
1921 :variable-default nil
1922 :variable-document
1923 "*Groups in which to automatically process spam or ham articles with
1924a backend on summary exit. If non-nil, this should be a list of group
1925name regexps that should match all groups in which to do automatic
1926spam processing, associated with the appropriate processor."
1927 :variable-group spam
1928 :variable-type
1929 '(repeat :tag "Spam/Ham Processors"
1930 (list :tag "Spam Summary Exit Processor Choices"
1931 (regexp :tag "Group Regexp")
1932 (set
1933 :tag "Spam/Ham Summary Exit Processor"
1934 (variable-item gnus-group-spam-exit-processor-ifile)
1935 (variable-item gnus-group-spam-exit-processor-stat)
1936 (variable-item gnus-group-spam-exit-processor-bogofilter)
1937 (variable-item gnus-group-spam-exit-processor-blacklist)
1938 (variable-item gnus-group-spam-exit-processor-spamoracle)
1939 (variable-item gnus-group-spam-exit-processor-report-gmane)
1940 (variable-item gnus-group-ham-exit-processor-bogofilter)
1941 (variable-item gnus-group-ham-exit-processor-ifile)
1942 (variable-item gnus-group-ham-exit-processor-stat)
1943 (variable-item gnus-group-ham-exit-processor-whitelist)
1944 (variable-item gnus-group-ham-exit-processor-BBDB)
1945 (variable-item gnus-group-ham-exit-processor-spamoracle)
1946 (variable-item gnus-group-ham-exit-processor-copy)
1947 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1948 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1949 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1950 (const :tag "Spam: ifile" (spam spam-use-ifile))
1951 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1952 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1953 (const :tag "Ham: ifile" (ham spam-use-ifile))
1954 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1955 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1956 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1957 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1958 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1959 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1960
1961 :parameter-document
1962 "Which spam or ham processors will be applied when the summary is exited.")
1963
1964 (gnus-define-group-parameter
1965 spam-autodetect
1966 :type list
1967 :parameter-type
1968 '(boolean :tag "Spam autodetection")
1969 :function-document
1970 "Should spam be autodetected (with spam-split) in this group?"
1971 :variable gnus-spam-autodetect
1972 :variable-default nil
1973 :variable-document
1974 "*Groups in which spam should be autodetected when they are entered.
1975 Only unseen articles will be examined, unless
1976 spam-autodetect-recheck-messages is set."
1977 :variable-group spam
1978 :variable-type
1979 '(repeat
1980 :tag "Autodetection setting"
1981 (list
1982 (regexp :tag "Group Regexp")
1983 boolean))
1984 :parameter-document
1985 "Spam autodetection.
1986Only unseen articles will be examined, unless
1987spam-autodetect-recheck-messages is set.")
1988
1989 (gnus-define-group-parameter
1990 spam-autodetect-methods
1991 :type list
1992 :parameter-type
1993 '(choice :tag "Spam autodetection-specific methods"
1994 (const none)
1995 (const default)
1996 (set :tag "Use specific methods"
1997 (variable-item spam-use-blacklist)
1998 (variable-item spam-use-regex-headers)
1999 (variable-item spam-use-regex-body)
2000 (variable-item spam-use-whitelist)
2001 (variable-item spam-use-BBDB)
2002 (variable-item spam-use-ifile)
2003 (variable-item spam-use-spamoracle)
2004 (variable-item spam-use-stat)
2005 (variable-item spam-use-blackholes)
2006 (variable-item spam-use-hashcash)
2007 (variable-item spam-use-bogofilter-headers)
2008 (variable-item spam-use-bogofilter)))
2009 :function-document
2010 "Methods to be used for autodetection in each group"
2011 :variable gnus-spam-autodetect-methods
2012 :variable-default nil
2013 :variable-document
2014 "*Methods for autodetecting spam per group.
2015Requires the spam-autodetect parameter. Only unseen articles
2016will be examined, unless spam-autodetect-recheck-messages is
2017set."
2018 :variable-group spam
2019 :variable-type
2020 '(repeat
2021 :tag "Autodetection methods"
2022 (list
2023 (regexp :tag "Group Regexp")
2024 (choice
2025 (const none)
2026 (const default)
2027 (set :tag "Use specific methods"
2028 (variable-item spam-use-blacklist)
2029 (variable-item spam-use-regex-headers)
2030 (variable-item spam-use-regex-body)
2031 (variable-item spam-use-whitelist)
2032 (variable-item spam-use-BBDB)
2033 (variable-item spam-use-ifile)
2034 (variable-item spam-use-spamoracle)
2035 (variable-item spam-use-stat)
2036 (variable-item spam-use-blackholes)
2037 (variable-item spam-use-hashcash)
2038 (variable-item spam-use-bogofilter-headers)
2039 (variable-item spam-use-bogofilter)))))
2040 :parameter-document
2041 "Spam autodetection methods.
2042Requires the spam-autodetect parameter. Only unseen articles
2043will be examined, unless spam-autodetect-recheck-messages is
2044set.")
2045
2046 (gnus-define-group-parameter
2047 spam-process-destination
2048 :type list
2049 :parameter-type
2050 '(choice :tag "Destination for spam-processed articles at summary exit"
2051 (string :tag "Move to a group")
2052 (repeat :tag "Move to multiple groups"
2053 (string :tag "Destination group"))
2054 (const :tag "Expire" nil))
2055 :function-document
2056 "Where spam-processed articles will go at summary exit."
2057 :variable gnus-spam-process-destinations
2058 :variable-default nil
2059 :variable-document
2060 "*Groups in which to explicitly send spam-processed articles to
2061another group, or expire them (the default). If non-nil, this should
2062be a list of group name regexps that should match all groups in which
2063to do spam-processed article moving, associated with the destination
2064group or nil for explicit expiration. This only makes sense for
2065mail groups."
2066 :variable-group spam
2067 :variable-type
2068 '(repeat
2069 :tag "Spam-processed articles destination"
2070 (list
2071 (regexp :tag "Group Regexp")
2072 (choice
2073 :tag "Destination for spam-processed articles at summary exit"
2074 (string :tag "Move to a group")
2075 (repeat :tag "Move to multiple groups"
2076 (string :tag "Destination group"))
2077 (const :tag "Expire" nil))))
2078 :parameter-document
2079 "Where spam-processed articles will go at summary exit.")
2080
2081 (gnus-define-group-parameter
2082 ham-process-destination
2083 :type list
2084 :parameter-type
2085 '(choice
2086 :tag "Destination for ham articles at summary exit from a spam group"
2087 (string :tag "Move to a group")
2088 (repeat :tag "Move to multiple groups"
2089 (string :tag "Destination group"))
2090 (const :tag "Respool" respool)
2091 (const :tag "Do nothing" nil))
2092 :function-document
2093 "Where ham articles will go at summary exit from a spam group."
2094 :variable gnus-ham-process-destinations
2095 :variable-default nil
2096 :variable-document
2097 "*Groups in which to explicitly send ham articles to
2098another group, or do nothing (the default). If non-nil, this should
2099be a list of group name regexps that should match all groups in which
2100to do ham article moving, associated with the destination
2101group or nil for explicit ignoring. This only makes sense for
2102mail groups, and only works in spam groups."
2103 :variable-group spam
2104 :variable-type
2105 '(repeat
2106 :tag "Ham articles destination"
2107 (list
2108 (regexp :tag "Group Regexp")
2109 (choice
2110 :tag "Destination for ham articles at summary exit from spam group"
2111 (string :tag "Move to a group")
2112 (repeat :tag "Move to multiple groups"
2113 (string :tag "Destination group"))
2114 (const :tag "Respool" respool)
2115 (const :tag "Expire" nil))))
2116 :parameter-document
2117 "Where ham articles will go at summary exit from a spam group.")
2118
2119 (gnus-define-group-parameter
2120 ham-marks
2121 :type 'list
2122 :parameter-type '(list :tag "Ham mark choices"
2123 (set
2124 (variable-item gnus-del-mark)
2125 (variable-item gnus-read-mark)
2126 (variable-item gnus-ticked-mark)
2127 (variable-item gnus-killed-mark)
2128 (variable-item gnus-kill-file-mark)
2129 (variable-item gnus-low-score-mark)))
2130
2131 :parameter-document
2132 "Marks considered ham (positively not spam). Such articles will be
2133processed as ham (non-spam) on group exit. When nil, the global
2134spam-ham-marks variable takes precedence."
2135 :variable-default '((".*" ((gnus-del-mark
2136 gnus-read-mark
2137 gnus-killed-mark
2138 gnus-kill-file-mark
2139 gnus-low-score-mark))))
2140 :variable-group spam
2141 :variable-document
2142 "*Groups in which to explicitly set the ham marks to some value.")
2143
2144 (gnus-define-group-parameter
2145 spam-marks
2146 :type 'list
2147 :parameter-type '(list :tag "Spam mark choices"
2148 (set
2149 (variable-item gnus-spam-mark)
2150 (variable-item gnus-killed-mark)
2151 (variable-item gnus-kill-file-mark)
2152 (variable-item gnus-low-score-mark)))
2153
2154 :parameter-document
2155 "Marks considered spam.
2156Such articles will be processed as spam on group exit. When nil, the global
2157spam-spam-marks variable takes precedence."
2158 :variable-default '((".*" ((gnus-spam-mark))))
2159 :variable-group spam
2160 :variable-document
2161 "*Groups in which to explicitly set the spam marks to some value."))
eec82323
LMI
2162
2163(defcustom gnus-group-uncollapsed-levels 1
2164 "Number of group name elements to leave alone when making a short group name."
2165 :group 'gnus-group-visual
2166 :type 'integer)
2167
2168(defcustom gnus-group-use-permanent-levels nil
2169 "*If non-nil, once you set a level, Gnus will use this level."
2170 :group 'gnus-group-levels
2171 :type 'boolean)
2172
2173;; Hooks.
2174
2175(defcustom gnus-load-hook nil
2176 "A hook run while Gnus is loaded."
2177 :group 'gnus-start
2178 :type 'hook)
2179
2180(defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2181 "A hook called to apply kill files to a group.
2182This hook is intended to apply a kill file to the selected newsgroup.
2183The function `gnus-apply-kill-file' is called by default.
2184
2185Since a general kill file is too heavy to use only for a few
2186newsgroups, I recommend you to use a lighter hook function. For
2187example, if you'd like to apply a kill file to articles which contains
2188a string `rmgroup' in subject in newsgroup `control', you can use the
2189following hook:
2190
2191 (setq gnus-apply-kill-hook
2192 (list
2193 (lambda ()
2194 (cond ((string-match \"control\" gnus-newsgroup-name)
2195 (gnus-kill \"Subject\" \"rmgroup\")
2196 (gnus-expunge \"X\"))))))"
2197 :group 'gnus-score-kill
2198 :options '(gnus-apply-kill-file)
2199 :type 'hook)
2200
2201(defcustom gnus-group-change-level-function nil
2202 "Function run when a group level is changed.
2203It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
16409b0b 2204 :group 'gnus-group-levels
eec82323
LMI
2205 :type 'function)
2206
2207;;; Face thingies.
2208
2209(defcustom gnus-visual
2210 '(summary-highlight group-highlight article-highlight
2211 mouse-face
2212 summary-menu group-menu article-menu
2213 tree-highlight menu highlight
2214 browse-menu server-menu
2215 page-marker tree-menu binary-menu pick-menu
2216 grouplens-menu)
6748645f 2217 "*Enable visual features.
eec82323
LMI
2218If `visual' is disabled, there will be no menus and few faces. Most of
2219the visual customization options below will be ignored. Gnus will use
2220less space and be faster as a result.
2221
2222This variable can also be a list of visual elements to switch on. For
2223instance, to switch off all visual things except menus, you can say:
2224
2225 (setq gnus-visual '(menu))
2226
2227Valid elements include `summary-highlight', `group-highlight',
2228`article-highlight', `mouse-face', `summary-menu', `group-menu',
2229`article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2230`server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2231and `grouplens-menu'."
2232 :group 'gnus-meta
2233 :group 'gnus-visual
2234 :type '(set (const summary-highlight)
2235 (const group-highlight)
2236 (const article-highlight)
2237 (const mouse-face)
2238 (const summary-menu)
2239 (const group-menu)
2240 (const article-menu)
2241 (const tree-highlight)
2242 (const menu)
2243 (const highlight)
2244 (const browse-menu)
2245 (const server-menu)
2246 (const page-marker)
2247 (const tree-menu)
2248 (const binary-menu)
2249 (const pick-menu)
2250 (const grouplens-menu)))
2251
23f87bed
MB
2252;; Byte-compiler warning.
2253(defvar gnus-visual)
2254;; Find out whether the gnus-visual TYPE is wanted.
2255(defun gnus-visual-p (&optional type class)
2256 (and gnus-visual ; Has to be non-nil, at least.
2257 (if (not type) ; We don't care about type.
2258 gnus-visual
2259 (if (listp gnus-visual) ; It's a list, so we check it.
2260 (or (memq type gnus-visual)
2261 (memq class gnus-visual))
2262 t))))
2263
eec82323
LMI
2264(defcustom gnus-mouse-face
2265 (condition-case ()
2266 (if (gnus-visual-p 'mouse-face 'highlight)
2267 (if (boundp 'gnus-mouse-face)
2268 (or gnus-mouse-face 'highlight)
2269 'highlight)
2270 'default)
2271 (error 'highlight))
6748645f 2272 "*Face used for group or summary buffer mouse highlighting.
eec82323
LMI
2273The line beneath the mouse pointer will be highlighted with this
2274face."
2275 :group 'gnus-visual
2276 :type 'face)
2277
eec82323
LMI
2278(defcustom gnus-article-save-directory gnus-directory
2279 "*Name of the directory articles will be saved in (default \"~/News\")."
2280 :group 'gnus-article-saving
2281 :type 'directory)
2282
6748645f
LMI
2283(defvar gnus-plugged t
2284 "Whether Gnus is plugged or not.")
2285
23f87bed
MB
2286(defcustom gnus-agent-cache t
2287 "Controls use of the agent cache while plugged.
2288When set, Gnus will prefer using the locally stored content rather
2289than re-fetching it from the server. You also need to enable
2290`gnus-agent' for this to have any affect."
2291 :version "21.3"
2292 :group 'gnus-agent
2293 :type 'boolean)
2294
2295(defcustom gnus-default-charset 'undecided
16409b0b
GM
2296 "Default charset assumed to be used when viewing non-ASCII characters.
2297This variable is overridden on a group-to-group basis by the
23f87bed 2298`gnus-group-charset-alist' variable and is only used on groups not
16409b0b
GM
2299covered by that variable."
2300 :type 'symbol
2301 :group 'gnus-charset)
2302
23f87bed
MB
2303;; Fixme: Doc reference to agent.
2304(defcustom gnus-agent t
2305 "Whether we want to use the Gnus agent or not.
2306
2307You may customize gnus-agent to disable its use. However, some
2308back ends have started to use the agent as a client-side cache.
2309Disabling the agent may result in noticeable loss of performance."
2310 :version "21.3"
2311 :group 'gnus-agent
2312 :type 'boolean)
2313
2314(defcustom gnus-other-frame-function 'gnus
2315 "Function called by the command `gnus-other-frame'."
2316 :group 'gnus-start
2317 :type '(choice (function-item gnus)
2318 (function-item gnus-no-server)
2319 (function-item gnus-slave)
2320 (function-item gnus-slave-no-server)))
2321
2322(defcustom gnus-other-frame-parameters nil
2323 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2324This should be an alist for Emacs, or a plist for XEmacs."
2325 :group 'gnus-start
2326 :type (if (featurep 'xemacs)
2327 '(repeat (list :inline t :format "%v"
2328 (symbol :tag "Property")
2329 (sexp :tag "Value")))
2330 '(repeat (cons :format "%v"
2331 (symbol :tag "Parameter")
2332 (sexp :tag "Value")))))
2333
2334(defcustom gnus-user-agent 'emacs-gnus-type
2335 "Which information should be exposed in the User-Agent header.
2336
2337It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2338\(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2339`emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2340`emacs-gnus' plus system type\) or a custom string. If you set it to a
2341string, be sure to use a valid format, see RFC 2616."
2342 :group 'gnus-message
2343 :type '(choice
2344 (item :tag "Show Gnus and Emacs versions and system type"
2345 emacs-gnus-type)
2346 (item :tag "Show Gnus and Emacs versions and system configuration"
2347 emacs-gnus-config)
2348 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2349 (item :tag "Show only Gnus version" gnus)
2350 (string :tag "Other")))
16409b0b 2351
eec82323
LMI
2352\f
2353;;; Internal variables
2354
48df946a 2355(defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
16409b0b 2356(defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
23f87bed
MB
2357(defvar gnus-agent-method-p-cache nil
2358 ; Reset each time gnus-agent-covered-methods is changed else
2359 ; gnus-agent-method-p may mis-report a methods status.
2360 )
2361(defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2362(defvar gnus-draft-meta-information-header "X-Draft-From")
eec82323
LMI
2363(defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2364(defvar gnus-original-article-buffer " *Original Article*")
2365(defvar gnus-newsgroup-name nil)
6748645f 2366(defvar gnus-ephemeral-servers nil)
23f87bed 2367(defvar gnus-server-method-cache nil)
6748645f 2368
48df946a
DL
2369(defvar gnus-agent-fetching nil
2370 "Whether Gnus agent is in fetching mode.")
2371
23f87bed
MB
2372(defvar gnus-agent-covered-methods nil
2373 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2374
6748645f 2375(defvar gnus-command-method nil
23f87bed 2376 "Dynamically bound variable that says what the current back end is.")
eec82323
LMI
2377
2378(defvar gnus-current-select-method nil
2379 "The current method for selecting a newsgroup.")
2380
2381(defvar gnus-tree-buffer "*Tree*"
2382 "Buffer where Gnus thread trees are displayed.")
2383
2384;; Dummy variable.
2385(defvar gnus-use-generic-from nil)
2386
2387;; Variable holding the user answers to all method prompts.
2388(defvar gnus-method-history nil)
eec82323
LMI
2389
2390;; Variable holding the user answers to all mail method prompts.
2391(defvar gnus-mail-method-history nil)
2392
2393;; Variable holding the user answers to all group prompts.
2394(defvar gnus-group-history nil)
2395
2396(defvar gnus-server-alist nil
2397 "List of available servers.")
2398
6748645f
LMI
2399(defcustom gnus-cache-directory
2400 (nnheader-concat gnus-directory "cache/")
2401 "*The directory where cached articles will be stored."
2402 :group 'gnus-cache
2403 :type 'directory)
2404
eec82323
LMI
2405(defvar gnus-predefined-server-alist
2406 `(("cache"
6748645f
LMI
2407 nnspool "cache"
2408 (nnspool-spool-directory ,gnus-cache-directory)
2409 (nnspool-nov-directory ,gnus-cache-directory)
2410 (nnspool-active-file
2411 ,(nnheader-concat gnus-cache-directory "active"))))
eec82323
LMI
2412 "List of predefined (convenience) servers.")
2413
23f87bed 2414(defvar gnus-topic-indentation "") ;; Obsolete variable.
eec82323
LMI
2415
2416(defconst gnus-article-mark-lists
2417 '((marked . tick) (replied . reply)
2418 (expirable . expire) (killed . killed)
2419 (bookmarks . bookmark) (dormant . dormant)
2420 (scored . score) (saved . save)
6748645f 2421 (cached . cache) (downloadable . download)
23f87bed
MB
2422 (unsendable . unsend) (forwarded . forward)
2423 (recent . recent) (seen . seen)))
2424
2425(defconst gnus-article-special-mark-lists
2426 '((seen range)
2427 (killed range)
2428 (bookmark tuple)
2429 (score tuple)))
2430
2431;; Propagate flags to server, with the following exceptions:
2432;; `seen' is private to each gnus installation
2433;; `cache' is a internal gnus flag for each gnus installation
2434;; `download' is a agent flag private to each gnus installation
2435;; `unsend' are for nndraft groups only
2436;; `score' is not a proper mark
2437;; `bookmark': don't propagated it, or fix the bug in update-mark.
2438(defconst gnus-article-unpropagated-mark-lists
2439 '(seen cache download unsend score bookmark)
2440 "Marks that shouldn't be propagated to back ends.
2441Typical marks are those that make no sense in a standalone back end,
2442such as a mark that says whether an article is stored in the cache
2443\(which doesn't make sense in a standalone back end).")
eec82323
LMI
2444
2445(defvar gnus-headers-retrieved-by nil)
2446(defvar gnus-article-reply nil)
2447(defvar gnus-override-method nil)
2448(defvar gnus-article-check-size nil)
2449(defvar gnus-opened-servers nil)
2450
2451(defvar gnus-current-kill-article nil)
2452
2453(defvar gnus-have-read-active-file nil)
2454
2455(defconst gnus-maintainer
2456 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2457 "The mail address of the Gnus maintainers.")
2458
2459(defvar gnus-info-nodes
23f87bed
MB
2460 '((gnus-group-mode "(gnus)Group Buffer")
2461 (gnus-summary-mode "(gnus)Summary Buffer")
2462 (gnus-article-mode "(gnus)Article Buffer")
2463 (gnus-server-mode "(gnus)Server Buffer")
eec82323
LMI
2464 (gnus-browse-mode "(gnus)Browse Foreign Server")
2465 (gnus-tree-mode "(gnus)Tree Display"))
2466 "Alist of major modes and related Info nodes.")
2467
2468(defvar gnus-group-buffer "*Group*")
2469(defvar gnus-summary-buffer "*Summary*")
2470(defvar gnus-article-buffer "*Article*")
2471(defvar gnus-server-buffer "*Server*")
2472
eec82323
LMI
2473(defvar gnus-slave nil
2474 "Whether this Gnus is a slave or not.")
2475
2476(defvar gnus-batch-mode nil
2477 "Whether this Gnus is running in batch mode or not.")
2478
2479(defvar gnus-variable-list
2480 '(gnus-newsrc-options gnus-newsrc-options-n
16409b0b
GM
2481 gnus-newsrc-last-checked-date
2482 gnus-newsrc-alist gnus-server-alist
2483 gnus-killed-list gnus-zombie-list
2484 gnus-topic-topology gnus-topic-alist
2485 gnus-format-specs)
eec82323
LMI
2486 "Gnus variables saved in the quick startup file.")
2487
2488(defvar gnus-newsrc-alist nil
2489 "Assoc list of read articles.
23f87bed
MB
2490`gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2491
2492(defvar gnus-registry-alist nil
2493 "Assoc list of registry data.
2494gnus-registry.el will populate this if it's loaded.")
eec82323
LMI
2495
2496(defvar gnus-newsrc-hashtb nil
23f87bed 2497 "Hashtable of `gnus-newsrc-alist'.")
eec82323
LMI
2498
2499(defvar gnus-killed-list nil
2500 "List of killed newsgroups.")
2501
2502(defvar gnus-killed-hashtb nil
23f87bed 2503 "Hash table equivalent of `gnus-killed-list'.")
eec82323
LMI
2504
2505(defvar gnus-zombie-list nil
2506 "List of almost dead newsgroups.")
2507
2508(defvar gnus-description-hashtb nil
2509 "Descriptions of newsgroups.")
2510
2511(defvar gnus-list-of-killed-groups nil
2512 "List of newsgroups that have recently been killed by the user.")
2513
2514(defvar gnus-active-hashtb nil
2515 "Hashtable of active articles.")
2516
2517(defvar gnus-moderated-hashtb nil
2518 "Hashtable of moderated newsgroups.")
2519
2520;; Save window configuration.
2521(defvar gnus-prev-winconf nil)
2522
2523(defvar gnus-reffed-article-number nil)
2524
2525;;; Let the byte-compiler know that we know about this variable.
2526(defvar rmail-default-rmail-file)
2527
2528(defvar gnus-dead-summary nil)
2529
16409b0b
GM
2530(defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2531 "Regexp matching invalid groups.")
2532
23f87bed
MB
2533(defvar gnus-other-frame-object nil
2534 "A frame object which will be created by `gnus-other-frame'.")
2535
eec82323
LMI
2536;;; End of variables.
2537
2538;; Define some autoload functions Gnus might use.
2539(eval-and-compile
2540
2541 ;; This little mapcar goes through the list below and marks the
2542 ;; symbols in question as autoloaded functions.
2543 (mapcar
2544 (lambda (package)
2545 (let ((interactive (nth 1 (memq ':interactive package))))
2546 (mapcar
2547 (lambda (function)
2548 (let (keymap)
2549 (when (consp function)
2550 (setq keymap (car (memq 'keymap function)))
2551 (setq function (car function)))
16409b0b
GM
2552 (unless (fboundp function)
2553 (autoload function (car package) nil interactive keymap))))
eec82323 2554 (if (eq (nth 1 package) ':interactive)
16409b0b 2555 (nthcdr 3 package)
eec82323 2556 (cdr package)))))
16409b0b 2557 '(("info" :interactive t Info-goto-node)
ceaed79b 2558 ("pp" pp-to-string)
16409b0b 2559 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
eec82323 2560 ("ps-print" ps-print-preprint)
eec82323
LMI
2561 ("message" :interactive t
2562 message-send-and-exit message-yank-original)
16409b0b
GM
2563 ("babel" babel-as-string)
2564 ("nnmail" nnmail-split-fancy nnmail-article-group)
eec82323 2565 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
16409b0b 2566 ("rmailout" rmail-output rmail-output-to-rmail-file)
eec82323 2567 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
6748645f
LMI
2568 rmail-show-message rmail-summary-exists
2569 rmail-select-summary rmail-update-summary)
eec82323
LMI
2570 ("gnus-audio" :interactive t gnus-audio-play)
2571 ("gnus-xmas" gnus-xmas-splash)
2572 ("gnus-soup" :interactive t
2573 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2574 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2575 ("nnsoup" nnsoup-pack-replies)
2576 ("score-mode" :interactive t gnus-score-mode)
2577 ("gnus-mh" gnus-summary-save-article-folder
2578 gnus-Folder-save-name gnus-folder-save-name)
2579 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2580 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2581 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2582 gnus-demon-add-disconnection gnus-demon-add-handler
2583 gnus-demon-remove-handler)
2584 ("gnus-demon" :interactive t
2585 gnus-demon-init gnus-demon-cancel)
23f87bed
MB
2586 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2587 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2588 gnus-face-from-file)
eec82323
LMI
2589 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2590 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2591 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2592 gnus-nocem-unwanted-article-p)
6748645f
LMI
2593 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2594 gnus-server-server-name)
eec82323
LMI
2595 ("gnus-srvr" gnus-browse-foreign-server)
2596 ("gnus-cite" :interactive t
2597 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2598 gnus-article-hide-citation gnus-article-fill-cited-article
2599 gnus-article-hide-citation-in-followups)
2600 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2601 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
16409b0b 2602 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
eec82323
LMI
2603 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2604 gnus-cache-possibly-remove-articles gnus-cache-request-article
2605 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2606 gnus-cache-enter-remove-article gnus-cached-article-p
16409b0b
GM
2607 gnus-cache-open gnus-cache-close gnus-cache-update-article
2608 gnus-cache-articles-in-group)
2609 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2610 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2611 ("gnus-score" :interactive t
2612 gnus-summary-increase-score gnus-summary-set-score
2613 gnus-summary-raise-thread gnus-summary-raise-same-subject
2614 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2615 gnus-summary-lower-thread gnus-summary-lower-same-subject
2616 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2617 gnus-summary-current-score gnus-score-delta-default
2618 gnus-score-flush-cache gnus-score-close
2619 gnus-possibly-score-headers gnus-score-followup-article
2620 gnus-score-followup-thread)
2621 ("gnus-score"
2622 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
eec82323
LMI
2623 gnus-current-score-file-nondirectory gnus-score-adaptive
2624 gnus-score-find-trace gnus-score-file-name)
2625 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2626 ("gnus-topic" :interactive t gnus-topic-mode)
16409b0b
GM
2627 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2628 gnus-subscribe-topics)
eec82323
LMI
2629 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2630 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2631 ("gnus-uu" :interactive t
2632 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2633 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2634 gnus-uu-mark-by-regexp gnus-uu-mark-all
2635 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2636 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2637 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2638 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2639 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2640 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
6748645f 2641 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
16409b0b
GM
2642 gnus-uu-mark-over gnus-uu-post-news)
2643 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
eec82323
LMI
2644 ("gnus-msg" (gnus-summary-send-map keymap)
2645 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2646 ("gnus-msg" :interactive t
23f87bed
MB
2647 gnus-group-post-news gnus-group-mail gnus-group-news
2648 gnus-summary-post-news gnus-summary-news-other-window
eec82323
LMI
2649 gnus-summary-followup gnus-summary-followup-with-original
2650 gnus-summary-cancel-article gnus-summary-supersede-article
2651 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2652 gnus-summary-mail-forward gnus-summary-mail-other-window
2653 gnus-summary-resend-message gnus-summary-resend-bounced-mail
6748645f
LMI
2654 gnus-summary-wide-reply gnus-summary-followup-to-mail
2655 gnus-summary-followup-to-mail-with-original gnus-bug
2656 gnus-summary-wide-reply-with-original
2657 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2658 gnus-summary-post-forward)
23f87bed 2659 ("gnus-picon" :interactive t gnus-treat-from-picon)
eec82323
LMI
2660 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2661 gnus-grouplens-mode)
23f87bed 2662 ("smiley" :interactive t smiley-region)
eec82323
LMI
2663 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2664 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2665 gnus-list-of-unread-articles gnus-list-of-read-articles
2666 gnus-offer-save-summaries gnus-make-thread-indent-array
6748645f
LMI
2667 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2668 gnus-summary-skip-intangible gnus-summary-article-number
2669 gnus-data-header gnus-data-find)
eec82323
LMI
2670 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2671 gnus-group-list-groups gnus-group-first-unread-group
2672 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2673 gnus-group-setup-buffer gnus-group-get-new-news
6748645f 2674 gnus-group-make-help-group gnus-group-update-group
16409b0b 2675 gnus-group-iterate gnus-group-group-name)
eec82323
LMI
2676 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2677 gnus-backlog-remove-article)
2678 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2679 gnus-article-prepare gnus-article-set-window-start
2680 gnus-article-next-page gnus-article-prev-page
2681 gnus-request-article-this-buffer gnus-article-mode
2682 gnus-article-setup-buffer gnus-narrow-to-page
16409b0b 2683 gnus-article-delete-invisible-text gnus-treat-article)
eec82323
LMI
2684 ("gnus-art" :interactive t
2685 gnus-article-hide-headers gnus-article-hide-boring-headers
16409b0b 2686 gnus-article-treat-overstrike
eec82323
LMI
2687 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2688 gnus-article-display-x-face gnus-article-de-quoted-unreadable
16409b0b
GM
2689 gnus-article-de-base64-unreadable
2690 gnus-article-decode-HZ
2691 gnus-article-wash-html
23f87bed 2692 gnus-article-unsplit-urls
eec82323
LMI
2693 gnus-article-hide-pem gnus-article-hide-signature
2694 gnus-article-strip-leading-blank-lines gnus-article-date-local
2695 gnus-article-date-original gnus-article-date-lapsed
23f87bed 2696;; gnus-article-show-all-headers
eec82323 2697 gnus-article-edit-mode gnus-article-edit-article
16409b0b
GM
2698 gnus-article-edit-done gnus-article-decode-encoded-words
2699 gnus-start-date-timer gnus-stop-date-timer
2700 gnus-mime-view-all-parts)
eec82323
LMI
2701 ("gnus-int" gnus-request-type)
2702 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
6748645f 2703 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
eec82323
LMI
2704 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2705 gnus-dup-enter-articles)
2706 ("gnus-range" gnus-copy-sequence)
2707 ("gnus-eform" gnus-edit-form)
2708 ("gnus-move" :interactive t
2709 gnus-group-move-group-to-server gnus-change-server)
2710 ("gnus-logic" gnus-score-advanced)
2711 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2712 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2713 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2714 gnus-async-halt-prefetch)
6748645f
LMI
2715 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2716 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2717 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
23f87bed
MB
2718 gnus-summary-set-agent-mark gnus-agent-save-group-info
2719 gnus-agent-request-article gnus-agent-retrieve-headers)
6748645f
LMI
2720 ("gnus-agent" :interactive t
2721 gnus-unplugged gnus-agentize gnus-agent-batch)
eec82323 2722 ("gnus-vm" :interactive t gnus-summary-save-in-vm
6748645f 2723 gnus-summary-save-article-vm)
23f87bed
MB
2724 ("compface" uncompface)
2725 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
16409b0b
GM
2726 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2727 ("gnus-mlspl" :interactive t gnus-group-split-setup
23f87bed
MB
2728 gnus-group-split-update)
2729 ("gnus-delay" gnus-delay-initialize))))
eec82323
LMI
2730
2731;;; gnus-sum.el thingies
2732
2733
23f87bed 2734(defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
eec82323
LMI
2735 "*The format specification of the lines in the summary buffer.
2736
2737It works along the same lines as a normal formatting string,
2738with some simple extensions.
2739
2740%N Article number, left padded with spaces (string)
2741%S Subject (string)
2742%s Subject if it is at the root of a thread, and \"\" otherwise (string)
2743%n Name of the poster (string)
2744%a Extracted name of the poster (string)
2745%A Extracted address of the poster (string)
2746%F Contents of the From: header (string)
16409b0b 2747%f Contents of the From: or To: headers (string)
eec82323
LMI
2748%x Contents of the Xref: header (string)
2749%D Date of the article (string)
2750%d Date of the article (string) in DD-MMM format
23f87bed 2751%o Date of the article (string) in YYYYMMDD`T'HHMMSS format
eec82323
LMI
2752%M Message-id of the article (string)
2753%r References of the article (string)
2754%c Number of characters in the article (integer)
23f87bed
MB
2755%k Pretty-printed version of the above (string)
2756 For example, \"1.2k\" or \"0.4M\".
eec82323
LMI
2757%L Number of lines in the article (integer)
2758%I Indentation based on thread level (a string of spaces)
23f87bed
MB
2759%B A complex trn-style thread tree (string)
2760 The variables `gnus-sum-thread-*' can be used for customization.
eec82323
LMI
2761%T A string with two possible values: 80 spaces if the article
2762 is on thread level two or larger and 0 spaces on level one
2763%R \"A\" if this article has been replied to, \" \" otherwise (character)
2764%U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2765%[ Opening bracket (character, \"[\" or \"<\")
2766%] Closing bracket (character, \"]\" or \">\")
2767%> Spaces of length thread-level (string)
2768%< Spaces of length (- 20 thread-level) (string)
2769%i Article score (number)
2770%z Article zcore (character)
2771%t Number of articles under the current thread (number).
2772%e Whether the thread is empty or not (character).
2773%l GroupLens score (string).
2774%V Total thread score (number).
2775%P The line number (number).
6748645f 2776%O Download mark (character).
23f87bed
MB
2777%* If present, indicates desired cursor position
2778 (instead of after first colon).
eec82323
LMI
2779%u User defined specifier. The next character in the format string should
2780 be a letter. Gnus will call the function gnus-user-format-function-X,
2781 where X is the letter following %u. The function will be passed the
2782 current header as argument. The function should return a string, which
2783 will be inserted into the summary just like information from any other
2784 summary specifier.
2785
eec82323
LMI
2786The %U (status), %R (replied) and %z (zcore) specs have to be handled
2787with care. For reasons of efficiency, Gnus will compute what column
2788these characters will end up in, and \"hard-code\" that. This means that
16409b0b 2789it is invalid to have these specs after a variable-length spec. Well,
eec82323
LMI
2790you might not be arrested, but your summary buffer will look strange,
2791which is bad enough.
2792
23f87bed 2793The smart choice is to have these specs as far to the left as
eec82323
LMI
2794possible.
2795
23f87bed
MB
2796This restriction may disappear in later versions of Gnus.
2797
2798General format specifiers can also be used.
2799See Info node `(gnus)Formatting Variables'."
2800 :link '(custom-manual "(gnus)Formatting Variables")
eec82323
LMI
2801 :type 'string
2802 :group 'gnus-summary-format)
2803
2804;;;
2805;;; Skeleton keymaps
2806;;;
2807
2808(defun gnus-suppress-keymap (keymap)
2809 (suppress-keymap keymap)
6748645f 2810 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
eec82323
LMI
2811 (while keys
2812 (define-key keymap (pop keys) 'undefined))))
2813
2814(defvar gnus-article-mode-map
16409b0b 2815 (let ((keymap (make-sparse-keymap)))
eec82323
LMI
2816 (gnus-suppress-keymap keymap)
2817 keymap))
2818(defvar gnus-summary-mode-map
2819 (let ((keymap (make-keymap)))
2820 (gnus-suppress-keymap keymap)
2821 keymap))
2822(defvar gnus-group-mode-map
2823 (let ((keymap (make-keymap)))
2824 (gnus-suppress-keymap keymap)
2825 keymap))
2826
2827\f
2828
2829;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2830;; If you want the cursor to go somewhere else, set these two
2831;; functions in some startup hook to whatever you want.
2832(defalias 'gnus-summary-position-point 'gnus-goto-colon)
2833(defalias 'gnus-group-position-point 'gnus-goto-colon)
2834
2835;;; Various macros and substs.
2836
2837(defun gnus-header-from (header)
2838 (mail-header-from header))
2839
2840(defmacro gnus-gethash (string hashtable)
2841 "Get hash value of STRING in HASHTABLE."
2842 `(symbol-value (intern-soft ,string ,hashtable)))
2843
23f87bed
MB
2844(defmacro gnus-gethash-safe (string hashtable)
2845 "Get hash value of STRING in HASHTABLE.
2846Return nil if not defined."
2847 `(let ((sym (intern-soft ,string ,hashtable)))
2848 (and (boundp sym) (symbol-value sym))))
2849
eec82323
LMI
2850(defmacro gnus-sethash (string value hashtable)
2851 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2852 `(set (intern ,string ,hashtable) ,value))
2853(put 'gnus-sethash 'edebug-form-spec '(form form form))
2854
2855(defmacro gnus-group-unread (group)
2856 "Get the currently computed number of unread articles in GROUP."
2857 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2858
2859(defmacro gnus-group-entry (group)
2860 "Get the newsrc entry for GROUP."
2861 `(gnus-gethash ,group gnus-newsrc-hashtb))
2862
2863(defmacro gnus-active (group)
2864 "Get active info on GROUP."
2865 `(gnus-gethash ,group gnus-active-hashtb))
2866
2867(defmacro gnus-set-active (group active)
2868 "Set GROUP's active info."
2869 `(gnus-sethash ,group ,active gnus-active-hashtb))
2870
eec82323
LMI
2871;; Info access macros.
2872
2873(defmacro gnus-info-group (info)
2874 `(nth 0 ,info))
2875(defmacro gnus-info-rank (info)
2876 `(nth 1 ,info))
2877(defmacro gnus-info-read (info)
2878 `(nth 2 ,info))
2879(defmacro gnus-info-marks (info)
2880 `(nth 3 ,info))
2881(defmacro gnus-info-method (info)
2882 `(nth 4 ,info))
2883(defmacro gnus-info-params (info)
2884 `(nth 5 ,info))
2885
2886(defmacro gnus-info-level (info)
2887 `(let ((rank (gnus-info-rank ,info)))
2888 (if (consp rank)
2889 (car rank)
2890 rank)))
2891(defmacro gnus-info-score (info)
2892 `(let ((rank (gnus-info-rank ,info)))
2893 (or (and (consp rank) (cdr rank)) 0)))
2894
2895(defmacro gnus-info-set-group (info group)
2896 `(setcar ,info ,group))
2897(defmacro gnus-info-set-rank (info rank)
2898 `(setcar (nthcdr 1 ,info) ,rank))
2899(defmacro gnus-info-set-read (info read)
2900 `(setcar (nthcdr 2 ,info) ,read))
2901(defmacro gnus-info-set-marks (info marks &optional extend)
2902 (if extend
2903 `(gnus-info-set-entry ,info ,marks 3)
2904 `(setcar (nthcdr 3 ,info) ,marks)))
2905(defmacro gnus-info-set-method (info method &optional extend)
2906 (if extend
2907 `(gnus-info-set-entry ,info ,method 4)
2908 `(setcar (nthcdr 4 ,info) ,method)))
2909(defmacro gnus-info-set-params (info params &optional extend)
2910 (if extend
2911 `(gnus-info-set-entry ,info ,params 5)
2912 `(setcar (nthcdr 5 ,info) ,params)))
2913
2914(defun gnus-info-set-entry (info entry number)
2915 ;; Extend the info until we have enough elements.
2916 (while (<= (length info) number)
2917 (nconc info (list nil)))
2918 ;; Set the entry.
2919 (setcar (nthcdr number info) entry))
2920
2921(defmacro gnus-info-set-level (info level)
2922 `(let ((rank (cdr ,info)))
2923 (if (consp (car rank))
2924 (setcar (car rank) ,level)
2925 (setcar rank ,level))))
2926(defmacro gnus-info-set-score (info score)
2927 `(let ((rank (cdr ,info)))
2928 (if (consp (car rank))
2929 (setcdr (car rank) ,score)
2930 (setcar rank (cons (car rank) ,score)))))
2931
2932(defmacro gnus-get-info (group)
2933 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2934
8f688cb0 2935;;; Load the compatibility functions.
eec82323
LMI
2936
2937(require 'gnus-ems)
2938
2939\f
2940;;;
2941;;; Shutdown
2942;;;
2943
2944(defvar gnus-shutdown-alist nil)
2945
2946(defun gnus-add-shutdown (function &rest symbols)
2947 "Run FUNCTION whenever one of SYMBOLS is shut down."
2948 (push (cons function symbols) gnus-shutdown-alist))
2949
2950(defun gnus-shutdown (symbol)
2951 "Shut down everything that waits for SYMBOL."
2952 (let ((alist gnus-shutdown-alist)
2953 entry)
2954 (while (setq entry (pop alist))
2955 (when (memq symbol (cdr entry))
2956 (funcall (car entry))))))
2957
2958\f
2959;;;
2960;;; Gnus Utility Functions
2961;;;
2962
23f87bed
MB
2963(defun gnus-find-subscribed-addresses ()
2964 "Return a regexp matching the addresses of all subscribed mail groups.
2965It consists of the `to-address' or `to-list' parameter of all groups
2966with a `subscribed' parameter."
2967 (let (group address addresses)
2968 (dolist (entry (cdr gnus-newsrc-alist))
2969 (setq group (car entry))
2970 (when (gnus-parameter-subscribed group)
2971 (setq address (mail-strip-quoted-names
2972 (or (gnus-group-fast-parameter group 'to-address)
2973 (gnus-group-fast-parameter group 'to-list))))
2974 (when address
2975 (add-to-list 'addresses address))))
2976 (when addresses
2977 (list (mapconcat 'regexp-quote addresses "\\|")))))
6748645f 2978
a8151ef7
LMI
2979(defmacro gnus-string-or (&rest strings)
2980 "Return the first element of STRINGS that is a non-blank string.
2981STRINGS will be evaluated in normal `or' order."
2982 `(gnus-string-or-1 ',strings))
2983
2984(defun gnus-string-or-1 (strings)
2985 (let (string)
2986 (while strings
2987 (setq string (eval (pop strings)))
2988 (if (string-match "^[ \t]*$" string)
2989 (setq string nil)
2990 (setq strings nil)))
2991 string))
2992
eec82323
LMI
2993(defun gnus-version (&optional arg)
2994 "Version number of this version of Gnus.
2995If ARG, insert string at point."
2996 (interactive "P")
6748645f
LMI
2997 (if arg
2998 (insert (message gnus-version))
2999 (message gnus-version)))
eec82323 3000
23f87bed 3001(defun gnus-continuum-version (&optional version)
eec82323 3002 "Return VERSION as a floating point number."
23f87bed
MB
3003 (interactive)
3004 (unless version
3005 (setq version gnus-version))
eec82323
LMI
3006 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3007 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
6748645f
LMI
3008 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3009 (number (match-string 2 version))
3010 major minor least)
3011 (unless (string-match
3012 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3013 (error "Invalid version string: %s" version))
3014 (setq major (string-to-number (match-string 1 number))
3015 minor (string-to-number (match-string 2 number))
3016 least (if (match-beginning 3)
eec82323
LMI
3017 (string-to-number (match-string 3 number))
3018 0))
3019 (string-to-number
3020 (if (zerop major)
23f87bed
MB
3021 (format "%s00%02d%02d"
3022 (if (member alpha '("(ding)" "d"))
3023 "4.99"
3024 (+ 5 (* 0.02
3025 (abs
3026 (- (mm-char-int (aref (downcase alpha) 0))
3027 (mm-char-int ?t))))
3028 -0.01))
3029 minor least)
eec82323
LMI
3030 (format "%d.%02d%02d" major minor least))))))
3031
23f87bed 3032(defun gnus-info-find-node (&optional nodename)
eec82323
LMI
3033 "Find Info documentation of Gnus."
3034 (interactive)
3035 ;; Enlarge info window if needed.
3036 (let (gnus-info-buffer)
23f87bed 3037 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
eec82323
LMI
3038 (setq gnus-info-buffer (current-buffer))
3039 (gnus-configure-windows 'info)))
3040
6748645f
LMI
3041;;;
3042;;; gnus-interactive
3043;;;
3044
3045(defvar gnus-current-prefix-symbol nil
3046 "Current prefix symbol.")
3047
3048(defvar gnus-current-prefix-symbols nil
3049 "List of current prefix symbols.")
3050
3051(defun gnus-interactive (string &optional params)
3052 "Return a list that can be fed to `interactive'.
3053See `interactive' for full documentation.
3054
3055Adds the following specs:
3056
3057y -- The current symbolic prefix.
3058Y -- A list of the current symbolic prefix(es).
3059A -- Article number.
3060H -- Article header.
3061g -- Group name."
3062 (let ((i 0)
3063 out c prompt)
3064 (while (< i (length string))
3065 (string-match ".\\([^\n]*\\)\n?" string i)
3066 (setq c (aref string i))
3067 (when (match-end 1)
3068 (setq prompt (match-string 1 string)))
3069 (setq i (match-end 0))
3070 ;; We basically emulate just about everything that
3071 ;; `interactive' does, but add the specs listed above.
3072 (push
3073 (cond
3074 ((= c ?a)
3075 (completing-read prompt obarray 'fboundp t))
3076 ((= c ?b)
3077 (read-buffer prompt (current-buffer) t))
3078 ((= c ?B)
3079 (read-buffer prompt (other-buffer (current-buffer))))
3080 ((= c ?c)
3081 (read-char))
3082 ((= c ?C)
3083 (completing-read prompt obarray 'commandp t))
3084 ((= c ?d)
3085 (point))
3086 ((= c ?D)
3087 (read-file-name prompt nil default-directory 'lambda))
3088 ((= c ?f)
3089 (read-file-name prompt nil nil 'lambda))
3090 ((= c ?F)
3091 (read-file-name prompt))
3092 ((= c ?k)
3093 (read-key-sequence prompt))
3094 ((= c ?K)
3095 (error "Not implemented spec"))
3096 ((= c ?e)
3097 (error "Not implemented spec"))
3098 ((= c ?m)
3099 (mark))
3100 ((= c ?N)
3101 (error "Not implemented spec"))
3102 ((= c ?n)
3103 (string-to-number (read-from-minibuffer prompt)))
3104 ((= c ?p)
3105 (prefix-numeric-value current-prefix-arg))
3106 ((= c ?P)
3107 current-prefix-arg)
3108 ((= c ?r)
3109 'gnus-prefix-nil)
3110 ((= c ?s)
3111 (read-string prompt))
3112 ((= c ?S)
3113 (intern (read-string prompt)))
3114 ((= c ?v)
3115 (read-variable prompt))
3116 ((= c ?x)
3117 (read-minibuffer prompt))
3118 ((= c ?x)
3119 (eval-minibuffer prompt))
3120 ;; And here the new specs come.
3121 ((= c ?y)
3122 gnus-current-prefix-symbol)
3123 ((= c ?Y)
3124 gnus-current-prefix-symbols)
3125 ((= c ?g)
3126 (gnus-group-group-name))
3127 ((= c ?A)
3128 (gnus-summary-skip-intangible)
3129 (or (get-text-property (point) 'gnus-number)
3130 (gnus-summary-last-subject)))
3131 ((= c ?H)
3132 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3133 (t
3134 (error "Non-implemented spec")))
3135 out)
3136 (cond
3137 ((= c ?r)
fa066d09
GM
3138 (push (if (< (point) (mark)) (point) (mark)) out)
3139 (push (if (> (point) (mark)) (point) (mark)) out))))
6748645f
LMI
3140 (setq out (delq 'gnus-prefix-nil out))
3141 (nreverse out)))
3142
3143(defun gnus-symbolic-argument (&optional arg)
3144 "Read a symbolic argument and a command, and then execute command."
3145 (interactive "P")
3146 (let* ((in-command (this-command-keys))
3147 (command in-command)
3148 gnus-current-prefix-symbols
3149 gnus-current-prefix-symbol
3150 syms)
3151 (while (equal in-command command)
3152 (message "%s-" (key-description (this-command-keys)))
3153 (push (intern (char-to-string (read-char))) syms)
3154 (setq command (read-key-sequence nil t)))
3155 (setq gnus-current-prefix-symbols (nreverse syms)
3156 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3157 (call-interactively (key-binding command t))))
3158
eec82323
LMI
3159;;; More various functions.
3160
a36c8d02
RS
3161(defsubst gnus-check-backend-function (func group)
3162 "Check whether GROUP supports function FUNC.
3163GROUP can either be a string (a group name) or a select method."
3164 (ignore-errors
3165 (let ((method (if (stringp group)
3166 (car (gnus-find-method-for-group group))
3167 group)))
3168 (unless (featurep method)
3169 (require method))
3170 (fboundp (intern (format "%s-%s" method func))))))
3171
eec82323
LMI
3172(defun gnus-group-read-only-p (&optional group)
3173 "Check whether GROUP supports editing or not.
3174If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3175that that variable is buffer-local to the summary buffers."
3176 (let ((group (or group gnus-newsgroup-name)))
3177 (not (gnus-check-backend-function 'request-replace-article group))))
3178
eec82323
LMI
3179(defun gnus-virtual-group-p (group)
3180 "Say whether GROUP is virtual or not."
3181 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3182 gnus-valid-select-methods)))
3183
3184(defun gnus-news-group-p (group &optional article)
3185 "Return non-nil if GROUP (and ARTICLE) come from a news server."
23f87bed
MB
3186 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3187 t) ;is news of course.
3188 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3189 nil) ;must be mail then.
3190 ((vectorp article) ;Has header info.
3191 (eq (gnus-request-type group (mail-header-id article)) 'news))
3192 ((null article) ;Hasn't header info
3193 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3194 ((< article 0) ;Virtual message
3195 nil) ;we don't know, guess mail.
3196 (t ;Has positive number
3197 (eq (gnus-request-type group article) 'news)))) ;use it.
eec82323
LMI
3198
3199;; Returns a list of writable groups.
3200(defun gnus-writable-groups ()
3201 (let ((alist gnus-newsrc-alist)
3202 groups group)
3203 (while (setq group (car (pop alist)))
3204 (unless (gnus-group-read-only-p group)
3205 (push group groups)))
3206 (nreverse groups)))
3207
3208;; Check whether to use long file names.
3209(defun gnus-use-long-file-name (symbol)
3210 ;; The variable has to be set...
3211 (and gnus-use-long-file-name
3212 ;; If it isn't a list, then we return t.
3213 (or (not (listp gnus-use-long-file-name))
3214 ;; If it is a list, and the list contains `symbol', we
3215 ;; return nil.
3216 (not (memq symbol gnus-use-long-file-name)))))
3217
3218;; Generate a unique new group name.
3219(defun gnus-generate-new-group-name (leaf)
3220 (let ((name leaf)
3221 (num 0))
3222 (while (gnus-gethash name gnus-newsrc-hashtb)
3223 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3224 name))
3225
3226(defun gnus-ephemeral-group-p (group)
3227 "Say whether GROUP is ephemeral or not."
6748645f 3228 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3229
3230(defun gnus-group-quit-config (group)
3231 "Return the quit-config of GROUP."
6748645f 3232 (gnus-group-get-parameter group 'quit-config t))
eec82323
LMI
3233
3234(defun gnus-kill-ephemeral-group (group)
3235 "Remove ephemeral GROUP from relevant structures."
3236 (gnus-sethash group nil gnus-newsrc-hashtb))
3237
3238(defun gnus-simplify-mode-line ()
3239 "Make mode lines a bit simpler."
a8151ef7 3240 (setq mode-line-modified (cdr gnus-mode-line-modified))
eec82323
LMI
3241 (when (listp mode-line-format)
3242 (make-local-variable 'mode-line-format)
3243 (setq mode-line-format (copy-sequence mode-line-format))
3244 (when (equal (nth 3 mode-line-format) " ")
3245 (setcar (nthcdr 3 mode-line-format) " "))))
3246
3247;;; Servers and groups.
3248
3249(defsubst gnus-server-add-address (method)
3250 (let ((method-name (symbol-name (car method))))
3251 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3252 (not (assq (intern (concat method-name "-address")) method))
3253 (memq 'physical-address (assq (car method)
3254 gnus-valid-select-methods)))
3255 (append method (list (list (intern (concat method-name "-address"))
3256 (nth 1 method))))
3257 method)))
3258
23f87bed
MB
3259(defsubst gnus-server-to-method (server)
3260 "Map virtual server names to select methods."
3261 (or (and server (listp server) server)
3262 (cdr (assoc server gnus-server-method-cache))
3263 (let ((result
3264 (or
3265 ;; Perhaps this is the native server?
3266 (and (equal server "native") gnus-select-method)
3267 ;; It should be in the server alist.
3268 (cdr (assoc server gnus-server-alist))
3269 ;; It could be in the predefined server alist.
3270 (cdr (assoc server gnus-predefined-server-alist))
3271 ;; If not, we look through all the opened server
3272 ;; to see whether we can find it there.
3273 (let ((opened gnus-opened-servers))
3274 (while (and opened
3275 (not (equal server (format "%s:%s" (caaar opened)
3276 (cadaar opened)))))
3277 (pop opened))
3278 (caar opened))
3279 ;; It could be a named method, search all servers
3280 (let ((servers gnus-secondary-select-methods))
3281 (while (and servers
3282 (not (equal server (format "%s:%s" (caar servers)
3283 (cadar servers)))))
3284 (pop servers))
3285 (car servers))
3286 ;; This could be some sort of foreign server that I
3287 ;; simply haven't opened (yet). Do a brute-force scan
3288 ;; of the entire gnus-newsrc-alist for the server name
3289 ;; of every method. As a side-effect, loads the
3290 ;; gnus-server-method-cache so this only happens once,
3291 ;; if at all.
3292 (let (match)
3293 (mapcar
3294 (lambda (info)
3295 (let ((info-method (gnus-info-method info)))
3296 (unless (stringp info-method)
3297 (let ((info-server (gnus-method-to-server info-method)))
3298 (when (equal server info-server)
3299 (setq match info-method))))))
3300 (cdr gnus-newsrc-alist))
3301 match))))
3302 (when result
3303 (push (cons server result) gnus-server-method-cache))
3304 result)))
3305
3306(defsubst gnus-method-to-server (method)
3307 (catch 'server-name
3308 (setq method (or method gnus-select-method))
3309
3310 ;; Perhaps it is already in the cache.
3311 (mapc (lambda (name-method)
3312 (if (equal (cdr name-method) method)
3313 (throw 'server-name (car name-method))))
3314 gnus-server-method-cache)
3315
3316 (mapc
3317 (lambda (server-alist)
3318 (mapc (lambda (name-method)
3319 (when (gnus-methods-equal-p (cdr name-method) method)
3320 (unless (member name-method gnus-server-method-cache)
3321 (push name-method gnus-server-method-cache))
3322 (throw 'server-name (car name-method))))
3323 server-alist))
3324 (let ((alists (list gnus-server-alist
3325 gnus-predefined-server-alist)))
3326 (if gnus-select-method
3327 (push (list (cons "native" gnus-select-method)) alists))
3328 alists))
3329
3330 (let* ((name (if (member (cadr method) '(nil ""))
3331 (format "%s" (car method))
3332 (format "%s:%s" (car method) (cadr method))))
3333 (name-method (cons name method)))
3334 (unless (member name-method gnus-server-method-cache)
3335 (push name-method gnus-server-method-cache))
3336 name)))
3337
eec82323
LMI
3338(defsubst gnus-server-get-method (group method)
3339 ;; Input either a server name, and extended server name, or a
3340 ;; select method, and return a select method.
3341 (cond ((stringp method)
3342 (gnus-server-to-method method))
3343 ((equal method gnus-select-method)
3344 gnus-select-method)
6748645f
LMI
3345 ((and (stringp (car method))
3346 group)
eec82323 3347 (gnus-server-extend-method group method))
6748645f
LMI
3348 ((and method
3349 (not group)
eec82323
LMI
3350 (equal (cadr method) ""))
3351 method)
3352 (t
3353 (gnus-server-add-address method))))
3354
eec82323
LMI
3355(defmacro gnus-method-equal (ss1 ss2)
3356 "Say whether two servers are equal."
3357 `(let ((s1 ,ss1)
3358 (s2 ,ss2))
3359 (or (equal s1 s2)
3360 (and (= (length s1) (length s2))
3361 (progn
3362 (while (and s1 (member (car s1) s2))
3363 (setq s1 (cdr s1)))
3364 (null s1))))))
3365
16409b0b
GM
3366(defun gnus-methods-equal-p (m1 m2)
3367 (let ((m1 (or m1 gnus-select-method))
3368 (m2 (or m2 gnus-select-method)))
3369 (or (equal m1 m2)
3370 (and (eq (car m1) (car m2))
3371 (or (not (memq 'address (assoc (symbol-name (car m1))
3372 gnus-valid-select-methods)))
3373 (equal (nth 1 m1) (nth 1 m2)))))))
3374
eec82323
LMI
3375(defun gnus-server-equal (m1 m2)
3376 "Say whether two methods are equal."
3377 (let ((m1 (cond ((null m1) gnus-select-method)
3378 ((stringp m1) (gnus-server-to-method m1))
3379 (t m1)))
3380 (m2 (cond ((null m2) gnus-select-method)
3381 ((stringp m2) (gnus-server-to-method m2))
3382 (t m2))))
3383 (gnus-method-equal m1 m2)))
3384
3385(defun gnus-servers-using-backend (backend)
3386 "Return a list of known servers using BACKEND."
3387 (let ((opened gnus-opened-servers)
3388 out)
3389 (while opened
3390 (when (eq backend (caaar opened))
3391 (push (caar opened) out))
3392 (pop opened))
3393 out))
3394
3395(defun gnus-archive-server-wanted-p ()
3396 "Say whether the user wants to use the archive server."
3397 (cond
3398 ((or (not gnus-message-archive-method)
3399 (not gnus-message-archive-group))
3400 nil)
3401 ((and gnus-message-archive-method gnus-message-archive-group)
3402 t)
3403 (t
3404 (let ((active (cadr (assq 'nnfolder-active-file
3405 gnus-message-archive-method))))
3406 (and active
3407 (file-exists-p active))))))
3408
23f87bed
MB
3409(defsubst gnus-method-to-server-name (method)
3410 (concat
3411 (format "%s" (car method))
3412 (when (and
3413 (or (assoc (format "%s" (car method))
3414 (gnus-methods-using 'address))
3415 (gnus-server-equal method gnus-message-archive-method))
3416 (nth 1 method)
3417 (not (string= (nth 1 method) "")))
3418 (concat "+" (nth 1 method)))))
3419
3420(defsubst gnus-method-to-full-server-name (method)
3421 (format "%s+%s" (car method) (nth 1 method)))
3422
3423(defun gnus-group-prefixed-name (group method &optional full)
3424 "Return the whole name from GROUP and METHOD.
3425Call with full set to get the fully qualified group name (even if the
3426server is native)."
3427 (when (stringp method)
3428 (setq method (gnus-server-to-method method)))
6748645f 3429 (if (or (not method)
23f87bed
MB
3430 (and (not full) (gnus-server-equal method "native"))
3431 ;;;!!! This might not be right. We'll see...
3432 ;(string-match ":" group)
3433 )
eec82323 3434 group
23f87bed
MB
3435 (concat (gnus-method-to-server-name method) ":" group)))
3436
3437(defun gnus-group-guess-prefixed-name (group)
3438 "Guess the whole name from GROUP and METHOD."
3439 (gnus-group-prefixed-name group (gnus-find-method-for-group
3440 group)))
3441
3442(defun gnus-group-full-name (group method)
3443 "Return the full name from GROUP and METHOD, even if the method is native."
3444 (gnus-group-prefixed-name group method t))
3445
3446(defun gnus-group-guess-full-name (group)
3447 "Guess the full name from GROUP, even if the method is native."
3448 (if (gnus-group-prefixed-p group)
3449 group
3450 (gnus-group-full-name group (gnus-find-method-for-group group))))
3451
3452(defun gnus-group-guess-full-name-from-command-method (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-command-method)))
eec82323
LMI
3457
3458(defun gnus-group-real-prefix (group)
3459 "Return the prefix of the current group name."
23f87bed
MB
3460 (if (stringp group)
3461 (if (string-match "^[^:]+:" group)
3462 (substring group 0 (match-end 0))
3463 "")
3464 nil))
3465
3466(defun gnus-group-short-name (group)
3467 "Return the short group name."
3468 (let ((prefix (gnus-group-real-prefix group)))
3469 (if (< 0 (length prefix))
3470 (substring group (length prefix) nil)
3471 group)))
3472
3473(defun gnus-group-prefixed-p (group)
3474 "Return the prefix of the current group name."
3475 (< 0 (length (gnus-group-real-prefix group))))
3476
3477(defun gnus-summary-buffer-name (group)
3478 "Return the summary buffer name of GROUP."
3479 (concat "*Summary " (gnus-group-decoded-name group) "*"))
eec82323
LMI
3480
3481(defun gnus-group-method (group)
3482 "Return the server or method used for selecting GROUP.
3483You should probably use `gnus-find-method-for-group' instead."
3484 (let ((prefix (gnus-group-real-prefix group)))
3485 (if (equal prefix "")
3486 gnus-select-method
3487 (let ((servers gnus-opened-servers)
3488 (server "")
3489 backend possible found)
3490 (if (string-match "^[^\\+]+\\+" prefix)
3491 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3492 server (substring prefix (match-end 0) (1- (length prefix))))
3493 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3494 (while servers
3495 (when (eq (caaar servers) backend)
3496 (setq possible (caar servers))
3497 (when (equal (cadaar servers) server)
3498 (setq found (caar servers))))
3499 (pop servers))
3500 (or (car (rassoc found gnus-server-alist))
3501 found
3502 (car (rassoc possible gnus-server-alist))
3503 possible
3504 (list backend server))))))
3505
16409b0b
GM
3506(defsubst gnus-native-method-p (method)
3507 "Return whether METHOD is the native select method."
3508 (gnus-method-equal method gnus-select-method))
3509
eec82323
LMI
3510(defsubst gnus-secondary-method-p (method)
3511 "Return whether METHOD is a secondary select method."
3512 (let ((methods gnus-secondary-select-methods)
23f87bed 3513 (gmethod (inline (gnus-server-get-method nil method))))
eec82323 3514 (while (and methods
16409b0b 3515 (not (gnus-method-equal
23f87bed 3516 (inline (gnus-server-get-method nil (car methods)))
16409b0b 3517 gmethod)))
eec82323
LMI
3518 (setq methods (cdr methods)))
3519 methods))
3520
16409b0b
GM
3521(defun gnus-method-simplify (method)
3522 "Return the shortest uniquely identifying string or method for METHOD."
3523 (cond ((stringp method)
3524 method)
3525 ((gnus-native-method-p method)
3526 nil)
3527 ((gnus-secondary-method-p method)
3528 (format "%s:%s" (nth 0 method) (nth 1 method)))
3529 (t
3530 method)))
3531
6748645f
LMI
3532(defun gnus-groups-from-server (server)
3533 "Return a list of all groups that are fetched from SERVER."
3534 (let ((alist (cdr gnus-newsrc-alist))
3535 info groups)
3536 (while (setq info (pop alist))
3537 (when (gnus-server-equal (gnus-info-method info) server)
3538 (push (gnus-info-group info) groups)))
3539 (sort groups 'string<)))
3540
eec82323
LMI
3541(defun gnus-group-foreign-p (group)
3542 "Say whether a group is foreign or not."
3543 (and (not (gnus-group-native-p group))
3544 (not (gnus-group-secondary-p group))))
3545
3546(defun gnus-group-native-p (group)
3547 "Say whether the group is native or not."
3548 (not (string-match ":" group)))
3549
3550(defun gnus-group-secondary-p (group)
3551 "Say whether the group is secondary or not."
3552 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3553
23f87bed
MB
3554(defun gnus-parameters-get-parameter (group)
3555 "Return the group parameters for GROUP from `gnus-parameters'."
3556 (let (params-list)
3557 (dolist (elem gnus-parameters)
3558 (when (string-match (car elem) group)
3559 (setq params-list
3560 (nconc (gnus-expand-group-parameters
3561 (car elem) (cdr elem) group)
3562 params-list))))
3563 params-list))
3564
3565(defun gnus-expand-group-parameter (match value group)
3566 "Use MATCH to expand VALUE in GROUP."
3567 (with-temp-buffer
3568 (insert group)
3569 (goto-char (point-min))
3570 (while (re-search-forward match nil t)
3571 (replace-match value))
3572 (buffer-string)))
3573
3574(defun gnus-expand-group-parameters (match parameters group)
3575 "Go through PARAMETERS and expand them according to the match data."
3576 (let (new)
3577 (dolist (elem parameters)
3578 (if (and (stringp (cdr elem))
3579 (string-match "\\\\[0-9&]" (cdr elem)))
3580 (push (cons (car elem)
3581 (gnus-expand-group-parameter match (cdr elem) group))
3582 new)
3583 (push elem new)))
3584 new))
3585
3586(defun gnus-group-fast-parameter (group symbol &optional allow-list)
3587 "For GROUP, return the value of SYMBOL.
3588
3589You should call this in the `gnus-group-buffer' buffer.
3590The function `gnus-group-find-parameter' will do that for you."
3591 ;; The speed trick: No cons'ing and quit early.
3592 (let* ((params (funcall gnus-group-get-parameter-function group))
3593 ;; Start easy, check the "real" group parameters.
3594 (simple-results
3595 (gnus-group-parameter-value params symbol allow-list t)))
3596 (if simple-results
3597 ;; Found results; return them.
3598 (car simple-results)
3599 ;; We didn't found it there, try `gnus-parameters'.
3600 (let ((result nil)
3601 (head nil)
3602 (tail gnus-parameters))
3603 ;; A good old-fashioned non-cl loop.
3604 (while tail
3605 (setq head (car tail)
3606 tail (cdr tail))
3607 ;; The car is regexp matching for matching the group name.
3608 (when (string-match (car head) group)
3609 ;; The cdr is the parameters.
3610 (setq result (gnus-group-parameter-value (cdr head)
3611 symbol allow-list))
3612 (when result
3613 ;; Expand if necessary.
3614 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3615 (setq result (gnus-expand-group-parameter (car head)
3616 result group)))
3617 ;; Exit the loop early.
3618 (setq tail nil))))
3619 ;; Done.
3620 result))))
3621
6748645f 3622(defun gnus-group-find-parameter (group &optional symbol allow-list)
eec82323 3623 "Return the group parameters for GROUP.
23f87bed
MB
3624If SYMBOL, return the value of that symbol in the group parameters.
3625
3626If you call this function inside a loop, consider using the faster
3627`gnus-group-fast-parameter' instead."
eec82323
LMI
3628 (save-excursion
3629 (set-buffer gnus-group-buffer)
23f87bed
MB
3630 (if symbol
3631 (gnus-group-fast-parameter group symbol allow-list)
3632 (nconc
3633 (copy-sequence
3634 (funcall gnus-group-get-parameter-function group))
3635 (gnus-parameters-get-parameter group)))))
eec82323 3636
6748645f 3637(defun gnus-group-get-parameter (group &optional symbol allow-list)
eec82323 3638 "Return the group parameters for GROUP.
6748645f
LMI
3639If SYMBOL, return the value of that symbol in the group parameters.
3640Most functions should use `gnus-group-find-parameter', which
3641also examines the topic parameters."
eec82323
LMI
3642 (let ((params (gnus-info-params (gnus-get-info group))))
3643 (if symbol
6748645f 3644 (gnus-group-parameter-value params symbol allow-list)
eec82323
LMI
3645 params)))
3646
23f87bed
MB
3647(defun gnus-group-parameter-value (params symbol &optional
3648 allow-list present-p)
eec82323 3649 "Return the value of SYMBOL in group PARAMS."
6748645f
LMI
3650 ;; We only wish to return group parameters (dotted lists) and
3651 ;; not local variables, which may have the same names.
3652 ;; But first we handle single elements...
3653 (or (car (memq symbol params))
3654 ;; Handle alist.
3655 (let (elem)
3656 (catch 'found
3657 (while (setq elem (pop params))
3658 (when (and (consp elem)
3659 (eq (car elem) symbol)
3660 (or allow-list
3661 (atom (cdr elem))))
23f87bed
MB
3662 (throw 'found (if present-p (list (cdr elem))
3663 (cdr elem)))))))))
eec82323
LMI
3664
3665(defun gnus-group-add-parameter (group param)
3666 "Add parameter PARAM to GROUP."
3667 (let ((info (gnus-get-info group)))
3668 (when info
3669 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3670 ;; Cons the new param to the old one and update.
3671 (gnus-group-set-info (cons param (gnus-info-params info))
3672 group 'params))))
3673
3674(defun gnus-group-set-parameter (group name value)
3675 "Set parameter NAME to VALUE in GROUP."
3676 (let ((info (gnus-get-info group)))
3677 (when info
3678 (gnus-group-remove-parameter group name)
3679 (let ((old-params (gnus-info-params info))
3680 (new-params (list (cons name value))))
3681 (while old-params
3682 (when (or (not (listp (car old-params)))
3683 (not (eq (caar old-params) name)))
3684 (setq new-params (append new-params (list (car old-params)))))
3685 (setq old-params (cdr old-params)))
3686 (gnus-group-set-info new-params group 'params)))))
3687
3688(defun gnus-group-remove-parameter (group name)
3689 "Remove parameter NAME from GROUP."
3690 (let ((info (gnus-get-info group)))
3691 (when info
3692 (let ((params (gnus-info-params info)))
3693 (when params
3694 (setq params (delq name params))
3695 (while (assq name params)
6748645f 3696 (gnus-pull name params))
eec82323
LMI
3697 (gnus-info-set-params info params))))))
3698
3699(defun gnus-group-add-score (group &optional score)
3700 "Add SCORE to the GROUP score.
3701If SCORE is nil, add 1 to the score of GROUP."
3702 (let ((info (gnus-get-info group)))
3703 (when info
3704 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3705
eec82323
LMI
3706(defun gnus-short-group-name (group &optional levels)
3707 "Collapse GROUP name LEVELS.
3708Select methods are stripped and any remote host name is stripped down to
3709just the host name."
6748645f
LMI
3710 (let* ((name "")
3711 (foreign "")
3712 (depth 0)
3713 (skip 1)
eec82323 3714 (levels (or levels
16409b0b 3715 gnus-group-uncollapsed-levels
eec82323
LMI
3716 (progn
3717 (while (string-match "\\." group skip)
3718 (setq skip (match-end 0)
3719 depth (+ depth 1)))
3720 depth))))
16409b0b 3721 ;; Separate foreign select method from group name and collapse.
23f87bed 3722 ;; If method contains a server, collapse to non-domain server name,
16409b0b
GM
3723 ;; otherwise collapse to select method.
3724 (let* ((colon (string-match ":" group))
3725 (server (and colon (substring group 0 colon)))
3726 (plus (and server (string-match "+" server))))
3727 (when server
3728 (if plus
3729 (setq foreign (substring server (+ 1 plus)
3730 (string-match "\\." server))
3731 group (substring group (+ 1 colon)))
3732 (setq foreign server
3733 group (substring group (+ 1 colon))))
3734 (setq foreign (concat foreign ":")))
3735 ;; Collapse group name leaving LEVELS uncollapsed elements
3736 (let* ((slist (split-string group "/"))
3737 (slen (length slist))
3738 (dlist (split-string group "\\."))
3739 (dlen (length dlist))
3740 glist
3741 glen
3742 gsep
3743 res)
3744 (if (> slen dlen)
3745 (setq glist slist
3746 glen slen
3747 gsep "/")
3748 (setq glist dlist
3749 glen dlen
3750 gsep "."))
3751 (setq levels (- glen levels))
3752 (dolist (g glist)
3753 (push (if (>= (decf levels) 0)
3754 (if (zerop (length g))
3755 ""
3756 (substring g 0 1))
3757 g)
3758 res))
3759 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
eec82323
LMI
3760
3761(defun gnus-narrow-to-body ()
3762 "Narrow to the body of an article."
3763 (narrow-to-region
3764 (progn
3765 (goto-char (point-min))
3766 (or (search-forward "\n\n" nil t)
3767 (point-max)))
3768 (point-max)))
3769
3770\f
3771;;;
3772;;; Kill file handling.
3773;;;
3774
3775(defun gnus-apply-kill-file ()
3776 "Apply a kill file to the current newsgroup.
3777Returns the number of articles marked as read."
3778 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3779 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3780 (gnus-apply-kill-file-internal)
3781 0))
3782
3783(defun gnus-kill-save-kill-buffer ()
3784 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3785 (when (get-file-buffer file)
3786 (save-excursion
3787 (set-buffer (get-file-buffer file))
3788 (when (buffer-modified-p)
3789 (save-buffer))
3790 (kill-buffer (current-buffer))))))
3791
3792(defcustom gnus-kill-file-name "KILL"
3793 "Suffix of the kill files."
3794 :group 'gnus-score-kill
3795 :group 'gnus-score-files
3796 :type 'string)
3797
3798(defun gnus-newsgroup-kill-file (newsgroup)
3799 "Return the name of a kill file name for NEWSGROUP.
3800If NEWSGROUP is nil, return the global kill file name instead."
3801 (cond
3802 ;; The global KILL file is placed at top of the directory.
3803 ((or (null newsgroup)
3804 (string-equal newsgroup ""))
3805 (expand-file-name gnus-kill-file-name
3806 gnus-kill-files-directory))
3807 ;; Append ".KILL" to newsgroup name.
3808 ((gnus-use-long-file-name 'not-kill)
3809 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3810 "." gnus-kill-file-name)
3811 gnus-kill-files-directory))
3812 ;; Place "KILL" under the hierarchical directory.
3813 (t
3814 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3815 "/" gnus-kill-file-name)
3816 gnus-kill-files-directory))))
3817
3818;;; Server things.
3819
3820(defun gnus-member-of-valid (symbol group)
3821 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3822 (memq symbol (assoc
3823 (symbol-name (car (gnus-find-method-for-group group)))
3824 gnus-valid-select-methods)))
3825
3826(defun gnus-method-option-p (method option)
3827 "Return non-nil if select METHOD has OPTION as a parameter."
3828 (when (stringp method)
3829 (setq method (gnus-server-to-method method)))
3830 (memq option (assoc (format "%s" (car method))
3831 gnus-valid-select-methods)))
3832
3833(defun gnus-similar-server-opened (method)
3834 (let ((opened gnus-opened-servers))
3835 (while (and method opened)
3836 (when (and (equal (cadr method) (cadaar opened))
16409b0b 3837 (equal (car method) (caaar opened))
eec82323
LMI
3838 (not (equal method (caar opened))))
3839 (setq method nil))
3840 (pop opened))
3841 (not method)))
3842
3843(defun gnus-server-extend-method (group method)
3844 ;; This function "extends" a virtual server. If the server is
3845 ;; "hello", and the select method is ("hello" (my-var "something"))
3846 ;; in the group "alt.alt", this will result in a new virtual server
3847 ;; called "hello+alt.alt".
3848 (if (or (not (inline (gnus-similar-server-opened method)))
3849 (not (cddr method)))
3850 method
3851 `(,(car method) ,(concat (cadr method) "+" group)
3852 (,(intern (format "%s-address" (car method))) ,(cadr method))
3853 ,@(cddr method))))
3854
3855(defun gnus-server-status (method)
3856 "Return the status of METHOD."
3857 (nth 1 (assoc method gnus-opened-servers)))
3858
3859(defun gnus-group-name-to-method (group)
3860 "Guess a select method based on GROUP."
3861 (if (string-match ":" group)
3862 (let ((server (substring group 0 (match-beginning 0))))
3863 (if (string-match "\\+" server)
3864 (list (intern (substring server 0 (match-beginning 0)))
3865 (substring server (match-end 0)))
3866 (list (intern server) "")))
3867 gnus-select-method))
3868
23f87bed
MB
3869(defun gnus-server-string (server)
3870 "Return a readable string that describes SERVER."
3871 (let* ((server (gnus-server-to-method server))
3872 (address (nth 1 server)))
3873 (if (and address
3874 (not (zerop (length address))))
3875 (format "%s using %s" address (car server))
3876 (format "%s" (car server)))))
3877
eec82323
LMI
3878(defun gnus-find-method-for-group (group &optional info)
3879 "Find the select method that GROUP uses."
3880 (or gnus-override-method
3881 (and (not group)
3882 gnus-select-method)
23f87bed 3883 (and (not (gnus-group-entry group)) ;; a new group
16409b0b 3884 (gnus-group-name-to-method group))
eec82323
LMI
3885 (let ((info (or info (gnus-get-info group)))
3886 method)
3887 (if (or (not info)
3888 (not (setq method (gnus-info-method info)))
3889 (equal method "native"))
3890 gnus-select-method
3891 (setq method
3892 (cond ((stringp method)
3893 (inline (gnus-server-to-method method)))
3894 ((stringp (cadr method))
3895 (inline (gnus-server-extend-method group method)))
3896 (t
3897 method)))
3898 (cond ((equal (cadr method) "")
3899 method)
3900 ((null (cadr method))
3901 (list (car method) ""))
3902 (t
3903 (gnus-server-add-address method)))))))
3904
eec82323
LMI
3905(defun gnus-methods-using (feature)
3906 "Find all methods that have FEATURE."
3907 (let ((valids gnus-valid-select-methods)
3908 outs)
3909 (while valids
3910 (when (memq feature (car valids))
3911 (push (car valids) outs))
3912 (setq valids (cdr valids)))
3913 outs))
3914
3915(defun gnus-read-group (prompt &optional default)
3916 "Prompt the user for a group name.
16409b0b 3917Disallow invalid group names."
eec82323
LMI
3918 (let ((prefix "")
3919 group)
3920 (while (not group)
a1506d29 3921 (when (string-match
16409b0b 3922 gnus-invalid-group-regexp
eec82323
LMI
3923 (setq group (read-string (concat prefix prompt)
3924 (cons (or default "") 0)
3925 'gnus-group-history)))
23f87bed
MB
3926 (let ((match (match-string 0 group)))
3927 ;; Might be okay (e.g. for nnimap), so ask the user:
3928 (unless (and (not (string-match "^$\\|:" match))
3929 (message-y-or-n-p
3930 "Proceed and create group anyway? " t
3931"The group name \"" group "\" contains a forbidden character: \"" match "\".
3932
3933Usually, it's dangerous to create a group with this name, because it's not
3934supported by all back ends and servers. On IMAP servers it should work,
3935though. If you are really sure, you can proceed anyway and create the group.
3936
3937You may customize the variable `gnus-invalid-group-regexp', which currently is
3938set to \"" gnus-invalid-group-regexp
3939"\", if you want to get rid of this query permanently."))
3940 (setq prefix (format "Invalid group name: \"%s\". " group)
3941 group nil)))))
eec82323
LMI
3942 group))
3943
3944(defun gnus-read-method (prompt)
3945 "Prompt the user for a method.
3946Allow completion over sensible values."
23f87bed
MB
3947 (let* ((open-servers
3948 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3949 gnus-opened-servers))
3950 (valid-methods
3951 (let (methods)
3952 (dolist (method gnus-valid-select-methods)
3953 (if (or (memq 'prompt-address method)
3954 (not (assoc (format "%s:" (car method)) open-servers)))
3955 (push method methods)))
3956 methods))
3957 (servers
3958 (append valid-methods
3959 open-servers
6748645f
LMI
3960 gnus-predefined-server-alist
3961 gnus-server-alist))
3962 (method
3963 (completing-read
3964 prompt servers
3965 nil t nil 'gnus-method-history)))
eec82323
LMI
3966 (cond
3967 ((equal method "")
3968 (setq method gnus-select-method))
3969 ((assoc method gnus-valid-select-methods)
16409b0b
GM
3970 (let ((address (if (memq 'prompt-address
3971 (assoc method gnus-valid-select-methods))
3972 (read-string "Address: ")
3973 "")))
23f87bed 3974 (or (cadr (assoc (format "%s:%s" method address) open-servers))
16409b0b 3975 (list (intern method) address))))
6748645f 3976 ((assoc method servers)
eec82323
LMI
3977 method)
3978 (t
3979 (list (intern method) "")))))
3980
23f87bed
MB
3981;;; Agent functions
3982
3983(defun gnus-agent-method-p (method)
3984 "Say whether METHOD is covered by the agent."
3985 (or (eq (car gnus-agent-method-p-cache) method)
3986 (setq gnus-agent-method-p-cache
3987 (cons method
3988 (member (if (stringp method)
3989 method
3990 (gnus-method-to-server method)) gnus-agent-covered-methods))))
3991 (cdr gnus-agent-method-p-cache))
3992
3993(defun gnus-online (method)
3994 (not
3995 (if gnus-plugged
3996 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3997 (gnus-agent-method-p method))))
3998
eec82323
LMI
3999;;; User-level commands.
4000
4001;;;###autoload
4002(defun gnus-slave-no-server (&optional arg)
23f87bed 4003 "Read network news as a slave, without connecting to the local server."
eec82323
LMI
4004 (interactive "P")
4005 (gnus-no-server arg t))
4006
4007;;;###autoload
4008(defun gnus-no-server (&optional arg slave)
4009 "Read network news.
23f87bed
MB
4010If ARG is a positive number, Gnus will use that as the startup
4011level. If ARG is nil, Gnus will be started at level 2. If ARG is
4012non-nil and not a positive number, Gnus will prompt the user for the
4013name of an NNTP server to use.
4014As opposed to `gnus', this command will not connect to the local
4015server."
eec82323
LMI
4016 (interactive "P")
4017 (gnus-no-server-1 arg slave))
4018
4019;;;###autoload
4020(defun gnus-slave (&optional arg)
4021 "Read news as a slave."
4022 (interactive "P")
4023 (gnus arg nil 'slave))
4024
4025;;;###autoload
23f87bed
MB
4026(defun gnus-other-frame (&optional arg display)
4027 "Pop up a frame to read news.
4028This will call one of the Gnus commands which is specified by the user
4029option `gnus-other-frame-function' (default `gnus') with the argument
4030ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4031optional second argument DISPLAY should be a standard display string
4032such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4033omitted or the function `make-frame-on-display' is not available, the
4034current display is used."
eec82323 4035 (interactive "P")
23f87bed
MB
4036 (if (fboundp 'make-frame-on-display)
4037 (unless display
4038 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4039 (setq display nil))
4040 (let ((alive (gnus-alive-p)))
4041 (unless (and alive
4042 (catch 'found
4043 (walk-windows
4044 (lambda (window)
4045 (when (and (or (not display)
4046 (equal display
4047 (gnus-frame-or-window-display-name
4048 window)))
4049 (with-current-buffer (window-buffer window)
4050 (string-match "\\`gnus-"
4051 (symbol-name major-mode))))
4052 (gnus-select-frame-set-input-focus
4053 (setq gnus-other-frame-object (window-frame window)))
4054 (select-window window)
4055 (throw 'found t)))
4056 'ignore t)))
4057 (gnus-select-frame-set-input-focus
4058 (setq gnus-other-frame-object
4059 (if display
4060 (make-frame-on-display display gnus-other-frame-parameters)
4061 (make-frame gnus-other-frame-parameters))))
4062 (if alive
4063 (switch-to-buffer gnus-group-buffer)
4064 (funcall gnus-other-frame-function arg)
4065 (add-hook 'gnus-exit-gnus-hook
4066 '(lambda nil
4067 (when (and (frame-live-p gnus-other-frame-object)
4068 (cdr (frame-list)))
4069 (delete-frame gnus-other-frame-object))
4070 (setq gnus-other-frame-object nil)))))))
eec82323 4071
16409b0b
GM
4072;;(setq thing ? ; this is a comment
4073;; more 'yes)
4074
eec82323
LMI
4075;;;###autoload
4076(defun gnus (&optional arg dont-connect slave)
4077 "Read network news.
4078If ARG is non-nil and a positive number, Gnus will use that as the
23f87bed 4079startup level. If ARG is non-nil and not a positive number, Gnus will
eec82323
LMI
4080prompt the user for the name of an NNTP server to use."
4081 (interactive "P")
23f87bed
MB
4082 (unless (byte-code-function-p (symbol-function 'gnus))
4083 (message "You should byte-compile Gnus")
4084 (sit-for 2))
eec82323
LMI
4085 (gnus-1 arg dont-connect slave))
4086
4087;; Allow redefinition of Gnus functions.
4088
4089(gnus-ems-redefine)
4090
4091(provide 'gnus)
4092
ab5796a9 4093;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
eec82323 4094;;; gnus.el ends here