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

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