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