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