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