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

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