code.delx.au - gnu-emacs/blob - lisp/gnus/gnus.el

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