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