git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus.el

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2 ;; Copyright (C) 1987-1990,1993-1999 Free Software Foundation, Inc.
   3
   4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   5 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;; Keywords: news, mail
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval '(run-hooks 'gnus-load-hook))
  30
  31 (eval-when-compile (require 'cl))
  32 (require 'mm-util)
  33
  34 (require 'custom)
  35 (eval-and-compile
  36   (if (< emacs-major-version 20)
  37       (require 'gnus-load)))
  38 (require 'message)
  39
  40 (defgroup gnus nil
  41   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  42   :group 'news
  43   :group 'mail)
  44
  45 (defgroup gnus-charset nil
  46   "Group character set issues."
  47   :link '(custom-manual "(gnus)Charsets")
  48   :group 'gnus)
  49
  50 (defgroup gnus-cache nil
  51   "Cache interface."
  52   :group 'gnus)
  53
  54 (defgroup gnus-start nil
  55   "Starting your favorite newsreader."
  56   :group 'gnus)
  57
  58 (defgroup gnus-start-server nil
  59   "Server options at startup."
  60   :group 'gnus-start)
  61
  62 ;; These belong to gnus-group.el.
  63 (defgroup gnus-group nil
  64   "Group buffers."
  65   :link '(custom-manual "(gnus)The Group Buffer")
  66   :group 'gnus)
  67
  68 (defgroup gnus-group-foreign nil
  69   "Foreign groups."
  70   :link '(custom-manual "(gnus)Foreign Groups")
  71   :group 'gnus-group)
  72
  73 (defgroup gnus-group-new nil
  74   "Automatic subscription of new groups."
  75   :group 'gnus-group)
  76
  77 (defgroup gnus-group-levels nil
  78   "Group levels."
  79   :link '(custom-manual "(gnus)Group Levels")
  80   :group 'gnus-group)
  81
  82 (defgroup gnus-group-select nil
  83   "Selecting a Group."
  84   :link '(custom-manual "(gnus)Selecting a Group")
  85   :group 'gnus-group)
  86
  87 (defgroup gnus-group-listing nil
  88   "Showing slices of the group list."
  89   :link '(custom-manual "(gnus)Listing Groups")
  90   :group 'gnus-group)
  91
  92 (defgroup gnus-group-visual nil
  93   "Sorting the group buffer."
  94   :link '(custom-manual "(gnus)Group Buffer Format")
  95   :group 'gnus-group
  96   :group 'gnus-visual)
  97
  98 (defgroup gnus-group-various nil
  99   "Various group options."
 100   :link '(custom-manual "(gnus)Scanning New Messages")
 101   :group 'gnus-group)
 102
 103 ;; These belong to gnus-sum.el.
 104 (defgroup gnus-summary nil
 105   "Summary buffers."
 106   :link '(custom-manual "(gnus)The Summary Buffer")
 107   :group 'gnus)
 108
 109 (defgroup gnus-summary-exit nil
 110   "Leaving summary buffers."
 111   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 112   :group 'gnus-summary)
 113
 114 (defgroup gnus-summary-marks nil
 115   "Marks used in summary buffers."
 116   :link '(custom-manual "(gnus)Marking Articles")
 117   :group 'gnus-summary)
 118
 119 (defgroup gnus-thread nil
 120   "Ordering articles according to replies."
 121   :link '(custom-manual "(gnus)Threading")
 122   :group 'gnus-summary)
 123
 124 (defgroup gnus-summary-format nil
 125   "Formatting of the summary buffer."
 126   :link '(custom-manual "(gnus)Summary Buffer Format")
 127   :group 'gnus-summary)
 128
 129 (defgroup gnus-summary-choose nil
 130   "Choosing Articles."
 131   :link '(custom-manual "(gnus)Choosing Articles")
 132   :group 'gnus-summary)
 133
 134 (defgroup gnus-summary-maneuvering nil
 135   "Summary movement commands."
 136   :link '(custom-manual "(gnus)Summary Maneuvering")
 137   :group 'gnus-summary)
 138
 139 (defgroup gnus-summary-mail nil
 140   "Mail group commands."
 141   :link '(custom-manual "(gnus)Mail Group Commands")
 142   :group 'gnus-summary)
 143
 144 (defgroup gnus-summary-sort nil
 145   "Sorting the summary buffer."
 146   :link '(custom-manual "(gnus)Sorting")
 147   :group 'gnus-summary)
 148
 149 (defgroup gnus-summary-visual nil
 150   "Highlighting and menus in the summary buffer."
 151   :link '(custom-manual "(gnus)Summary Highlighting")
 152   :group 'gnus-visual
 153   :group 'gnus-summary)
 154
 155 (defgroup gnus-summary-various nil
 156   "Various summary buffer options."
 157   :link '(custom-manual "(gnus)Various Summary Stuff")
 158   :group 'gnus-summary)
 159
 160 (defgroup gnus-summary-pick nil
 161   "Pick mode in the summary buffer."
 162   :link '(custom-manual "(gnus)Pick and Read")
 163   :prefix "gnus-pick-"
 164   :group 'gnus-summary)
 165
 166 (defgroup gnus-summary-tree nil
 167   "Tree display of threads in the summary buffer."
 168   :link '(custom-manual "(gnus)Tree Display")
 169   :prefix "gnus-tree-"
 170   :group 'gnus-summary)
 171
 172 ;; Belongs to gnus-uu.el
 173 (defgroup gnus-extract-view nil
 174   "Viewing extracted files."
 175   :link '(custom-manual "(gnus)Viewing Files")
 176   :group 'gnus-extract)
 177
 178 ;; Belongs to gnus-score.el
 179 (defgroup gnus-score nil
 180   "Score and kill file handling."
 181   :group 'gnus)
 182
 183 (defgroup gnus-score-kill nil
 184   "Kill files."
 185   :group 'gnus-score)
 186
 187 (defgroup gnus-score-adapt nil
 188   "Adaptive score files."
 189   :group 'gnus-score)
 190
 191 (defgroup gnus-score-default nil
 192   "Default values for score files."
 193   :group 'gnus-score)
 194
 195 (defgroup gnus-score-expire nil
 196   "Expiring score rules."
 197   :group 'gnus-score)
 198
 199 (defgroup gnus-score-decay nil
 200   "Decaying score rules."
 201   :group 'gnus-score)
 202
 203 (defgroup gnus-score-files nil
 204   "Score and kill file names."
 205   :group 'gnus-score
 206   :group 'gnus-files)
 207
 208 (defgroup gnus-score-various nil
 209   "Various scoring and killing options."
 210   :group 'gnus-score)
 211
 212 ;; Other
 213 (defgroup gnus-visual nil
 214   "Options controling the visual fluff."
 215   :group 'gnus
 216   :group 'faces)
 217
 218 (defgroup gnus-agent nil
 219   "Offline support for Gnus."
 220   :group 'gnus)
 221
 222 (defgroup gnus-files nil
 223   "Files used by Gnus."
 224   :group 'gnus)
 225
 226 (defgroup gnus-dribble-file nil
 227   "Auto save file."
 228   :link '(custom-manual "(gnus)Auto Save")
 229   :group 'gnus-files)
 230
 231 (defgroup gnus-newsrc nil
 232   "Storing Gnus state."
 233   :group 'gnus-files)
 234
 235 (defgroup gnus-server nil
 236   "Options related to newsservers and other servers used by Gnus."
 237   :group 'gnus)
 238
 239 (defgroup gnus-message '((message custom-group))
 240   "Composing replies and followups in Gnus."
 241   :group 'gnus)
 242
 243 (defgroup gnus-meta nil
 244   "Meta variables controling major portions of Gnus.
 245 In general, modifying these variables does not take affect until Gnus
 246 is restarted, and sometimes reloaded."
 247   :group 'gnus)
 248
 249 (defgroup gnus-various nil
 250   "Other Gnus options."
 251   :link '(custom-manual "(gnus)Various Various")
 252   :group 'gnus)
 253
 254 (defgroup gnus-mime nil
 255   "Variables for controlling the Gnus MIME interface."
 256   :group 'gnus)
 257
 258 (defgroup gnus-exit nil
 259   "Exiting gnus."
 260   :link '(custom-manual "(gnus)Exiting Gnus")
 261   :group 'gnus)
 262
 263 (defconst gnus-original-version-number "5.8.3"
 264   "Version number for this version of original Gnus.")
 265
 266 (defconst gnus-original-version
 267   (format "Gnus v%s" gnus-original-version-number)
 268   "Version string for this version of Gnus.")
 269
 270 (defconst gnus-product-name "Nana-gnus"
 271   "Product name of this version of gnus.")
 272
 273 (defconst gnus-version-number "7.1.0.8"
 274   "Version number for this version of gnus.")
 275
 276 (defconst gnus-version
 277   (format "%s %s (based on %s; for SEMI 1.13, FLIM 1.13)"
 278           gnus-product-name gnus-version-number gnus-original-version)
 279   "Version string for this version of gnus.")
 280
 281 (defcustom gnus-inhibit-startup-message nil
 282   "If non-nil, the startup message will not be displayed.
 283 This variable is used before `.gnus.el' is loaded, so it should
 284 be set in `.emacs' instead."
 285   :group 'gnus-start
 286   :type 'boolean)
 287
 288 (defcustom gnus-play-startup-jingle nil
 289   "If non-nil, play the Gnus jingle at startup."
 290   :group 'gnus-start
 291   :type 'boolean)
 292
 293 (unless (featurep 'gnus-xmas)
 294   (defalias 'gnus-make-overlay 'make-overlay)
 295   (defalias 'gnus-delete-overlay 'delete-overlay)
 296   (defalias 'gnus-overlay-put 'overlay-put)
 297   (defalias 'gnus-move-overlay 'move-overlay)
 298   (defalias 'gnus-overlay-end 'overlay-end)
 299   (defalias 'gnus-extent-detached-p 'ignore)
 300   (defalias 'gnus-extent-start-open 'ignore)
 301   (defalias 'gnus-set-text-properties 'set-text-properties)
 302   (defalias 'gnus-group-remove-excess-properties 'ignore)
 303   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 304   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 305   (defalias 'gnus-character-to-event 'identity)
 306   (defalias 'gnus-add-text-properties 'add-text-properties)
 307   (defalias 'gnus-put-text-property 'put-text-property)
 308   (defalias 'gnus-mode-line-buffer-identification 'identity)
 309   (defalias 'gnus-characterp 'numberp)
 310   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 311   (defalias 'gnus-window-edges 'window-edges)
 312   (defalias 'gnus-key-press-event-p 'numberp)
 313   (defalias 'gnus-decode-rfc1522 'ignore))
 314
 315 ;; We define these group faces here to avoid the display
 316 ;; update forced when creating new faces.
 317
 318 (defface gnus-group-news-1-face
 319   '((((class color)
 320       (background dark))
 321      (:foreground "PaleTurquoise" :bold t))
 322     (((class color)
 323       (background light))
 324      (:foreground "ForestGreen" :bold t))
 325     (t
 326      ()))
 327   "Level 1 newsgroup face.")
 328
 329 (defface gnus-group-news-1-empty-face
 330   '((((class color)
 331       (background dark))
 332      (:foreground "PaleTurquoise"))
 333     (((class color)
 334       (background light))
 335      (:foreground "ForestGreen"))
 336     (t
 337      ()))
 338   "Level 1 empty newsgroup face.")
 339
 340 (defface gnus-group-news-2-face
 341   '((((class color)
 342       (background dark))
 343      (:foreground "turquoise" :bold t))
 344     (((class color)
 345       (background light))
 346      (:foreground "CadetBlue4" :bold t))
 347     (t
 348      ()))
 349   "Level 2 newsgroup face.")
 350
 351 (defface gnus-group-news-2-empty-face
 352   '((((class color)
 353       (background dark))
 354      (:foreground "turquoise"))
 355     (((class color)
 356       (background light))
 357      (:foreground "CadetBlue4"))
 358     (t
 359      ()))
 360   "Level 2 empty newsgroup face.")
 361
 362 (defface gnus-group-news-3-face
 363   '((((class color)
 364       (background dark))
 365      (:bold t))
 366     (((class color)
 367       (background light))
 368      (:bold t))
 369     (t
 370      ()))
 371   "Level 3 newsgroup face.")
 372
 373 (defface gnus-group-news-3-empty-face
 374   '((((class color)
 375       (background dark))
 376      ())
 377     (((class color)
 378       (background light))
 379      ())
 380     (t
 381      ()))
 382   "Level 3 empty newsgroup face.")
 383
 384 (defface gnus-group-news-4-face
 385   '((((class color)
 386       (background dark))
 387      (:bold t))
 388     (((class color)
 389       (background light))
 390      (:bold t))
 391     (t
 392      ()))
 393   "Level 4 newsgroup face.")
 394
 395 (defface gnus-group-news-4-empty-face
 396   '((((class color)
 397       (background dark))
 398      ())
 399     (((class color)
 400       (background light))
 401      ())
 402     (t
 403      ()))
 404   "Level 4 empty newsgroup face.")
 405
 406 (defface gnus-group-news-5-face
 407   '((((class color)
 408       (background dark))
 409      (:bold t))
 410     (((class color)
 411       (background light))
 412      (:bold t))
 413     (t
 414      ()))
 415   "Level 5 newsgroup face.")
 416
 417 (defface gnus-group-news-5-empty-face
 418   '((((class color)
 419       (background dark))
 420      ())
 421     (((class color)
 422       (background light))
 423      ())
 424     (t
 425      ()))
 426   "Level 5 empty newsgroup face.")
 427
 428 (defface gnus-group-news-6-face
 429   '((((class color)
 430       (background dark))
 431      (:bold t))
 432     (((class color)
 433       (background light))
 434      (:bold t))
 435     (t
 436      ()))
 437   "Level 6 newsgroup face.")
 438
 439 (defface gnus-group-news-6-empty-face
 440   '((((class color)
 441       (background dark))
 442      ())
 443     (((class color)
 444       (background light))
 445      ())
 446     (t
 447      ()))
 448   "Level 6 empty newsgroup face.")
 449
 450 (defface gnus-group-news-low-face
 451   '((((class color)
 452       (background dark))
 453      (:foreground "DarkTurquoise" :bold t))
 454     (((class color)
 455       (background light))
 456      (:foreground "DarkGreen" :bold t))
 457     (t
 458      ()))
 459   "Low level newsgroup face.")
 460
 461 (defface gnus-group-news-low-empty-face
 462   '((((class color)
 463       (background dark))
 464      (:foreground "DarkTurquoise"))
 465     (((class color)
 466       (background light))
 467      (:foreground "DarkGreen"))
 468     (t
 469      ()))
 470   "Low level empty newsgroup face.")
 471
 472 (defface gnus-group-mail-1-face
 473   '((((class color)
 474       (background dark))
 475      (:foreground "aquamarine1" :bold t))
 476     (((class color)
 477       (background light))
 478      (:foreground "DeepPink3" :bold t))
 479     (t
 480      (:bold t)))
 481   "Level 1 mailgroup face.")
 482
 483 (defface gnus-group-mail-1-empty-face
 484   '((((class color)
 485       (background dark))
 486      (:foreground "aquamarine1"))
 487     (((class color)
 488       (background light))
 489      (:foreground "DeepPink3"))
 490     (t
 491      (:italic t :bold t)))
 492   "Level 1 empty mailgroup face.")
 493
 494 (defface gnus-group-mail-2-face
 495   '((((class color)
 496       (background dark))
 497      (:foreground "aquamarine2" :bold t))
 498     (((class color)
 499       (background light))
 500      (:foreground "HotPink3" :bold t))
 501     (t
 502      (:bold t)))
 503   "Level 2 mailgroup face.")
 504
 505 (defface gnus-group-mail-2-empty-face
 506   '((((class color)
 507       (background dark))
 508      (:foreground "aquamarine2"))
 509     (((class color)
 510       (background light))
 511      (:foreground "HotPink3"))
 512     (t
 513      (:bold t)))
 514   "Level 2 empty mailgroup face.")
 515
 516 (defface gnus-group-mail-3-face
 517   '((((class color)
 518       (background dark))
 519      (:foreground "aquamarine3" :bold t))
 520     (((class color)
 521       (background light))
 522      (:foreground "magenta4" :bold t))
 523     (t
 524      (:bold t)))
 525   "Level 3 mailgroup face.")
 526
 527 (defface gnus-group-mail-3-empty-face
 528   '((((class color)
 529       (background dark))
 530      (:foreground "aquamarine3"))
 531     (((class color)
 532       (background light))
 533      (:foreground "magenta4"))
 534     (t
 535      ()))
 536   "Level 3 empty mailgroup face.")
 537
 538 (defface gnus-group-mail-low-face
 539   '((((class color)
 540       (background dark))
 541      (:foreground "aquamarine4" :bold t))
 542     (((class color)
 543       (background light))
 544      (:foreground "DeepPink4" :bold t))
 545     (t
 546      (:bold t)))
 547   "Low level mailgroup face.")
 548
 549 (defface gnus-group-mail-low-empty-face
 550   '((((class color)
 551       (background dark))
 552      (:foreground "aquamarine4"))
 553     (((class color)
 554       (background light))
 555      (:foreground "DeepPink4"))
 556     (t
 557      (:bold t)))
 558   "Low level empty mailgroup face.")
 559
 560 ;; Summary mode faces.
 561
 562 (defface gnus-summary-selected-face '((t
 563                                        (:underline t)))
 564   "Face used for selected articles.")
 565
 566 (defface gnus-summary-cancelled-face
 567   '((((class color))
 568      (:foreground "yellow" :background "black")))
 569   "Face used for cancelled articles.")
 570
 571 (defface gnus-summary-high-ticked-face
 572   '((((class color)
 573       (background dark))
 574      (:foreground "pink" :bold t))
 575     (((class color)
 576       (background light))
 577      (:foreground "firebrick" :bold t))
 578     (t
 579      (:bold t)))
 580   "Face used for high interest ticked articles.")
 581
 582 (defface gnus-summary-low-ticked-face
 583   '((((class color)
 584       (background dark))
 585      (:foreground "pink" :italic t))
 586     (((class color)
 587       (background light))
 588      (:foreground "firebrick" :italic t))
 589     (t
 590      (:italic t)))
 591   "Face used for low interest ticked articles.")
 592
 593 (defface gnus-summary-normal-ticked-face
 594   '((((class color)
 595       (background dark))
 596      (:foreground "pink"))
 597     (((class color)
 598       (background light))
 599      (:foreground "firebrick"))
 600     (t
 601      ()))
 602   "Face used for normal interest ticked articles.")
 603
 604 (defface gnus-summary-high-ancient-face
 605   '((((class color)
 606       (background dark))
 607      (:foreground "SkyBlue" :bold t))
 608     (((class color)
 609       (background light))
 610      (:foreground "RoyalBlue" :bold t))
 611     (t
 612      (:bold t)))
 613   "Face used for high interest ancient articles.")
 614
 615 (defface gnus-summary-low-ancient-face
 616   '((((class color)
 617       (background dark))
 618      (:foreground "SkyBlue" :italic t))
 619     (((class color)
 620       (background light))
 621      (:foreground "RoyalBlue" :italic t))
 622     (t
 623      (:italic t)))
 624   "Face used for low interest ancient articles.")
 625
 626 (defface gnus-summary-normal-ancient-face
 627   '((((class color)
 628       (background dark))
 629      (:foreground "SkyBlue"))
 630     (((class color)
 631       (background light))
 632      (:foreground "RoyalBlue"))
 633     (t
 634      ()))
 635   "Face used for normal interest ancient articles.")
 636
 637 (defface gnus-summary-high-unread-face
 638   '((t
 639      (:bold t)))
 640   "Face used for high interest unread articles.")
 641
 642 (defface gnus-summary-low-unread-face
 643   '((t
 644      (:italic t)))
 645   "Face used for low interest unread articles.")
 646
 647 (defface gnus-summary-normal-unread-face
 648   '((t
 649      ()))
 650   "Face used for normal interest unread articles.")
 651
 652 (defface gnus-summary-high-read-face
 653   '((((class color)
 654       (background dark))
 655      (:foreground "PaleGreen"
 656                   :bold t))
 657     (((class color)
 658       (background light))
 659      (:foreground "DarkGreen"
 660                   :bold t))
 661     (t
 662      (:bold t)))
 663   "Face used for high interest read articles.")
 664
 665 (defface gnus-summary-low-read-face
 666   '((((class color)
 667       (background dark))
 668      (:foreground "PaleGreen"
 669                   :italic t))
 670     (((class color)
 671       (background light))
 672      (:foreground "DarkGreen"
 673                   :italic t))
 674     (t
 675      (:italic t)))
 676   "Face used for low interest read articles.")
 677
 678 (defface gnus-summary-normal-read-face
 679   '((((class color)
 680       (background dark))
 681      (:foreground "PaleGreen"))
 682     (((class color)
 683       (background light))
 684      (:foreground "DarkGreen"))
 685     (t
 686      ()))
 687   "Face used for normal interest read articles.")
 688
 689
 690 ;;;
 691 ;;; Gnus buffers
 692 ;;;
 693
 694 (defvar gnus-buffers nil)
 695
 696 (defun gnus-get-buffer-create (name)
 697   "Do the same as `get-buffer-create', but store the created buffer."
 698   (or (get-buffer name)
 699       (car (push (get-buffer-create name) gnus-buffers))))
 700
 701 (defun gnus-add-buffer ()
 702   "Add the current buffer to the list of Gnus buffers."
 703   (push (current-buffer) gnus-buffers))
 704
 705 (defun gnus-buffers ()
 706   "Return a list of live Gnus buffers."
 707   (while (and gnus-buffers
 708               (not (buffer-name (car gnus-buffers))))
 709     (pop gnus-buffers))
 710   (let ((buffers gnus-buffers))
 711     (while (cdr buffers)
 712       (if (buffer-name (cadr buffers))
 713           (pop buffers)
 714         (setcdr buffers (cddr buffers)))))
 715   gnus-buffers)
 716
 717 ;;; Splash screen.
 718
 719 (defvar gnus-group-buffer "*Group*")
 720
 721 (eval-and-compile
 722   (autoload 'gnus-play-jingle "gnus-audio"))
 723
 724 (defface gnus-splash-face
 725   '((((class color)
 726       (background dark))
 727      (:foreground "Brown"))
 728     (((class color)
 729       (background light))
 730      (:foreground "Brown"))
 731     (t
 732      ()))
 733   "Face of the splash screen.")
 734
 735 (defun gnus-splash ()
 736   (save-excursion
 737     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 738     (let ((buffer-read-only nil))
 739       (erase-buffer)
 740       (unless gnus-inhibit-startup-message
 741         (gnus-group-startup-message)
 742         (sit-for 0)
 743         (when gnus-play-startup-jingle
 744           (gnus-play-jingle))))))
 745
 746 (defun gnus-indent-rigidly (start end arg)
 747   "Indent rigidly using only spaces and no tabs."
 748   (save-excursion
 749     (save-restriction
 750       (narrow-to-region start end)
 751       (let ((tab-width 8))
 752         (indent-rigidly start end arg)
 753         ;; We translate tabs into spaces -- not everybody uses
 754         ;; an 8-character tab.
 755         (goto-char (point-min))
 756         (while (search-forward "\t" nil t)
 757           (replace-match "        " t t))))))
 758
 759 (defvar gnus-simple-splash nil)
 760
 761 (defun gnus-group-startup-message (&optional x y)
 762   "Insert startup message in current buffer."
 763   ;; Insert the message.
 764   (erase-buffer)
 765   (insert
 766    (format "              %s
 767           _    ___ _             _
 768           _ ___ __ ___  __    _ ___
 769           __   _     ___    __  ___
 770               _           ___     _
 771              _  _ __             _
 772              ___   __            _
 773                    __           _
 774                     _      _   _
 775                    _      _    _
 776                       _  _    _
 777                   __  ___
 778                  _   _ _     _
 779                 _   _
 780               _    _
 781              _    _
 782             _
 783           __
 784
 785 "
 786            ""))
 787   ;; And then hack it.
 788   (gnus-indent-rigidly (point-min) (point-max)
 789                        (/ (max (- (window-width) (or x 46)) 0) 2))
 790   (goto-char (point-min))
 791   (forward-line 1)
 792   (let* ((pheight (count-lines (point-min) (point-max)))
 793          (wheight (window-height))
 794          (rest (- wheight pheight)))
 795     (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 796   ;; Fontify some.
 797   (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 798   (goto-char (point-min))
 799   (setq mode-line-buffer-identification (concat " " gnus-version))
 800   (setq gnus-simple-splash t)
 801   (set-buffer-modified-p t))
 802
 803 (eval-when (load)
 804   (let ((command (format "%s" this-command)))
 805     (if (and (string-match "gnus" command)
 806              (not (string-match "gnus-other-frame" command)))
 807         (gnus-splash)
 808       (gnus-get-buffer-create gnus-group-buffer))))
 809
 810 ;;; Do the rest.
 811
 812 (require 'custom)
 813 (require 'gnus-util)
 814 (require 'nnheader)
 815
 816 (defcustom gnus-home-directory "~/"
 817   "Directory variable that specifies the \"home\" directory.
 818 All other Gnus path variables are initialized from this variable."
 819   :group 'gnus-files
 820   :type 'directory)
 821
 822 (defcustom gnus-directory (or (getenv "SAVEDIR")
 823                               (nnheader-concat gnus-home-directory "News/"))
 824   "*Directory variable from which all other Gnus file variables are derived.
 825
 826 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
 827 This means that other directory variables that are initialized from
 828 this variable won't be set properly if you set this variable in `.gnus.el'.
 829 Set this variable in `.emacs' instead."
 830   :group 'gnus-files
 831   :type 'directory)
 832
 833 (defcustom gnus-default-directory nil
 834   "*Default directory for all Gnus buffers."
 835   :group 'gnus-files
 836   :type '(choice (const :tag "current" nil)
 837                  directory))
 838
 839 ;; Site dependent variables.  These variables should be defined in
 840 ;; paths.el.
 841
 842 (defvar gnus-default-nntp-server nil
 843   "Specify a default NNTP server.
 844 This variable should be defined in paths.el, and should never be set
 845 by the user.
 846 If you want to change servers, you should use `gnus-select-method'.
 847 See the documentation to that variable.")
 848
 849 ;; Don't touch this variable.
 850 (defvar gnus-nntp-service "nntp"
 851   "NNTP service name (\"nntp\" or 119).
 852 This is an obsolete variable, which is scarcely used.  If you use an
 853 nntp server for your newsgroup and want to change the port number
 854 used to 899, you would say something along these lines:
 855
 856  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
 857
 858 (defcustom gnus-nntpserver-file "/etc/nntpserver"
 859   "A file with only the name of the nntp server in it."
 860   :group 'gnus-files
 861   :group 'gnus-server
 862   :type 'file)
 863
 864 ;; This function is used to check both the environment variable
 865 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
 866 ;; an nntp server name default.
 867 (defun gnus-getenv-nntpserver ()
 868   (or (getenv "NNTPSERVER")
 869       (and (file-readable-p gnus-nntpserver-file)
 870            (save-excursion
 871              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
 872              (insert-file-contents gnus-nntpserver-file)
 873              (let ((name (buffer-string)))
 874                (prog1
 875                    (if (string-match "\\'[ \t\n]*$" name)
 876                        nil
 877                      name)
 878                  (kill-buffer (current-buffer))))))))
 879
 880 (defcustom gnus-select-method
 881   (condition-case nil
 882       (nconc
 883        (list 'nntp (or (condition-case nil
 884                            (gnus-getenv-nntpserver)
 885                          (error nil))
 886                        (when (and gnus-default-nntp-server
 887                                   (not (string= gnus-default-nntp-server "")))
 888                          gnus-default-nntp-server)
 889                        "news"))
 890        (if (or (null gnus-nntp-service)
 891                (equal gnus-nntp-service "nntp"))
 892            nil
 893          (list gnus-nntp-service)))
 894     (error nil))
 895   "Default method for selecting a newsgroup.
 896 This variable should be a list, where the first element is how the
 897 news is to be fetched, the second is the address.
 898
 899 For instance, if you want to get your news via NNTP from
 900 \"flab.flab.edu\", you could say:
 901
 902 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
 903
 904 If you want to use your local spool, say:
 905
 906 \(setq gnus-select-method (list 'nnspool (system-name)))
 907
 908 If you use this variable, you must set `gnus-nntp-server' to nil.
 909
 910 There is a lot more to know about select methods and virtual servers -
 911 see the manual for details."
 912   :group 'gnus-server
 913   :type 'gnus-select-method)
 914
 915 (defcustom gnus-message-archive-method
 916   `(nnfolder
 917     "archive"
 918     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
 919     (nnfolder-active-file
 920      ,(nnheader-concat message-directory "archive/active"))
 921     (nnfolder-get-new-mail nil)
 922     (nnfolder-inhibit-expiry t))
 923   "*Method used for archiving messages you've sent.
 924 This should be a mail method.
 925
 926 It's probably not a very effective to change this variable once you've
 927 run Gnus once.  After doing that, you must edit this server from the
 928 server buffer."
 929   :group 'gnus-server
 930   :group 'gnus-message
 931   :type 'gnus-select-method)
 932
 933 (defcustom gnus-message-archive-group nil
 934   "*Name of the group in which to save the messages you've written.
 935 This can either be a string; a list of strings; or an alist
 936 of regexps/functions/forms to be evaluated to return a string (or a list
 937 of strings).  The functions are called with the name of the current
 938 group (or nil) as a parameter.
 939
 940 If you want to save your mail in one group and the news articles you
 941 write in another group, you could say something like:
 942
 943  \(setq gnus-message-archive-group
 944         '((if (message-news-p)
 945               \"misc-news\"
 946             \"misc-mail\")))
 947
 948 Normally the group names returned by this variable should be
 949 unprefixed -- which implicitly means \"store on the archive server\".
 950 However, you may wish to store the message on some other server.  In
 951 that case, just return a fully prefixed name of the group --
 952 \"nnml+private:mail.misc\", for instance."
 953   :group 'gnus-message
 954   :type '(choice (const :tag "none" nil)
 955                  function
 956                  sexp
 957                  string))
 958
 959 (defcustom gnus-secondary-servers nil
 960   "List of NNTP servers that the user can choose between interactively.
 961 To make Gnus query you for a server, you have to give `gnus' a
 962 non-numeric prefix - `C-u M-x gnus', in short."
 963   :group 'gnus-server
 964   :type '(repeat string))
 965
 966 (defcustom gnus-nntp-server nil
 967   "*The name of the host running the NNTP server.
 968 This variable is semi-obsolete.  Use the `gnus-select-method'
 969 variable instead."
 970   :group 'gnus-server
 971   :type '(choice (const :tag "disable" nil)
 972                  string))
 973
 974 (defcustom gnus-secondary-select-methods nil
 975   "A list of secondary methods that will be used for reading news.
 976 This is a list where each element is a complete select method (see
 977 `gnus-select-method').
 978
 979 If, for instance, you want to read your mail with the nnml backend,
 980 you could set this variable:
 981
 982 \(setq gnus-secondary-select-methods '((nnml \"\")))"
 983   :group 'gnus-server
 984   :type '(repeat gnus-select-method))
 985
 986 (defvar gnus-backup-default-subscribed-newsgroups
 987   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
 988   "Default default new newsgroups the first time Gnus is run.
 989 Should be set in paths.el, and shouldn't be touched by the user.")
 990
 991 (defcustom gnus-local-domain nil
 992   "Local domain name without a host name.
 993 The DOMAINNAME environment variable is used instead if it is defined.
 994 If the `system-name' function returns the full Internet name, there is
 995 no need to set this variable."
 996   :group 'gnus-message
 997   :type '(choice (const :tag "default" nil)
 998                  string))
 999
1000 (defvar gnus-local-organization nil
1001   "String with a description of what organization (if any) the user belongs to.
1002 Obsolete variable; use `message-user-organization' instead.")
1003
1004 ;; Customization variables
1005
1006 (defcustom gnus-refer-article-method nil
1007   "Preferred method for fetching an article by Message-ID.
1008 If you are reading news from the local spool (with nnspool), fetching
1009 articles by Message-ID is painfully slow.  By setting this method to an
1010 nntp method, you might get acceptable results.
1011
1012 The value of this variable must be a valid select method as discussed
1013 in the documentation of `gnus-select-method'.
1014
1015 It can also be a list of select methods, as well as the special symbol
1016 `current', which means to use the current select method.  If it is a
1017 list, Gnus will try all the methods in the list until it finds a match."
1018   :group 'gnus-server
1019   :type '(choice (const :tag "default" nil)
1020                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1021                  gnus-select-method
1022                  (repeat :menu-tag "Try multiple"
1023                          :tag "Multiple"
1024                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1025                          (choice :tag "Method"
1026                                  (const current)
1027                                  (const :tag "DejaNews"
1028                                         (nnweb "refer" (nnweb-type dejanews)))
1029                                  gnus-select-method))))
1030
1031 (defcustom gnus-group-faq-directory
1032   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1033     "/ftp@sunsite.auc.dk:/pub/usenet/"
1034     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1035     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1036     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1037     "/ftp@rtfm.mit.edu:/pub/usenet/"
1038     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1039     "/ftp@ftp.sunet.se:/pub/usenet/"
1040     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1041     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1042     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1043   "*Directory where the group FAQs are stored.
1044 This will most commonly be on a remote machine, and the file will be
1045 fetched by ange-ftp.
1046
1047 This variable can also be a list of directories.  In that case, the
1048 first element in the list will be used by default.  The others can
1049 be used when being prompted for a site.
1050
1051 Note that Gnus uses an aol machine as the default directory.  If this
1052 feels fundamentally unclean, just think of it as a way to finally get
1053 something of value back from them.
1054
1055 If the default site is too slow, try one of these:
1056
1057    North America: mirrors.aol.com                /pub/rtfm/usenet
1058                   ftp.seas.gwu.edu               /pub/rtfm
1059                   rtfm.mit.edu                   /pub/usenet
1060    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1061                   src.doc.ic.ac.uk               /usenet/news-FAQS
1062                   ftp.sunet.se                   /pub/usenet
1063                   sunsite.auc.dk                 /pub/usenet
1064    Asia:          nctuccca.edu.tw                /USENET/FAQ
1065                   hwarang.postech.ac.kr          /pub/usenet
1066                   ftp.hk.super.net               /mirror/faqs"
1067   :group 'gnus-group-various
1068   :type '(choice directory
1069                  (repeat directory)))
1070
1071 (defcustom gnus-use-cross-reference t
1072   "*Non-nil means that cross referenced articles will be marked as read.
1073 If nil, ignore cross references.  If t, mark articles as read in
1074 subscribed newsgroups.  If neither t nor nil, mark as read in all
1075 newsgroups."
1076   :group 'gnus-server
1077   :type '(choice (const :tag "off" nil)
1078                  (const :tag "subscribed" t)
1079                  (sexp :format "all"
1080                        :value always)))
1081
1082 (defcustom gnus-process-mark ?#
1083   "*Process mark."
1084   :group 'gnus-group-visual
1085   :group 'gnus-summary-marks
1086   :type 'character)
1087
1088 (defcustom gnus-asynchronous nil
1089   "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1090   :group 'gnus-asynchronous
1091   :type 'boolean)
1092
1093 (defcustom gnus-large-newsgroup 200
1094   "*The number of articles which indicates a large newsgroup.
1095 If the number of articles in a newsgroup is greater than this value,
1096 confirmation is required for selecting the newsgroup."
1097   :group 'gnus-group-select
1098   :type 'integer)
1099
1100 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1101   "*Non-nil means that the default name of a file to save articles in is the group name.
1102 If it's nil, the directory form of the group name is used instead.
1103
1104 If this variable is a list, and the list contains the element
1105 `not-score', long file names will not be used for score files; if it
1106 contains the element `not-save', long file names will not be used for
1107 saving; and if it contains the element `not-kill', long file names
1108 will not be used for kill files.
1109
1110 Note that the default for this variable varies according to what system
1111 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1112 to nil while on all other systems it defaults to t."
1113   :group 'gnus-start
1114   :type 'boolean)
1115
1116 (defcustom gnus-kill-files-directory gnus-directory
1117   "*Name of the directory where kill files will be stored (default \"~/News\")."
1118   :group 'gnus-score-files
1119   :group 'gnus-score-kill
1120   :type 'directory)
1121
1122 (defcustom gnus-save-score nil
1123   "*If non-nil, save group scoring info."
1124   :group 'gnus-score-various
1125   :group 'gnus-start
1126   :type 'boolean)
1127
1128 (defcustom gnus-use-undo t
1129   "*If non-nil, allow undoing in Gnus group mode buffers."
1130   :group 'gnus-meta
1131   :type 'boolean)
1132
1133 (defcustom gnus-use-adaptive-scoring nil
1134   "*If non-nil, use some adaptive scoring scheme.
1135 If a list, then the values `word' and `line' are meaningful.  The
1136 former will perform adaption on individual words in the subject
1137 header while `line' will perform adaption on several headers."
1138   :group 'gnus-meta
1139   :group 'gnus-score-adapt
1140   :type '(set (const word) (const line)))
1141
1142 (defcustom gnus-use-cache 'passive
1143   "*If nil, Gnus will ignore the article cache.
1144 If `passive', it will allow entering (and reading) articles
1145 explicitly entered into the cache.  If anything else, use the
1146 cache to the full extent of the law."
1147   :group 'gnus-meta
1148   :group 'gnus-cache
1149   :type '(choice (const :tag "off" nil)
1150                  (const :tag "passive" passive)
1151                  (const :tag "active" t)))
1152
1153 (defcustom gnus-use-trees nil
1154   "*If non-nil, display a thread tree buffer."
1155   :group 'gnus-meta
1156   :type 'boolean)
1157
1158 (defcustom gnus-use-grouplens nil
1159   "*If non-nil, use GroupLens ratings."
1160   :group 'gnus-meta
1161   :type 'boolean)
1162
1163 (defcustom gnus-keep-backlog nil
1164   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1165 If it is a number N, then Gnus will only keep the last N articles
1166 read.  If it is neither nil nor a number, Gnus will keep all read
1167 articles.  This is not a good idea."
1168   :group 'gnus-meta
1169   :type '(choice (const :tag "off" nil)
1170                  integer
1171                  (sexp :format "all"
1172                        :value t)))
1173
1174 (defcustom gnus-use-nocem nil
1175   "*If non-nil, Gnus will read NoCeM cancel messages."
1176   :group 'gnus-meta
1177   :type 'boolean)
1178
1179 (defcustom gnus-suppress-duplicates nil
1180   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1181   :group 'gnus-meta
1182   :type 'boolean)
1183
1184 (defcustom gnus-use-scoring t
1185   "*If non-nil, enable scoring."
1186   :group 'gnus-meta
1187   :type 'boolean)
1188
1189 (defcustom gnus-use-picons nil
1190   "*If non-nil, display picons in a frame of their own."
1191   :group 'gnus-meta
1192   :type 'boolean)
1193
1194 (defcustom gnus-summary-prepare-exit-hook
1195   '(gnus-summary-expire-articles)
1196   "*A hook called when preparing to exit from the summary buffer.
1197 It calls `gnus-summary-expire-articles' by default."
1198   :group 'gnus-summary-exit
1199   :type 'hook)
1200
1201 (defcustom gnus-novice-user t
1202   "*Non-nil means that you are a usenet novice.
1203 If non-nil, verbose messages may be displayed and confirmations may be
1204 required."
1205   :group 'gnus-meta
1206   :type 'boolean)
1207
1208 (defcustom gnus-expert-user nil
1209   "*Non-nil means that you will never be asked for confirmation about anything.
1210 That doesn't mean *anything* anything; particularly destructive
1211 commands will still require prompting."
1212   :group 'gnus-meta
1213   :type 'boolean)
1214
1215 (defcustom gnus-interactive-catchup t
1216   "*If non-nil, require your confirmation when catching up a group."
1217   :group 'gnus-group-select
1218   :type 'boolean)
1219
1220 (defcustom gnus-interactive-exit t
1221   "*If non-nil, require your confirmation when exiting Gnus."
1222   :group 'gnus-exit
1223   :type 'boolean)
1224
1225 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1226   "*Function for extracting address components from a From header.
1227 Two pre-defined function exist: `gnus-extract-address-components',
1228 which is the default, quite fast, and too simplistic solution, and
1229 `mail-extract-address-components', which works much better, but is
1230 slower."
1231   :group 'gnus-summary-format
1232   :type '(radio (function-item gnus-extract-address-components)
1233                 (function-item mail-extract-address-components)
1234                 (function :tag "Other")))
1235
1236 (defcustom gnus-carpal nil
1237   "*If non-nil, display clickable icons."
1238   :group 'gnus-meta
1239   :type 'boolean)
1240
1241 (defcustom gnus-shell-command-separator ";"
1242   "String used to separate to shell commands."
1243   :group 'gnus-files
1244   :type 'string)
1245
1246 (defcustom gnus-valid-select-methods
1247   '(("nntp" post address prompt-address physical-address)
1248     ("nnspool" post address)
1249     ("nnvirtual" post-mail virtual prompt-address)
1250     ("nnmbox" mail respool address)
1251     ("nnml" mail respool address)
1252     ("nnmh" mail respool address)
1253     ("nndir" post-mail prompt-address physical-address)
1254     ("nneething" none address prompt-address physical-address)
1255     ("nndoc" none address prompt-address)
1256     ("nnbabyl" mail address respool)
1257     ("nnkiboze" post virtual)
1258     ("nnsoup" post-mail address)
1259     ("nndraft" post-mail)
1260     ("nnfolder" mail respool address)
1261     ("nngateway" post-mail address prompt-address physical-address)
1262     ("nnweb" none)
1263     ("nnslashdot" post)
1264     ("nnultimate" none)
1265     ("nnwarchive" none)
1266     ("nnlistserv" none)
1267     ("nnagent" post-mail)
1268     ("nnimap" post-mail address prompt-address physical-address))
1269   "*An alist of valid select methods.
1270 The first element of each list lists should be a string with the name
1271 of the select method.  The other elements may be the category of
1272 this method (i. e., `post', `mail', `none' or whatever) or other
1273 properties that this method has (like being respoolable).
1274 If you implement a new select method, all you should have to change is
1275 this variable.  I think."
1276   :group 'gnus-server
1277   :type '(repeat (group (string :tag "Name")
1278                         (radio-button-choice (const :format "%v " post)
1279                                              (const :format "%v " mail)
1280                                              (const :format "%v " none)
1281                                              (const post-mail))
1282                         (checklist :inline t
1283                                    (const :format "%v " address)
1284                                    (const :format "%v " prompt-address)
1285                                    (const :format "%v " physical-address)
1286                                    (const :format "%v " virtual)
1287                                    (const respool)))))
1288
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           (string :tag "Address")
1299           (repeat :tag "Options"
1300                   :inline t
1301                   (list :format "%v"
1302                         variable
1303                         (sexp :tag "Value")))))
1304
1305 (defcustom gnus-updated-mode-lines '(group article summary tree)
1306   "List of buffers that should update their mode lines.
1307 The list may contain the symbols `group', `article', `tree' and
1308 `summary'.  If the corresponding symbol is present, Gnus will keep
1309 that mode line updated with information that may be pertinent.
1310 If this variable is nil, screen refresh may be quicker."
1311   :group 'gnus-various
1312   :type '(set (const group)
1313               (const article)
1314               (const summary)
1315               (const tree)))
1316
1317 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1318 (defcustom gnus-mode-non-string-length nil
1319   "*Max length of mode-line non-string contents.
1320 If this is nil, Gnus will take space as is needed, leaving the rest
1321 of the modeline intact.  Note that the default of nil is unlikely
1322 to be desirable; see the manual for further details."
1323   :group 'gnus-various
1324   :type '(choice (const nil)
1325                  integer))
1326
1327 (defcustom gnus-auto-expirable-newsgroups nil
1328   "*Groups in which to automatically mark read articles as expirable.
1329 If non-nil, this should be a regexp that should match all groups in
1330 which to perform auto-expiry.  This only makes sense for mail groups."
1331   :group 'nnmail-expire
1332   :type '(choice (const nil)
1333                  regexp))
1334
1335 (defcustom gnus-total-expirable-newsgroups nil
1336   "*Groups in which to perform expiry of all read articles.
1337 Use with extreme caution.  All groups that match this regexp will be
1338 expiring - which means that all read articles will be deleted after
1339 \(say) one week.         (This only goes for mail groups and the like, of
1340 course.)"
1341   :group 'nnmail-expire
1342   :type '(choice (const nil)
1343                  regexp))
1344
1345 (defcustom gnus-group-uncollapsed-levels 1
1346   "Number of group name elements to leave alone when making a short group name."
1347   :group 'gnus-group-visual
1348   :type 'integer)
1349
1350 (defcustom gnus-group-use-permanent-levels nil
1351   "*If non-nil, once you set a level, Gnus will use this level."
1352   :group 'gnus-group-levels
1353   :type 'boolean)
1354
1355 ;; Hooks.
1356
1357 (defcustom gnus-load-hook nil
1358   "A hook run while Gnus is loaded."
1359   :group 'gnus-start
1360   :type 'hook)
1361
1362 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1363   "A hook called to apply kill files to a group.
1364 This hook is intended to apply a kill file to the selected newsgroup.
1365 The function `gnus-apply-kill-file' is called by default.
1366
1367 Since a general kill file is too heavy to use only for a few
1368 newsgroups, I recommend you to use a lighter hook function.  For
1369 example, if you'd like to apply a kill file to articles which contains
1370 a string `rmgroup' in subject in newsgroup `control', you can use the
1371 following hook:
1372
1373  (setq gnus-apply-kill-hook
1374       (list
1375         (lambda ()
1376           (cond ((string-match \"control\" gnus-newsgroup-name)
1377                  (gnus-kill \"Subject\" \"rmgroup\")
1378                  (gnus-expunge \"X\"))))))"
1379   :group 'gnus-score-kill
1380   :options '(gnus-apply-kill-file)
1381   :type 'hook)
1382
1383 (defcustom gnus-group-change-level-function nil
1384   "Function run when a group level is changed.
1385 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1386   :group 'gnus-group-levels
1387   :type 'function)
1388
1389 ;;; Face thingies.
1390
1391 (defcustom gnus-visual
1392   '(summary-highlight group-highlight article-highlight
1393                       mouse-face
1394                       summary-menu group-menu article-menu
1395                       tree-highlight menu highlight
1396                       browse-menu server-menu
1397                       page-marker tree-menu binary-menu pick-menu
1398                       grouplens-menu)
1399   "*Enable visual features.
1400 If `visual' is disabled, there will be no menus and few faces.  Most of
1401 the visual customization options below will be ignored.  Gnus will use
1402 less space and be faster as a result.
1403
1404 This variable can also be a list of visual elements to switch on.  For
1405 instance, to switch off all visual things except menus, you can say:
1406
1407    (setq gnus-visual '(menu))
1408
1409 Valid elements include `summary-highlight', `group-highlight',
1410 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1411 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1412 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1413 and `grouplens-menu'."
1414   :group 'gnus-meta
1415   :group 'gnus-visual
1416   :type '(set (const summary-highlight)
1417               (const group-highlight)
1418               (const article-highlight)
1419               (const mouse-face)
1420               (const summary-menu)
1421               (const group-menu)
1422               (const article-menu)
1423               (const tree-highlight)
1424               (const menu)
1425               (const highlight)
1426               (const browse-menu)
1427               (const server-menu)
1428               (const page-marker)
1429               (const tree-menu)
1430               (const binary-menu)
1431               (const pick-menu)
1432               (const grouplens-menu)))
1433
1434 (defcustom gnus-mouse-face
1435   (condition-case ()
1436       (if (gnus-visual-p 'mouse-face 'highlight)
1437           (if (boundp 'gnus-mouse-face)
1438               (or gnus-mouse-face 'highlight)
1439             'highlight)
1440         'default)
1441     (error 'highlight))
1442   "*Face used for group or summary buffer mouse highlighting.
1443 The line beneath the mouse pointer will be highlighted with this
1444 face."
1445   :group 'gnus-visual
1446   :type 'face)
1447
1448 (defcustom gnus-article-save-directory gnus-directory
1449   "*Name of the directory articles will be saved in (default \"~/News\")."
1450   :group 'gnus-article-saving
1451   :type 'directory)
1452
1453 (defvar gnus-plugged t
1454   "Whether Gnus is plugged or not.")
1455
1456 (defcustom gnus-default-charset 'iso-8859-1
1457   "Default charset assumed to be used when viewing non-ASCII characters.
1458 This variable is overridden on a group-to-group basis by the
1459 gnus-group-charset-alist variable and is only used on groups not
1460 covered by that variable."
1461   :type 'symbol
1462   :group 'gnus-charset)
1463
1464 (defcustom gnus-default-posting-charset nil
1465   "Default charset assumed to be used when posting non-ASCII characters.
1466 This variable is overridden on a group-to-group basis by the
1467 gnus-group-posting-charset-alist variable and is only used on groups not
1468 covered by that variable.
1469 If nil, no default charset is assumed when posting."
1470   :type 'symbol
1471   :group 'gnus-charset)
1472
1473 \f
1474 ;;; Internal variables
1475
1476 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1477 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1478 (defvar gnus-original-article-buffer " *Original Article*")
1479 (defvar gnus-newsgroup-name nil)
1480 (defvar gnus-ephemeral-servers nil)
1481
1482 (defvar gnus-agent nil
1483   "Whether we want to use the Gnus agent or not.")
1484
1485 (defvar gnus-command-method nil
1486   "Dynamically bound variable that says what the current backend is.")
1487
1488 (defvar gnus-current-select-method nil
1489   "The current method for selecting a newsgroup.")
1490
1491 (defvar gnus-tree-buffer "*Tree*"
1492   "Buffer where Gnus thread trees are displayed.")
1493
1494 ;; Dummy variable.
1495 (defvar gnus-use-generic-from nil)
1496
1497 ;; Variable holding the user answers to all method prompts.
1498 (defvar gnus-method-history nil)
1499
1500 ;; Variable holding the user answers to all mail method prompts.
1501 (defvar gnus-mail-method-history nil)
1502
1503 ;; Variable holding the user answers to all group prompts.
1504 (defvar gnus-group-history nil)
1505
1506 (defvar gnus-server-alist nil
1507   "List of available servers.")
1508
1509 (defcustom gnus-cache-directory
1510   (nnheader-concat gnus-directory "cache/")
1511   "*The directory where cached articles will be stored."
1512   :group 'gnus-cache
1513   :type 'directory)
1514
1515 (defvar gnus-predefined-server-alist
1516   `(("cache"
1517      nnspool "cache"
1518      (nnspool-spool-directory ,gnus-cache-directory)
1519      (nnspool-nov-directory ,gnus-cache-directory)
1520      (nnspool-active-file
1521       ,(nnheader-concat gnus-cache-directory "active"))))
1522   "List of predefined (convenience) servers.")
1523
1524 (defvar gnus-topic-indentation "");; Obsolete variable.
1525
1526 (defconst gnus-article-mark-lists
1527   '((marked . tick) (replied . reply)
1528     (expirable . expire) (killed . killed)
1529     (bookmarks . bookmark) (dormant . dormant)
1530     (scored . score) (saved . save)
1531     (cached . cache) (downloadable . download)
1532     (unsendable . unsend)))
1533
1534 (defvar gnus-headers-retrieved-by nil)
1535 (defvar gnus-article-reply nil)
1536 (defvar gnus-override-method nil)
1537 (defvar gnus-article-check-size nil)
1538 (defvar gnus-opened-servers nil)
1539
1540 (defvar gnus-current-kill-article nil)
1541
1542 (defvar gnus-have-read-active-file nil)
1543
1544 (defconst gnus-maintainer
1545   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1546   "The mail address of the Gnus maintainers.")
1547
1548 (defconst semi-gnus-developers
1549   "Semi-gnus Developers:
1550  semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1551  semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1552   "The mail address of the Semi-gnus developers.")
1553
1554 (defvar gnus-info-nodes
1555   '((gnus-group-mode "(gnus)The Group Buffer")
1556     (gnus-summary-mode "(gnus)The Summary Buffer")
1557     (gnus-article-mode "(gnus)The Article Buffer")
1558     (gnus-server-mode "(gnus)The Server Buffer")
1559     (gnus-browse-mode "(gnus)Browse Foreign Server")
1560     (gnus-tree-mode "(gnus)Tree Display"))
1561   "Alist of major modes and related Info nodes.")
1562
1563 (defvar gnus-group-buffer "*Group*")
1564 (defvar gnus-summary-buffer "*Summary*")
1565 (defvar gnus-article-buffer "*Article*")
1566 (defvar gnus-server-buffer "*Server*")
1567
1568 (defvar gnus-slave nil
1569   "Whether this Gnus is a slave or not.")
1570
1571 (defvar gnus-batch-mode nil
1572   "Whether this Gnus is running in batch mode or not.")
1573
1574 (defvar gnus-variable-list
1575   '(gnus-newsrc-options gnus-newsrc-options-n
1576                         gnus-newsrc-last-checked-date
1577                         gnus-newsrc-alist gnus-server-alist
1578                         gnus-killed-list gnus-zombie-list
1579                         gnus-topic-topology gnus-topic-alist
1580                         gnus-format-specs)
1581   "Gnus variables saved in the quick startup file.")
1582
1583 (defvar gnus-newsrc-alist nil
1584   "Assoc list of read articles.
1585 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1586
1587 (defvar gnus-newsrc-hashtb nil
1588   "Hashtable of gnus-newsrc-alist.")
1589
1590 (defvar gnus-killed-list nil
1591   "List of killed newsgroups.")
1592
1593 (defvar gnus-killed-hashtb nil
1594   "Hash table equivalent of gnus-killed-list.")
1595
1596 (defvar gnus-zombie-list nil
1597   "List of almost dead newsgroups.")
1598
1599 (defvar gnus-description-hashtb nil
1600   "Descriptions of newsgroups.")
1601
1602 (defvar gnus-list-of-killed-groups nil
1603   "List of newsgroups that have recently been killed by the user.")
1604
1605 (defvar gnus-active-hashtb nil
1606   "Hashtable of active articles.")
1607
1608 (defvar gnus-moderated-hashtb nil
1609   "Hashtable of moderated newsgroups.")
1610
1611 ;; Save window configuration.
1612 (defvar gnus-prev-winconf nil)
1613
1614 (defvar gnus-reffed-article-number nil)
1615
1616 ;;; Let the byte-compiler know that we know about this variable.
1617 (defvar rmail-default-rmail-file)
1618
1619 (defvar gnus-dead-summary nil)
1620
1621 ;;; End of variables.
1622
1623 ;; Define some autoload functions Gnus might use.
1624 (eval-and-compile
1625
1626   ;; This little mapcar goes through the list below and marks the
1627   ;; symbols in question as autoloaded functions.
1628   (mapcar
1629    (lambda (package)
1630      (let ((interactive (nth 1 (memq ':interactive package))))
1631        (mapcar
1632         (lambda (function)
1633           (let (keymap)
1634             (when (consp function)
1635               (setq keymap (car (memq 'keymap function)))
1636               (setq function (car function)))
1637             (autoload function (car package) nil interactive keymap)))
1638         (if (eq (nth 1 package) ':interactive)
1639             (cdddr package)
1640           (cdr package)))))
1641    '(("metamail" metamail-buffer)
1642      ("info" Info-goto-node)
1643      ("pp" pp pp-to-string pp-eval-expression)
1644      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1645      ("ps-print" ps-print-preprint)
1646      ("mail-extr" mail-extract-address-components)
1647      ("browse-url" browse-url)
1648      ("message" :interactive t
1649       message-send-and-exit message-yank-original)
1650      ("babel" babel-as-string)
1651      ("nnmail" nnmail-split-fancy nnmail-article-group)
1652      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1653      ("rmailout" rmail-output rmail-output-to-rmail-file)
1654      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1655       rmail-show-message rmail-summary-exists
1656       rmail-select-summary rmail-update-summary)
1657      ("gnus-audio" :interactive t gnus-audio-play)
1658      ("gnus-xmas" gnus-xmas-splash)
1659      ("gnus-soup" :interactive t
1660       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1661       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1662      ("nnsoup" nnsoup-pack-replies)
1663      ("score-mode" :interactive t gnus-score-mode)
1664      ("gnus-mh" gnus-summary-save-article-folder
1665       gnus-Folder-save-name gnus-folder-save-name)
1666      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1667      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1668       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1669       gnus-demon-add-disconnection gnus-demon-add-handler
1670       gnus-demon-remove-handler)
1671      ("gnus-demon" :interactive t
1672       gnus-demon-init gnus-demon-cancel)
1673      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1674       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1675      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1676       gnus-nocem-unwanted-article-p)
1677      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1678       gnus-server-server-name)
1679      ("gnus-srvr" gnus-browse-foreign-server)
1680      ("gnus-cite" :interactive t
1681       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1682       gnus-article-hide-citation gnus-article-fill-cited-article
1683       gnus-article-hide-citation-in-followups)
1684      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1685       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1686       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1687      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1688       gnus-cache-possibly-remove-articles gnus-cache-request-article
1689       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1690       gnus-cache-enter-remove-article gnus-cached-article-p
1691       gnus-cache-open gnus-cache-close gnus-cache-update-article)
1692      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1693       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1694      ("gnus-score" :interactive t
1695       gnus-summary-increase-score gnus-summary-set-score
1696       gnus-summary-raise-thread gnus-summary-raise-same-subject
1697       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1698       gnus-summary-lower-thread gnus-summary-lower-same-subject
1699       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1700       gnus-summary-current-score gnus-score-delta-default
1701       gnus-score-flush-cache gnus-score-close
1702       gnus-possibly-score-headers gnus-score-followup-article
1703       gnus-score-followup-thread)
1704      ("gnus-score"
1705       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1706       gnus-current-score-file-nondirectory gnus-score-adaptive
1707       gnus-score-find-trace gnus-score-file-name)
1708      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1709      ("gnus-topic" :interactive t gnus-topic-mode)
1710      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1711       gnus-subscribe-topics)
1712      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1713      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1714      ("gnus-uu" :interactive t
1715       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1716       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1717       gnus-uu-mark-by-regexp gnus-uu-mark-all
1718       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1719       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1720       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1721       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1722       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1723       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1724       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1725       gnus-uu-mark-over gnus-uu-post-news)
1726      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1727      ("gnus-msg" (gnus-summary-send-map keymap)
1728       gnus-article-mail gnus-copy-article-buffer)
1729      ("gnus-msg" :interactive t
1730       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1731       gnus-summary-followup gnus-summary-followup-with-original
1732       gnus-summary-cancel-article gnus-summary-supersede-article
1733       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1734       gnus-summary-mail-forward gnus-summary-mail-other-window
1735       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1736       gnus-summary-wide-reply gnus-summary-followup-to-mail
1737       gnus-summary-followup-to-mail-with-original gnus-bug
1738       gnus-summary-wide-reply-with-original
1739       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1740       gnus-summary-post-forward)
1741      ("gnus-picon" :interactive t gnus-article-display-picons
1742       gnus-group-display-picons gnus-picons-article-display-x-face
1743       gnus-picons-display-x-face)
1744      ("gnus-picon" gnus-picons-buffer-name)
1745      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1746       gnus-grouplens-mode)
1747      ("smiley" :interactive t gnus-smiley-display)
1748      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1749      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1750       gnus-list-of-unread-articles gnus-list-of-read-articles
1751       gnus-offer-save-summaries gnus-make-thread-indent-array
1752       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1753       gnus-summary-skip-intangible gnus-summary-article-number
1754       gnus-data-header gnus-data-find)
1755      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1756       gnus-group-list-groups gnus-group-first-unread-group
1757       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1758       gnus-group-setup-buffer gnus-group-get-new-news
1759       gnus-group-make-help-group gnus-group-update-group
1760       gnus-group-iterate gnus-group-group-name)
1761      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1762       gnus-backlog-remove-article)
1763      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1764       gnus-article-prepare gnus-article-set-window-start
1765       gnus-article-next-page gnus-article-prev-page
1766       gnus-request-article-this-buffer gnus-article-mode
1767       gnus-article-setup-buffer gnus-narrow-to-page
1768       gnus-article-delete-invisible-text gnus-treat-article)
1769      ("gnus-art" :interactive t
1770       gnus-article-hide-headers gnus-article-hide-boring-headers
1771       gnus-article-treat-overstrike
1772       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1773       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1774       gnus-article-decode-HZ
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            (other-frame 1))))
2884   (gnus arg))
2885
2886 ;;;###autoload
2887 (defun gnus (&optional arg dont-connect slave)
2888   "Read network news.
2889 If ARG is non-nil and a positive number, Gnus will use that as the
2890 startup level.  If ARG is non-nil and not a positive number, Gnus will
2891 prompt the user for the name of an NNTP server to use."
2892   (interactive "P")
2893   (gnus-1 arg dont-connect slave))
2894
2895 ;; Allow redefinition of Gnus functions.
2896
2897 (gnus-ems-redefine)
2898
2899 (provide 'gnus)
2900
2901 ;;; gnus.el ends here