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