cgit.sxemacs.org Git - gnus/blob - lisp/gnus.el

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