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