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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
   3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news, mail
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval '(run-hooks 'gnus-load-hook))
  31
  32 (eval-when-compile (require 'cl))
  33 (require 'mm-util)
  34
  35 (require 'message)
  36
  37 (defgroup gnus nil
  38   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  39   :group 'news
  40   :group 'mail)
  41
  42 (defgroup gnus-charset nil
  43   "Group character set issues."
  44   :link '(custom-manual "(gnus)Charsets")
  45   :group 'gnus)
  46
  47 (defgroup gnus-cache nil
  48   "Cache interface."
  49   :group 'gnus)
  50
  51 (defgroup gnus-start nil
  52   "Starting your favorite newsreader."
  53   :group 'gnus)
  54
  55 (defgroup gnus-start-server nil
  56   "Server options at startup."
  57   :group 'gnus-start)
  58
  59 ;; These belong to gnus-group.el.
  60 (defgroup gnus-group nil
  61   "Group buffers."
  62   :link '(custom-manual "(gnus)The Group Buffer")
  63   :group 'gnus)
  64
  65 (defgroup gnus-group-foreign nil
  66   "Foreign groups."
  67   :link '(custom-manual "(gnus)Foreign Groups")
  68   :group 'gnus-group)
  69
  70 (defgroup gnus-group-new nil
  71   "Automatic subscription of new groups."
  72   :group 'gnus-group)
  73
  74 (defgroup gnus-group-levels nil
  75   "Group levels."
  76   :link '(custom-manual "(gnus)Group Levels")
  77   :group 'gnus-group)
  78
  79 (defgroup gnus-group-select nil
  80   "Selecting a Group."
  81   :link '(custom-manual "(gnus)Selecting a Group")
  82   :group 'gnus-group)
  83
  84 (defgroup gnus-group-listing nil
  85   "Showing slices of the group list."
  86   :link '(custom-manual "(gnus)Listing Groups")
  87   :group 'gnus-group)
  88
  89 (defgroup gnus-group-visual nil
  90   "Sorting the group buffer."
  91   :link '(custom-manual "(gnus)Group Buffer Format")
  92   :group 'gnus-group
  93   :group 'gnus-visual)
  94
  95 (defgroup gnus-group-various nil
  96   "Various group options."
  97   :link '(custom-manual "(gnus)Scanning New Messages")
  98   :group 'gnus-group)
  99
 100 ;; These belong to gnus-sum.el.
 101 (defgroup gnus-summary nil
 102   "Summary buffers."
 103   :link '(custom-manual "(gnus)The Summary Buffer")
 104   :group 'gnus)
 105
 106 (defgroup gnus-summary-exit nil
 107   "Leaving summary buffers."
 108   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 109   :group 'gnus-summary)
 110
 111 (defgroup gnus-summary-marks nil
 112   "Marks used in summary buffers."
 113   :link '(custom-manual "(gnus)Marking Articles")
 114   :group 'gnus-summary)
 115
 116 (defgroup gnus-thread nil
 117   "Ordering articles according to replies."
 118   :link '(custom-manual "(gnus)Threading")
 119   :group 'gnus-summary)
 120
 121 (defgroup gnus-summary-format nil
 122   "Formatting of the summary buffer."
 123   :link '(custom-manual "(gnus)Summary Buffer Format")
 124   :group 'gnus-summary)
 125
 126 (defgroup gnus-summary-choose nil
 127   "Choosing Articles."
 128   :link '(custom-manual "(gnus)Choosing Articles")
 129   :group 'gnus-summary)
 130
 131 (defgroup gnus-summary-maneuvering nil
 132   "Summary movement commands."
 133   :link '(custom-manual "(gnus)Summary Maneuvering")
 134   :group 'gnus-summary)
 135
 136 (defgroup gnus-summary-mail nil
 137   "Mail group commands."
 138   :link '(custom-manual "(gnus)Mail Group Commands")
 139   :group 'gnus-summary)
 140
 141 (defgroup gnus-summary-sort nil
 142   "Sorting the summary buffer."
 143   :link '(custom-manual "(gnus)Sorting")
 144   :group 'gnus-summary)
 145
 146 (defgroup gnus-summary-visual nil
 147   "Highlighting and menus in the summary buffer."
 148   :link '(custom-manual "(gnus)Summary Highlighting")
 149   :group 'gnus-visual
 150   :group 'gnus-summary)
 151
 152 (defgroup gnus-summary-various nil
 153   "Various summary buffer options."
 154   :link '(custom-manual "(gnus)Various Summary Stuff")
 155   :group 'gnus-summary)
 156
 157 (defgroup gnus-summary-pick nil
 158   "Pick mode in the summary buffer."
 159   :link '(custom-manual "(gnus)Pick and Read")
 160   :prefix "gnus-pick-"
 161   :group 'gnus-summary)
 162
 163 (defgroup gnus-summary-tree nil
 164   "Tree display of threads in the summary buffer."
 165   :link '(custom-manual "(gnus)Tree Display")
 166   :prefix "gnus-tree-"
 167   :group 'gnus-summary)
 168
 169 ;; Belongs to gnus-uu.el
 170 (defgroup gnus-extract-view nil
 171   "Viewing extracted files."
 172   :link '(custom-manual "(gnus)Viewing Files")
 173   :group 'gnus-extract)
 174
 175 ;; Belongs to gnus-score.el
 176 (defgroup gnus-score nil
 177   "Score and kill file handling."
 178   :group 'gnus)
 179
 180 (defgroup gnus-score-kill nil
 181   "Kill files."
 182   :group 'gnus-score)
 183
 184 (defgroup gnus-score-adapt nil
 185   "Adaptive score files."
 186   :group 'gnus-score)
 187
 188 (defgroup gnus-score-default nil
 189   "Default values for score files."
 190   :group 'gnus-score)
 191
 192 (defgroup gnus-score-expire nil
 193   "Expiring score rules."
 194   :group 'gnus-score)
 195
 196 (defgroup gnus-score-decay nil
 197   "Decaying score rules."
 198   :group 'gnus-score)
 199
 200 (defgroup gnus-score-files nil
 201   "Score and kill file names."
 202   :group 'gnus-score
 203   :group 'gnus-files)
 204
 205 (defgroup gnus-score-various nil
 206   "Various scoring and killing options."
 207   :group 'gnus-score)
 208
 209 ;; Other
 210 (defgroup gnus-visual nil
 211   "Options controling the visual fluff."
 212   :group 'gnus
 213   :group 'faces)
 214
 215 (defgroup gnus-agent nil
 216   "Offline support for Gnus."
 217   :group 'gnus)
 218
 219 (defgroup gnus-files nil
 220   "Files used by Gnus."
 221   :group 'gnus)
 222
 223 (defgroup gnus-dribble-file nil
 224   "Auto save file."
 225   :link '(custom-manual "(gnus)Auto Save")
 226   :group 'gnus-files)
 227
 228 (defgroup gnus-newsrc nil
 229   "Storing Gnus state."
 230   :group 'gnus-files)
 231
 232 (defgroup gnus-server nil
 233   "Options related to newsservers and other servers used by Gnus."
 234   :group 'gnus)
 235
 236 (defgroup gnus-message '((message custom-group))
 237   "Composing replies and followups in Gnus."
 238   :group 'gnus)
 239
 240 (defgroup gnus-meta nil
 241   "Meta variables controling major portions of Gnus.
 242 In general, modifying these variables does not take affect until Gnus
 243 is restarted, and sometimes reloaded."
 244   :group 'gnus)
 245
 246 (defgroup gnus-various nil
 247   "Other Gnus options."
 248   :link '(custom-manual "(gnus)Various Various")
 249   :group 'gnus)
 250
 251 (defgroup gnus-mime nil
 252   "Variables for controlling the Gnus MIME interface."
 253   :group 'gnus)
 254
 255 (defgroup gnus-exit nil
 256   "Exiting gnus."
 257   :link '(custom-manual "(gnus)Exiting Gnus")
 258   :group 'gnus)
 259
 260 (defconst gnus-version-number "5.8.7"
 261   "Version number for this version of Gnus.")
 262
 263 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
 264   "Version string for this version of Gnus.")
 265
 266 (defcustom gnus-inhibit-startup-message nil
 267   "If non-nil, the startup message will not be displayed.
 268 This variable is used before `.gnus.el' is loaded, so it should
 269 be set in `.emacs' instead."
 270   :group 'gnus-start
 271   :type 'boolean)
 272
 273 (defcustom gnus-play-startup-jingle nil
 274   "If non-nil, play the Gnus jingle at startup."
 275   :group 'gnus-start
 276   :type 'boolean)
 277
 278 (unless (featurep 'gnus-xmas)
 279   (defalias 'gnus-make-overlay 'make-overlay)
 280   (defalias 'gnus-delete-overlay 'delete-overlay)
 281   (defalias 'gnus-overlay-put 'overlay-put)
 282   (defalias 'gnus-move-overlay 'move-overlay)
 283   (defalias 'gnus-overlay-end 'overlay-end)
 284   (defalias 'gnus-extent-detached-p 'ignore)
 285   (defalias 'gnus-extent-start-open 'ignore)
 286   (defalias 'gnus-set-text-properties 'set-text-properties)
 287   (defalias 'gnus-group-remove-excess-properties 'ignore)
 288   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 289   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 290   (defalias 'gnus-character-to-event 'identity)
 291   (defalias 'gnus-add-text-properties 'add-text-properties)
 292   (defalias 'gnus-put-text-property 'put-text-property)
 293   (defalias 'gnus-mode-line-buffer-identification 'identity)
 294   (defalias 'gnus-characterp 'numberp)
 295   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 296   (defalias 'gnus-window-edges 'window-edges)
 297   (defalias 'gnus-key-press-event-p 'numberp)
 298   (defalias 'gnus-decode-rfc1522 'ignore))
 299
 300 ;; We define these group faces here to avoid the display
 301 ;; update forced when creating new faces.
 302
 303 (defface gnus-group-news-1-face
 304   '((((class color)
 305       (background dark))
 306      (:foreground "PaleTurquoise" :bold t))
 307     (((class color)
 308       (background light))
 309      (:foreground "ForestGreen" :bold t))
 310     (t
 311      ()))
 312   "Level 1 newsgroup face.")
 313
 314 (defface gnus-group-news-1-empty-face
 315   '((((class color)
 316       (background dark))
 317      (:foreground "PaleTurquoise"))
 318     (((class color)
 319       (background light))
 320      (:foreground "ForestGreen"))
 321     (t
 322      ()))
 323   "Level 1 empty newsgroup face.")
 324
 325 (defface gnus-group-news-2-face
 326   '((((class color)
 327       (background dark))
 328      (:foreground "turquoise" :bold t))
 329     (((class color)
 330       (background light))
 331      (:foreground "CadetBlue4" :bold t))
 332     (t
 333      ()))
 334   "Level 2 newsgroup face.")
 335
 336 (defface gnus-group-news-2-empty-face
 337   '((((class color)
 338       (background dark))
 339      (:foreground "turquoise"))
 340     (((class color)
 341       (background light))
 342      (:foreground "CadetBlue4"))
 343     (t
 344      ()))
 345   "Level 2 empty newsgroup face.")
 346
 347 (defface gnus-group-news-3-face
 348   '((((class color)
 349       (background dark))
 350      (:bold t))
 351     (((class color)
 352       (background light))
 353      (:bold t))
 354     (t
 355      ()))
 356   "Level 3 newsgroup face.")
 357
 358 (defface gnus-group-news-3-empty-face
 359   '((((class color)
 360       (background dark))
 361      ())
 362     (((class color)
 363       (background light))
 364      ())
 365     (t
 366      ()))
 367   "Level 3 empty newsgroup face.")
 368
 369 (defface gnus-group-news-4-face
 370   '((((class color)
 371       (background dark))
 372      (:bold t))
 373     (((class color)
 374       (background light))
 375      (:bold t))
 376     (t
 377      ()))
 378   "Level 4 newsgroup face.")
 379
 380 (defface gnus-group-news-4-empty-face
 381   '((((class color)
 382       (background dark))
 383      ())
 384     (((class color)
 385       (background light))
 386      ())
 387     (t
 388      ()))
 389   "Level 4 empty newsgroup face.")
 390
 391 (defface gnus-group-news-5-face
 392   '((((class color)
 393       (background dark))
 394      (:bold t))
 395     (((class color)
 396       (background light))
 397      (:bold t))
 398     (t
 399      ()))
 400   "Level 5 newsgroup face.")
 401
 402 (defface gnus-group-news-5-empty-face
 403   '((((class color)
 404       (background dark))
 405      ())
 406     (((class color)
 407       (background light))
 408      ())
 409     (t
 410      ()))
 411   "Level 5 empty newsgroup face.")
 412
 413 (defface gnus-group-news-6-face
 414   '((((class color)
 415       (background dark))
 416      (:bold t))
 417     (((class color)
 418       (background light))
 419      (:bold t))
 420     (t
 421      ()))
 422   "Level 6 newsgroup face.")
 423
 424 (defface gnus-group-news-6-empty-face
 425   '((((class color)
 426       (background dark))
 427      ())
 428     (((class color)
 429       (background light))
 430      ())
 431     (t
 432      ()))
 433   "Level 6 empty newsgroup face.")
 434
 435 (defface gnus-group-news-low-face
 436   '((((class color)
 437       (background dark))
 438      (:foreground "DarkTurquoise" :bold t))
 439     (((class color)
 440       (background light))
 441      (:foreground "DarkGreen" :bold t))
 442     (t
 443      ()))
 444   "Low level newsgroup face.")
 445
 446 (defface gnus-group-news-low-empty-face
 447   '((((class color)
 448       (background dark))
 449      (:foreground "DarkTurquoise"))
 450     (((class color)
 451       (background light))
 452      (:foreground "DarkGreen"))
 453     (t
 454      ()))
 455   "Low level empty newsgroup face.")
 456
 457 (defface gnus-group-mail-1-face
 458   '((((class color)
 459       (background dark))
 460      (:foreground "aquamarine1" :bold t))
 461     (((class color)
 462       (background light))
 463      (:foreground "DeepPink3" :bold t))
 464     (t
 465      (:bold t)))
 466   "Level 1 mailgroup face.")
 467
 468 (defface gnus-group-mail-1-empty-face
 469   '((((class color)
 470       (background dark))
 471      (:foreground "aquamarine1"))
 472     (((class color)
 473       (background light))
 474      (:foreground "DeepPink3"))
 475     (t
 476      (:italic t :bold t)))
 477   "Level 1 empty mailgroup face.")
 478
 479 (defface gnus-group-mail-2-face
 480   '((((class color)
 481       (background dark))
 482      (:foreground "aquamarine2" :bold t))
 483     (((class color)
 484       (background light))
 485      (:foreground "HotPink3" :bold t))
 486     (t
 487      (:bold t)))
 488   "Level 2 mailgroup face.")
 489
 490 (defface gnus-group-mail-2-empty-face
 491   '((((class color)
 492       (background dark))
 493      (:foreground "aquamarine2"))
 494     (((class color)
 495       (background light))
 496      (:foreground "HotPink3"))
 497     (t
 498      (:bold t)))
 499   "Level 2 empty mailgroup face.")
 500
 501 (defface gnus-group-mail-3-face
 502   '((((class color)
 503       (background dark))
 504      (:foreground "aquamarine3" :bold t))
 505     (((class color)
 506       (background light))
 507      (:foreground "magenta4" :bold t))
 508     (t
 509      (:bold t)))
 510   "Level 3 mailgroup face.")
 511
 512 (defface gnus-group-mail-3-empty-face
 513   '((((class color)
 514       (background dark))
 515      (:foreground "aquamarine3"))
 516     (((class color)
 517       (background light))
 518      (:foreground "magenta4"))
 519     (t
 520      ()))
 521   "Level 3 empty mailgroup face.")
 522
 523 (defface gnus-group-mail-low-face
 524   '((((class color)
 525       (background dark))
 526      (:foreground "aquamarine4" :bold t))
 527     (((class color)
 528       (background light))
 529      (:foreground "DeepPink4" :bold t))
 530     (t
 531      (:bold t)))
 532   "Low level mailgroup face.")
 533
 534 (defface gnus-group-mail-low-empty-face
 535   '((((class color)
 536       (background dark))
 537      (:foreground "aquamarine4"))
 538     (((class color)
 539       (background light))
 540      (:foreground "DeepPink4"))
 541     (t
 542      (:bold t)))
 543   "Low level empty mailgroup face.")
 544
 545 ;; Summary mode faces.
 546
 547 (defface gnus-summary-selected-face '((t
 548                                        (:underline t)))
 549   "Face used for selected articles.")
 550
 551 (defface gnus-summary-cancelled-face
 552   '((((class color))
 553      (:foreground "yellow" :background "black")))
 554   "Face used for cancelled articles.")
 555
 556 (defface gnus-summary-high-ticked-face
 557   '((((class color)
 558       (background dark))
 559      (:foreground "pink" :bold t))
 560     (((class color)
 561       (background light))
 562      (:foreground "firebrick" :bold t))
 563     (t
 564      (:bold t)))
 565   "Face used for high interest ticked articles.")
 566
 567 (defface gnus-summary-low-ticked-face
 568   '((((class color)
 569       (background dark))
 570      (:foreground "pink" :italic t))
 571     (((class color)
 572       (background light))
 573      (:foreground "firebrick" :italic t))
 574     (t
 575      (:italic t)))
 576   "Face used for low interest ticked articles.")
 577
 578 (defface gnus-summary-normal-ticked-face
 579   '((((class color)
 580       (background dark))
 581      (:foreground "pink"))
 582     (((class color)
 583       (background light))
 584      (:foreground "firebrick"))
 585     (t
 586      ()))
 587   "Face used for normal interest ticked articles.")
 588
 589 (defface gnus-summary-high-ancient-face
 590   '((((class color)
 591       (background dark))
 592      (:foreground "SkyBlue" :bold t))
 593     (((class color)
 594       (background light))
 595      (:foreground "RoyalBlue" :bold t))
 596     (t
 597      (:bold t)))
 598   "Face used for high interest ancient articles.")
 599
 600 (defface gnus-summary-low-ancient-face
 601   '((((class color)
 602       (background dark))
 603      (:foreground "SkyBlue" :italic t))
 604     (((class color)
 605       (background light))
 606      (:foreground "RoyalBlue" :italic t))
 607     (t
 608      (:italic t)))
 609   "Face used for low interest ancient articles.")
 610
 611 (defface gnus-summary-normal-ancient-face
 612   '((((class color)
 613       (background dark))
 614      (:foreground "SkyBlue"))
 615     (((class color)
 616       (background light))
 617      (:foreground "RoyalBlue"))
 618     (t
 619      ()))
 620   "Face used for normal interest ancient articles.")
 621
 622 (defface gnus-summary-high-unread-face
 623   '((t
 624      (:bold t)))
 625   "Face used for high interest unread articles.")
 626
 627 (defface gnus-summary-low-unread-face
 628   '((t
 629      (:italic t)))
 630   "Face used for low interest unread articles.")
 631
 632 (defface gnus-summary-normal-unread-face
 633   '((t
 634      ()))
 635   "Face used for normal interest unread articles.")
 636
 637 (defface gnus-summary-high-read-face
 638   '((((class color)
 639       (background dark))
 640      (:foreground "PaleGreen"
 641                   :bold t))
 642     (((class color)
 643       (background light))
 644      (:foreground "DarkGreen"
 645                   :bold t))
 646     (t
 647      (:bold t)))
 648   "Face used for high interest read articles.")
 649
 650 (defface gnus-summary-low-read-face
 651   '((((class color)
 652       (background dark))
 653      (:foreground "PaleGreen"
 654                   :italic t))
 655     (((class color)
 656       (background light))
 657      (:foreground "DarkGreen"
 658                   :italic t))
 659     (t
 660      (:italic t)))
 661   "Face used for low interest read articles.")
 662
 663 (defface gnus-summary-normal-read-face
 664   '((((class color)
 665       (background dark))
 666      (:foreground "PaleGreen"))
 667     (((class color)
 668       (background light))
 669      (:foreground "DarkGreen"))
 670     (t
 671      ()))
 672   "Face used for normal interest read articles.")
 673
 674
 675 ;;;
 676 ;;; Gnus buffers
 677 ;;;
 678
 679 (defvar gnus-buffers nil)
 680
 681 (defun gnus-get-buffer-create (name)
 682   "Do the same as `get-buffer-create', but store the created buffer."
 683   (or (get-buffer name)
 684       (car (push (get-buffer-create name) gnus-buffers))))
 685
 686 (defun gnus-add-buffer ()
 687   "Add the current buffer to the list of Gnus buffers."
 688   (push (current-buffer) gnus-buffers))
 689
 690 (defun gnus-buffers ()
 691   "Return a list of live Gnus buffers."
 692   (while (and gnus-buffers
 693               (not (buffer-name (car gnus-buffers))))
 694     (pop gnus-buffers))
 695   (let ((buffers gnus-buffers))
 696     (while (cdr buffers)
 697       (if (buffer-name (cadr buffers))
 698           (pop buffers)
 699         (setcdr buffers (cddr buffers)))))
 700   gnus-buffers)
 701
 702 ;;; Splash screen.
 703
 704 (defvar gnus-group-buffer "*Group*")
 705
 706 (eval-and-compile
 707   (autoload 'gnus-play-jingle "gnus-audio"))
 708
 709 (defface gnus-splash-face
 710   '((((class color)
 711       (background dark))
 712      (:foreground "Brown"))
 713     (((class color)
 714       (background light))
 715      (:foreground "Brown"))
 716     (t
 717      ()))
 718   "Face of the splash screen.")
 719
 720 (defun gnus-splash ()
 721   (save-excursion
 722     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 723     (let ((buffer-read-only nil))
 724       (erase-buffer)
 725       (unless gnus-inhibit-startup-message
 726         (gnus-group-startup-message)
 727         (sit-for 0)
 728         (when gnus-play-startup-jingle
 729           (gnus-play-jingle))))))
 730
 731 (defun gnus-indent-rigidly (start end arg)
 732   "Indent rigidly using only spaces and no tabs."
 733   (save-excursion
 734     (save-restriction
 735       (narrow-to-region start end)
 736       (let ((tab-width 8))
 737         (indent-rigidly start end arg)
 738         ;; We translate tabs into spaces -- not everybody uses
 739         ;; an 8-character tab.
 740         (goto-char (point-min))
 741         (while (search-forward "\t" nil t)
 742           (replace-match "        " t t))))))
 743
 744 (defvar gnus-simple-splash nil)
 745
 746 (defun gnus-group-startup-message (&optional x y)
 747   "Insert startup message in current buffer."
 748   ;; Insert the message.
 749   (erase-buffer)
 750   (cond
 751    ((and (fboundp 'find-image)
 752          (display-graphic-p)
 753          (let ((image (find-image '((:type xpm :file "gnus.xpm")
 754                                     (:type xbm :file "gnus.xbm")))))
 755            (when image
 756              (newline)                  ; Have somewhere for cursor to
 757                                         ; go, not stretched over image.
 758              (insert-image image)
 759              (goto-char (point-min))
 760              (while (not (eobp))
 761                (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
 762                                     ?\ ))
 763                (forward-line 1))
 764              (setq gnus-simple-splash nil)
 765              t))))
 766    (t
 767     (insert
 768      (format "              %s
 769           _    ___ _             _
 770           _ ___ __ ___  __    _ ___
 771           __   _     ___    __  ___
 772               _           ___     _
 773              _  _ __             _
 774              ___   __            _
 775                    __           _
 776                     _      _   _
 777                    _      _    _
 778                       _  _    _
 779                   __  ___
 780                  _   _ _     _
 781                 _   _
 782               _    _
 783              _    _
 784             _
 785           __
 786
 787 "
 788              ""))
 789     ;; And then hack it.
 790     (gnus-indent-rigidly (point-min) (point-max)
 791                          (/ (max (- (window-width) (or x 46)) 0) 2))
 792     (goto-char (point-min))
 793     (forward-line 1)
 794     (let* ((pheight (count-lines (point-min) (point-max)))
 795            (wheight (window-height))
 796            (rest (- wheight pheight)))
 797       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 798     ;; Fontify some.
 799     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 800     (setq gnus-simple-splash t)))
 801   (goto-char (point-min))
 802   (setq mode-line-buffer-identification (concat " " gnus-version))
 803   (set-buffer-modified-p t))
 804
 805 (eval-when (load)
 806   (let ((command (format "%s" this-command)))
 807     (if (and (string-match "gnus" command)
 808              (not (string-match "gnus-other-frame" command)))
 809         (gnus-splash)
 810       (gnus-get-buffer-create gnus-group-buffer))))
 811
 812 ;;; Do the rest.
 813
 814 (require 'custom)
 815 (require 'gnus-util)
 816 (require 'nnheader)
 817
 818 (defcustom gnus-home-directory "~/"
 819   "Directory variable that specifies the \"home\" directory.
 820 All other Gnus path variables are initialized from this variable."
 821   :group 'gnus-files
 822   :type 'directory)
 823
 824 (defcustom gnus-directory (or (getenv "SAVEDIR")
 825                               (nnheader-concat gnus-home-directory "News/"))
 826   "*Directory variable from which all other Gnus file variables are derived.
 827
 828 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
 829 This means that other directory variables that are initialized from
 830 this variable won't be set properly if you set this variable in `.gnus.el'.
 831 Set this variable in `.emacs' instead."
 832   :group 'gnus-files
 833   :type 'directory)
 834
 835 (defcustom gnus-default-directory nil
 836   "*Default directory for all Gnus buffers."
 837   :group 'gnus-files
 838   :type '(choice (const :tag "current" nil)
 839                  directory))
 840
 841 ;; Site dependent variables.  These variables should be defined in
 842 ;; paths.el.
 843
 844 (defvar gnus-default-nntp-server nil
 845   "Specify a default NNTP server.
 846 This variable should be defined in paths.el, and should never be set
 847 by the user.
 848 If you want to change servers, you should use `gnus-select-method'.
 849 See the documentation to that variable.")
 850
 851 ;; Don't touch this variable.
 852 (defvar gnus-nntp-service "nntp"
 853   "NNTP service name (\"nntp\" or 119).
 854 This is an obsolete variable, which is scarcely used.  If you use an
 855 nntp server for your newsgroup and want to change the port number
 856 used to 899, you would say something along these lines:
 857
 858  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
 859
 860 (defcustom gnus-nntpserver-file "/etc/nntpserver"
 861   "A file with only the name of the nntp server in it."
 862   :group 'gnus-files
 863   :group 'gnus-server
 864   :type 'file)
 865
 866 ;; This function is used to check both the environment variable
 867 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
 868 ;; an nntp server name default.
 869 (defun gnus-getenv-nntpserver ()
 870   (or (getenv "NNTPSERVER")
 871       (and (file-readable-p gnus-nntpserver-file)
 872            (save-excursion
 873              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
 874              (insert-file-contents gnus-nntpserver-file)
 875              (let ((name (buffer-string)))
 876                (prog1
 877                    (if (string-match "\\'[ \t\n]*$" name)
 878                        nil
 879                      name)
 880                  (kill-buffer (current-buffer))))))))
 881
 882 (defcustom gnus-select-method
 883   (condition-case nil
 884       (nconc
 885        (list 'nntp (or (condition-case nil
 886                            (gnus-getenv-nntpserver)
 887                          (error nil))
 888                        (when (and gnus-default-nntp-server
 889                                   (not (string= gnus-default-nntp-server "")))
 890                          gnus-default-nntp-server)
 891                        "news"))
 892        (if (or (null gnus-nntp-service)
 893                (equal gnus-nntp-service "nntp"))
 894            nil
 895          (list gnus-nntp-service)))
 896     (error nil))
 897   "Default method for selecting a newsgroup.
 898 This variable should be a list, where the first element is how the
 899 news is to be fetched, the second is the address.
 900
 901 For instance, if you want to get your news via NNTP from
 902 \"flab.flab.edu\", you could say:
 903
 904 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
 905
 906 If you want to use your local spool, say:
 907
 908 \(setq gnus-select-method (list 'nnspool (system-name)))
 909
 910 If you use this variable, you must set `gnus-nntp-server' to nil.
 911
 912 There is a lot more to know about select methods and virtual servers -
 913 see the manual for details."
 914   :group 'gnus-server
 915   :type 'gnus-select-method)
 916
 917 (defcustom gnus-message-archive-method
 918   `(nnfolder
 919     "archive"
 920     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
 921     (nnfolder-active-file
 922      ,(nnheader-concat message-directory "archive/active"))
 923     (nnfolder-get-new-mail nil)
 924     (nnfolder-inhibit-expiry t))
 925   "*Method used for archiving messages you've sent.
 926 This should be a mail method.
 927
 928 It's probably not very effective to change this variable once you've
 929 run Gnus once.  After doing that, you must edit this server from the
 930 server buffer."
 931   :group 'gnus-server
 932   :group 'gnus-message
 933   :type 'gnus-select-method)
 934
 935 (defcustom gnus-message-archive-group nil
 936   "*Name of the group in which to save the messages you've written.
 937 This can either be a string; a list of strings; or an alist
 938 of regexps/functions/forms to be evaluated to return a string (or a list
 939 of strings).  The functions are called with the name of the current
 940 group (or nil) as a parameter.
 941
 942 If you want to save your mail in one group and the news articles you
 943 write in another group, you could say something like:
 944
 945  \(setq gnus-message-archive-group
 946         '((if (message-news-p)
 947               \"misc-news\"
 948             \"misc-mail\")))
 949
 950 Normally the group names returned by this variable should be
 951 unprefixed -- which implicitly means \"store on the archive server\".
 952 However, you may wish to store the message on some other server.  In
 953 that case, just return a fully prefixed name of the group --
 954 \"nnml+private:mail.misc\", for instance."
 955   :group 'gnus-message
 956   :type '(choice (const :tag "none" nil)
 957                  function
 958                  sexp
 959                  string))
 960
 961 (defcustom gnus-secondary-servers nil
 962   "List of NNTP servers that the user can choose between interactively.
 963 To make Gnus query you for a server, you have to give `gnus' a
 964 non-numeric prefix - `C-u M-x gnus', in short."
 965   :group 'gnus-server
 966   :type '(repeat string))
 967
 968 (defcustom gnus-nntp-server nil
 969   "*The name of the host running the NNTP server.
 970 This variable is semi-obsolete.  Use the `gnus-select-method'
 971 variable instead."
 972   :group 'gnus-server
 973   :type '(choice (const :tag "disable" nil)
 974                  string))
 975
 976 (defcustom gnus-secondary-select-methods nil
 977   "A list of secondary methods that will be used for reading news.
 978 This is a list where each element is a complete select method (see
 979 `gnus-select-method').
 980
 981 If, for instance, you want to read your mail with the nnml backend,
 982 you could set this variable:
 983
 984 \(setq gnus-secondary-select-methods '((nnml \"\")))"
 985   :group 'gnus-server
 986   :type '(repeat gnus-select-method))
 987
 988 (defvar gnus-backup-default-subscribed-newsgroups
 989   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
 990   "Default default new newsgroups the first time Gnus is run.
 991 Should be set in paths.el, and shouldn't be touched by the user.")
 992
 993 (defcustom gnus-local-domain nil
 994   "Local domain name without a host name.
 995 The DOMAINNAME environment variable is used instead if it is defined.
 996 If the `system-name' function returns the full Internet name, there is
 997 no need to set this variable."
 998   :group 'gnus-message
 999   :type '(choice (const :tag "default" nil)
1000                  string))
1001
1002 (defvar gnus-local-organization nil
1003   "String with a description of what organization (if any) the user belongs to.
1004 Obsolete variable; use `message-user-organization' instead.")
1005
1006 ;; Customization variables
1007
1008 (defcustom gnus-refer-article-method nil
1009   "Preferred method for fetching an article by Message-ID.
1010 If you are reading news from the local spool (with nnspool), fetching
1011 articles by Message-ID is painfully slow.  By setting this method to an
1012 nntp method, you might get acceptable results.
1013
1014 The value of this variable must be a valid select method as discussed
1015 in the documentation of `gnus-select-method'.
1016
1017 It can also be a list of select methods, as well as the special symbol
1018 `current', which means to use the current select method.  If it is a
1019 list, Gnus will try all the methods in the list until it finds a match."
1020   :group 'gnus-server
1021   :type '(choice (const :tag "default" nil)
1022                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1023                  gnus-select-method
1024                  (repeat :menu-tag "Try multiple"
1025                          :tag "Multiple"
1026                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1027                          (choice :tag "Method"
1028                                  (const current)
1029                                  (const :tag "DejaNews"
1030                                         (nnweb "refer" (nnweb-type dejanews)))
1031                                  gnus-select-method))))
1032
1033 (defcustom gnus-group-faq-directory
1034   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1035     "/ftp@sunsite.auc.dk:/pub/usenet/"
1036     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1037     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1038     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1039     "/ftp@rtfm.mit.edu:/pub/usenet/"
1040     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1041     "/ftp@ftp.sunet.se:/pub/usenet/"
1042     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1043     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1044     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1045   "*Directory where the group FAQs are stored.
1046 This will most commonly be on a remote machine, and the file will be
1047 fetched by ange-ftp.
1048
1049 This variable can also be a list of directories.  In that case, the
1050 first element in the list will be used by default.  The others can
1051 be used when being prompted for a site.
1052
1053 Note that Gnus uses an aol machine as the default directory.  If this
1054 feels fundamentally unclean, just think of it as a way to finally get
1055 something of value back from them.
1056
1057 If the default site is too slow, try one of these:
1058
1059    North America: mirrors.aol.com                /pub/rtfm/usenet
1060                   ftp.seas.gwu.edu               /pub/rtfm
1061                   rtfm.mit.edu                   /pub/usenet
1062    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1063                   src.doc.ic.ac.uk               /usenet/news-FAQS
1064                   ftp.sunet.se                   /pub/usenet
1065                   sunsite.auc.dk                 /pub/usenet
1066    Asia:          nctuccca.edu.tw                /USENET/FAQ
1067                   hwarang.postech.ac.kr          /pub/usenet
1068                   ftp.hk.super.net               /mirror/faqs"
1069   :group 'gnus-group-various
1070   :type '(choice directory
1071                  (repeat directory)))
1072
1073 (defcustom gnus-use-cross-reference t
1074   "*Non-nil means that cross referenced articles will be marked as read.
1075 If nil, ignore cross references.  If t, mark articles as read in
1076 subscribed newsgroups.  If neither t nor nil, mark as read in all
1077 newsgroups."
1078   :group 'gnus-server
1079   :type '(choice (const :tag "off" nil)
1080                  (const :tag "subscribed" t)
1081                  (sexp :format "all"
1082                        :value always)))
1083
1084 (defcustom gnus-process-mark ?#
1085   "*Process mark."
1086   :group 'gnus-group-visual
1087   :group 'gnus-summary-marks
1088   :type 'character)
1089
1090 (defcustom gnus-large-newsgroup 200
1091   "*The number of articles which indicates a large newsgroup.
1092 If the number of articles in a newsgroup is greater than this value,
1093 confirmation is required for selecting the newsgroup."
1094   :group 'gnus-group-select
1095   :type 'integer)
1096
1097 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1098   "*Non-nil means that the default name of a file to save articles in is the group name.
1099 If it's nil, the directory form of the group name is used instead.
1100
1101 If this variable is a list, and the list contains the element
1102 `not-score', long file names will not be used for score files; if it
1103 contains the element `not-save', long file names will not be used for
1104 saving; and if it contains the element `not-kill', long file names
1105 will not be used for kill files.
1106
1107 Note that the default for this variable varies according to what system
1108 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1109 to nil while on all other systems it defaults to t."
1110   :group 'gnus-start
1111   :type 'boolean)
1112
1113 (defcustom gnus-kill-files-directory gnus-directory
1114   "*Name of the directory where kill files will be stored (default \"~/News\")."
1115   :group 'gnus-score-files
1116   :group 'gnus-score-kill
1117   :type 'directory)
1118
1119 (defcustom gnus-save-score nil
1120   "*If non-nil, save group scoring info."
1121   :group 'gnus-score-various
1122   :group 'gnus-start
1123   :type 'boolean)
1124
1125 (defcustom gnus-use-undo t
1126   "*If non-nil, allow undoing in Gnus group mode buffers."
1127   :group 'gnus-meta
1128   :type 'boolean)
1129
1130 (defcustom gnus-use-adaptive-scoring nil
1131   "*If non-nil, use some adaptive scoring scheme.
1132 If a list, then the values `word' and `line' are meaningful.  The
1133 former will perform adaption on individual words in the subject
1134 header while `line' will perform adaption on several headers."
1135   :group 'gnus-meta
1136   :group 'gnus-score-adapt
1137   :type '(set (const word) (const line)))
1138
1139 (defcustom gnus-use-cache 'passive
1140   "*If nil, Gnus will ignore the article cache.
1141 If `passive', it will allow entering (and reading) articles
1142 explicitly entered into the cache.  If anything else, use the
1143 cache to the full extent of the law."
1144   :group 'gnus-meta
1145   :group 'gnus-cache
1146   :type '(choice (const :tag "off" nil)
1147                  (const :tag "passive" passive)
1148                  (const :tag "active" t)))
1149
1150 (defcustom gnus-use-trees nil
1151   "*If non-nil, display a thread tree buffer."
1152   :group 'gnus-meta
1153   :type 'boolean)
1154
1155 (defcustom gnus-use-grouplens nil
1156   "*If non-nil, use GroupLens ratings."
1157   :group 'gnus-meta
1158   :type 'boolean)
1159
1160 (defcustom gnus-keep-backlog nil
1161   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1162 If it is a number N, then Gnus will only keep the last N articles
1163 read.  If it is neither nil nor a number, Gnus will keep all read
1164 articles.  This is not a good idea."
1165   :group 'gnus-meta
1166   :type '(choice (const :tag "off" nil)
1167                  integer
1168                  (sexp :format "all"
1169                        :value t)))
1170
1171 (defcustom gnus-use-nocem nil
1172   "*If non-nil, Gnus will read NoCeM cancel messages."
1173   :group 'gnus-meta
1174   :type 'boolean)
1175
1176 (defcustom gnus-suppress-duplicates nil
1177   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1178   :group 'gnus-meta
1179   :type 'boolean)
1180
1181 (defcustom gnus-use-scoring t
1182   "*If non-nil, enable scoring."
1183   :group 'gnus-meta
1184   :type 'boolean)
1185
1186 (defcustom gnus-use-picons nil
1187   "*If non-nil, display picons in a frame of their own."
1188   :group 'gnus-meta
1189   :type 'boolean)
1190
1191 (defcustom gnus-summary-prepare-exit-hook
1192   '(gnus-summary-expire-articles)
1193   "*A hook called when preparing to exit from the summary buffer.
1194 It calls `gnus-summary-expire-articles' by default."
1195   :group 'gnus-summary-exit
1196   :type 'hook)
1197
1198 (defcustom gnus-novice-user t
1199   "*Non-nil means that you are a usenet novice.
1200 If non-nil, verbose messages may be displayed and confirmations may be
1201 required."
1202   :group 'gnus-meta
1203   :type 'boolean)
1204
1205 (defcustom gnus-expert-user nil
1206   "*Non-nil means that you will never be asked for confirmation about anything.
1207 That doesn't mean *anything* anything; particularly destructive
1208 commands will still require prompting."
1209   :group 'gnus-meta
1210   :type 'boolean)
1211
1212 (defcustom gnus-interactive-catchup t
1213   "*If non-nil, require your confirmation when catching up a group."
1214   :group 'gnus-group-select
1215   :type 'boolean)
1216
1217 (defcustom gnus-interactive-exit t
1218   "*If non-nil, require your confirmation when exiting Gnus."
1219   :group 'gnus-exit
1220   :type 'boolean)
1221
1222 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1223   "*Function for extracting address components from a From header.
1224 Two pre-defined function exist: `gnus-extract-address-components',
1225 which is the default, quite fast, and too simplistic solution, and
1226 `mail-extract-address-components', which works much better, but is
1227 slower."
1228   :group 'gnus-summary-format
1229   :type '(radio (function-item gnus-extract-address-components)
1230                 (function-item mail-extract-address-components)
1231                 (function :tag "Other")))
1232
1233 (defcustom gnus-carpal nil
1234   "*If non-nil, display clickable icons."
1235   :group 'gnus-meta
1236   :type 'boolean)
1237
1238 (defcustom gnus-shell-command-separator ";"
1239   "String used to separate to shell commands."
1240   :group 'gnus-files
1241   :type 'string)
1242
1243 (defcustom gnus-valid-select-methods
1244   '(("nntp" post address prompt-address physical-address)
1245     ("nnspool" post address)
1246     ("nnvirtual" post-mail virtual prompt-address)
1247     ("nnmbox" mail respool address)
1248     ("nnml" mail respool address)
1249     ("nnmh" mail respool address)
1250     ("nndir" post-mail prompt-address physical-address)
1251     ("nneething" none address prompt-address physical-address)
1252     ("nndoc" none address prompt-address)
1253     ("nnbabyl" mail address respool)
1254     ("nnkiboze" post virtual)
1255     ("nnsoup" post-mail address)
1256     ("nndraft" post-mail)
1257     ("nnfolder" mail respool address)
1258     ("nngateway" post-mail address prompt-address physical-address)
1259     ("nnweb" none)
1260     ("nnslashdot" post)
1261     ("nnultimate" none)
1262     ("nnwarchive" none)
1263     ("nnlistserv" none)
1264     ("nnagent" post-mail)
1265     ("nnimap" post-mail address prompt-address physical-address))
1266   "*An alist of valid select methods.
1267 The first element of each list lists should be a string with the name
1268 of the select method.  The other elements may be the category of
1269 this method (i. e., `post', `mail', `none' or whatever) or other
1270 properties that this method has (like being respoolable).
1271 If you implement a new select method, all you should have to change is
1272 this variable.  I think."
1273   :group 'gnus-server
1274   :type '(repeat (group (string :tag "Name")
1275                         (radio-button-choice (const :format "%v " post)
1276                                              (const :format "%v " mail)
1277                                              (const :format "%v " none)
1278                                              (const post-mail))
1279                         (checklist :inline t
1280                                    (const :format "%v " address)
1281                                    (const :format "%v " prompt-address)
1282                                    (const :format "%v " physical-address)
1283                                    (const :format "%v " virtual)
1284                                    (const respool)))))
1285
1286 (defun gnus-redefine-select-method-widget ()
1287   "Recomputes the select-method widget based on the value of
1288 `gnus-valid-select-methods'."
1289   (define-widget 'gnus-select-method 'list
1290     "Widget for entering a select method."
1291     :value '(nntp "")
1292     :tag "Select Method"
1293     :args `((choice :tag "Method"
1294                     ,@(mapcar (lambda (entry)
1295                                 (list 'const :format "%v\n"
1296                                       (intern (car entry))))
1297                               gnus-valid-select-methods)
1298                     (symbol :tag "other"))
1299             (string :tag "Address")
1300             (repeat :tag "Options"
1301                     :inline t
1302                     (list :format "%v"
1303                           variable
1304                           (sexp :tag "Value"))))
1305     ))
1306
1307 (gnus-redefine-select-method-widget)
1308
1309 (defcustom gnus-updated-mode-lines '(group article summary tree)
1310   "List of buffers that should update their mode lines.
1311 The list may contain the symbols `group', `article', `tree' and
1312 `summary'.  If the corresponding symbol is present, Gnus will keep
1313 that mode line updated with information that may be pertinent.
1314 If this variable is nil, screen refresh may be quicker."
1315   :group 'gnus-various
1316   :type '(set (const group)
1317               (const article)
1318               (const summary)
1319               (const tree)))
1320
1321 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1322 (defcustom gnus-mode-non-string-length nil
1323   "*Max length of mode-line non-string contents.
1324 If this is nil, Gnus will take space as is needed, leaving the rest
1325 of the modeline intact.  Note that the default of nil is unlikely
1326 to be desirable; see the manual for further details."
1327   :group 'gnus-various
1328   :type '(choice (const nil)
1329                  integer))
1330
1331 (defcustom gnus-auto-expirable-newsgroups nil
1332   "*Groups in which to automatically mark read articles as expirable.
1333 If non-nil, this should be a regexp that should match all groups in
1334 which to perform auto-expiry.  This only makes sense for mail groups."
1335   :group 'nnmail-expire
1336   :type '(choice (const nil)
1337                  regexp))
1338
1339 (defcustom gnus-total-expirable-newsgroups nil
1340   "*Groups in which to perform expiry of all read articles.
1341 Use with extreme caution.  All groups that match this regexp will be
1342 expiring - which means that all read articles will be deleted after
1343 \(say) one week.         (This only goes for mail groups and the like, of
1344 course.)"
1345   :group 'nnmail-expire
1346   :type '(choice (const nil)
1347                  regexp))
1348
1349 (defcustom gnus-group-uncollapsed-levels 1
1350   "Number of group name elements to leave alone when making a short group name."
1351   :group 'gnus-group-visual
1352   :type 'integer)
1353
1354 (defcustom gnus-group-use-permanent-levels nil
1355   "*If non-nil, once you set a level, Gnus will use this level."
1356   :group 'gnus-group-levels
1357   :type 'boolean)
1358
1359 ;; Hooks.
1360
1361 (defcustom gnus-load-hook nil
1362   "A hook run while Gnus is loaded."
1363   :group 'gnus-start
1364   :type 'hook)
1365
1366 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1367   "A hook called to apply kill files to a group.
1368 This hook is intended to apply a kill file to the selected newsgroup.
1369 The function `gnus-apply-kill-file' is called by default.
1370
1371 Since a general kill file is too heavy to use only for a few
1372 newsgroups, I recommend you to use a lighter hook function.  For
1373 example, if you'd like to apply a kill file to articles which contains
1374 a string `rmgroup' in subject in newsgroup `control', you can use the
1375 following hook:
1376
1377  (setq gnus-apply-kill-hook
1378       (list
1379         (lambda ()
1380           (cond ((string-match \"control\" gnus-newsgroup-name)
1381                  (gnus-kill \"Subject\" \"rmgroup\")
1382                  (gnus-expunge \"X\"))))))"
1383   :group 'gnus-score-kill
1384   :options '(gnus-apply-kill-file)
1385   :type 'hook)
1386
1387 (defcustom gnus-group-change-level-function nil
1388   "Function run when a group level is changed.
1389 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1390   :group 'gnus-group-levels
1391   :type 'function)
1392
1393 ;;; Face thingies.
1394
1395 (defcustom gnus-visual
1396   '(summary-highlight group-highlight article-highlight
1397                       mouse-face
1398                       summary-menu group-menu article-menu
1399                       tree-highlight menu highlight
1400                       browse-menu server-menu
1401                       page-marker tree-menu binary-menu pick-menu
1402                       grouplens-menu)
1403   "*Enable visual features.
1404 If `visual' is disabled, there will be no menus and few faces.  Most of
1405 the visual customization options below will be ignored.  Gnus will use
1406 less space and be faster as a result.
1407
1408 This variable can also be a list of visual elements to switch on.  For
1409 instance, to switch off all visual things except menus, you can say:
1410
1411    (setq gnus-visual '(menu))
1412
1413 Valid elements include `summary-highlight', `group-highlight',
1414 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1415 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1416 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1417 and `grouplens-menu'."
1418   :group 'gnus-meta
1419   :group 'gnus-visual
1420   :type '(set (const summary-highlight)
1421               (const group-highlight)
1422               (const article-highlight)
1423               (const mouse-face)
1424               (const summary-menu)
1425               (const group-menu)
1426               (const article-menu)
1427               (const tree-highlight)
1428               (const menu)
1429               (const highlight)
1430               (const browse-menu)
1431               (const server-menu)
1432               (const page-marker)
1433               (const tree-menu)
1434               (const binary-menu)
1435               (const pick-menu)
1436               (const grouplens-menu)))
1437
1438 (defcustom gnus-mouse-face
1439   (condition-case ()
1440       (if (gnus-visual-p 'mouse-face 'highlight)
1441           (if (boundp 'gnus-mouse-face)
1442               (or gnus-mouse-face 'highlight)
1443             'highlight)
1444         'default)
1445     (error 'highlight))
1446   "*Face used for group or summary buffer mouse highlighting.
1447 The line beneath the mouse pointer will be highlighted with this
1448 face."
1449   :group 'gnus-visual
1450   :type 'face)
1451
1452 (defcustom gnus-article-save-directory gnus-directory
1453   "*Name of the directory articles will be saved in (default \"~/News\")."
1454   :group 'gnus-article-saving
1455   :type 'directory)
1456
1457 (defvar gnus-plugged t
1458   "Whether Gnus is plugged or not.")
1459
1460 (defcustom gnus-default-charset 'iso-8859-1
1461   "Default charset assumed to be used when viewing non-ASCII characters.
1462 This variable is overridden on a group-to-group basis by the
1463 gnus-group-charset-alist variable and is only used on groups not
1464 covered by that variable."
1465   :type 'symbol
1466   :group 'gnus-charset)
1467
1468 (defcustom gnus-default-posting-charset nil
1469   "Default charset assumed to be used when posting non-ASCII characters.
1470 This variable is overridden on a group-to-group basis by the
1471 gnus-group-posting-charset-alist variable and is only used on groups not
1472 covered by that variable.
1473 If nil, no default charset is assumed when posting."
1474   :type 'symbol
1475   :group 'gnus-charset)
1476
1477 \f
1478 ;;; Internal variables
1479
1480 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1481 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1482 (defvar gnus-original-article-buffer " *Original Article*")
1483 (defvar gnus-newsgroup-name nil)
1484 (defvar gnus-ephemeral-servers nil)
1485
1486 (defvar gnus-agent nil
1487   "Whether we want to use the Gnus agent or not.")
1488
1489 (defvar gnus-command-method nil
1490   "Dynamically bound variable that says what the current backend is.")
1491
1492 (defvar gnus-current-select-method nil
1493   "The current method for selecting a newsgroup.")
1494
1495 (defvar gnus-tree-buffer "*Tree*"
1496   "Buffer where Gnus thread trees are displayed.")
1497
1498 ;; Dummy variable.
1499 (defvar gnus-use-generic-from nil)
1500
1501 ;; Variable holding the user answers to all method prompts.
1502 (defvar gnus-method-history nil)
1503
1504 ;; Variable holding the user answers to all mail method prompts.
1505 (defvar gnus-mail-method-history nil)
1506
1507 ;; Variable holding the user answers to all group prompts.
1508 (defvar gnus-group-history nil)
1509
1510 (defvar gnus-server-alist nil
1511   "List of available servers.")
1512
1513 (defcustom gnus-cache-directory
1514   (nnheader-concat gnus-directory "cache/")
1515   "*The directory where cached articles will be stored."
1516   :group 'gnus-cache
1517   :type 'directory)
1518
1519 (defvar gnus-predefined-server-alist
1520   `(("cache"
1521      nnspool "cache"
1522      (nnspool-spool-directory ,gnus-cache-directory)
1523      (nnspool-nov-directory ,gnus-cache-directory)
1524      (nnspool-active-file
1525       ,(nnheader-concat gnus-cache-directory "active"))))
1526   "List of predefined (convenience) servers.")
1527
1528 (defvar gnus-topic-indentation "");; Obsolete variable.
1529
1530 (defconst gnus-article-mark-lists
1531   '((marked . tick) (replied . reply)
1532     (expirable . expire) (killed . killed)
1533     (bookmarks . bookmark) (dormant . dormant)
1534     (scored . score) (saved . save)
1535     (cached . cache) (downloadable . download)
1536     (unsendable . unsend)))
1537
1538 (defvar gnus-headers-retrieved-by nil)
1539 (defvar gnus-article-reply nil)
1540 (defvar gnus-override-method nil)
1541 (defvar gnus-article-check-size nil)
1542 (defvar gnus-opened-servers nil)
1543
1544 (defvar gnus-current-kill-article nil)
1545
1546 (defvar gnus-have-read-active-file nil)
1547
1548 (defconst gnus-maintainer
1549   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1550   "The mail address of the Gnus maintainers.")
1551
1552 (defvar gnus-info-nodes
1553   '((gnus-group-mode "(gnus)The Group Buffer")
1554     (gnus-summary-mode "(gnus)The Summary Buffer")
1555     (gnus-article-mode "(gnus)The Article Buffer")
1556     (gnus-server-mode "(gnus)The Server Buffer")
1557     (gnus-browse-mode "(gnus)Browse Foreign Server")
1558     (gnus-tree-mode "(gnus)Tree Display"))
1559   "Alist of major modes and related Info nodes.")
1560
1561 (defvar gnus-group-buffer "*Group*")
1562 (defvar gnus-summary-buffer "*Summary*")
1563 (defvar gnus-article-buffer "*Article*")
1564 (defvar gnus-server-buffer "*Server*")
1565
1566 (defvar gnus-slave nil
1567   "Whether this Gnus is a slave or not.")
1568
1569 (defvar gnus-batch-mode nil
1570   "Whether this Gnus is running in batch mode or not.")
1571
1572 (defvar gnus-variable-list
1573   '(gnus-newsrc-options gnus-newsrc-options-n
1574                         gnus-newsrc-last-checked-date
1575                         gnus-newsrc-alist gnus-server-alist
1576                         gnus-killed-list gnus-zombie-list
1577                         gnus-topic-topology gnus-topic-alist
1578                         gnus-format-specs)
1579   "Gnus variables saved in the quick startup file.")
1580
1581 (defvar gnus-newsrc-alist nil
1582   "Assoc list of read articles.
1583 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1584
1585 (defvar gnus-newsrc-hashtb nil
1586   "Hashtable of gnus-newsrc-alist.")
1587
1588 (defvar gnus-killed-list nil
1589   "List of killed newsgroups.")
1590
1591 (defvar gnus-killed-hashtb nil
1592   "Hash table equivalent of gnus-killed-list.")
1593
1594 (defvar gnus-zombie-list nil
1595   "List of almost dead newsgroups.")
1596
1597 (defvar gnus-description-hashtb nil
1598   "Descriptions of newsgroups.")
1599
1600 (defvar gnus-list-of-killed-groups nil
1601   "List of newsgroups that have recently been killed by the user.")
1602
1603 (defvar gnus-active-hashtb nil
1604   "Hashtable of active articles.")
1605
1606 (defvar gnus-moderated-hashtb nil
1607   "Hashtable of moderated newsgroups.")
1608
1609 ;; Save window configuration.
1610 (defvar gnus-prev-winconf nil)
1611
1612 (defvar gnus-reffed-article-number nil)
1613
1614 ;;; Let the byte-compiler know that we know about this variable.
1615 (defvar rmail-default-rmail-file)
1616
1617 (defvar gnus-dead-summary nil)
1618
1619 ;;; End of variables.
1620
1621 ;; Define some autoload functions Gnus might use.
1622 (eval-and-compile
1623
1624   ;; This little mapcar goes through the list below and marks the
1625   ;; symbols in question as autoloaded functions.
1626   (mapcar
1627    (lambda (package)
1628      (let ((interactive (nth 1 (memq ':interactive package))))
1629        (mapcar
1630         (lambda (function)
1631           (let (keymap)
1632             (when (consp function)
1633               (setq keymap (car (memq 'keymap function)))
1634               (setq function (car function)))
1635             (unless (fboundp function)
1636               (autoload function (car package) nil interactive keymap))))
1637         (if (eq (nth 1 package) ':interactive)
1638             (nthcdr 3 package)
1639           (cdr package)))))
1640    '(("info" :interactive t Info-goto-node)
1641      ("pp" pp pp-to-string pp-eval-expression)
1642      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1643      ("ps-print" ps-print-preprint)
1644      ("browse-url" :interactive t browse-url)
1645      ("message" :interactive t
1646       message-send-and-exit message-yank-original)
1647      ("babel" babel-as-string)
1648      ("nnmail" nnmail-split-fancy nnmail-article-group)
1649      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1650      ("rmailout" rmail-output rmail-output-to-rmail-file)
1651      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1652       rmail-show-message rmail-summary-exists
1653       rmail-select-summary rmail-update-summary)
1654      ("gnus-audio" :interactive t gnus-audio-play)
1655      ("gnus-xmas" gnus-xmas-splash)
1656      ("gnus-soup" :interactive t
1657       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1658       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1659      ("nnsoup" nnsoup-pack-replies)
1660      ("score-mode" :interactive t gnus-score-mode)
1661      ("gnus-mh" gnus-summary-save-article-folder
1662       gnus-Folder-save-name gnus-folder-save-name)
1663      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1664      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1665       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1666       gnus-demon-add-disconnection gnus-demon-add-handler
1667       gnus-demon-remove-handler)
1668      ("gnus-demon" :interactive t
1669       gnus-demon-init gnus-demon-cancel)
1670      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1671       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1672      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1673       gnus-nocem-unwanted-article-p)
1674      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1675       gnus-server-server-name)
1676      ("gnus-srvr" gnus-browse-foreign-server)
1677      ("gnus-cite" :interactive t
1678       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1679       gnus-article-hide-citation gnus-article-fill-cited-article
1680       gnus-article-hide-citation-in-followups)
1681      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1682       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1683       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1684      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1685       gnus-cache-possibly-remove-articles gnus-cache-request-article
1686       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1687       gnus-cache-enter-remove-article gnus-cached-article-p
1688       gnus-cache-open gnus-cache-close gnus-cache-update-article
1689       gnus-cache-articles-in-group)
1690      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1691       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1692      ("gnus-score" :interactive t
1693       gnus-summary-increase-score gnus-summary-set-score
1694       gnus-summary-raise-thread gnus-summary-raise-same-subject
1695       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1696       gnus-summary-lower-thread gnus-summary-lower-same-subject
1697       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1698       gnus-summary-current-score gnus-score-delta-default
1699       gnus-score-flush-cache gnus-score-close
1700       gnus-possibly-score-headers gnus-score-followup-article
1701       gnus-score-followup-thread)
1702      ("gnus-score"
1703       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1704       gnus-current-score-file-nondirectory gnus-score-adaptive
1705       gnus-score-find-trace gnus-score-file-name)
1706      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1707      ("gnus-topic" :interactive t gnus-topic-mode)
1708      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1709       gnus-subscribe-topics)
1710      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1711      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1712      ("gnus-uu" :interactive t
1713       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1714       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1715       gnus-uu-mark-by-regexp gnus-uu-mark-all
1716       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1717       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1718       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1719       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1720       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1721       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1722       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1723       gnus-uu-mark-over gnus-uu-post-news)
1724      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1725      ("gnus-msg" (gnus-summary-send-map keymap)
1726       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1727      ("gnus-msg" :interactive t
1728       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1729       gnus-summary-followup gnus-summary-followup-with-original
1730       gnus-summary-cancel-article gnus-summary-supersede-article
1731       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1732       gnus-summary-mail-forward gnus-summary-mail-other-window
1733       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1734       gnus-summary-wide-reply gnus-summary-followup-to-mail
1735       gnus-summary-followup-to-mail-with-original gnus-bug
1736       gnus-summary-wide-reply-with-original
1737       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1738       gnus-summary-post-forward)
1739      ("gnus-picon" :interactive t gnus-article-display-picons
1740       gnus-group-display-picons gnus-picons-article-display-x-face
1741       gnus-picons-display-x-face)
1742      ("gnus-picon" gnus-picons-buffer-name)
1743      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1744       gnus-grouplens-mode)
1745      ("smiley" :interactive t gnus-smiley-display)
1746      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1747      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1748       gnus-list-of-unread-articles gnus-list-of-read-articles
1749       gnus-offer-save-summaries gnus-make-thread-indent-array
1750       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1751       gnus-summary-skip-intangible gnus-summary-article-number
1752       gnus-data-header gnus-data-find)
1753      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1754       gnus-group-list-groups gnus-group-first-unread-group
1755       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1756       gnus-group-setup-buffer gnus-group-get-new-news
1757       gnus-group-make-help-group gnus-group-update-group
1758       gnus-group-iterate gnus-group-group-name)
1759      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1760       gnus-backlog-remove-article)
1761      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1762       gnus-article-prepare gnus-article-set-window-start
1763       gnus-article-next-page gnus-article-prev-page
1764       gnus-request-article-this-buffer gnus-article-mode
1765       gnus-article-setup-buffer gnus-narrow-to-page
1766       gnus-article-delete-invisible-text gnus-treat-article)
1767      ("gnus-art" :interactive t
1768       gnus-article-hide-headers gnus-article-hide-boring-headers
1769       gnus-article-treat-overstrike
1770       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1771       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1772       gnus-article-de-base64-unreadable
1773       gnus-article-decode-HZ
1774       gnus-article-wash-html
1775       gnus-article-hide-pgp
1776       gnus-article-hide-pem gnus-article-hide-signature
1777       gnus-article-strip-leading-blank-lines gnus-article-date-local
1778       gnus-article-date-original gnus-article-date-lapsed
1779       gnus-article-show-all-headers
1780       gnus-article-edit-mode gnus-article-edit-article
1781       gnus-article-edit-done gnus-article-decode-encoded-words
1782       gnus-start-date-timer gnus-stop-date-timer
1783       gnus-mime-view-all-parts)
1784      ("gnus-int" gnus-request-type)
1785      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1786       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1787      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1788       gnus-dup-enter-articles)
1789      ("gnus-range" gnus-copy-sequence)
1790      ("gnus-eform" gnus-edit-form)
1791      ("gnus-move" :interactive t
1792       gnus-group-move-group-to-server gnus-change-server)
1793      ("gnus-logic" gnus-score-advanced)
1794      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1795      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1796       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1797       gnus-async-halt-prefetch)
1798      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1799       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1800       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1801       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1802      ("gnus-agent" :interactive t
1803       gnus-unplugged gnus-agentize gnus-agent-batch)
1804      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1805       gnus-summary-save-article-vm)
1806      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1807      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1808      ("gnus-mlspl" :interactive t gnus-group-split-setup
1809       gnus-group-split-update))))
1810
1811 ;;; gnus-sum.el thingies
1812
1813
1814 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1815   "*The format specification of the lines in the summary buffer.
1816
1817 It works along the same lines as a normal formatting string,
1818 with some simple extensions.
1819
1820 %N   Article number, left padded with spaces (string)
1821 %S   Subject (string)
1822 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1823 %n   Name of the poster (string)
1824 %a   Extracted name of the poster (string)
1825 %A   Extracted address of the poster (string)
1826 %F   Contents of the From: header (string)
1827 %f   Contents of the From: or To: headers (string)
1828 %x   Contents of the Xref: header (string)
1829 %D   Date of the article (string)
1830 %d   Date of the article (string) in DD-MMM format
1831 %M   Message-id of the article (string)
1832 %r   References of the article (string)
1833 %c   Number of characters in the article (integer)
1834 %L   Number of lines in the article (integer)
1835 %I   Indentation based on thread level (a string of spaces)
1836 %T   A string with two possible values: 80 spaces if the article
1837      is on thread level two or larger and 0 spaces on level one
1838 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1839 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1840 %[   Opening bracket (character, \"[\" or \"<\")
1841 %]   Closing bracket (character, \"]\" or \">\")
1842 %>   Spaces of length thread-level (string)
1843 %<   Spaces of length (- 20 thread-level) (string)
1844 %i   Article score (number)
1845 %z   Article zcore (character)
1846 %t   Number of articles under the current thread (number).
1847 %e   Whether the thread is empty or not (character).
1848 %l   GroupLens score (string).
1849 %V   Total thread score (number).
1850 %P   The line number (number).
1851 %O   Download mark (character).
1852 %u   User defined specifier.  The next character in the format string should
1853      be a letter.  Gnus will call the function gnus-user-format-function-X,
1854      where X is the letter following %u.  The function will be passed the
1855      current header as argument.  The function should return a string, which
1856      will be inserted into the summary just like information from any other
1857      summary specifier.
1858
1859 Text between %( and %) will be highlighted with `gnus-mouse-face'
1860 when the mouse point is placed inside the area.  There can only be one
1861 such area.
1862
1863 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1864 with care.  For reasons of efficiency, Gnus will compute what column
1865 these characters will end up in, and \"hard-code\" that.  This means that
1866 it is invalid to have these specs after a variable-length spec.  Well,
1867 you might not be arrested, but your summary buffer will look strange,
1868 which is bad enough.
1869
1870 The smart choice is to have these specs as for to the left as
1871 possible.
1872
1873 This restriction may disappear in later versions of Gnus."
1874   :type 'string
1875   :group 'gnus-summary-format)
1876
1877 ;;;
1878 ;;; Skeleton keymaps
1879 ;;;
1880
1881 (defun gnus-suppress-keymap (keymap)
1882   (suppress-keymap keymap)
1883   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1884     (while keys
1885       (define-key keymap (pop keys) 'undefined))))
1886
1887 (defvar gnus-article-mode-map
1888   (let ((keymap (make-sparse-keymap)))
1889     (gnus-suppress-keymap keymap)
1890     keymap))
1891 (defvar gnus-summary-mode-map
1892   (let ((keymap (make-keymap)))
1893     (gnus-suppress-keymap keymap)
1894     keymap))
1895 (defvar gnus-group-mode-map
1896   (let ((keymap (make-keymap)))
1897     (gnus-suppress-keymap keymap)
1898     keymap))
1899
1900 \f
1901
1902 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1903 ;; If you want the cursor to go somewhere else, set these two
1904 ;; functions in some startup hook to whatever you want.
1905 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1906 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1907
1908 ;;; Various macros and substs.
1909
1910 (defun gnus-header-from (header)
1911   (mail-header-from header))
1912
1913 (defmacro gnus-gethash (string hashtable)
1914   "Get hash value of STRING in HASHTABLE."
1915   `(symbol-value (intern-soft ,string ,hashtable)))
1916
1917 (defmacro gnus-sethash (string value hashtable)
1918   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1919   `(set (intern ,string ,hashtable) ,value))
1920 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1921
1922 (defmacro gnus-group-unread (group)
1923   "Get the currently computed number of unread articles in GROUP."
1924   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1925
1926 (defmacro gnus-group-entry (group)
1927   "Get the newsrc entry for GROUP."
1928   `(gnus-gethash ,group gnus-newsrc-hashtb))
1929
1930 (defmacro gnus-active (group)
1931   "Get active info on GROUP."
1932   `(gnus-gethash ,group gnus-active-hashtb))
1933
1934 (defmacro gnus-set-active (group active)
1935   "Set GROUP's active info."
1936   `(gnus-sethash ,group ,active gnus-active-hashtb))
1937
1938 ;; Info access macros.
1939
1940 (defmacro gnus-info-group (info)
1941   `(nth 0 ,info))
1942 (defmacro gnus-info-rank (info)
1943   `(nth 1 ,info))
1944 (defmacro gnus-info-read (info)
1945   `(nth 2 ,info))
1946 (defmacro gnus-info-marks (info)
1947   `(nth 3 ,info))
1948 (defmacro gnus-info-method (info)
1949   `(nth 4 ,info))
1950 (defmacro gnus-info-params (info)
1951   `(nth 5 ,info))
1952
1953 (defmacro gnus-info-level (info)
1954   `(let ((rank (gnus-info-rank ,info)))
1955      (if (consp rank)
1956          (car rank)
1957        rank)))
1958 (defmacro gnus-info-score (info)
1959   `(let ((rank (gnus-info-rank ,info)))
1960      (or (and (consp rank) (cdr rank)) 0)))
1961
1962 (defmacro gnus-info-set-group (info group)
1963   `(setcar ,info ,group))
1964 (defmacro gnus-info-set-rank (info rank)
1965   `(setcar (nthcdr 1 ,info) ,rank))
1966 (defmacro gnus-info-set-read (info read)
1967   `(setcar (nthcdr 2 ,info) ,read))
1968 (defmacro gnus-info-set-marks (info marks &optional extend)
1969   (if extend
1970       `(gnus-info-set-entry ,info ,marks 3)
1971     `(setcar (nthcdr 3 ,info) ,marks)))
1972 (defmacro gnus-info-set-method (info method &optional extend)
1973   (if extend
1974       `(gnus-info-set-entry ,info ,method 4)
1975     `(setcar (nthcdr 4 ,info) ,method)))
1976 (defmacro gnus-info-set-params (info params &optional extend)
1977   (if extend
1978       `(gnus-info-set-entry ,info ,params 5)
1979     `(setcar (nthcdr 5 ,info) ,params)))
1980
1981 (defun gnus-info-set-entry (info entry number)
1982   ;; Extend the info until we have enough elements.
1983   (while (<= (length info) number)
1984     (nconc info (list nil)))
1985   ;; Set the entry.
1986   (setcar (nthcdr number info) entry))
1987
1988 (defmacro gnus-info-set-level (info level)
1989   `(let ((rank (cdr ,info)))
1990      (if (consp (car rank))
1991          (setcar (car rank) ,level)
1992        (setcar rank ,level))))
1993 (defmacro gnus-info-set-score (info score)
1994   `(let ((rank (cdr ,info)))
1995      (if (consp (car rank))
1996          (setcdr (car rank) ,score)
1997        (setcar rank (cons (car rank) ,score)))))
1998
1999 (defmacro gnus-get-info (group)
2000   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2001
2002 ;; Byte-compiler warning.
2003 (defvar gnus-visual)
2004 ;; Find out whether the gnus-visual TYPE is wanted.
2005 (defun gnus-visual-p (&optional type class)
2006   (and gnus-visual                      ; Has to be non-nil, at least.
2007        (if (not type)                   ; We don't care about type.
2008            gnus-visual
2009          (if (listp gnus-visual)        ; It's a list, so we check it.
2010              (or (memq type gnus-visual)
2011                  (memq class gnus-visual))
2012            t))))
2013
2014 ;;; Load the compatability functions.
2015
2016 (require 'gnus-ems)
2017
2018 \f
2019 ;;;
2020 ;;; Shutdown
2021 ;;;
2022
2023 (defvar gnus-shutdown-alist nil)
2024
2025 (defun gnus-add-shutdown (function &rest symbols)
2026   "Run FUNCTION whenever one of SYMBOLS is shut down."
2027   (push (cons function symbols) gnus-shutdown-alist))
2028
2029 (defun gnus-shutdown (symbol)
2030   "Shut down everything that waits for SYMBOL."
2031   (let ((alist gnus-shutdown-alist)
2032         entry)
2033     (while (setq entry (pop alist))
2034       (when (memq symbol (cdr entry))
2035         (funcall (car entry))))))
2036
2037 \f
2038 ;;;
2039 ;;; Gnus Utility Functions
2040 ;;;
2041
2042
2043 (defmacro gnus-string-or (&rest strings)
2044   "Return the first element of STRINGS that is a non-blank string.
2045 STRINGS will be evaluated in normal `or' order."
2046   `(gnus-string-or-1 ',strings))
2047
2048 (defun gnus-string-or-1 (strings)
2049   (let (string)
2050     (while strings
2051       (setq string (eval (pop strings)))
2052       (if (string-match "^[ \t]*$" string)
2053           (setq string nil)
2054         (setq strings nil)))
2055     string))
2056
2057 (defun gnus-version (&optional arg)
2058   "Version number of this version of Gnus.
2059 If ARG, insert string at point."
2060   (interactive "P")
2061   (if arg
2062       (insert (message gnus-version))
2063     (message gnus-version)))
2064
2065 (defun gnus-continuum-version (version)
2066   "Return VERSION as a floating point number."
2067   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2068             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2069     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2070           (number (match-string 2 version))
2071           major minor least)
2072       (unless (string-match
2073                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2074         (error "Invalid version string: %s" version))
2075       (setq major (string-to-number (match-string 1 number))
2076             minor (string-to-number (match-string 2 number))
2077             least (if (match-beginning 3)
2078                       (string-to-number (match-string 3 number))
2079                     0))
2080       (string-to-number
2081        (if (zerop major)
2082            (format "%s00%02d%02d"
2083                    (if (member alpha '("(ding)" "d"))
2084                        "4.99"
2085                      (+ 5 (* 0.02
2086                              (abs
2087                               (- (mm-char-int (aref (downcase alpha) 0))
2088                                  (mm-char-int ?t))))
2089                         -0.01))
2090                    minor least)
2091          (format "%d.%02d%02d" major minor least))))))
2092
2093 (defun gnus-info-find-node ()
2094   "Find Info documentation of Gnus."
2095   (interactive)
2096   ;; Enlarge info window if needed.
2097   (let (gnus-info-buffer)
2098     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2099     (setq gnus-info-buffer (current-buffer))
2100     (gnus-configure-windows 'info)))
2101
2102 ;;;
2103 ;;; gnus-interactive
2104 ;;;
2105
2106 (defvar gnus-current-prefix-symbol nil
2107   "Current prefix symbol.")
2108
2109 (defvar gnus-current-prefix-symbols nil
2110   "List of current prefix symbols.")
2111
2112 (defun gnus-interactive (string &optional params)
2113   "Return a list that can be fed to `interactive'.
2114 See `interactive' for full documentation.
2115
2116 Adds the following specs:
2117
2118 y -- The current symbolic prefix.
2119 Y -- A list of the current symbolic prefix(es).
2120 A -- Article number.
2121 H -- Article header.
2122 g -- Group name."
2123   (let ((i 0)
2124         out c prompt)
2125     (while (< i (length string))
2126       (string-match ".\\([^\n]*\\)\n?" string i)
2127       (setq c (aref string i))
2128       (when (match-end 1)
2129         (setq prompt (match-string 1 string)))
2130       (setq i (match-end 0))
2131       ;; We basically emulate just about everything that
2132       ;; `interactive' does, but add the specs listed above.
2133       (push
2134        (cond
2135         ((= c ?a)
2136          (completing-read prompt obarray 'fboundp t))
2137         ((= c ?b)
2138          (read-buffer prompt (current-buffer) t))
2139         ((= c ?B)
2140          (read-buffer prompt (other-buffer (current-buffer))))
2141         ((= c ?c)
2142          (read-char))
2143         ((= c ?C)
2144          (completing-read prompt obarray 'commandp t))
2145         ((= c ?d)
2146          (point))
2147         ((= c ?D)
2148          (read-file-name prompt nil default-directory 'lambda))
2149         ((= c ?f)
2150          (read-file-name prompt nil nil 'lambda))
2151         ((= c ?F)
2152          (read-file-name prompt))
2153         ((= c ?k)
2154          (read-key-sequence prompt))
2155         ((= c ?K)
2156          (error "Not implemented spec"))
2157         ((= c ?e)
2158          (error "Not implemented spec"))
2159         ((= c ?m)
2160          (mark))
2161         ((= c ?N)
2162          (error "Not implemented spec"))
2163         ((= c ?n)
2164          (string-to-number (read-from-minibuffer prompt)))
2165         ((= c ?p)
2166          (prefix-numeric-value current-prefix-arg))
2167         ((= c ?P)
2168          current-prefix-arg)
2169         ((= c ?r)
2170          'gnus-prefix-nil)
2171         ((= c ?s)
2172          (read-string prompt))
2173         ((= c ?S)
2174          (intern (read-string prompt)))
2175         ((= c ?v)
2176          (read-variable prompt))
2177         ((= c ?x)
2178          (read-minibuffer prompt))
2179         ((= c ?x)
2180          (eval-minibuffer prompt))
2181         ;; And here the new specs come.
2182         ((= c ?y)
2183          gnus-current-prefix-symbol)
2184         ((= c ?Y)
2185          gnus-current-prefix-symbols)
2186         ((= c ?g)
2187          (gnus-group-group-name))
2188         ((= c ?A)
2189          (gnus-summary-skip-intangible)
2190          (or (get-text-property (point) 'gnus-number)
2191              (gnus-summary-last-subject)))
2192         ((= c ?H)
2193          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2194         (t
2195          (error "Non-implemented spec")))
2196        out)
2197       (cond
2198        ((= c ?r)
2199         (push (if (< (point) (mark) (point) (mark))) out)
2200         (push (if (> (point) (mark) (point) (mark))) out))))
2201     (setq out (delq 'gnus-prefix-nil out))
2202     (nreverse out)))
2203
2204 (defun gnus-symbolic-argument (&optional arg)
2205   "Read a symbolic argument and a command, and then execute command."
2206   (interactive "P")
2207   (let* ((in-command (this-command-keys))
2208          (command in-command)
2209          gnus-current-prefix-symbols
2210          gnus-current-prefix-symbol
2211          syms)
2212     (while (equal in-command command)
2213       (message "%s-" (key-description (this-command-keys)))
2214       (push (intern (char-to-string (read-char))) syms)
2215       (setq command (read-key-sequence nil t)))
2216     (setq gnus-current-prefix-symbols (nreverse syms)
2217           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2218     (call-interactively (key-binding command t))))
2219
2220 ;;; More various functions.
2221
2222 (defsubst gnus-check-backend-function (func group)
2223   "Check whether GROUP supports function FUNC.
2224 GROUP can either be a string (a group name) or a select method."
2225   (ignore-errors
2226     (let ((method (if (stringp group)
2227                       (car (gnus-find-method-for-group group))
2228                     group)))
2229       (unless (featurep method)
2230         (require method))
2231       (fboundp (intern (format "%s-%s" method func))))))
2232
2233 (defun gnus-group-read-only-p (&optional group)
2234   "Check whether GROUP supports editing or not.
2235 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2236 that that variable is buffer-local to the summary buffers."
2237   (let ((group (or group gnus-newsgroup-name)))
2238     (not (gnus-check-backend-function 'request-replace-article group))))
2239
2240 (defun gnus-group-total-expirable-p (group)
2241   "Check whether GROUP is total-expirable or not."
2242   (let ((params (gnus-group-find-parameter group))
2243         val)
2244     (cond
2245      ((memq 'total-expire params)
2246       t)
2247      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2248       (cdr val))
2249      (gnus-total-expirable-newsgroups   ; Check var.
2250       (string-match gnus-total-expirable-newsgroups group)))))
2251
2252 (defun gnus-group-auto-expirable-p (group)
2253   "Check whether GROUP is auto-expirable or not."
2254   (let ((params (gnus-group-find-parameter group))
2255         val)
2256     (cond
2257      ((memq 'auto-expire params)
2258       t)
2259      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2260       (cdr val))
2261      (gnus-auto-expirable-newsgroups    ; Check var.
2262       (string-match gnus-auto-expirable-newsgroups group)))))
2263
2264 (defun gnus-virtual-group-p (group)
2265   "Say whether GROUP is virtual or not."
2266   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2267                         gnus-valid-select-methods)))
2268
2269 (defun gnus-news-group-p (group &optional article)
2270   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2271   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2272       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2273            (if (or (null article)
2274                    (not (< article 0)))
2275                (eq (gnus-request-type group article) 'news)
2276              (if (not (vectorp article))
2277                  nil
2278                ;; It's a real article.
2279                (eq (gnus-request-type group (mail-header-id article))
2280                    'news))))))
2281
2282 ;; Returns a list of writable groups.
2283 (defun gnus-writable-groups ()
2284   (let ((alist gnus-newsrc-alist)
2285         groups group)
2286     (while (setq group (car (pop alist)))
2287       (unless (gnus-group-read-only-p group)
2288         (push group groups)))
2289     (nreverse groups)))
2290
2291 ;; Check whether to use long file names.
2292 (defun gnus-use-long-file-name (symbol)
2293   ;; The variable has to be set...
2294   (and gnus-use-long-file-name
2295        ;; If it isn't a list, then we return t.
2296        (or (not (listp gnus-use-long-file-name))
2297            ;; If it is a list, and the list contains `symbol', we
2298            ;; return nil.
2299            (not (memq symbol gnus-use-long-file-name)))))
2300
2301 ;; Generate a unique new group name.
2302 (defun gnus-generate-new-group-name (leaf)
2303   (let ((name leaf)
2304         (num 0))
2305     (while (gnus-gethash name gnus-newsrc-hashtb)
2306       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2307     name))
2308
2309 (defun gnus-ephemeral-group-p (group)
2310   "Say whether GROUP is ephemeral or not."
2311   (gnus-group-get-parameter group 'quit-config t))
2312
2313 (defun gnus-group-quit-config (group)
2314   "Return the quit-config of GROUP."
2315   (gnus-group-get-parameter group 'quit-config t))
2316
2317 (defun gnus-kill-ephemeral-group (group)
2318   "Remove ephemeral GROUP from relevant structures."
2319   (gnus-sethash group nil gnus-newsrc-hashtb))
2320
2321 (defun gnus-simplify-mode-line ()
2322   "Make mode lines a bit simpler."
2323   (setq mode-line-modified (cdr gnus-mode-line-modified))
2324   (when (listp mode-line-format)
2325     (make-local-variable 'mode-line-format)
2326     (setq mode-line-format (copy-sequence mode-line-format))
2327     (when (equal (nth 3 mode-line-format) "   ")
2328       (setcar (nthcdr 3 mode-line-format) " "))))
2329
2330 ;;; Servers and groups.
2331
2332 (defsubst gnus-server-add-address (method)
2333   (let ((method-name (symbol-name (car method))))
2334     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2335              (not (assq (intern (concat method-name "-address")) method))
2336              (memq 'physical-address (assq (car method)
2337                                            gnus-valid-select-methods)))
2338         (append method (list (list (intern (concat method-name "-address"))
2339                                    (nth 1 method))))
2340       method)))
2341
2342 (defsubst gnus-server-get-method (group method)
2343   ;; Input either a server name, and extended server name, or a
2344   ;; select method, and return a select method.
2345   (cond ((stringp method)
2346          (gnus-server-to-method method))
2347         ((equal method gnus-select-method)
2348          gnus-select-method)
2349         ((and (stringp (car method))
2350               group)
2351          (gnus-server-extend-method group method))
2352         ((and method
2353               (not group)
2354               (equal (cadr method) ""))
2355          method)
2356         (t
2357          (gnus-server-add-address method))))
2358
2359 (defun gnus-server-to-method (server)
2360   "Map virtual server names to select methods."
2361   (or
2362    ;; Is this a method, perhaps?
2363    (and server (listp server) server)
2364    ;; Perhaps this is the native server?
2365    (and (equal server "native") gnus-select-method)
2366    ;; It should be in the server alist.
2367    (cdr (assoc server gnus-server-alist))
2368    ;; It could be in the predefined server alist.
2369    (cdr (assoc server gnus-predefined-server-alist))
2370    ;; If not, we look through all the opened server
2371    ;; to see whether we can find it there.
2372    (let ((opened gnus-opened-servers))
2373      (while (and opened
2374                  (not (equal server (format "%s:%s" (caaar opened)
2375                                             (cadaar opened)))))
2376        (pop opened))
2377      (caar opened))
2378    ;; It could be a named method, search all servers
2379    (let ((servers gnus-secondary-select-methods))
2380      (while (and servers
2381                  (not (equal server (format "%s:%s" (caar servers)
2382                                             (cadar servers)))))
2383        (pop servers))
2384      (car servers))))
2385
2386 (defmacro gnus-method-equal (ss1 ss2)
2387   "Say whether two servers are equal."
2388   `(let ((s1 ,ss1)
2389          (s2 ,ss2))
2390      (or (equal s1 s2)
2391          (and (= (length s1) (length s2))
2392               (progn
2393                 (while (and s1 (member (car s1) s2))
2394                   (setq s1 (cdr s1)))
2395                 (null s1))))))
2396
2397 (defun gnus-methods-equal-p (m1 m2)
2398   (let ((m1 (or m1 gnus-select-method))
2399         (m2 (or m2 gnus-select-method)))
2400     (or (equal m1 m2)
2401         (and (eq (car m1) (car m2))
2402              (or (not (memq 'address (assoc (symbol-name (car m1))
2403                                             gnus-valid-select-methods)))
2404                  (equal (nth 1 m1) (nth 1 m2)))))))
2405
2406 (defun gnus-server-equal (m1 m2)
2407   "Say whether two methods are equal."
2408   (let ((m1 (cond ((null m1) gnus-select-method)
2409                   ((stringp m1) (gnus-server-to-method m1))
2410                   (t m1)))
2411         (m2 (cond ((null m2) gnus-select-method)
2412                   ((stringp m2) (gnus-server-to-method m2))
2413                   (t m2))))
2414     (gnus-method-equal m1 m2)))
2415
2416 (defun gnus-servers-using-backend (backend)
2417   "Return a list of known servers using BACKEND."
2418   (let ((opened gnus-opened-servers)
2419         out)
2420     (while opened
2421       (when (eq backend (caaar opened))
2422         (push (caar opened) out))
2423       (pop opened))
2424     out))
2425
2426 (defun gnus-archive-server-wanted-p ()
2427   "Say whether the user wants to use the archive server."
2428   (cond
2429    ((or (not gnus-message-archive-method)
2430         (not gnus-message-archive-group))
2431     nil)
2432    ((and gnus-message-archive-method gnus-message-archive-group)
2433     t)
2434    (t
2435     (let ((active (cadr (assq 'nnfolder-active-file
2436                               gnus-message-archive-method))))
2437       (and active
2438            (file-exists-p active))))))
2439
2440 (defun gnus-group-prefixed-name (group method)
2441   "Return the whole name from GROUP and METHOD."
2442   (and (stringp method) (setq method (gnus-server-to-method method)))
2443   (if (or (not method)
2444           (gnus-server-equal method "native"))
2445       group
2446     (concat (format "%s" (car method))
2447             (when (and
2448                    (or (assoc (format "%s" (car method))
2449                               (gnus-methods-using 'address))
2450                        (gnus-server-equal method gnus-message-archive-method))
2451                    (nth 1 method)
2452                    (not (string= (nth 1 method) "")))
2453               (concat "+" (nth 1 method)))
2454             ":" group)))
2455
2456 (defun gnus-group-real-prefix (group)
2457   "Return the prefix of the current group name."
2458   (if (string-match "^[^:]+:" group)
2459       (substring group 0 (match-end 0))
2460     ""))
2461
2462 (defun gnus-group-method (group)
2463   "Return the server or method used for selecting GROUP.
2464 You should probably use `gnus-find-method-for-group' instead."
2465   (let ((prefix (gnus-group-real-prefix group)))
2466     (if (equal prefix "")
2467         gnus-select-method
2468       (let ((servers gnus-opened-servers)
2469             (server "")
2470             backend possible found)
2471         (if (string-match "^[^\\+]+\\+" prefix)
2472             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2473                   server (substring prefix (match-end 0) (1- (length prefix))))
2474           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2475         (while servers
2476           (when (eq (caaar servers) backend)
2477             (setq possible (caar servers))
2478             (when (equal (cadaar servers) server)
2479               (setq found (caar servers))))
2480           (pop servers))
2481         (or (car (rassoc found gnus-server-alist))
2482             found
2483             (car (rassoc possible gnus-server-alist))
2484             possible
2485             (list backend server))))))
2486
2487 (defsubst gnus-native-method-p (method)
2488   "Return whether METHOD is the native select method."
2489   (gnus-method-equal method gnus-select-method))
2490
2491 (defsubst gnus-secondary-method-p (method)
2492   "Return whether METHOD is a secondary select method."
2493   (let ((methods gnus-secondary-select-methods)
2494         (gmethod (gnus-server-get-method nil method)))
2495     (while (and methods
2496                 (not (gnus-method-equal
2497                       (gnus-server-get-method nil (car methods))
2498                       gmethod)))
2499       (setq methods (cdr methods)))
2500     methods))
2501
2502 (defun gnus-method-simplify (method)
2503   "Return the shortest uniquely identifying string or method for METHOD."
2504   (cond ((stringp method)
2505          method)
2506         ((gnus-native-method-p method)
2507          nil)
2508         ((gnus-secondary-method-p method)
2509          (format "%s:%s" (nth 0 method) (nth 1 method)))
2510         (t
2511          method)))
2512
2513 (defun gnus-groups-from-server (server)
2514   "Return a list of all groups that are fetched from SERVER."
2515   (let ((alist (cdr gnus-newsrc-alist))
2516         info groups)
2517     (while (setq info (pop alist))
2518       (when (gnus-server-equal (gnus-info-method info) server)
2519         (push (gnus-info-group info) groups)))
2520     (sort groups 'string<)))
2521
2522 (defun gnus-group-foreign-p (group)
2523   "Say whether a group is foreign or not."
2524   (and (not (gnus-group-native-p group))
2525        (not (gnus-group-secondary-p group))))
2526
2527 (defun gnus-group-native-p (group)
2528   "Say whether the group is native or not."
2529   (not (string-match ":" group)))
2530
2531 (defun gnus-group-secondary-p (group)
2532   "Say whether the group is secondary or not."
2533   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2534
2535 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2536   "Return the group parameters for GROUP.
2537 If SYMBOL, return the value of that symbol in the group parameters."
2538   (save-excursion
2539     (set-buffer gnus-group-buffer)
2540     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2541       (if symbol
2542           (gnus-group-parameter-value parameters symbol allow-list)
2543         parameters))))
2544
2545 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2546   "Return the group parameters for GROUP.
2547 If SYMBOL, return the value of that symbol in the group parameters.
2548 Most functions should use `gnus-group-find-parameter', which
2549 also examines the topic parameters."
2550   (let ((params (gnus-info-params (gnus-get-info group))))
2551     (if symbol
2552         (gnus-group-parameter-value params symbol allow-list)
2553       params)))
2554
2555 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2556   "Return the value of SYMBOL in group PARAMS."
2557   ;; We only wish to return group parameters (dotted lists) and
2558   ;; not local variables, which may have the same names.
2559   ;; But first we handle single elements...
2560   (or (car (memq symbol params))
2561       ;; Handle alist.
2562       (let (elem)
2563         (catch 'found
2564           (while (setq elem (pop params))
2565             (when (and (consp elem)
2566                        (eq (car elem) symbol)
2567                        (or allow-list
2568                            (atom (cdr elem))))
2569               (throw 'found (cdr elem))))))))
2570
2571 (defun gnus-group-add-parameter (group param)
2572   "Add parameter PARAM to GROUP."
2573   (let ((info (gnus-get-info group)))
2574     (when info
2575       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2576       ;; Cons the new param to the old one and update.
2577       (gnus-group-set-info (cons param (gnus-info-params info))
2578                            group 'params))))
2579
2580 (defun gnus-group-set-parameter (group name value)
2581   "Set parameter NAME to VALUE in GROUP."
2582   (let ((info (gnus-get-info group)))
2583     (when info
2584       (gnus-group-remove-parameter group name)
2585       (let ((old-params (gnus-info-params info))
2586             (new-params (list (cons name value))))
2587         (while old-params
2588           (when (or (not (listp (car old-params)))
2589                     (not (eq (caar old-params) name)))
2590             (setq new-params (append new-params (list (car old-params)))))
2591           (setq old-params (cdr old-params)))
2592         (gnus-group-set-info new-params group 'params)))))
2593
2594 (defun gnus-group-remove-parameter (group name)
2595   "Remove parameter NAME from GROUP."
2596   (let ((info (gnus-get-info group)))
2597     (when info
2598       (let ((params (gnus-info-params info)))
2599         (when params
2600           (setq params (delq name params))
2601           (while (assq name params)
2602             (gnus-pull name params))
2603           (gnus-info-set-params info params))))))
2604
2605 (defun gnus-group-add-score (group &optional score)
2606   "Add SCORE to the GROUP score.
2607 If SCORE is nil, add 1 to the score of GROUP."
2608   (let ((info (gnus-get-info group)))
2609     (when info
2610       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2611
2612 (defun gnus-short-group-name (group &optional levels)
2613   "Collapse GROUP name LEVELS.
2614 Select methods are stripped and any remote host name is stripped down to
2615 just the host name."
2616   (let* ((name "")
2617          (foreign "")
2618          (depth 0)
2619          (skip 1)
2620          (levels (or levels
2621                      gnus-group-uncollapsed-levels
2622                      (progn
2623                        (while (string-match "\\." group skip)
2624                          (setq skip (match-end 0)
2625                                depth (+ depth 1)))
2626                        depth))))
2627     ;; Separate foreign select method from group name and collapse.
2628     ;; If method contains a server, collapse to non-domain server name,
2629     ;; otherwise collapse to select method.
2630     (let* ((colon (string-match ":" group))
2631            (server (and colon (substring group 0 colon)))
2632            (plus (and server (string-match "+" server))))
2633       (when server
2634         (if plus
2635             (setq foreign (substring server (+ 1 plus)
2636                                      (string-match "\\." server))
2637                   group (substring group (+ 1 colon)))
2638           (setq foreign server
2639                 group (substring group (+ 1 colon))))
2640         (setq foreign (concat foreign ":")))
2641       ;; Collapse group name leaving LEVELS uncollapsed elements
2642       (let* ((glist (split-string group "\\."))
2643              (glen (length glist))
2644              res)
2645         (setq levels (- glen levels))
2646         (dolist (g glist)
2647           (push (if (>= (decf levels) 0)
2648                     (if (zerop (length g))
2649                         ""
2650                       (substring g 0 1))
2651                   g)
2652                 res))
2653         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2654
2655 (defun gnus-narrow-to-body ()
2656   "Narrow to the body of an article."
2657   (narrow-to-region
2658    (progn
2659      (goto-char (point-min))
2660      (or (search-forward "\n\n" nil t)
2661          (point-max)))
2662    (point-max)))
2663
2664 \f
2665 ;;;
2666 ;;; Kill file handling.
2667 ;;;
2668
2669 (defun gnus-apply-kill-file ()
2670   "Apply a kill file to the current newsgroup.
2671 Returns the number of articles marked as read."
2672   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2673           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2674       (gnus-apply-kill-file-internal)
2675     0))
2676
2677 (defun gnus-kill-save-kill-buffer ()
2678   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2679     (when (get-file-buffer file)
2680       (save-excursion
2681         (set-buffer (get-file-buffer file))
2682         (when (buffer-modified-p)
2683           (save-buffer))
2684         (kill-buffer (current-buffer))))))
2685
2686 (defcustom gnus-kill-file-name "KILL"
2687   "Suffix of the kill files."
2688   :group 'gnus-score-kill
2689   :group 'gnus-score-files
2690   :type 'string)
2691
2692 (defun gnus-newsgroup-kill-file (newsgroup)
2693   "Return the name of a kill file name for NEWSGROUP.
2694 If NEWSGROUP is nil, return the global kill file name instead."
2695   (cond
2696    ;; The global KILL file is placed at top of the directory.
2697    ((or (null newsgroup)
2698         (string-equal newsgroup ""))
2699     (expand-file-name gnus-kill-file-name
2700                       gnus-kill-files-directory))
2701    ;; Append ".KILL" to newsgroup name.
2702    ((gnus-use-long-file-name 'not-kill)
2703     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2704                               "." gnus-kill-file-name)
2705                       gnus-kill-files-directory))
2706    ;; Place "KILL" under the hierarchical directory.
2707    (t
2708     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2709                               "/" gnus-kill-file-name)
2710                       gnus-kill-files-directory))))
2711
2712 ;;; Server things.
2713
2714 (defun gnus-member-of-valid (symbol group)
2715   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2716   (memq symbol (assoc
2717                 (symbol-name (car (gnus-find-method-for-group group)))
2718                 gnus-valid-select-methods)))
2719
2720 (defun gnus-method-option-p (method option)
2721   "Return non-nil if select METHOD has OPTION as a parameter."
2722   (when (stringp method)
2723     (setq method (gnus-server-to-method method)))
2724   (memq option (assoc (format "%s" (car method))
2725                       gnus-valid-select-methods)))
2726
2727 (defun gnus-similar-server-opened (method)
2728   (let ((opened gnus-opened-servers))
2729     (while (and method opened)
2730       (when (and (equal (cadr method) (cadaar opened))
2731                  (equal (car method) (caaar opened))
2732                  (not (equal method (caar opened))))
2733         (setq method nil))
2734       (pop opened))
2735     (not method)))
2736
2737 (defun gnus-server-extend-method (group method)
2738   ;; This function "extends" a virtual server.  If the server is
2739   ;; "hello", and the select method is ("hello" (my-var "something"))
2740   ;; in the group "alt.alt", this will result in a new virtual server
2741   ;; called "hello+alt.alt".
2742   (if (or (not (inline (gnus-similar-server-opened method)))
2743           (not (cddr method)))
2744       method
2745     `(,(car method) ,(concat (cadr method) "+" group)
2746       (,(intern (format "%s-address" (car method))) ,(cadr method))
2747       ,@(cddr method))))
2748
2749 (defun gnus-server-status (method)
2750   "Return the status of METHOD."
2751   (nth 1 (assoc method gnus-opened-servers)))
2752
2753 (defun gnus-group-name-to-method (group)
2754   "Guess a select method based on GROUP."
2755   (if (string-match ":" group)
2756       (let ((server (substring group 0 (match-beginning 0))))
2757         (if (string-match "\\+" server)
2758             (list (intern (substring server 0 (match-beginning 0)))
2759                   (substring server (match-end 0)))
2760           (list (intern server) "")))
2761     gnus-select-method))
2762
2763 (defun gnus-find-method-for-group (group &optional info)
2764   "Find the select method that GROUP uses."
2765   (or gnus-override-method
2766       (and (not group)
2767            gnus-select-method)
2768       (and (not (gnus-group-entry group));; a new group
2769            (gnus-group-name-to-method group))
2770       (let ((info (or info (gnus-get-info group)))
2771             method)
2772         (if (or (not info)
2773                 (not (setq method (gnus-info-method info)))
2774                 (equal method "native"))
2775             gnus-select-method
2776           (setq method
2777                 (cond ((stringp method)
2778                        (inline (gnus-server-to-method method)))
2779                       ((stringp (cadr method))
2780                        (inline (gnus-server-extend-method group method)))
2781                       (t
2782                        method)))
2783           (cond ((equal (cadr method) "")
2784                  method)
2785                 ((null (cadr method))
2786                  (list (car method) ""))
2787                 (t
2788                  (gnus-server-add-address method)))))))
2789
2790 (defun gnus-methods-using (feature)
2791   "Find all methods that have FEATURE."
2792   (let ((valids gnus-valid-select-methods)
2793         outs)
2794     (while valids
2795       (when (memq feature (car valids))
2796         (push (car valids) outs))
2797       (setq valids (cdr valids)))
2798     outs))
2799
2800 (defun gnus-read-group (prompt &optional default)
2801   "Prompt the user for a group name.
2802 Disallow invalid group names."
2803   (let ((prefix "")
2804         group)
2805     (while (not group)
2806       (when (string-match
2807              "[: `'\"/]\\|^$"
2808              (setq group (read-string (concat prefix prompt)
2809                                       (cons (or default "") 0)
2810                                       'gnus-group-history)))
2811         (setq prefix (format "Invalid group name: \"%s\".  " group)
2812               group nil)))
2813     group))
2814
2815 (defun gnus-read-method (prompt)
2816   "Prompt the user for a method.
2817 Allow completion over sensible values."
2818   (let* ((servers
2819           (append gnus-valid-select-methods
2820                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2821                                                     (cadar i))))
2822                           gnus-opened-servers)
2823                   gnus-predefined-server-alist
2824                   gnus-server-alist))
2825          (method
2826           (completing-read
2827            prompt servers
2828            nil t nil 'gnus-method-history)))
2829     (cond
2830      ((equal method "")
2831       (setq method gnus-select-method))
2832      ((assoc method gnus-valid-select-methods)
2833       (let ((address (if (memq 'prompt-address
2834                                (assoc method gnus-valid-select-methods))
2835                          (read-string "Address: ")
2836                        "")))
2837         (or (let ((opened gnus-opened-servers))
2838               (while (and opened
2839                           (not (equal (format "%s:%s" method address)
2840                                       (format "%s:%s" (caaar opened)
2841                                               (cadaar opened)))))
2842                 (pop opened))
2843               (caar opened))
2844             (list (intern method) address))))
2845      ((assoc method servers)
2846       method)
2847      (t
2848       (list (intern method) "")))))
2849
2850 ;;; User-level commands.
2851
2852 ;;;###autoload
2853 (defun gnus-slave-no-server (&optional arg)
2854   "Read network news as a slave, without connecting to local server."
2855   (interactive "P")
2856   (gnus-no-server arg t))
2857
2858 ;;;###autoload
2859 (defun gnus-no-server (&optional arg slave)
2860   "Read network news.
2861 If ARG is a positive number, Gnus will use that as the
2862 startup level.  If ARG is nil, Gnus will be started at level 2.
2863 If ARG is non-nil and not a positive number, Gnus will
2864 prompt the user for the name of an NNTP server to use.
2865 As opposed to `gnus', this command will not connect to the local server."
2866   (interactive "P")
2867   (gnus-no-server-1 arg slave))
2868
2869 ;;;###autoload
2870 (defun gnus-slave (&optional arg)
2871   "Read news as a slave."
2872   (interactive "P")
2873   (gnus arg nil 'slave))
2874
2875 ;;;###autoload
2876 (defun gnus-other-frame (&optional arg)
2877   "Pop up a frame to read news."
2878   (interactive "P")
2879   (let ((window (get-buffer-window gnus-group-buffer)))
2880     (cond (window
2881            (select-frame (window-frame window)))
2882           (t
2883            (select-frame (make-frame)))))
2884   (gnus arg))
2885
2886 ;;(setq thing ?                         ; this is a comment
2887 ;;      more 'yes)
2888
2889 ;;;###autoload
2890 (defun gnus (&optional arg dont-connect slave)
2891   "Read network news.
2892 If ARG is non-nil and a positive number, Gnus will use that as the
2893 startup level.  If ARG is non-nil and not a positive number, Gnus will
2894 prompt the user for the name of an NNTP server to use."
2895   (interactive "P")
2896   (gnus-1 arg dont-connect slave))
2897
2898 ;; Allow redefinition of Gnus functions.
2899
2900 (gnus-ems-redefine)
2901
2902 (provide 'gnus)
2903
2904 ;;; gnus.el ends here