lisp/gnus/gnus.el

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