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

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