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