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