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