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