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

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