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