lisp/gnus/gnus.el

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