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