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

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