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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997, 1998,
   4 ;;   2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   5
   6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   7 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   8 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
   9 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
  10 ;; Keywords: news, mail
  11
  12 ;; This file is part of GNU Emacs.
  13
  14 ;; GNU Emacs is free software; you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation; either version 2, or (at your option)
  17 ;; any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  27 ;; Boston, MA 02110-1301, USA.
  28
  29 ;;; Commentary:
  30
  31 ;;; Code:
  32
  33 (eval '(run-hooks 'gnus-load-hook))
  34
  35 (eval-when-compile (require 'cl))
  36 (eval-when-compile (require 'static))
  37
  38 (require 'wid-edit)
  39 (require 'nnheader)
  40
  41 (require 'gnus-vers)
  42
  43 ;; These are defined afterwards with gnus-define-group-parameter
  44 (defvar gnus-ham-process-destinations)
  45 (defvar gnus-parameter-ham-marks-alist)
  46 (defvar gnus-parameter-spam-marks-alist)
  47 (defvar gnus-spam-autodetect)
  48 (defvar gnus-spam-autodetect-methods)
  49 (defvar gnus-spam-newsgroup-contents)
  50 (defvar gnus-spam-process-destinations)
  51 (defvar gnus-spam-process-newsgroups)
  52
  53
  54 (defgroup gnus nil
  55   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  56   :group 'news
  57   :group 'mail)
  58
  59 (defgroup gnus-format nil
  60   "Dealing with formatting issues."
  61   :group 'gnus)
  62
  63 (defgroup gnus-charset nil
  64   "Group character set issues."
  65   :link '(custom-manual "(gnus)Charsets")
  66   :version "21.1"
  67   :group 'gnus)
  68
  69 (defgroup gnus-cache nil
  70   "Cache interface."
  71   :link '(custom-manual "(gnus)Article Caching")
  72   :group 'gnus)
  73
  74 (defgroup gnus-registry nil
  75   "Article Registry."
  76   :group 'gnus)
  77
  78 (defgroup gnus-start nil
  79   "Starting your favorite newsreader."
  80   :group 'gnus)
  81
  82 (defgroup gnus-start-server nil
  83   "Server options at startup."
  84   :group 'gnus-start)
  85
  86 ;; These belong to gnus-group.el.
  87 (defgroup gnus-group nil
  88   "Group buffers."
  89   :link '(custom-manual "(gnus)Group Buffer")
  90   :group 'gnus)
  91
  92 (defgroup gnus-group-foreign nil
  93   "Foreign groups."
  94   :link '(custom-manual "(gnus)Foreign Groups")
  95   :group 'gnus-group)
  96
  97 (defgroup gnus-group-new nil
  98   "Automatic subscription of new groups."
  99   :group 'gnus-group)
 100
 101 (defgroup gnus-group-levels nil
 102   "Group levels."
 103   :link '(custom-manual "(gnus)Group Levels")
 104   :group 'gnus-group)
 105
 106 (defgroup gnus-group-select nil
 107   "Selecting a Group."
 108   :link '(custom-manual "(gnus)Selecting a Group")
 109   :group 'gnus-group)
 110
 111 (defgroup gnus-group-listing nil
 112   "Showing slices of the group list."
 113   :link '(custom-manual "(gnus)Listing Groups")
 114   :group 'gnus-group)
 115
 116 (defgroup gnus-group-visual nil
 117   "Sorting the group buffer."
 118   :link '(custom-manual "(gnus)Group Buffer Format")
 119   :group 'gnus-group
 120   :group 'gnus-visual)
 121
 122 (defgroup gnus-group-various nil
 123   "Various group options."
 124   :link '(custom-manual "(gnus)Scanning New Messages")
 125   :group 'gnus-group)
 126
 127 ;; These belong to gnus-sum.el.
 128 (defgroup gnus-summary nil
 129   "Summary buffers."
 130   :link '(custom-manual "(gnus)Summary Buffer")
 131   :group 'gnus)
 132
 133 (defgroup gnus-summary-exit nil
 134   "Leaving summary buffers."
 135   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 136   :group 'gnus-summary)
 137
 138 (defgroup gnus-summary-marks nil
 139   "Marks used in summary buffers."
 140   :link '(custom-manual "(gnus)Marking Articles")
 141   :group 'gnus-summary)
 142
 143 (defgroup gnus-thread nil
 144   "Ordering articles according to replies."
 145   :link '(custom-manual "(gnus)Threading")
 146   :group 'gnus-summary)
 147
 148 (defgroup gnus-summary-format nil
 149   "Formatting of the summary buffer."
 150   :link '(custom-manual "(gnus)Summary Buffer Format")
 151   :group 'gnus-summary)
 152
 153 (defgroup gnus-summary-choose nil
 154   "Choosing Articles."
 155   :link '(custom-manual "(gnus)Choosing Articles")
 156   :group 'gnus-summary)
 157
 158 (defgroup gnus-summary-maneuvering nil
 159   "Summary movement commands."
 160   :link '(custom-manual "(gnus)Summary Maneuvering")
 161   :group 'gnus-summary)
 162
 163 (defgroup gnus-picon nil
 164   "Show pictures of people, domains, and newsgroups."
 165   :group 'gnus-visual)
 166
 167 (defgroup gnus-summary-mail nil
 168   "Mail group commands."
 169   :link '(custom-manual "(gnus)Mail Group Commands")
 170   :group 'gnus-summary)
 171
 172 (defgroup gnus-summary-sort nil
 173   "Sorting the summary buffer."
 174   :link '(custom-manual "(gnus)Sorting the Summary Buffer")
 175   :group 'gnus-summary)
 176
 177 (defgroup gnus-summary-visual nil
 178   "Highlighting and menus in the summary buffer."
 179   :link '(custom-manual "(gnus)Summary Highlighting")
 180   :group 'gnus-visual
 181   :group 'gnus-summary)
 182
 183 (defgroup gnus-summary-various nil
 184   "Various summary buffer options."
 185   :link '(custom-manual "(gnus)Various Summary Stuff")
 186   :group 'gnus-summary)
 187
 188 (defgroup gnus-summary-pick nil
 189   "Pick mode in the summary buffer."
 190   :link '(custom-manual "(gnus)Pick and Read")
 191   :prefix "gnus-pick-"
 192   :group 'gnus-summary)
 193
 194 (defgroup gnus-summary-tree nil
 195   "Tree display of threads in the summary buffer."
 196   :link '(custom-manual "(gnus)Tree Display")
 197   :prefix "gnus-tree-"
 198   :group 'gnus-summary)
 199
 200 ;; Belongs to gnus-uu.el
 201 (defgroup gnus-extract-view nil
 202   "Viewing extracted files."
 203   :link '(custom-manual "(gnus)Viewing Files")
 204   :group 'gnus-extract)
 205
 206 ;; Belongs to gnus-score.el
 207 (defgroup gnus-score nil
 208   "Score and kill file handling."
 209   :group 'gnus)
 210
 211 (defgroup gnus-score-kill nil
 212   "Kill files."
 213   :group 'gnus-score)
 214
 215 (defgroup gnus-score-adapt nil
 216   "Adaptive score files."
 217   :group 'gnus-score)
 218
 219 (defgroup gnus-score-default nil
 220   "Default values for score files."
 221   :group 'gnus-score)
 222
 223 (defgroup gnus-score-expire nil
 224   "Expiring score rules."
 225   :group 'gnus-score)
 226
 227 (defgroup gnus-score-decay nil
 228   "Decaying score rules."
 229   :group 'gnus-score)
 230
 231 (defgroup gnus-score-files nil
 232   "Score and kill file names."
 233   :group 'gnus-score
 234   :group 'gnus-files)
 235
 236 (defgroup gnus-score-various nil
 237   "Various scoring and killing options."
 238   :group 'gnus-score)
 239
 240 ;; Other
 241 (defgroup gnus-visual nil
 242   "Options controlling the visual fluff."
 243   :group 'gnus
 244   :group 'faces)
 245
 246 (defgroup gnus-agent nil
 247   "Offline support for Gnus."
 248   :group 'gnus)
 249
 250 (defgroup gnus-files nil
 251   "Files used by Gnus."
 252   :group 'gnus)
 253
 254 (defgroup gnus-dribble-file nil
 255   "Auto save file."
 256   :link '(custom-manual "(gnus)Auto Save")
 257   :group 'gnus-files)
 258
 259 (defgroup gnus-newsrc nil
 260   "Storing Gnus state."
 261   :group 'gnus-files)
 262
 263 (defgroup gnus-server nil
 264   "Options related to newsservers and other servers used by Gnus."
 265   :group 'gnus)
 266
 267 (defgroup gnus-server-visual nil
 268   "Highlighting and menus in the server buffer."
 269   :group 'gnus-visual
 270   :group 'gnus-server)
 271
 272 (defgroup gnus-message '((message custom-group))
 273   "Composing replies and followups in Gnus."
 274   :group 'gnus)
 275
 276 (defgroup gnus-meta nil
 277   "Meta variables controlling major portions of Gnus.
 278 In general, modifying these variables does not take affect until Gnus
 279 is restarted, and sometimes reloaded."
 280   :group 'gnus)
 281
 282 (defgroup gnus-various nil
 283   "Other Gnus options."
 284   :link '(custom-manual "(gnus)Various Various")
 285   :group 'gnus)
 286
 287 (defgroup gnus-mime nil
 288   "Variables for controlling the Gnus MIME interface."
 289   :group 'gnus)
 290
 291 (defgroup gnus-exit nil
 292   "Exiting Gnus."
 293   :link '(custom-manual "(gnus)Exiting Gnus")
 294   :group 'gnus)
 295
 296 (defgroup gnus-fun nil
 297   "Frivolous Gnus extensions."
 298   :link '(custom-manual "(gnus)Exiting Gnus")
 299   :group 'gnus)
 300
 301 (defcustom gnus-inhibit-startup-message nil
 302   "If non-nil, the startup message will not be displayed.
 303 This variable is used before `.gnus.el' is loaded, so it should
 304 be set in `.emacs' instead."
 305   :group 'gnus-start
 306   :type 'boolean)
 307
 308 (defcustom gnus-play-startup-jingle nil
 309   "If non-nil, play the Gnus jingle at startup."
 310   :group 'gnus-start
 311   :type 'boolean)
 312
 313 (unless (fboundp 'gnus-group-remove-excess-properties)
 314   (defalias 'gnus-group-remove-excess-properties 'ignore))
 315
 316 (unless (featurep 'gnus-xmas)
 317   (defalias 'gnus-make-overlay 'make-overlay)
 318   (defalias 'gnus-delete-overlay 'delete-overlay)
 319   (defalias 'gnus-overlay-put 'overlay-put)
 320   (defalias 'gnus-move-overlay 'move-overlay)
 321   (defalias 'gnus-overlay-buffer 'overlay-buffer)
 322   (defalias 'gnus-overlay-start 'overlay-start)
 323   (defalias 'gnus-overlay-end 'overlay-end)
 324   (defalias 'gnus-extent-detached-p 'ignore)
 325   (defalias 'gnus-extent-start-open 'ignore)
 326   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 327   (defalias 'gnus-character-to-event 'identity)
 328   (defalias 'gnus-assq-delete-all 'assq-delete-all)
 329   (defalias 'gnus-add-text-properties 'add-text-properties)
 330   (defalias 'gnus-put-text-property 'put-text-property)
 331   (defvar gnus-mode-line-image-cache t)
 332   (if (fboundp 'find-image)
 333       (defun gnus-mode-line-buffer-identification (line)
 334         (let ((str (car-safe line))
 335               (load-path (mm-image-load-path)))
 336           (if (and (stringp str)
 337                    (string-match "^Gnus:" str))
 338               (progn (add-text-properties
 339                       0 5
 340                       (list 'display
 341                             (if (eq t gnus-mode-line-image-cache)
 342                                 (setq gnus-mode-line-image-cache
 343                                       (find-image
 344                                        '((:type xpm :file "gnus-pointer.xpm"
 345                                                 :ascent center)
 346                                          (:type xbm :file "gnus-pointer.xbm"
 347                                                 :ascent center))))
 348                               gnus-mode-line-image-cache)
 349                             'help-echo (format
 350                                         "This is %s, %s."
 351                                         gnus-version (gnus-emacs-version)))
 352                       str)
 353                      (list str))
 354             line)))
 355     (defalias 'gnus-mode-line-buffer-identification 'identity))
 356   (defalias 'gnus-characterp 'numberp)
 357   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 358   (defalias 'gnus-window-edges 'window-edges)
 359   (defalias 'gnus-key-press-event-p 'numberp)
 360   ;;(defalias 'gnus-decode-rfc1522 'ignore)
 361   )
 362
 363 ;; We define these group faces here to avoid the display
 364 ;; update forced when creating new faces.
 365
 366 (defface gnus-group-news-1
 367   '((((class color)
 368       (background dark))
 369      (:foreground "PaleTurquoise" :bold t))
 370     (((class color)
 371       (background light))
 372      (:foreground "ForestGreen" :bold t))
 373     (t
 374      ()))
 375   "Level 1 newsgroup face."
 376   :group 'gnus-group)
 377 ;; backward-compatibility alias
 378 (put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
 379
 380 (defface gnus-group-news-1-empty
 381   '((((class color)
 382       (background dark))
 383      (:foreground "PaleTurquoise"))
 384     (((class color)
 385       (background light))
 386      (:foreground "ForestGreen"))
 387     (t
 388      ()))
 389   "Level 1 empty newsgroup face."
 390   :group 'gnus-group)
 391 ;; backward-compatibility alias
 392 (put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
 393
 394 (defface gnus-group-news-2
 395   '((((class color)
 396       (background dark))
 397      (:foreground "turquoise" :bold t))
 398     (((class color)
 399       (background light))
 400      (:foreground "CadetBlue4" :bold t))
 401     (t
 402      ()))
 403   "Level 2 newsgroup face."
 404   :group 'gnus-group)
 405 ;; backward-compatibility alias
 406 (put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
 407
 408 (defface gnus-group-news-2-empty
 409   '((((class color)
 410       (background dark))
 411      (:foreground "turquoise"))
 412     (((class color)
 413       (background light))
 414      (:foreground "CadetBlue4"))
 415     (t
 416      ()))
 417   "Level 2 empty newsgroup face."
 418   :group 'gnus-group)
 419 ;; backward-compatibility alias
 420 (put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
 421
 422 (defface gnus-group-news-3
 423   '((((class color)
 424       (background dark))
 425      (:bold t))
 426     (((class color)
 427       (background light))
 428      (:bold t))
 429     (t
 430      ()))
 431   "Level 3 newsgroup face."
 432   :group 'gnus-group)
 433 ;; backward-compatibility alias
 434 (put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
 435
 436 (defface gnus-group-news-3-empty
 437   '((((class color)
 438       (background dark))
 439      ())
 440     (((class color)
 441       (background light))
 442      ())
 443     (t
 444      ()))
 445   "Level 3 empty newsgroup face."
 446   :group 'gnus-group)
 447 ;; backward-compatibility alias
 448 (put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
 449
 450 (defface gnus-group-news-4
 451   '((((class color)
 452       (background dark))
 453      (:bold t))
 454     (((class color)
 455       (background light))
 456      (:bold t))
 457     (t
 458      ()))
 459   "Level 4 newsgroup face."
 460   :group 'gnus-group)
 461 ;; backward-compatibility alias
 462 (put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
 463
 464 (defface gnus-group-news-4-empty
 465   '((((class color)
 466       (background dark))
 467      ())
 468     (((class color)
 469       (background light))
 470      ())
 471     (t
 472      ()))
 473   "Level 4 empty newsgroup face."
 474   :group 'gnus-group)
 475 ;; backward-compatibility alias
 476 (put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
 477
 478 (defface gnus-group-news-5
 479   '((((class color)
 480       (background dark))
 481      (:bold t))
 482     (((class color)
 483       (background light))
 484      (:bold t))
 485     (t
 486      ()))
 487   "Level 5 newsgroup face."
 488   :group 'gnus-group)
 489 ;; backward-compatibility alias
 490 (put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
 491
 492 (defface gnus-group-news-5-empty
 493   '((((class color)
 494       (background dark))
 495      ())
 496     (((class color)
 497       (background light))
 498      ())
 499     (t
 500      ()))
 501   "Level 5 empty newsgroup face."
 502   :group 'gnus-group)
 503 ;; backward-compatibility alias
 504 (put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
 505
 506 (defface gnus-group-news-6
 507   '((((class color)
 508       (background dark))
 509      (:bold t))
 510     (((class color)
 511       (background light))
 512      (:bold t))
 513     (t
 514      ()))
 515   "Level 6 newsgroup face."
 516   :group 'gnus-group)
 517 ;; backward-compatibility alias
 518 (put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
 519
 520 (defface gnus-group-news-6-empty
 521   '((((class color)
 522       (background dark))
 523      ())
 524     (((class color)
 525       (background light))
 526      ())
 527     (t
 528      ()))
 529   "Level 6 empty newsgroup face."
 530   :group 'gnus-group)
 531 ;; backward-compatibility alias
 532 (put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
 533
 534 (defface gnus-group-news-low
 535   '((((class color)
 536       (background dark))
 537      (:foreground "DarkTurquoise" :bold t))
 538     (((class color)
 539       (background light))
 540      (:foreground "DarkGreen" :bold t))
 541     (t
 542      ()))
 543   "Low level newsgroup face."
 544   :group 'gnus-group)
 545 ;; backward-compatibility alias
 546 (put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
 547
 548 (defface gnus-group-news-low-empty
 549   '((((class color)
 550       (background dark))
 551      (:foreground "DarkTurquoise"))
 552     (((class color)
 553       (background light))
 554      (:foreground "DarkGreen"))
 555     (t
 556      ()))
 557   "Low level empty newsgroup face."
 558   :group 'gnus-group)
 559 ;; backward-compatibility alias
 560 (put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
 561
 562 (defface gnus-group-mail-1
 563   '((((class color)
 564       (background dark))
 565      (:foreground "aquamarine1" :bold t))
 566     (((class color)
 567       (background light))
 568      (:foreground "DeepPink3" :bold t))
 569     (t
 570      (:bold t)))
 571   "Level 1 mailgroup face."
 572   :group 'gnus-group)
 573 ;; backward-compatibility alias
 574 (put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
 575
 576 (defface gnus-group-mail-1-empty
 577   '((((class color)
 578       (background dark))
 579      (:foreground "aquamarine1"))
 580     (((class color)
 581       (background light))
 582      (:foreground "DeepPink3"))
 583     (t
 584      (:italic t :bold t)))
 585   "Level 1 empty mailgroup face."
 586   :group 'gnus-group)
 587 ;; backward-compatibility alias
 588 (put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
 589
 590 (defface gnus-group-mail-2
 591   '((((class color)
 592       (background dark))
 593      (:foreground "aquamarine2" :bold t))
 594     (((class color)
 595       (background light))
 596      (:foreground "HotPink3" :bold t))
 597     (t
 598      (:bold t)))
 599   "Level 2 mailgroup face."
 600   :group 'gnus-group)
 601 ;; backward-compatibility alias
 602 (put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
 603
 604 (defface gnus-group-mail-2-empty
 605   '((((class color)
 606       (background dark))
 607      (:foreground "aquamarine2"))
 608     (((class color)
 609       (background light))
 610      (:foreground "HotPink3"))
 611     (t
 612      (:bold t)))
 613   "Level 2 empty mailgroup face."
 614   :group 'gnus-group)
 615 ;; backward-compatibility alias
 616 (put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
 617
 618 (defface gnus-group-mail-3
 619   '((((class color)
 620       (background dark))
 621      (:foreground "aquamarine3" :bold t))
 622     (((class color)
 623       (background light))
 624      (:foreground "magenta4" :bold t))
 625     (t
 626      (:bold t)))
 627   "Level 3 mailgroup face."
 628   :group 'gnus-group)
 629 ;; backward-compatibility alias
 630 (put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
 631
 632 (defface gnus-group-mail-3-empty
 633   '((((class color)
 634       (background dark))
 635      (:foreground "aquamarine3"))
 636     (((class color)
 637       (background light))
 638      (:foreground "magenta4"))
 639     (t
 640      ()))
 641   "Level 3 empty mailgroup face."
 642   :group 'gnus-group)
 643 ;; backward-compatibility alias
 644 (put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
 645
 646 (defface gnus-group-mail-low
 647   '((((class color)
 648       (background dark))
 649      (:foreground "aquamarine4" :bold t))
 650     (((class color)
 651       (background light))
 652      (:foreground "DeepPink4" :bold t))
 653     (t
 654      (:bold t)))
 655   "Low level mailgroup face."
 656   :group 'gnus-group)
 657 ;; backward-compatibility alias
 658 (put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
 659
 660 (defface gnus-group-mail-low-empty
 661   '((((class color)
 662       (background dark))
 663      (:foreground "aquamarine4"))
 664     (((class color)
 665       (background light))
 666      (:foreground "DeepPink4"))
 667     (t
 668      (:bold t)))
 669   "Low level empty mailgroup face."
 670   :group 'gnus-group)
 671 ;; backward-compatibility alias
 672 (put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
 673
 674 ;; Summary mode faces.
 675
 676 (defface gnus-summary-selected '((t (:underline t)))
 677   "Face used for selected articles."
 678   :group 'gnus-summary)
 679 ;; backward-compatibility alias
 680 (put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
 681
 682 (defface gnus-summary-cancelled
 683   '((((class color))
 684      (:foreground "yellow" :background "black")))
 685   "Face used for cancelled articles."
 686   :group 'gnus-summary)
 687 ;; backward-compatibility alias
 688 (put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
 689
 690 (defface gnus-summary-high-ticked
 691   '((((class color)
 692       (background dark))
 693      (:foreground "pink" :bold t))
 694     (((class color)
 695       (background light))
 696      (:foreground "firebrick" :bold t))
 697     (t
 698      (:bold t)))
 699   "Face used for high interest ticked articles."
 700   :group 'gnus-summary)
 701 ;; backward-compatibility alias
 702 (put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
 703
 704 (defface gnus-summary-low-ticked
 705   '((((class color)
 706       (background dark))
 707      (:foreground "pink" :italic t))
 708     (((class color)
 709       (background light))
 710      (:foreground "firebrick" :italic t))
 711     (t
 712      (:italic t)))
 713   "Face used for low interest ticked articles."
 714   :group 'gnus-summary)
 715 ;; backward-compatibility alias
 716 (put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
 717
 718 (defface gnus-summary-normal-ticked
 719   '((((class color)
 720       (background dark))
 721      (:foreground "pink"))
 722     (((class color)
 723       (background light))
 724      (:foreground "firebrick"))
 725     (t
 726      ()))
 727   "Face used for normal interest ticked articles."
 728   :group 'gnus-summary)
 729 ;; backward-compatibility alias
 730 (put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
 731
 732 (defface gnus-summary-high-ancient
 733   '((((class color)
 734       (background dark))
 735      (:foreground "SkyBlue" :bold t))
 736     (((class color)
 737       (background light))
 738      (:foreground "RoyalBlue" :bold t))
 739     (t
 740      (:bold t)))
 741   "Face used for high interest ancient articles."
 742   :group 'gnus-summary)
 743 ;; backward-compatibility alias
 744 (put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
 745
 746 (defface gnus-summary-low-ancient
 747   '((((class color)
 748       (background dark))
 749      (:foreground "SkyBlue" :italic t))
 750     (((class color)
 751       (background light))
 752      (:foreground "RoyalBlue" :italic t))
 753     (t
 754      (:italic t)))
 755   "Face used for low interest ancient articles."
 756   :group 'gnus-summary)
 757 ;; backward-compatibility alias
 758 (put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
 759
 760 (defface gnus-summary-normal-ancient
 761   '((((class color)
 762       (background dark))
 763      (:foreground "SkyBlue"))
 764     (((class color)
 765       (background light))
 766      (:foreground "RoyalBlue"))
 767     (t
 768      ()))
 769   "Face used for normal interest ancient articles."
 770   :group 'gnus-summary)
 771 ;; backward-compatibility alias
 772 (put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
 773
 774 (defface gnus-summary-high-undownloaded
 775    '((((class color)
 776        (background light))
 777       (:bold t :foreground "cyan4"))
 778      (((class color) (background dark))
 779       (:bold t :foreground "LightGray"))
 780      (t (:inverse-video t :bold t)))
 781   "Face used for high interest uncached articles."
 782   :group 'gnus-summary)
 783 ;; backward-compatibility alias
 784 (put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
 785
 786 (defface gnus-summary-low-undownloaded
 787    '((((class color)
 788        (background light))
 789       (:italic t :foreground "cyan4" :bold nil))
 790      (((class color) (background dark))
 791       (:italic t :foreground "LightGray" :bold nil))
 792      (t (:inverse-video t :italic t)))
 793   "Face used for low interest uncached articles."
 794   :group 'gnus-summary)
 795 ;; backward-compatibility alias
 796 (put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
 797
 798 (defface gnus-summary-normal-undownloaded
 799    '((((class color)
 800        (background light))
 801       (:foreground "cyan4" :bold nil))
 802      (((class color) (background dark))
 803       (:foreground "LightGray" :bold nil))
 804      (t (:inverse-video t)))
 805   "Face used for normal interest uncached articles."
 806   :group 'gnus-summary)
 807 ;; backward-compatibility alias
 808 (put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
 809
 810 (defface gnus-summary-high-unread
 811   '((t
 812      (:bold t)))
 813   "Face used for high interest unread articles."
 814   :group 'gnus-summary)
 815 ;; backward-compatibility alias
 816 (put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
 817
 818 (defface gnus-summary-low-unread
 819   '((t
 820      (:italic t)))
 821   "Face used for low interest unread articles."
 822   :group 'gnus-summary)
 823 ;; backward-compatibility alias
 824 (put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
 825
 826 (defface gnus-summary-normal-unread
 827   '((t
 828      ()))
 829   "Face used for normal interest unread articles."
 830   :group 'gnus-summary)
 831 ;; backward-compatibility alias
 832 (put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
 833
 834 (defface gnus-summary-incorporated
 835   '((t
 836      ()))
 837   "Face used for incorporated articles."
 838   :group 'gnus-summary)
 839 ;; backward-compatibility alias
 840 (put 'gnus-summary-incorporated-face 'face-alias 'gnus-summary-incorporated)
 841
 842 (defface gnus-summary-high-read
 843   '((((class color)
 844       (background dark))
 845      (:foreground "PaleGreen"
 846                   :bold t))
 847     (((class color)
 848       (background light))
 849      (:foreground "DarkGreen"
 850                   :bold t))
 851     (t
 852      (:bold t)))
 853   "Face used for high interest read articles."
 854   :group 'gnus-summary)
 855 ;; backward-compatibility alias
 856 (put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
 857
 858 (defface gnus-summary-low-read
 859   '((((class color)
 860       (background dark))
 861      (:foreground "PaleGreen"
 862                   :italic t))
 863     (((class color)
 864       (background light))
 865      (:foreground "DarkGreen"
 866                   :italic t))
 867     (t
 868      (:italic t)))
 869   "Face used for low interest read articles."
 870   :group 'gnus-summary)
 871 ;; backward-compatibility alias
 872 (put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
 873
 874 (defface gnus-summary-normal-read
 875   '((((class color)
 876       (background dark))
 877      (:foreground "PaleGreen"))
 878     (((class color)
 879       (background light))
 880      (:foreground "DarkGreen"))
 881     (t
 882      ()))
 883   "Face used for normal interest read articles."
 884   :group 'gnus-summary)
 885 ;; backward-compatibility alias
 886 (put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
 887
 888
 889 ;;;
 890 ;;; Gnus buffers
 891 ;;;
 892
 893 (defvar gnus-buffers nil)
 894
 895 (defun gnus-get-buffer-create (name)
 896   "Do the same as `get-buffer-create', but store the created buffer."
 897   (or (get-buffer name)
 898       (car (push (get-buffer-create name) gnus-buffers))))
 899
 900 (defun gnus-add-buffer ()
 901   "Add the current buffer to the list of Gnus buffers."
 902   (push (current-buffer) gnus-buffers))
 903
 904 (defmacro gnus-kill-buffer (buffer)
 905   "Kill BUFFER and remove from the list of Gnus buffers."
 906   `(let ((buf ,buffer))
 907      (when (gnus-buffer-exists-p buf)
 908        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
 909        (kill-buffer buf))))
 910
 911 (defun gnus-buffers ()
 912   "Return a list of live Gnus buffers."
 913   (while (and gnus-buffers
 914               (not (buffer-name (car gnus-buffers))))
 915     (pop gnus-buffers))
 916   (let ((buffers gnus-buffers))
 917     (while (cdr buffers)
 918       (if (buffer-name (cadr buffers))
 919           (pop buffers)
 920         (setcdr buffers (cddr buffers)))))
 921   gnus-buffers)
 922
 923 ;;; Splash screen.
 924
 925 (defvar gnus-group-buffer "*Group*")
 926
 927 (eval-and-compile
 928   (autoload 'gnus-play-jingle "gnus-audio"))
 929
 930 (defface gnus-splash
 931   '((((class color)
 932       (background dark))
 933      (:foreground "#888888"))
 934     (((class color)
 935       (background light))
 936      (:foreground "#888888"))
 937     (t
 938      ()))
 939   "Face for the splash screen."
 940   :group 'gnus)
 941 ;; backward-compatibility alias
 942 (put 'gnus-splash-face 'face-alias 'gnus-splash)
 943
 944 (defun gnus-splash ()
 945   (save-excursion
 946     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 947     (let ((buffer-read-only nil))
 948       (erase-buffer)
 949       (unless gnus-inhibit-startup-message
 950         (gnus-group-startup-message)
 951         (sit-for 0)
 952         (when gnus-play-startup-jingle
 953           (gnus-play-jingle))))))
 954
 955 (defun gnus-indent-rigidly (start end arg)
 956   "Indent rigidly using only spaces and no tabs."
 957   (save-excursion
 958     (save-restriction
 959       (narrow-to-region start end)
 960       (let ((tab-width 8))
 961         (indent-rigidly start end arg)
 962         ;; We translate tabs into spaces -- not everybody uses
 963         ;; an 8-character tab.
 964         (goto-char (point-min))
 965         (while (search-forward "\t" nil t)
 966           (replace-match "        " t t))))))
 967
 968 (defvar gnus-simple-splash nil)
 969
 970 ;;(format "%02x%02x%02x" 114 66 20) "724214"
 971
 972 (defvar gnus-logo-color-alist
 973   '((flame "#cc3300" "#ff2200")
 974     (pine "#c0cc93" "#f8ffb8")
 975     (moss "#a1cc93" "#d2ffb8")
 976     (irish "#04cc90" "#05ff97")
 977     (sky "#049acc" "#05deff")
 978     (tin "#6886cc" "#82b6ff")
 979     (velvet "#7c68cc" "#8c82ff")
 980     (grape "#b264cc" "#cf7df")
 981     (labia "#cc64c2" "#fd7dff")
 982     (berry "#cc6485" "#ff7db5")
 983     (dino "#724214" "#1e3f03")
 984     (oort "#cccccc" "#888888")
 985     (storm "#666699" "#99ccff")
 986     (pdino "#9999cc" "#99ccff")
 987     (purp "#9999cc" "#666699")
 988     (no "#ff0000" "#ffff00")
 989     (neutral "#b4b4b4" "#878787")
 990     (september "#bf9900" "#ffcc00"))
 991   "Color alist used for the Gnus logo.")
 992
 993 (defcustom gnus-logo-color-style 'no
 994   "*Color styles used for the Gnus logo."
 995   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
 996                            gnus-logo-color-alist))
 997   :group 'gnus-xmas)
 998
 999 (defvar gnus-logo-colors
1000   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
1001   "Colors used for the Gnus logo.")
1002
1003 (defun gnus-group-startup-message (&optional x y)
1004   "Insert startup message in current buffer."
1005   ;; Insert the message.
1006   (erase-buffer)
1007   (cond
1008    ((and (fboundp 'find-image)
1009          (display-graphic-p)
1010          (let* ((bg (face-background 'default))
1011                 (fg (face-foreground 'gnus-splash))
1012                 (data-directory (nnheader-find-etc-directory "images/gnus"))
1013                 (image-load-path (cond (data-directory
1014                                         (list data-directory))
1015                                        ((boundp 'image-load-path)
1016                                         (symbol-value 'image-load-path))
1017                                        (t load-path)))
1018                 (image (find-image
1019                         `((:type xpm :file "gnus.xpm"
1020                                  :color-symbols
1021                                  (("thing" . ,(car gnus-logo-colors))
1022                                   ("shadow" . ,(cadr gnus-logo-colors))
1023                                   ("oort" . "#eeeeee")
1024                                   ("background" . ,bg)))
1025                           (:type pbm :file "gnus.pbm"
1026                                  ;; Account for the pbm's blackground.
1027                                  :background ,bg :foreground ,fg)
1028                           (:type xbm :file "gnus.xbm"
1029                                  ;; Account for the xbm's blackground.
1030                                  :background ,bg :foreground ,fg)))))
1031            (when image
1032              (insert
1033               (propertize
1034                (concat gnus-product-name " " gnus-version-number
1035                        (if (zerop (string-to-number gnus-revision-number))
1036                            ""
1037                          (concat " (r" gnus-revision-number ")"))
1038                        " based on " gnus-original-product-name " v"
1039                        gnus-original-version-number)
1040                'face `(variable-pitch :background ,bg :foreground ,fg)))
1041              (let ((fill-column (window-width)))
1042                (center-region (point-min) (point)))
1043              (let ((size (image-size image)))
1044                (insert-char ?\n (max 1 (round (- (window-height)
1045                                                  (or y (cdr size))) 2)))
1046                (insert
1047                 (propertize " " 'display
1048                             `(space :align-to
1049                                     ,(max 0 (round (- (window-width)
1050                                                       (or x (car size))) 2)))))
1051                (insert-image image))
1052              (setq gnus-simple-splash nil)
1053              t))))
1054    (t
1055     (insert "
1056           _    ___ _             _
1057           _ ___ __ ___  __    _ ___
1058           __   _     ___    __  ___
1059               _           ___     _
1060              _  _ __             _
1061              ___   __            _
1062                    __           _
1063                     _      _   _
1064                    _      _    _
1065                       _  _    _
1066                   __  ___
1067                  _   _ _     _
1068                 _   _
1069               _    _
1070              _    _
1071             _
1072           __
1073
1074 "
1075             )
1076     (goto-char (point-min))
1077     (insert gnus-product-name " " gnus-version-number
1078             (if (zerop (string-to-number gnus-revision-number))
1079                 ""
1080               (concat " (r" gnus-revision-number ")"))
1081             " based on " gnus-original-product-name " v"
1082             gnus-original-version-number)
1083     (insert-char ?\  (prog1
1084                          (max 0 (/ (- (window-width) (point)) 2))
1085                        (goto-char (point-min))))
1086     (forward-line 1)
1087     ;; And then hack it.
1088     (gnus-indent-rigidly (point) (point-max)
1089                          (/ (max (- (window-width) (or x 46)) 0) 2))
1090     (goto-char (point-min))
1091     (forward-line 1)
1092     (let* ((pheight (count-lines (point-min) (point-max)))
1093            (wheight (window-height))
1094            (rest (- wheight pheight)))
1095       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1096     ;; Fontify some.
1097     (put-text-property (point-min) (point-max) 'face 'gnus-splash)
1098     (setq gnus-simple-splash t)))
1099   (goto-char (point-min))
1100   (setq mode-line-buffer-identification (concat " " gnus-version))
1101   (set-buffer-modified-p t))
1102
1103 (eval-when (load)
1104   (let ((command (format "%s" this-command)))
1105     (when (string-match "gnus" command)
1106       (if (string-match "gnus-other-frame" command)
1107           (gnus-get-buffer-create gnus-group-buffer)
1108         (gnus-splash)))))
1109
1110 ;;; Do the rest.
1111
1112 (require 'gnus-util)
1113 (require 'nnheader)
1114
1115 (defcustom gnus-parameters nil
1116   "Alist of group parameters.
1117
1118 For example:
1119    ((\"mail\\\\..*\"  (gnus-show-threads nil)
1120                   (gnus-use-scoring nil)
1121                   (gnus-summary-line-format
1122                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1123                   (gcc-self . t)
1124                   (display . all))
1125      (\"mail\\\\.me\" (gnus-use-scoring  t))
1126      (\"list\\\\..*\" (total-expire . t)
1127                   (broken-reply-to . t)))"
1128   :version "22.1"
1129   :group 'gnus-group-various
1130   :type '(repeat (cons regexp
1131                        (repeat sexp))))
1132
1133 (defvar gnus-group-parameters-more nil)
1134
1135 (defmacro gnus-define-group-parameter (param &rest rest)
1136   "Define a group parameter PARAM.
1137 REST is a plist of following:
1138 :type               One of `bool', `list' or nil.
1139 :function           The name of the function.
1140 :function-document  The documentation of the function.
1141 :parameter-type     The type for customizing the parameter.
1142 :parameter-document The documentation for the parameter.
1143 :variable           The name of the variable.
1144 :variable-document  The documentation for the variable.
1145 :variable-group     The group for customizing the variable.
1146 :variable-type      The type for customizing the variable.
1147 :variable-default   The default value of the variable."
1148   (let* ((type (plist-get rest :type))
1149          (parameter-type (plist-get rest :parameter-type))
1150          (parameter-document (plist-get rest :parameter-document))
1151          (function (or (plist-get rest :function)
1152                        (intern (format "gnus-parameter-%s" param))))
1153          (function-document (or (plist-get rest :function-document) ""))
1154          (variable (or (plist-get rest :variable)
1155                        (intern (format "gnus-parameter-%s-alist" param))))
1156          (variable-document (or (plist-get rest :variable-document) ""))
1157          (variable-group (plist-get rest :variable-group))
1158          (variable-type (or (plist-get rest :variable-type)
1159                             `(quote (repeat
1160                                      (list (regexp :tag "Group")
1161                                            ,(car (cdr parameter-type)))))))
1162          (variable-default (plist-get rest :variable-default)))
1163     (list
1164      'progn
1165      `(defcustom ,variable ,variable-default
1166         ,variable-document
1167         :group 'gnus-group-parameter
1168         :group ',variable-group
1169         :type ,variable-type)
1170      `(setq gnus-group-parameters-more
1171             (delq (assq ',param gnus-group-parameters-more)
1172                   gnus-group-parameters-more))
1173      `(add-to-list 'gnus-group-parameters-more
1174                    (list ',param
1175                          ,parameter-type
1176                          ,parameter-document))
1177      (if (eq type 'bool)
1178          `(defun ,function (name)
1179             ,function-document
1180             (let ((params (gnus-group-find-parameter name))
1181                   val)
1182               (cond
1183                ((memq ',param params)
1184                 t)
1185                ((setq val (assq ',param params))
1186                 (cdr val))
1187                ((stringp ,variable)
1188                 (string-match ,variable name))
1189                (,variable
1190                 (let ((alist ,variable)
1191                       elem value)
1192                   (while (setq elem (pop alist))
1193                     (when (and name
1194                                (string-match (car elem) name))
1195                       (setq alist nil
1196                             value (cdr elem))))
1197                   (if (consp value) (car value) value))))))
1198        `(defun ,function (name)
1199           ,function-document
1200           (and name
1201                (or (gnus-group-find-parameter name ',param ,(and type t))
1202                    (let ((alist ,variable)
1203                          elem value)
1204                      (while (setq elem (pop alist))
1205                        (when (and name
1206                                   (string-match (car elem) name))
1207                          (setq alist nil
1208                                value (cdr elem))))
1209                      ,(if type
1210                           'value
1211                         '(if (consp value) (car value) value))))))))))
1212
1213 (defcustom gnus-home-directory "~/"
1214   "Directory variable that specifies the \"home\" directory.
1215 All other Gnus file and directory variables are initialized from this variable."
1216   :group 'gnus-files
1217   :type 'directory)
1218
1219 (defcustom gnus-directory (or (getenv "SAVEDIR")
1220                               (nnheader-concat gnus-home-directory "News/"))
1221   "*Directory variable from which all other Gnus file variables are derived.
1222
1223 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1224 This means that other directory variables that are initialized from
1225 this variable won't be set properly if you set this variable in `.gnus.el'.
1226 Set this variable in `.emacs' instead."
1227   :group 'gnus-files
1228   :type 'directory)
1229
1230 (defcustom gnus-default-directory nil
1231   "*Default directory for all Gnus buffers."
1232   :group 'gnus-files
1233   :type '(choice (const :tag "current" nil)
1234                  directory))
1235
1236 ;; Site dependent variables.  These variables should be defined in
1237 ;; paths.el.
1238
1239 (defvar gnus-default-nntp-server nil
1240   "Specify a default NNTP server.
1241 This variable should be defined in paths.el, and should never be set
1242 by the user.
1243 If you want to change servers, you should use `gnus-select-method'.
1244 See the documentation to that variable.")
1245
1246 ;; Don't touch this variable.
1247 (defvar gnus-nntp-service "nntp"
1248   "NNTP service name (\"nntp\" or 119).
1249 This is an obsolete variable, which is scarcely used.  If you use an
1250 nntp server for your newsgroup and want to change the port number
1251 used to 899, you would say something along these lines:
1252
1253  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1254
1255 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1256   "A file with only the name of the nntp server in it."
1257   :group 'gnus-files
1258   :group 'gnus-server
1259   :type 'file)
1260
1261 (defun gnus-getenv-nntpserver ()
1262   "Find default nntp server.
1263 Check the NNTPSERVER environment variable and the
1264 `gnus-nntpserver-file' file."
1265   (or (getenv "NNTPSERVER")
1266       (and (file-readable-p gnus-nntpserver-file)
1267            (with-temp-buffer
1268              (insert-file-contents gnus-nntpserver-file)
1269              (when (re-search-forward "[^ \t\n\r]+" nil t)
1270                (match-string 0))))))
1271
1272 (defcustom gnus-select-method
1273   (condition-case nil
1274       (nconc
1275        (list 'nntp (or (condition-case nil
1276                            (gnus-getenv-nntpserver)
1277                          (error nil))
1278                        (when (and gnus-default-nntp-server
1279                                   (not (string= gnus-default-nntp-server "")))
1280                          gnus-default-nntp-server)
1281                        "news"))
1282        (if (or (null gnus-nntp-service)
1283                (equal gnus-nntp-service "nntp"))
1284            nil
1285          (list gnus-nntp-service)))
1286     (error nil))
1287   "Default method for selecting a newsgroup.
1288 This variable should be a list, where the first element is how the
1289 news is to be fetched, the second is the address.
1290
1291 For instance, if you want to get your news via \"flab.flab.edu\" using
1292 NNTP, you could say:
1293
1294 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1295
1296 If you want to use your local spool, say:
1297
1298 \(setq gnus-select-method (list 'nnspool (system-name)))
1299
1300 If you use this variable, you must set `gnus-nntp-server' to nil.
1301
1302 There is a lot more to know about select methods and virtual servers -
1303 see the manual for details."
1304   :group 'gnus-server
1305   :type 'gnus-select-method)
1306
1307 (defcustom gnus-message-archive-method "archive"
1308   "*Method used for archiving messages you've sent.
1309 This should be a mail method."
1310   :group 'gnus-server
1311   :group 'gnus-message
1312   :type '(choice (const :tag "Default archive method" "archive")
1313                  gnus-select-method))
1314
1315 (defcustom gnus-message-archive-group nil
1316   "*Name of the group in which to save the messages you've written.
1317 This can either be a string; a list of strings; or an alist
1318 of regexps/functions/forms to be evaluated to return a string (or a list
1319 of strings).  The functions are called with the name of the current
1320 group (or nil) as a parameter.
1321
1322 If you want to save your mail in one group and the news articles you
1323 write in another group, you could say something like:
1324
1325  \(setq gnus-message-archive-group
1326         '((if (message-news-p)
1327               \"misc-news\"
1328             \"misc-mail\")))
1329
1330 Normally the group names returned by this variable should be
1331 unprefixed -- which implicitly means \"store on the archive server\".
1332 However, you may wish to store the message on some other server.  In
1333 that case, just return a fully prefixed name of the group --
1334 \"nnml+private:mail.misc\", for instance."
1335   :group 'gnus-message
1336   :type '(choice (const :tag "none" nil)
1337                  function
1338                  sexp
1339                  string))
1340
1341 (defcustom gnus-secondary-servers nil
1342   "List of NNTP servers that the user can choose between interactively.
1343 To make Gnus query you for a server, you have to give `gnus' a
1344 non-numeric prefix - `C-u M-x gnus', in short."
1345   :group 'gnus-server
1346   :type '(repeat string))
1347
1348 (defcustom gnus-nntp-server nil
1349   "*The name of the host running the NNTP server.
1350 This variable is semi-obsolete.  Use the `gnus-select-method'
1351 variable instead."
1352   :group 'gnus-server
1353   :type '(choice (const :tag "disable" nil)
1354                  string))
1355
1356 (defcustom gnus-secondary-select-methods nil
1357   "A list of secondary methods that will be used for reading news.
1358 This is a list where each element is a complete select method (see
1359 `gnus-select-method').
1360
1361 If, for instance, you want to read your mail with the nnml back end,
1362 you could set this variable:
1363
1364 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1365   :group 'gnus-server
1366   :type '(repeat gnus-select-method))
1367
1368 (defvar gnus-backup-default-subscribed-newsgroups
1369   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1370   "Default default new newsgroups the first time Gnus is run.
1371 Should be set in paths.el, and shouldn't be touched by the user.")
1372
1373 (defcustom gnus-local-domain nil
1374   "Local domain name without a host name.
1375 The DOMAINNAME environment variable is used instead if it is defined.
1376 If the function `system-name' returns the full Internet name, there is
1377 no need to set this variable."
1378   :group 'gnus-message
1379   :type '(choice (const :tag "default" nil)
1380                  string))
1381
1382 (defvar gnus-local-organization nil
1383   "String with a description of what organization (if any) the user belongs to.
1384 Obsolete variable; use `message-user-organization' instead.")
1385
1386 ;; Customization variables
1387
1388 (defcustom gnus-refer-article-method nil
1389   "Preferred method for fetching an article by Message-ID.
1390 If you are reading news from the local spool (with nnspool), fetching
1391 articles by Message-ID is painfully slow.  By setting this method to an
1392 nntp method, you might get acceptable results.
1393
1394 The value of this variable must be a valid select method as discussed
1395 in the documentation of `gnus-select-method'.
1396
1397 It can also be a list of select methods, as well as the special symbol
1398 `current', which means to use the current select method.  If it is a
1399 list, Gnus will try all the methods in the list until it finds a match."
1400   :group 'gnus-server
1401   :type '(choice (const :tag "default" nil)
1402                  (const current)
1403                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1404                  gnus-select-method
1405                  (repeat :menu-tag "Try multiple"
1406                          :tag "Multiple"
1407                          :value (current (nnweb "refer" (nnweb-type google)))
1408                          (choice :tag "Method"
1409                                  (const current)
1410                                  (const :tag "Google"
1411                                         (nnweb "refer" (nnweb-type google)))
1412                                  gnus-select-method))))
1413
1414 (defcustom gnus-group-faq-directory
1415   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1416     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1417     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1418     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1419     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1420     "/ftp@rtfm.mit.edu:/pub/usenet/"
1421     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1422     "/ftp@ftp.sunet.se:/pub/usenet/"
1423     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1424     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1425     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1426   "*Directory where the group FAQs are stored.
1427 This will most commonly be on a remote machine, and the file will be
1428 fetched by ange-ftp.
1429
1430 This variable can also be a list of directories.  In that case, the
1431 first element in the list will be used by default.  The others can
1432 be used when being prompted for a site.
1433
1434 Note that Gnus uses an aol machine as the default directory.  If this
1435 feels fundamentally unclean, just think of it as a way to finally get
1436 something of value back from them.
1437
1438 If the default site is too slow, try one of these:
1439
1440    North America: mirrors.aol.com                /pub/rtfm/usenet
1441                   ftp.seas.gwu.edu               /pub/rtfm
1442                   rtfm.mit.edu                   /pub/usenet
1443    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1444                   src.doc.ic.ac.uk               /usenet/news-FAQS
1445                   ftp.sunet.se                   /pub/usenet
1446                   ftp.pasteur.fr                 /pub/FAQ
1447    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1448                   hwarang.postech.ac.kr          /pub/usenet
1449                   ftp.hk.super.net               /mirror/faqs"
1450   :group 'gnus-group-various
1451   :type '(choice directory
1452                  (repeat directory)))
1453
1454 (defcustom gnus-group-charter-alist
1455   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1456     ("de" . (concat "http://purl.net/charta/" name ".html"))
1457     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1458     ("england" . (concat "http://england.news-admin.org/charters/" name))
1459     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1460     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1461                         (gnus-replace-in-string name "europa\\." "") ".html"))
1462     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1463     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1464     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1465     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1466     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1467     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1468     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1469     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1470                     (gnus-replace-in-string name "\\." "_") ".html"))
1471     ("milw" . (concat "http://usenet.mil.wi.us/"
1472                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1473     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1474     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1475                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1476   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1477 When FORM is evaluated `name' is bound to the name of the group."
1478   :version "22.1"
1479   :group 'gnus-group-various
1480   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1481
1482 (defcustom gnus-group-fetch-control-use-browse-url nil
1483   "*Non-nil means that control messages are displayed using `browse-url'.
1484 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1485 group."
1486   :version "22.1"
1487   :group 'gnus-group-various
1488   :type 'boolean)
1489
1490 (defcustom gnus-use-cross-reference t
1491   "*Non-nil means that cross referenced articles will be marked as read.
1492 If nil, ignore cross references.  If t, mark articles as read in
1493 subscribed newsgroups.  If neither t nor nil, mark as read in all
1494 newsgroups."
1495   :group 'gnus-server
1496   :type '(choice (const :tag "off" nil)
1497                  (const :tag "subscribed" t)
1498                  (sexp :format "all"
1499                        :value always)))
1500
1501 (defcustom gnus-process-mark ?#
1502   "*Process mark."
1503   :group 'gnus-group-visual
1504   :group 'gnus-summary-marks
1505   :type 'character)
1506
1507 (defcustom gnus-large-newsgroup 200
1508   "*The number of articles which indicates a large newsgroup.
1509 If the number of articles in a newsgroup is greater than this value,
1510 confirmation is required for selecting the newsgroup.
1511 If it is nil, no confirmation is required."
1512   :group 'gnus-group-select
1513   :type '(choice (const :tag "No limit" nil)
1514                  integer))
1515
1516 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1517   "*Non-nil means that the default name of a file to save articles in is the group name.
1518 If it's nil, the directory form of the group name is used instead.
1519
1520 If this variable is a list, and the list contains the element
1521 `not-score', long file names will not be used for score files; if it
1522 contains the element `not-save', long file names will not be used for
1523 saving; and if it contains the element `not-kill', long file names
1524 will not be used for kill files.
1525
1526 Note that the default for this variable varies according to what system
1527 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1528 to nil while on all other systems it defaults to t."
1529   :group 'gnus-start
1530   :type '(radio (sexp :format "Non-nil\n"
1531                       :match (lambda (widget value)
1532                                (and value (not (listp value))))
1533                       :value t)
1534                 (const nil)
1535                 (checklist (const :format "%v " not-score)
1536                            (const :format "%v " not-save)
1537                            (const not-kill))))
1538
1539 (defcustom gnus-kill-files-directory gnus-directory
1540   "*Name of the directory where kill files will be stored (default \"~/News\")."
1541   :group 'gnus-score-files
1542   :group 'gnus-score-kill
1543   :type 'directory)
1544
1545 (defcustom gnus-save-score nil
1546   "*If non-nil, save group scoring info."
1547   :group 'gnus-score-various
1548   :group 'gnus-start
1549   :type 'boolean)
1550
1551 (defcustom gnus-use-undo t
1552   "*If non-nil, allow undoing in Gnus group mode buffers."
1553   :group 'gnus-meta
1554   :type 'boolean)
1555
1556 (defcustom gnus-use-adaptive-scoring nil
1557   "*If non-nil, use some adaptive scoring scheme.
1558 If a list, then the values `word' and `line' are meaningful.  The
1559 former will perform adaption on individual words in the subject
1560 header while `line' will perform adaption on several headers."
1561   :group 'gnus-meta
1562   :group 'gnus-score-adapt
1563   :type '(set (const word) (const line)))
1564
1565 (defcustom gnus-use-cache 'passive
1566   "*If nil, Gnus will ignore the article cache.
1567 If `passive', it will allow entering (and reading) articles
1568 explicitly entered into the cache.  If anything else, use the
1569 cache to the full extent of the law."
1570   :group 'gnus-meta
1571   :group 'gnus-cache
1572   :type '(choice (const :tag "off" nil)
1573                  (const :tag "passive" passive)
1574                  (const :tag "active" t)))
1575
1576 (defcustom gnus-use-trees nil
1577   "*If non-nil, display a thread tree buffer."
1578   :group 'gnus-meta
1579   :type 'boolean)
1580
1581 (defcustom gnus-keep-backlog 20
1582   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1583 If it is a number N, then Gnus will only keep the last N articles
1584 read.  If it is neither nil nor a number, Gnus will keep all read
1585 articles.  This is not a good idea."
1586   :group 'gnus-meta
1587   :type '(choice (const :tag "off" nil)
1588                  integer
1589                  (sexp :format "all"
1590                        :value t)))
1591
1592 (defcustom gnus-use-nocem nil
1593   "*If non-nil, Gnus will read NoCeM cancel messages."
1594   :group 'gnus-meta
1595   :type 'boolean)
1596
1597 (defcustom gnus-suppress-duplicates nil
1598   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1599   :group 'gnus-meta
1600   :type 'boolean)
1601
1602 (defcustom gnus-use-scoring t
1603   "*If non-nil, enable scoring."
1604   :group 'gnus-meta
1605   :type 'boolean)
1606
1607 (defcustom gnus-summary-prepare-exit-hook
1608   '(gnus-summary-expire-articles)
1609   "*A hook called when preparing to exit from the summary buffer.
1610 It calls `gnus-summary-expire-articles' by default."
1611   :group 'gnus-summary-exit
1612   :type 'hook)
1613
1614 (defcustom gnus-novice-user t
1615   "*Non-nil means that you are a Usenet novice.
1616 If non-nil, verbose messages may be displayed and confirmations may be
1617 required."
1618   :group 'gnus-meta
1619   :type 'boolean)
1620
1621 (defcustom gnus-expert-user nil
1622   "*Non-nil means that you will never be asked for confirmation about anything.
1623 That doesn't mean *anything* anything; particularly destructive
1624 commands will still require prompting."
1625   :group 'gnus-meta
1626   :type 'boolean)
1627
1628 (defcustom gnus-interactive-catchup t
1629   "*If non-nil, require your confirmation when catching up a group."
1630   :group 'gnus-group-select
1631   :type 'boolean)
1632
1633 (defcustom gnus-interactive-exit t
1634   "*If non-nil, require your confirmation when exiting Gnus."
1635   :group 'gnus-exit
1636   :type 'boolean)
1637
1638 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1639   "Function for extracting address components from a From header.
1640 Three pre-defined functions exist: `gnus-extract-address-components',
1641 which is the default, quite fast, and too simplistic solution,
1642 `mail-extract-address-components', which works much better, but is
1643 slower, and `std11-extract-address-components'."
1644   :group 'gnus-summary-format
1645   :type '(radio (function-item gnus-extract-address-components)
1646                 (function-item mail-extract-address-components)
1647                 (function-item std11-extract-address-components)
1648                 (function :tag "Other")))
1649
1650 (defcustom gnus-carpal nil
1651   "*If non-nil, display clickable icons."
1652   :group 'gnus-meta
1653   :type 'boolean)
1654
1655 (defcustom gnus-shell-command-separator ";"
1656   "String used to separate shell commands."
1657   :group 'gnus-files
1658   :type 'string)
1659
1660 (defcustom gnus-valid-select-methods
1661   '(("nntp" post address prompt-address physical-address)
1662     ("nnspool" post address)
1663     ("nnvirtual" post-mail virtual prompt-address)
1664     ("nnmbox" mail respool address)
1665     ("nnml" post-mail respool address)
1666     ("nnmh" mail respool address)
1667     ("nndir" post-mail prompt-address physical-address)
1668     ("nneething" none address prompt-address physical-address)
1669     ("nndoc" none address prompt-address)
1670     ("nnbabyl" mail address respool)
1671     ("nnkiboze" post virtual)
1672     ("nnsoup" post-mail address)
1673     ("nndraft" post-mail)
1674     ("nnfolder" mail respool address)
1675     ("nngateway" post-mail address prompt-address physical-address)
1676     ("nnweb" none)
1677     ("nngoogle" post)
1678     ("nnslashdot" post)
1679     ("nnultimate" none)
1680     ("nnrss" none)
1681     ("nnwfm" none)
1682     ("nnwarchive" none)
1683     ("nnlistserv" none)
1684     ("nnagent" post-mail)
1685     ("nnimap" post-mail address prompt-address physical-address)
1686     ("nnmaildir" mail respool address)
1687     ("nnnil" none))
1688   "*An alist of valid select methods.
1689 The first element of each list lists should be a string with the name
1690 of the select method.  The other elements may be the category of
1691 this method (i. e., `post', `mail', `none' or whatever) or other
1692 properties that this method has (like being respoolable).
1693 If you implement a new select method, all you should have to change is
1694 this variable.  I think."
1695   :group 'gnus-server
1696   :type '(repeat (group (string :tag "Name")
1697                         (radio-button-choice (const :format "%v " post)
1698                                              (const :format "%v " mail)
1699                                              (const :format "%v " none)
1700                                              (const post-mail))
1701                         (checklist :inline t
1702                                    (const :format "%v " address)
1703                                    (const :format "%v " prompt-address)
1704                                    (const :format "%v " physical-address)
1705                                    (const :format "%v " virtual)
1706                                    (const respool)))))
1707
1708 (defun gnus-redefine-select-method-widget ()
1709   "Recomputes the select-method widget based on the value of
1710 `gnus-valid-select-methods'."
1711   (define-widget 'gnus-select-method 'list
1712     "Widget for entering a select method."
1713     :value '(nntp "")
1714     :tag "Select Method"
1715     :args `((choice :tag "Method"
1716                     ,@(mapcar (lambda (entry)
1717                                 (list 'const :format "%v\n"
1718                                       (intern (car entry))))
1719                               gnus-valid-select-methods)
1720                     (symbol :tag "other"))
1721             (string :tag "Address")
1722             (repeat :tag "Options"
1723                     :inline t
1724                     (list :format "%v"
1725                           variable
1726                           (sexp :tag "Value"))))))
1727
1728 (gnus-redefine-select-method-widget)
1729
1730 (defcustom gnus-updated-mode-lines '(group article summary tree)
1731   "List of buffers that should update their mode lines.
1732 The list may contain the symbols `group', `article', `tree' and
1733 `summary'.  If the corresponding symbol is present, Gnus will keep
1734 that mode line updated with information that may be pertinent.
1735 If this variable is nil, screen refresh may be quicker."
1736   :group 'gnus-various
1737   :type '(set (const group)
1738               (const article)
1739               (const summary)
1740               (const tree)))
1741
1742 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1743 (defcustom gnus-mode-non-string-length nil
1744   "*Max length of mode-line non-string contents.
1745 If this is nil, Gnus will take space as is needed, leaving the rest
1746 of the mode line intact.  Note that the default of nil is unlikely
1747 to be desirable; see the manual for further details."
1748   :group 'gnus-various
1749   :type '(choice (const nil)
1750                  integer))
1751
1752 ;; There should be special validation for this.
1753 (define-widget 'gnus-email-address 'string
1754   "An email address.")
1755
1756 (gnus-define-group-parameter
1757  to-address
1758  :function-document
1759  "Return GROUP's to-address."
1760  :variable-document
1761  "*Alist of group regexps and correspondent to-addresses."
1762  :variable-group gnus-group-parameter
1763  :parameter-type '(gnus-email-address :tag "To Address")
1764  :parameter-document "\
1765 This will be used when doing followups and posts.
1766
1767 This is primarily useful in mail groups that represent closed
1768 mailing lists--mailing lists where it's expected that everybody that
1769 writes to the mailing list is subscribed to it.  Since using this
1770 parameter ensures that the mail only goes to the mailing list itself,
1771 it means that members won't receive two copies of your followups.
1772
1773 Using `to-address' will actually work whether the group is foreign or
1774 not.  Let's say there's a group on the server that is called
1775 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1776 articles from a mail-to-news gateway.  Posting directly to this group
1777 is therefore impossible--you have to send mail to the mailing list
1778 address instead.
1779
1780 The gnus-group-split mail splitting mechanism will behave as if this
1781 address was listed in gnus-group-split Addresses (see below).")
1782
1783 (gnus-define-group-parameter
1784  to-list
1785  :function-document
1786  "Return GROUP's to-list."
1787  :variable-document
1788  "*Alist of group regexps and correspondent to-lists."
1789  :variable-group gnus-group-parameter
1790  :parameter-type '(gnus-email-address :tag "To List")
1791  :parameter-document "\
1792 This address will be used when doing a `a' in the group.
1793
1794 It is totally ignored when doing a followup--except that if it is
1795 present in a news group, you'll get mail group semantics when doing
1796 `f'.
1797
1798 The gnus-group-split mail splitting mechanism will behave as if this
1799 address was listed in gnus-group-split Addresses (see below).")
1800
1801 (gnus-define-group-parameter
1802  subscribed
1803  :type bool
1804  :function-document
1805  "Return GROUP's subscription status."
1806  :variable-document
1807  "*Groups which are automatically considered subscribed."
1808  :variable-group gnus-group-parameter
1809  :parameter-type '(const :tag "Subscribed" t)
1810  :parameter-document "\
1811 Gnus assumed that you are subscribed to the To/List address.
1812
1813 When constructing a list of subscribed groups using
1814 `gnus-find-subscribed-addresses', Gnus includes the To address given
1815 above, or the list address (if the To address has not been set).")
1816
1817 (gnus-define-group-parameter
1818  auto-expire
1819  :type bool
1820  :function gnus-group-auto-expirable-p
1821  :function-document
1822  "Check whether GROUP is auto-expirable or not."
1823  :variable gnus-auto-expirable-newsgroups
1824  :variable-default nil
1825  :variable-document
1826  "*Groups in which to automatically mark read articles as expirable.
1827 If non-nil, this should be a regexp that should match all groups in
1828 which to perform auto-expiry.  This only makes sense for mail groups."
1829  :variable-group nnmail-expire
1830  :variable-type '(choice (const nil)
1831                          regexp)
1832  :parameter-type '(const :tag "Automatic Expire" t)
1833  :parameter-document
1834  "All articles that are read will be marked as expirable.")
1835
1836 (gnus-define-group-parameter
1837  total-expire
1838  :type bool
1839  :function gnus-group-total-expirable-p
1840  :function-document
1841  "Check whether GROUP is total-expirable or not."
1842  :variable gnus-total-expirable-newsgroups
1843  :variable-default nil
1844  :variable-document
1845  "*Groups in which to perform expiry of all read articles.
1846 Use with extreme caution.  All groups that match this regexp will be
1847 expiring - which means that all read articles will be deleted after
1848 \(say) one week.         (This only goes for mail groups and the like, of
1849 course.)"
1850  :variable-group nnmail-expire
1851  :variable-type '(choice (const nil)
1852                          regexp)
1853  :parameter-type '(const :tag "Total Expire" t)
1854  :parameter-document
1855  "All read articles will be put through the expiry process
1856
1857 This happens even if they are not marked as expirable.
1858 Use with caution.")
1859
1860 (gnus-define-group-parameter
1861  charset
1862  :function-document
1863  "Return the default charset of GROUP."
1864  :variable gnus-group-charset-alist
1865  :variable-default
1866  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1867    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1868    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1869    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1870    ("\\(^\\|:\\)relcom\\>" koi8-r)
1871    ("\\(^\\|:\\)fido7\\>" koi8-r)
1872    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1873    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1874    ("\\(^\\|:\\)han\\>" euc-kr)
1875    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1876    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1877    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1878  :variable-document
1879  "Alist of regexps (to match group names) and default charsets to be used when reading."
1880  :variable-group gnus-charset
1881  :variable-type '(repeat (list (regexp :tag "Group")
1882                                (symbol :tag "Charset")))
1883  :parameter-type '(symbol :tag "Charset")
1884  :parameter-document "\
1885 The default charset to use in the group.")
1886
1887 (gnus-define-group-parameter
1888  post-method
1889  :type list
1890  :function-document
1891  "Return a posting method for GROUP."
1892  :variable gnus-post-method-alist
1893  :variable-document
1894  "Alist of regexps (to match group names) and method to be used when
1895 posting an article."
1896  :variable-group gnus-group-foreign
1897  :parameter-type
1898  '(choice :tag "Posting Method"
1899           (const :tag "Use native server" native)
1900           (const :tag "Use current server" current)
1901           (list :convert-widget
1902                 (lambda (widget)
1903                   (list 'sexp :tag "Methods"
1904                         :value gnus-select-method))))
1905  :parameter-document
1906  "Posting method for this group.")
1907
1908 (gnus-define-group-parameter
1909  large-newsgroup-initial
1910  :type integer
1911  :function-document
1912  "Return GROUP's initial input of the number of articles."
1913  :variable-document
1914  "*Alist of group regexps and its initial input of the number of articles."
1915  :variable-group gnus-group-parameter
1916  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1917                           (const :tag "All" nil)
1918                           (integer))
1919  :parameter-document "\
1920
1921 This number will be prompted as the initial value of the number of
1922 articles to list when the group is a large newsgroup (see
1923 `gnus-large-newsgroup').  If it is nil, the default value is the
1924 total number of articles in the group.")
1925
1926 ;; The Gnus registry's ignored groups
1927 (gnus-define-group-parameter
1928  registry-ignore
1929  :type list
1930  :function-document
1931  "Whether this group should be ignored by the registry."
1932  :variable gnus-registry-ignored-groups
1933  :variable-default nil
1934  :variable-document
1935  "*Groups in which the registry should be turned off."
1936  :variable-group gnus-registry
1937  :variable-type '(repeat
1938                   (list
1939                    (regexp :tag "Group Name Regular Expression")
1940                    (boolean :tag "Ignored")))
1941
1942  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1943  :parameter-document
1944  "Whether the Gnus Registry should ignore this group.")
1945
1946 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1947 (defcustom gnus-install-group-spam-parameters t
1948   "*Disable the group parameters for spam detection.
1949 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1950   :version "22.1"
1951   :type 'boolean
1952   :group 'gnus-start)
1953
1954 (when gnus-install-group-spam-parameters
1955   (defvar gnus-group-spam-classification-spam t
1956     "Spam group classification (requires spam.el).
1957 This group contains spam messages.  On summary entry, unread messages
1958 will be marked as spam.  On summary exit, the specified spam
1959 processors will be invoked on spam-marked messages, then those
1960 messages will be expired, so the spam processor will only see a
1961 spam-marked message once.")
1962
1963   (defvar gnus-group-spam-classification-ham 'ask
1964     "The ham value for the spam group parameter (requires spam.el).
1965 On summary exit, the specified ham processors will be invoked on
1966 ham-marked messages.  Exercise caution, since the ham processor will
1967 see the same message more than once because there is no ham message
1968 registry.")
1969
1970   (gnus-define-group-parameter
1971    spam-contents
1972    :type list
1973    :function-document
1974    "The spam type (spam, ham, or neither) of the group."
1975    :variable gnus-spam-newsgroup-contents
1976    :variable-default nil
1977    :variable-document
1978    "*Group classification (spam, ham, or neither).  Only
1979 meaningful when spam.el is loaded.  If non-nil, this should be a
1980 list of group name regexps associated with a classification for
1981 each one.  In spam groups, new articles are marked as spam on
1982 summary entry.  There is other behavior associated with ham and
1983 no classification when spam.el is loaded - see the manual."
1984    :variable-group spam
1985    :variable-type '(repeat
1986                     (list :tag "Group contents spam/ham classification"
1987                           (regexp :tag "Group")
1988                           (choice
1989                            (variable-item gnus-group-spam-classification-spam)
1990                            (variable-item gnus-group-spam-classification-ham)
1991                            (const :tag "Unclassified" nil))))
1992
1993    :parameter-type '(list :tag "Group contents spam/ham classification"
1994                           (choice :tag "Group contents classification for spam sorting"
1995                                   (variable-item gnus-group-spam-classification-spam)
1996                                   (variable-item gnus-group-spam-classification-ham)
1997                                   (const :tag "Unclassified" nil)))
1998    :parameter-document
1999    "The spam classification (spam, ham, or neither) of this group.
2000 When a spam group is entered, all unread articles are marked as
2001 spam.  There is other behavior associated with ham and no
2002 classification when spam.el is loaded - see the manual.")
2003
2004   (gnus-define-group-parameter
2005    spam-resend-to
2006    :type list
2007    :function-document
2008    "The address to get spam resent (through spam-report-resend)."
2009    :variable gnus-spam-resend-to
2010    :variable-default nil
2011    :variable-document
2012    "The address to get spam resent (through spam-report-resend)."
2013    :variable-group spam
2014    :variable-type '(repeat
2015                     (list :tag "Group address for resending spam"
2016                           (regexp :tag "Group")
2017                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
2018    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
2019    :parameter-document
2020    "The address to get spam resent (through spam-report-resend).")
2021
2022   (gnus-define-group-parameter
2023    ham-resend-to
2024    :type list
2025    :function-document
2026    "The address to get ham resent (through spam-report-resend)."
2027    :variable gnus-ham-resend-to
2028    :variable-default nil
2029    :variable-document
2030    "The address to get ham resent (through spam-report-resend)."
2031    :variable-group spam
2032    :variable-type '(repeat
2033                     (list :tag "Group address for resending ham"
2034                           (regexp :tag "Group")
2035                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
2036    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
2037    :parameter-document
2038    "The address to get ham resent (through spam-report-resend).")
2039
2040   (defvar gnus-group-spam-exit-processor-ifile "ifile"
2041     "OBSOLETE: The ifile summary exit spam processor.")
2042
2043   (defvar gnus-group-spam-exit-processor-stat "stat"
2044     "OBSOLETE: The spam-stat summary exit spam processor.")
2045
2046   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
2047     "OBSOLETE: The Bogofilter summary exit spam processor.")
2048
2049   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
2050     "OBSOLETE: The Blacklist summary exit spam processor.")
2051
2052   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
2053     "OBSOLETE: The Gmane reporting summary exit spam processor.
2054 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
2055
2056   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
2057     "OBSOLETE: The spamoracle summary exit spam processor.")
2058
2059   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
2060     "OBSOLETE: The ifile summary exit ham processor.
2061 Only applicable to non-spam (unclassified and ham) groups.")
2062
2063   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
2064     "OBSOLETE: The Bogofilter summary exit ham processor.
2065 Only applicable to non-spam (unclassified and ham) groups.")
2066
2067   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
2068     "OBSOLETE: The spam-stat summary exit ham processor.
2069 Only applicable to non-spam (unclassified and ham) groups.")
2070
2071   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
2072     "OBSOLETE: The whitelist summary exit ham processor.
2073 Only applicable to non-spam (unclassified and ham) groups.")
2074
2075   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
2076     "OBSOLETE: The BBDB summary exit ham processor.
2077 Only applicable to non-spam (unclassified and ham) groups.")
2078
2079   (defvar gnus-group-ham-exit-processor-copy "copy"
2080     "OBSOLETE: The ham copy exit ham processor.
2081 Only applicable to non-spam (unclassified and ham) groups.")
2082
2083   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2084     "OBSOLETE: The spamoracle summary exit ham processor.
2085 Only applicable to non-spam (unclassified and ham) groups.")
2086
2087   (gnus-define-group-parameter
2088    spam-process
2089    :type list
2090    :parameter-type
2091    '(choice
2092      :tag "Spam Summary Exit Processor"
2093      :value nil
2094      (list :tag "Spam Summary Exit Processor Choices"
2095            (set
2096             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2097             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2098             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2099             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2100             (const :tag "Spam: Resend Message"(spam spam-use-resend))
2101             (const :tag "Spam: ifile"         (spam spam-use-ifile))
2102             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2103             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2104             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2105             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2106             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2107             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2108             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2109             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2110             (const :tag "Ham: Resend Message" (ham spam-use-resend))
2111             (const :tag "Ham: ifile"          (ham spam-use-ifile))
2112             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2113             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2114             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2115             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2116             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2117             (variable-item gnus-group-spam-exit-processor-ifile)
2118             (variable-item gnus-group-spam-exit-processor-stat)
2119             (variable-item gnus-group-spam-exit-processor-bogofilter)
2120             (variable-item gnus-group-spam-exit-processor-blacklist)
2121             (variable-item gnus-group-spam-exit-processor-spamoracle)
2122             (variable-item gnus-group-spam-exit-processor-report-gmane)
2123             (variable-item gnus-group-ham-exit-processor-bogofilter)
2124             (variable-item gnus-group-ham-exit-processor-ifile)
2125             (variable-item gnus-group-ham-exit-processor-stat)
2126             (variable-item gnus-group-ham-exit-processor-whitelist)
2127             (variable-item gnus-group-ham-exit-processor-BBDB)
2128             (variable-item gnus-group-ham-exit-processor-spamoracle)
2129             (variable-item gnus-group-ham-exit-processor-copy))))
2130    :function-document
2131    "Which spam or ham processors will be applied when the summary is exited."
2132    :variable gnus-spam-process-newsgroups
2133    :variable-default nil
2134    :variable-document
2135    "*Groups in which to automatically process spam or ham articles with
2136 a backend on summary exit.  If non-nil, this should be a list of group
2137 name regexps that should match all groups in which to do automatic
2138 spam processing, associated with the appropriate processor."
2139    :variable-group spam
2140    :variable-type
2141    '(repeat :tag "Spam/Ham Processors"
2142             (list :tag "Spam Summary Exit Processor Choices"
2143                   (regexp :tag "Group Regexp")
2144                   (set
2145                    :tag "Spam/Ham Summary Exit Processor"
2146                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2147                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2148                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2149                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2150                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2151                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2152                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2153                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2154                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2155                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2156                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2157                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2158                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2159                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2160                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2161                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2162                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2163                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2164                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2165                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2166                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2167                    (variable-item gnus-group-spam-exit-processor-ifile)
2168                    (variable-item gnus-group-spam-exit-processor-stat)
2169                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2170                    (variable-item gnus-group-spam-exit-processor-blacklist)
2171                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2172                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2173                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2174                    (variable-item gnus-group-ham-exit-processor-ifile)
2175                    (variable-item gnus-group-ham-exit-processor-stat)
2176                    (variable-item gnus-group-ham-exit-processor-whitelist)
2177                    (variable-item gnus-group-ham-exit-processor-BBDB)
2178                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2179                    (variable-item gnus-group-ham-exit-processor-copy))))
2180
2181    :parameter-document
2182    "Which spam or ham processors will be applied when the summary is exited.")
2183
2184   (gnus-define-group-parameter
2185    spam-autodetect
2186    :type list
2187    :parameter-type
2188    '(boolean :tag "Spam autodetection")
2189    :function-document
2190    "Should spam be autodetected (with spam-split) in this group?"
2191    :variable gnus-spam-autodetect
2192    :variable-default nil
2193    :variable-document
2194    "*Groups in which spam should be autodetected when they are entered.
2195    Only unseen articles will be examined, unless
2196    spam-autodetect-recheck-messages is set."
2197    :variable-group spam
2198    :variable-type
2199    '(repeat
2200      :tag "Autodetection setting"
2201      (list
2202       (regexp :tag "Group Regexp")
2203       boolean))
2204    :parameter-document
2205    "Spam autodetection.
2206 Only unseen articles will be examined, unless
2207 spam-autodetect-recheck-messages is set.")
2208
2209   (gnus-define-group-parameter
2210    spam-autodetect-methods
2211    :type list
2212    :parameter-type
2213    '(choice :tag "Spam autodetection-specific methods"
2214      (const none)
2215      (const default)
2216      (set :tag "Use specific methods"
2217           (variable-item spam-use-blacklist)
2218           (variable-item spam-use-gmane-xref)
2219           (variable-item spam-use-regex-headers)
2220           (variable-item spam-use-regex-body)
2221           (variable-item spam-use-whitelist)
2222           (variable-item spam-use-BBDB)
2223           (variable-item spam-use-ifile)
2224           (variable-item spam-use-spamoracle)
2225           (variable-item spam-use-crm114)
2226           (variable-item spam-use-spamassassin)
2227           (variable-item spam-use-spamassassin-headers)
2228           (variable-item spam-use-bsfilter)
2229           (variable-item spam-use-bsfilter-headers)
2230           (variable-item spam-use-stat)
2231           (variable-item spam-use-blackholes)
2232           (variable-item spam-use-hashcash)
2233           (variable-item spam-use-bogofilter-headers)
2234           (variable-item spam-use-bogofilter)))
2235    :function-document
2236    "Methods to be used for autodetection in each group"
2237    :variable gnus-spam-autodetect-methods
2238    :variable-default nil
2239    :variable-document
2240    "*Methods for autodetecting spam per group.
2241 Requires the spam-autodetect parameter.  Only unseen articles
2242 will be examined, unless spam-autodetect-recheck-messages is
2243 set."
2244    :variable-group spam
2245    :variable-type
2246    '(repeat
2247      :tag "Autodetection methods"
2248      (list
2249       (regexp :tag "Group Regexp")
2250       (choice
2251        (const none)
2252        (const default)
2253        (set :tag "Use specific methods"
2254         (variable-item spam-use-blacklist)
2255         (variable-item spam-use-gmane-xref)
2256         (variable-item spam-use-regex-headers)
2257         (variable-item spam-use-regex-body)
2258         (variable-item spam-use-whitelist)
2259         (variable-item spam-use-BBDB)
2260         (variable-item spam-use-ifile)
2261         (variable-item spam-use-spamoracle)
2262         (variable-item spam-use-crm114)
2263         (variable-item spam-use-stat)
2264         (variable-item spam-use-blackholes)
2265         (variable-item spam-use-hashcash)
2266         (variable-item spam-use-spamassassin)
2267         (variable-item spam-use-spamassassin-headers)
2268         (variable-item spam-use-bsfilter)
2269         (variable-item spam-use-bsfilter-headers)
2270         (variable-item spam-use-bogofilter-headers)
2271         (variable-item spam-use-bogofilter)))))
2272      :parameter-document
2273    "Spam autodetection methods.
2274 Requires the spam-autodetect parameter.  Only unseen articles
2275 will be examined, unless spam-autodetect-recheck-messages is
2276 set.")
2277
2278   (gnus-define-group-parameter
2279    spam-process-destination
2280    :type list
2281    :parameter-type
2282    '(choice :tag "Destination for spam-processed articles at summary exit"
2283             (string :tag "Move to a group")
2284             (repeat :tag "Move to multiple groups"
2285                     (string :tag "Destination group"))
2286             (const :tag "Expire" nil))
2287    :function-document
2288    "Where spam-processed articles will go at summary exit."
2289    :variable gnus-spam-process-destinations
2290    :variable-default nil
2291    :variable-document
2292    "*Groups in which to explicitly send spam-processed articles to
2293 another group, or expire them (the default).  If non-nil, this should
2294 be a list of group name regexps that should match all groups in which
2295 to do spam-processed article moving, associated with the destination
2296 group or nil for explicit expiration.  This only makes sense for
2297 mail groups."
2298    :variable-group spam
2299    :variable-type
2300    '(repeat
2301      :tag "Spam-processed articles destination"
2302      (list
2303       (regexp :tag "Group Regexp")
2304       (choice
2305        :tag "Destination for spam-processed articles at summary exit"
2306        (string :tag "Move to a group")
2307        (repeat :tag "Move to multiple groups"
2308                (string :tag "Destination group"))
2309        (const :tag "Expire" nil))))
2310    :parameter-document
2311    "Where spam-processed articles will go at summary exit.")
2312
2313   (gnus-define-group-parameter
2314    ham-process-destination
2315    :type list
2316    :parameter-type
2317    '(choice
2318      :tag "Destination for ham articles at summary exit from a spam group"
2319      (string :tag "Move to a group")
2320      (repeat :tag "Move to multiple groups"
2321              (string :tag "Destination group"))
2322      (const :tag "Respool" respool)
2323      (const :tag "Do nothing" nil))
2324    :function-document
2325    "Where ham articles will go at summary exit from a spam group."
2326    :variable gnus-ham-process-destinations
2327    :variable-default nil
2328    :variable-document
2329    "*Groups in which to explicitly send ham articles to
2330 another group, or do nothing (the default).  If non-nil, this should
2331 be a list of group name regexps that should match all groups in which
2332 to do ham article moving, associated with the destination
2333 group or nil for explicit ignoring.  This only makes sense for
2334 mail groups, and only works in spam groups."
2335    :variable-group spam
2336    :variable-type
2337    '(repeat
2338      :tag "Ham articles destination"
2339      (list
2340       (regexp :tag "Group Regexp")
2341       (choice
2342        :tag "Destination for ham articles at summary exit from spam group"
2343        (string :tag "Move to a group")
2344        (repeat :tag "Move to multiple groups"
2345                 (string :tag "Destination group"))
2346        (const :tag "Respool" respool)
2347        (const :tag "Expire" nil))))
2348    :parameter-document
2349    "Where ham articles will go at summary exit from a spam group.")
2350
2351   (gnus-define-group-parameter
2352    ham-marks
2353    :type 'list
2354    :parameter-type '(list :tag "Ham mark choices"
2355                           (set
2356                            (variable-item gnus-del-mark)
2357                            (variable-item gnus-read-mark)
2358                            (variable-item gnus-ticked-mark)
2359                            (variable-item gnus-killed-mark)
2360                            (variable-item gnus-kill-file-mark)
2361                            (variable-item gnus-low-score-mark)))
2362
2363    :parameter-document
2364    "Marks considered ham (positively not spam).  Such articles will be
2365 processed as ham (non-spam) on group exit.  When nil, the global
2366 spam-ham-marks variable takes precedence."
2367    :variable-default '((".*" ((gnus-del-mark
2368                                gnus-read-mark
2369                                gnus-killed-mark
2370                                gnus-kill-file-mark
2371                                gnus-low-score-mark))))
2372    :variable-group spam
2373    :variable-document
2374    "*Groups in which to explicitly set the ham marks to some value.")
2375
2376   (gnus-define-group-parameter
2377    spam-marks
2378    :type 'list
2379    :parameter-type '(list :tag "Spam mark choices"
2380                           (set
2381                            (variable-item gnus-spam-mark)
2382                            (variable-item gnus-killed-mark)
2383                            (variable-item gnus-kill-file-mark)
2384                            (variable-item gnus-low-score-mark)))
2385
2386    :parameter-document
2387    "Marks considered spam.
2388 Such articles will be processed as spam on group exit.  When nil, the global
2389 spam-spam-marks variable takes precedence."
2390    :variable-default '((".*" ((gnus-spam-mark))))
2391    :variable-group spam
2392    :variable-document
2393    "*Groups in which to explicitly set the spam marks to some value."))
2394
2395 (defcustom gnus-group-uncollapsed-levels 1
2396   "Number of group name elements to leave alone when making a short group name."
2397   :group 'gnus-group-visual
2398   :type 'integer)
2399
2400 (defcustom gnus-group-use-permanent-levels nil
2401   "*If non-nil, once you set a level, Gnus will use this level."
2402   :group 'gnus-group-levels
2403   :type 'boolean)
2404
2405 ;; Hooks.
2406
2407 (defcustom gnus-load-hook nil
2408   "A hook run while Gnus is loaded."
2409   :group 'gnus-start
2410   :type 'hook)
2411
2412 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2413   "A hook called to apply kill files to a group.
2414 This hook is intended to apply a kill file to the selected newsgroup.
2415 The function `gnus-apply-kill-file' is called by default.
2416
2417 Since a general kill file is too heavy to use only for a few
2418 newsgroups, I recommend you to use a lighter hook function.  For
2419 example, if you'd like to apply a kill file to articles which contains
2420 a string `rmgroup' in subject in newsgroup `control', you can use the
2421 following hook:
2422
2423  (setq gnus-apply-kill-hook
2424       (list
2425         (lambda ()
2426           (cond ((string-match \"control\" gnus-newsgroup-name)
2427                  (gnus-kill \"Subject\" \"rmgroup\")
2428                  (gnus-expunge \"X\"))))))"
2429   :group 'gnus-score-kill
2430   :options '(gnus-apply-kill-file)
2431   :type 'hook)
2432
2433 (defcustom gnus-group-change-level-function nil
2434   "Function run when a group level is changed.
2435 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2436   :group 'gnus-group-levels
2437   :type '(choice (const nil)
2438                  function))
2439
2440 ;;; Face thingies.
2441
2442 (defcustom gnus-visual
2443   '(summary-highlight group-highlight article-highlight
2444                       mouse-face
2445                       summary-menu group-menu article-menu
2446                       tree-highlight menu highlight
2447                       browse-menu server-menu
2448                       page-marker tree-menu binary-menu pick-menu)
2449   "*Enable visual features.
2450 If `visual' is disabled, there will be no menus and few faces.  Most of
2451 the visual customization options below will be ignored.  Gnus will use
2452 less space and be faster as a result.
2453
2454 This variable can also be a list of visual elements to switch on.  For
2455 instance, to switch off all visual things except menus, you can say:
2456
2457    (setq gnus-visual '(menu))
2458
2459 Valid elements include `summary-highlight', `group-highlight',
2460 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2461 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2462 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2463   :group 'gnus-meta
2464   :group 'gnus-visual
2465   :type '(set (const summary-highlight)
2466               (const group-highlight)
2467               (const article-highlight)
2468               (const mouse-face)
2469               (const summary-menu)
2470               (const group-menu)
2471               (const article-menu)
2472               (const tree-highlight)
2473               (const menu)
2474               (const highlight)
2475               (const browse-menu)
2476               (const server-menu)
2477               (const page-marker)
2478               (const tree-menu)
2479               (const binary-menu)
2480               (const pick-menu)))
2481
2482 ;; Byte-compiler warning.
2483 (defvar gnus-visual)
2484 ;; Find out whether the gnus-visual TYPE is wanted.
2485 (defun gnus-visual-p (&optional type class)
2486   (and gnus-visual                      ; Has to be non-nil, at least.
2487        (if (not type)                   ; We don't care about type.
2488            gnus-visual
2489          (if (listp gnus-visual)        ; It's a list, so we check it.
2490              (or (memq type gnus-visual)
2491                  (memq class gnus-visual))
2492            t))))
2493
2494 (defcustom gnus-mouse-face
2495   (condition-case ()
2496       (if (gnus-visual-p 'mouse-face 'highlight)
2497           (if (boundp 'gnus-mouse-face)
2498               (or gnus-mouse-face 'highlight)
2499             'highlight)
2500         'default)
2501     (error 'highlight))
2502   "*Face used for group or summary buffer mouse highlighting.
2503 The line beneath the mouse pointer will be highlighted with this
2504 face."
2505   :group 'gnus-visual
2506   :type 'face)
2507
2508 (defcustom gnus-article-save-directory gnus-directory
2509   "*Name of the directory articles will be saved in (default \"~/News\")."
2510   :group 'gnus-article-saving
2511   :type 'directory)
2512
2513 (defvar gnus-plugged t
2514   "Whether Gnus is plugged or not.")
2515
2516 (defcustom gnus-agent-cache t
2517   "Controls use of the agent cache while plugged.
2518 When set, Gnus will prefer using the locally stored content rather
2519 than re-fetching it from the server.  You also need to enable
2520 `gnus-agent' for this to have any affect."
2521   :version "22.1"
2522   :group 'gnus-agent
2523   :type 'boolean)
2524
2525 (defcustom gnus-default-charset 'undecided
2526   "Default charset assumed to be used when viewing non-ASCII characters.
2527 This variable is overridden on a group-to-group basis by the
2528 `gnus-group-charset-alist' variable and is only used on groups not
2529 covered by that variable."
2530   :type 'symbol
2531   :group 'gnus-charset)
2532
2533 ;; Fixme: Doc reference to agent.
2534 (defcustom gnus-agent t
2535   "Whether we want to use the Gnus agent or not.
2536
2537 You may customize gnus-agent to disable its use.  However, some
2538 back ends have started to use the agent as a client-side cache.
2539 Disabling the agent may result in noticeable loss of performance."
2540   :version "22.1"
2541   :group 'gnus-agent
2542   :type 'boolean)
2543
2544 (defcustom gnus-other-frame-function 'gnus
2545   "Function called by the command `gnus-other-frame'."
2546   :group 'gnus-start
2547   :type '(choice (function-item gnus)
2548                  (function-item gnus-no-server)
2549                  (function-item gnus-slave)
2550                  (function-item gnus-slave-no-server)))
2551
2552 (defcustom gnus-other-frame-parameters nil
2553   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2554 This should be an alist for Emacs, or a plist for XEmacs."
2555   :group 'gnus-start
2556   :type (if (featurep 'xemacs)
2557             '(repeat (list :inline t :format "%v"
2558                            (symbol :tag "Property")
2559                            (sexp :tag "Value")))
2560           '(repeat (cons :format "%v"
2561                          (symbol :tag "Parameter")
2562                          (sexp :tag "Value")))))
2563
2564 (defcustom gnus-user-agent '(emacs gnus mime config mule)
2565   "Which information should be exposed in the User-Agent header.
2566
2567 Can be a list of symbols or a string.  Valid symbols are `gnus' (show
2568 Gnus version), `emacs' (show Emacs version) and `mime' (show SEMI,
2569 FLIM and APEL versions).  In addition to the Emacs version, you can
2570 add `codename' (show (S)XEmacs codename), `mule' (show Mule version
2571 and also Meadow version if it exists) or either `config' (show system
2572 configuration) or `type' (show system type).  If you set it to a
2573 string, be sure to use a valid format, see RFC 2616."
2574
2575   :version "22.1"
2576   :group 'gnus-message
2577   :type '(choice (list (set :format "%v" :inline t
2578                             (const gnus  :tag "Gnus version")
2579                             (const emacs :tag "Emacs version")
2580                             (choice :tag "system"
2581                                     (const type   :tag "system type")
2582                                     (const config :tag "system configuration"))
2583                             (const codename :tag "Emacs codename")
2584                             (const mime :tag "SEMI and FLIM versions")
2585                             (const mule
2586                                    :tag "Mule version (and Meadow version)")))
2587                  (string :format "%t:\n%v")))
2588
2589 ;; Convert old (< 2005-01-10) symbol type values:
2590 (when (symbolp gnus-user-agent)
2591   (setq gnus-user-agent
2592         (cond ((eq gnus-user-agent 'gnus-mime-edit)
2593                '(emacs gnus mime config mule))
2594               ((eq gnus-user-agent 'emacs-gnus-config)
2595                '(emacs gnus config))
2596               ((eq gnus-user-agent 'emacs-gnus-type)
2597                '(emacs gnus type))
2598               ((eq gnus-user-agent 'emacs-gnus)
2599                '(emacs gnus))
2600               ((eq gnus-user-agent 'gnus)
2601                '(gnus))
2602               (t gnus-user-agent)))
2603   (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2604   (sit-for 1)
2605   (if (get 'gnus-user-agent 'saved-value)
2606       (customize-save-variable 'gnus-user-agent gnus-user-agent)
2607     (gnus-message 1 "Edit your init file to make this change permanent.")
2608     (sit-for 2)))
2609
2610 \f
2611 ;;; Internal variables
2612
2613 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2614 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2615 (defvar gnus-agent-method-p-cache nil
2616   ; Reset each time gnus-agent-covered-methods is changed else
2617   ; gnus-agent-method-p may mis-report a methods status.
2618   )
2619 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2620 (defvar gnus-draft-meta-information-header "X-Draft-From")
2621 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2622 (defvar gnus-original-article-buffer " *Original Article*")
2623 (defvar gnus-newsgroup-name nil)
2624 (defvar gnus-ephemeral-servers nil)
2625 (defvar gnus-server-method-cache nil)
2626
2627 (defvar gnus-agent-fetching nil
2628   "Whether Gnus agent is in fetching mode.")
2629
2630 (defvar gnus-agent-covered-methods nil
2631   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2632
2633 (defvar gnus-command-method nil
2634   "Dynamically bound variable that says what the current back end is.")
2635
2636 (defvar gnus-current-select-method nil
2637   "The current method for selecting a newsgroup.")
2638
2639 (defvar gnus-tree-buffer "*Tree*"
2640   "Buffer where Gnus thread trees are displayed.")
2641
2642 ;; Dummy variable.
2643 (defvar gnus-use-generic-from nil)
2644
2645 ;; Variable holding the user answers to all method prompts.
2646 (defvar gnus-method-history nil)
2647
2648 ;; Variable holding the user answers to all mail method prompts.
2649 (defvar gnus-mail-method-history nil)
2650
2651 ;; Variable holding the user answers to all group prompts.
2652 (defvar gnus-group-history nil)
2653
2654 (defvar gnus-server-alist nil
2655   "List of available servers.")
2656
2657 (defcustom gnus-cache-directory
2658   (nnheader-concat gnus-directory "cache/")
2659   "*The directory where cached articles will be stored."
2660   :group 'gnus-cache
2661   :type 'directory)
2662
2663 (defvar gnus-predefined-server-alist
2664   `(("cache"
2665      nnspool "cache"
2666      (nnspool-spool-directory ,gnus-cache-directory)
2667      (nnspool-nov-directory ,gnus-cache-directory)
2668      (nnspool-active-file
2669       ,(nnheader-concat gnus-cache-directory "active"))))
2670   "List of predefined (convenience) servers.")
2671
2672 (defvar gnus-topic-indentation "");; Obsolete variable.
2673
2674 (defconst gnus-article-mark-lists
2675   '((marked . tick) (replied . reply)
2676     (expirable . expire) (killed . killed)
2677     (bookmarks . bookmark) (dormant . dormant)
2678     (scored . score) (saved . save)
2679     (cached . cache) (downloadable . download)
2680     (unsendable . unsend) (forwarded . forward)
2681     (recent . recent) (seen . seen)))
2682
2683 (defconst gnus-article-special-mark-lists
2684   '((seen range)
2685     (killed range)
2686     (bookmark tuple)
2687     (score tuple)))
2688
2689 ;; Propagate flags to server, with the following exceptions:
2690 ;; `seen' is private to each gnus installation
2691 ;; `cache' is a internal gnus flag for each gnus installation
2692 ;; `download' is a agent flag private to each gnus installation
2693 ;; `unsend' are for nndraft groups only
2694 ;; `score' is not a proper mark
2695 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2696 (defconst gnus-article-unpropagated-mark-lists
2697   '(seen cache download unsend score bookmark)
2698   "Marks that shouldn't be propagated to back ends.
2699 Typical marks are those that make no sense in a standalone back end,
2700 such as a mark that says whether an article is stored in the cache
2701 \(which doesn't make sense in a standalone back end).")
2702
2703 (defvar gnus-headers-retrieved-by nil)
2704 (defvar gnus-article-reply nil)
2705 (defvar gnus-override-method nil)
2706 (defvar gnus-opened-servers nil)
2707
2708 (defvar gnus-current-kill-article nil)
2709
2710 (defvar gnus-have-read-active-file nil)
2711
2712 (defconst gnus-maintainer
2713   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2714   "The mail address of the T-gnus maintainers.")
2715
2716 (defcustom gnus-info-filename nil
2717   "*Controls language of gnus Info.
2718 If nil and current-language-environment is Japanese, go to gnus-ja.
2719 Otherwise go to corresponding Info.
2720 This variable can be nil, gnus or gnus-ja."
2721   :group 'gnus-start
2722   :type '(choice (const nil)
2723                  (const :tag "English" gnus)
2724                  (const :tag "Japanese" gnus-ja)))
2725
2726 (defvar gnus-info-nodes
2727   '((gnus-group-mode "Group Buffer")
2728     (gnus-summary-mode "Summary Buffer")
2729     (gnus-article-mode "Article Buffer")
2730     (gnus-server-mode "Server Buffer")
2731     (gnus-browse-mode "Browse Foreign Server")
2732     (gnus-tree-mode "Tree Display"))
2733   "Alist of major modes and related Info nodes.")
2734
2735 (defvar gnus-group-buffer "*Group*")
2736 (defvar gnus-summary-buffer "*Summary*")
2737 (defvar gnus-article-buffer "*Article*")
2738 (defvar gnus-server-buffer "*Server*")
2739
2740 (defvar gnus-slave nil
2741   "Whether this Gnus is a slave or not.")
2742
2743 (defvar gnus-batch-mode nil
2744   "Whether this Gnus is running in batch mode or not.")
2745
2746 (defvar gnus-variable-list
2747   '(gnus-newsrc-options gnus-newsrc-options-n
2748                         gnus-newsrc-last-checked-date
2749                         gnus-newsrc-alist gnus-server-alist
2750                         gnus-killed-list gnus-zombie-list
2751                         gnus-topic-topology gnus-topic-alist)
2752   "Gnus variables saved in the quick startup file.")
2753
2754 (defvar gnus-product-variable-file-list
2755   (let ((version (product-version (product-find 'gnus-vers))))
2756     `(("strict-cache"
2757        ((product-version ,version)
2758         (emacs-version)
2759         (correct-string-widths))
2760        binary
2761        gnus-format-specs-compiled)
2762       ("cache"
2763        ((product-version ,version)
2764         (emacs-version)
2765         (correct-string-widths))
2766        ctext
2767        gnus-format-specs)))
2768   "Alist of the methods for checking whether the contents of the T-gnus
2769 quick startup files are valid.  One is for the byte-compiled format
2770 specifications, the other is for the source form.  Each element should
2771 be a list which looks like follows:
2772
2773 \(\"FILE_NAME\"
2774  ((VARIABLE EXPECTED_VALUE_or_NIL)
2775   (VARIABLE EXPECTED_VALUE_or_NIL)
2776   ...)
2777  CODING-SYSTEM_FOR_READING_FILE
2778  SYMBOL_OF_FORMAT_SPECS)")
2779
2780 (defcustom gnus-compile-user-specs t
2781   "If non-nil, the user-defined format specs will be byte-compiled
2782 automatically.
2783 It has an effect on the values of `gnus-*-line-format-spec'."
2784   :group 'gnus
2785   :type 'boolean)
2786
2787 (defvar gnus-newsrc-alist nil
2788   "Assoc list of read articles.
2789 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2790
2791 (defvar gnus-registry-alist nil
2792   "Assoc list of registry data.
2793 gnus-registry.el will populate this if it's loaded.")
2794
2795 (defvar gnus-newsrc-hashtb nil
2796   "Hashtable of `gnus-newsrc-alist'.")
2797
2798 (defvar gnus-killed-list nil
2799   "List of killed newsgroups.")
2800
2801 (defvar gnus-killed-hashtb nil
2802   "Hash table equivalent of `gnus-killed-list'.")
2803
2804 (defvar gnus-zombie-list nil
2805   "List of almost dead newsgroups.")
2806
2807 (defvar gnus-description-hashtb nil
2808   "Descriptions of newsgroups.")
2809
2810 (defvar gnus-list-of-killed-groups nil
2811   "List of newsgroups that have recently been killed by the user.")
2812
2813 (defvar gnus-active-hashtb nil
2814   "Hashtable of active articles.")
2815
2816 (defvar gnus-moderated-hashtb nil
2817   "Hashtable of moderated newsgroups.")
2818
2819 ;; Save window configuration.
2820 (defvar gnus-prev-winconf nil)
2821
2822 (defvar gnus-reffed-article-number nil)
2823
2824 ;;; Let the byte-compiler know that we know about this variable.
2825 (defvar rmail-default-rmail-file)
2826
2827 (defvar gnus-dead-summary nil)
2828
2829 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2830   "Regexp matching invalid groups.")
2831
2832 (defvar gnus-other-frame-object nil
2833   "A frame object which will be created by `gnus-other-frame'.")
2834
2835 ;;; End of variables.
2836
2837 ;; Define some autoload functions Gnus might use.
2838 (eval-and-compile
2839
2840   ;; This little mapcar goes through the list below and marks the
2841   ;; symbols in question as autoloaded functions.
2842   (mapcar
2843    (lambda (package)
2844      (let ((interactive (nth 1 (memq ':interactive package))))
2845        (mapcar
2846         (lambda (function)
2847           (let (keymap)
2848             (when (consp function)
2849               (setq keymap (car (memq 'keymap function)))
2850               (setq function (car function)))
2851             (unless (fboundp function)
2852               (autoload function (car package) nil interactive keymap))))
2853         (if (eq (nth 1 package) ':interactive)
2854             (nthcdr 3 package)
2855           (cdr package)))))
2856    '(("info" :interactive t Info-goto-node)
2857      ("pp" pp-to-string)
2858      ("ps-print" ps-print-preprint)
2859      ("message" :interactive t
2860       message-send-and-exit message-yank-original)
2861      ("babel" babel-as-string)
2862      ("nnmail" nnmail-split-fancy nnmail-article-group)
2863      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2864      ("rmailout" rmail-output rmail-output-to-rmail-file)
2865      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2866       rmail-show-message rmail-summary-exists
2867       rmail-select-summary rmail-update-summary)
2868      ("gnus-audio" :interactive t gnus-audio-play)
2869      ("gnus-xmas" gnus-xmas-splash)
2870      ("gnus-soup" :interactive t
2871       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2872       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2873      ("nnsoup" nnsoup-pack-replies)
2874      ("score-mode" :interactive t gnus-score-mode)
2875      ("gnus-mh" gnus-summary-save-article-folder
2876       gnus-Folder-save-name gnus-folder-save-name)
2877      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2878      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2879       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2880       gnus-demon-add-disconnection gnus-demon-add-handler
2881       gnus-demon-remove-handler)
2882      ("gnus-demon" :interactive t
2883       gnus-demon-init gnus-demon-cancel)
2884      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2885       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2886       gnus-face-from-file)
2887      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2888       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2889      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2890       gnus-nocem-unwanted-article-p)
2891      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2892       gnus-server-server-name)
2893      ("gnus-srvr" gnus-browse-foreign-server)
2894      ("gnus-cite" :interactive t
2895       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2896       gnus-article-hide-citation gnus-article-fill-cited-article
2897       gnus-article-hide-citation-in-followups)
2898      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2899       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2900       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2901      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2902       gnus-cache-possibly-remove-articles gnus-cache-request-article
2903       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2904       gnus-cache-enter-remove-article gnus-cached-article-p
2905       gnus-cache-open gnus-cache-close gnus-cache-update-article
2906       gnus-cache-articles-in-group)
2907      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2908       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2909      ("gnus-score" :interactive t
2910       gnus-summary-increase-score gnus-summary-set-score
2911       gnus-summary-raise-thread gnus-summary-raise-same-subject
2912       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2913       gnus-summary-lower-thread gnus-summary-lower-same-subject
2914       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2915       gnus-summary-current-score gnus-score-delta-default
2916       gnus-score-flush-cache gnus-score-close
2917       gnus-possibly-score-headers gnus-score-followup-article
2918       gnus-score-followup-thread)
2919      ("gnus-score"
2920       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2921       gnus-current-score-file-nondirectory gnus-score-adaptive
2922       gnus-score-find-trace gnus-score-file-name)
2923      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2924       gnus-score-customize)
2925      ("gnus-topic" :interactive t gnus-topic-mode)
2926      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2927       gnus-subscribe-topics)
2928      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2929      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2930      ("gnus-uu" :interactive t
2931       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2932       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2933       gnus-uu-mark-by-regexp gnus-uu-mark-all
2934       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2935       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2936       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2937       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2938       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2939       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2940       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2941       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2942      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2943       gnus-uu-unmark-thread)
2944      ("gnus-msg" (gnus-summary-send-map keymap)
2945       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2946      ("gnus-msg" :interactive t
2947       gnus-group-post-news gnus-group-mail gnus-group-news
2948       gnus-summary-post-news gnus-summary-news-other-window
2949       gnus-summary-followup gnus-summary-followup-with-original
2950       gnus-summary-cancel-article gnus-summary-supersede-article
2951       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2952       gnus-summary-mail-forward gnus-summary-mail-other-window
2953       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2954       gnus-summary-wide-reply gnus-summary-followup-to-mail
2955       gnus-summary-followup-to-mail-with-original gnus-bug
2956       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2957       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2958      ("gnus-picon" :interactive t gnus-treat-from-picon)
2959      ("smiley" :interactive t smiley-region)
2960      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2961      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2962       gnus-list-of-unread-articles gnus-list-of-read-articles
2963       gnus-offer-save-summaries gnus-make-thread-indent-array
2964       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2965       gnus-summary-skip-intangible gnus-summary-article-number
2966       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2967      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2968       gnus-group-list-groups gnus-group-first-unread-group
2969       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2970       gnus-group-setup-buffer gnus-group-get-new-news
2971       gnus-group-make-help-group gnus-group-update-group
2972       gnus-group-iterate gnus-group-group-name)
2973      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2974       gnus-backlog-remove-article)
2975      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2976       gnus-article-prepare gnus-article-set-window-start
2977       gnus-article-next-page gnus-article-prev-page
2978       gnus-request-article-this-buffer gnus-article-mode
2979       gnus-article-setup-buffer gnus-narrow-to-page
2980       gnus-article-delete-invisible-text gnus-treat-article)
2981      ("gnus-art" :interactive t
2982       gnus-article-hide-headers gnus-article-hide-boring-headers
2983       gnus-article-treat-overstrike
2984       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2985       gnus-article-display-x-face
2986       gnus-article-decode-HZ
2987       gnus-article-wash-html
2988       gnus-article-unsplit-urls
2989       gnus-article-hide-pem gnus-article-hide-signature
2990       gnus-article-strip-leading-blank-lines gnus-article-date-local
2991       gnus-article-date-original gnus-article-date-lapsed
2992       gnus-article-show-all-headers
2993       ;; gnus-article-show-all
2994       gnus-article-edit-mode gnus-article-edit-article
2995       gnus-article-edit-done article-decode-encoded-words
2996       gnus-start-date-timer gnus-stop-date-timer)
2997      ("gnus-int" gnus-request-type)
2998      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2999       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
3000       gnus-check-reasonable-setup)
3001      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
3002       gnus-dup-enter-articles)
3003      ("gnus-range" gnus-copy-sequence)
3004      ("gnus-eform" gnus-edit-form)
3005      ("gnus-move" :interactive t
3006       gnus-group-move-group-to-server gnus-change-server)
3007      ("gnus-logic" gnus-score-advanced)
3008      ("gnus-undo" gnus-undo-mode gnus-undo-register)
3009      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
3010       gnus-async-prefetch-article gnus-async-prefetch-remove-group
3011       gnus-async-halt-prefetch)
3012      ("gnus-offline"
3013       gnus-offline-setup)
3014      ("gnus-offline" :interactive t
3015       gnus-offline-toggle-plugged
3016       gnus-offline-set-unplugged-state
3017       gnus-offline-toggle-auto-hangup
3018       gnus-offline-toggle-on/off-send-mail
3019       gnus-offline-toggle-articles-to-fetch
3020       gnus-offline-set-interval-time
3021       gnus-offline-agent-expire)
3022      ("miee" :interactive t gnspool-get-news
3023       mail-spool-send news-spool-post)
3024      ("international/mw32misc" define-process-argument-editing
3025       general-process-argument-editing-function)
3026      ("gnus-agent" gnus-open-agent gnus-agent-get-function
3027       gnus-agent-save-active gnus-agent-method-p
3028       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
3029       gnus-summary-set-agent-mark gnus-agent-save-group-info
3030       gnus-agent-request-article gnus-agent-retrieve-headers)
3031      ("gnus-agent" :interactive t
3032       gnus-unplugged gnus-agentize gnus-agent-batch)
3033      ("gnus-vm" :interactive t gnus-summary-save-in-vm
3034       gnus-summary-save-article-vm)
3035      ("compface" uncompface)
3036      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
3037      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
3038      ("gnus-mlspl" :interactive t gnus-group-split-setup
3039       gnus-group-split-update)
3040      ("gnus-delay" gnus-delay-initialize))))
3041
3042 ;; To search articles with Namazu.
3043 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
3044 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
3045 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
3046 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
3047
3048 ;; To make nnir groups.
3049 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
3050
3051 ;; To make shimbun groups.
3052 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
3053
3054 ;;; gnus-sum.el thingies
3055
3056 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
3057   "*The format specification of the lines in the summary buffer.
3058
3059 It works along the same lines as a normal formatting string,
3060 with some simple extensions.
3061
3062 %N   Article number, left padded with spaces (string)
3063 %S   Subject (string)
3064 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
3065 %n   Name of the poster (string)
3066 %a   Extracted name of the poster (string)
3067 %A   Extracted address of the poster (string)
3068 %F   Contents of the From: header (string)
3069 %f   Contents of the From: or To: headers (string)
3070 %x   Contents of the Xref: header (string)
3071 %D   Date of the article (string)
3072 %d   Date of the article (string) in DD-MMM format
3073 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
3074 %M   Message-id of the article (string)
3075 %r   References of the article (string)
3076 %c   Number of characters in the article (integer)
3077 %k   Pretty-printed version of the above (string)
3078      For example, \"1.2k\" or \"0.4M\".
3079 %L   Number of lines in the article (integer)
3080 %I   Indentation based on thread level (a string of spaces)
3081 %B   A complex trn-style thread tree (string)
3082      The variables `gnus-sum-thread-*' can be used for customization.
3083 %T   A string with two possible values: 80 spaces if the article
3084      is on thread level two or larger and 0 spaces on level one
3085 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
3086 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
3087 %[   Opening bracket (character, \"[\" or \"<\")
3088 %]   Closing bracket (character, \"]\" or \">\")
3089 %>   Spaces of length thread-level (string)
3090 %<   Spaces of length (- 20 thread-level) (string)
3091 %i   Article score (number)
3092 %z   Article zcore (character)
3093 %t   Number of articles under the current thread (number).
3094 %e   Whether the thread is empty or not (character).
3095 %V   Total thread score (number).
3096 %P   The line number (number).
3097 %O   Download mark (character).
3098 %*   If present, indicates desired cursor position
3099      (instead of after first colon).
3100 %u   User defined specifier.  The next character in the format string should
3101      be a letter.  Gnus will call the function gnus-user-format-function-X,
3102      where X is the letter following %u.  The function will be passed the
3103      current header as argument.  The function should return a string, which
3104      will be inserted into the summary just like information from any other
3105      summary specifier.
3106
3107 The %U (status), %R (replied) and %z (zcore) specs have to be handled
3108 with care.  For reasons of efficiency, Gnus will compute what column
3109 these characters will end up in, and \"hard-code\" that.  This means that
3110 it is invalid to have these specs after a variable-length spec.  Well,
3111 you might not be arrested, but your summary buffer will look strange,
3112 which is bad enough.
3113
3114 The smart choice is to have these specs as far to the left as
3115 possible.
3116
3117 This restriction may disappear in later versions of Gnus.
3118
3119 General format specifiers can also be used.
3120 See Info node `(gnus)Formatting Variables'."
3121   :link '(custom-manual "(gnus)Formatting Variables")
3122   :type 'string
3123   :group 'gnus-summary-format)
3124
3125 ;;;
3126 ;;; Skeleton keymaps
3127 ;;;
3128
3129 (defun gnus-suppress-keymap (keymap)
3130   (suppress-keymap keymap)
3131   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3132     (while keys
3133       (define-key keymap (pop keys) 'undefined))))
3134
3135 (defvar gnus-article-mode-map
3136   (let ((keymap (make-sparse-keymap)))
3137     (gnus-suppress-keymap keymap)
3138     keymap))
3139 (defvar gnus-summary-mode-map
3140   (let ((keymap (make-keymap)))
3141     (gnus-suppress-keymap keymap)
3142     keymap))
3143 (defvar gnus-group-mode-map
3144   (let ((keymap (make-keymap)))
3145     (gnus-suppress-keymap keymap)
3146     keymap))
3147
3148 \f
3149
3150 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3151 ;; If you want the cursor to go somewhere else, set these two
3152 ;; functions in some startup hook to whatever you want.
3153 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3154 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3155
3156 ;;; Various macros and substs.
3157
3158 (defun gnus-header-from (header)
3159   (mail-header-from header))
3160
3161 (defmacro gnus-gethash (string hashtable)
3162   "Get hash value of STRING in HASHTABLE."
3163   `(symbol-value (intern-soft ,string ,hashtable)))
3164
3165 (defmacro gnus-gethash-safe (string hashtable)
3166   "Get hash value of STRING in HASHTABLE.
3167 Return nil if not defined."
3168   `(let ((sym (intern-soft ,string ,hashtable)))
3169      (and (boundp sym) (symbol-value sym))))
3170
3171 (defmacro gnus-sethash (string value hashtable)
3172   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3173   `(set (intern ,string ,hashtable) ,value))
3174 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3175
3176 (defmacro gnus-group-unread (group)
3177   "Get the currently computed number of unread articles in GROUP."
3178   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3179
3180 (defmacro gnus-group-entry (group)
3181   "Get the newsrc entry for GROUP."
3182   `(gnus-gethash ,group gnus-newsrc-hashtb))
3183
3184 (defmacro gnus-active (group)
3185   "Get active info on GROUP."
3186   `(gnus-gethash ,group gnus-active-hashtb))
3187
3188 (defmacro gnus-set-active (group active)
3189   "Set GROUP's active info."
3190   `(gnus-sethash ,group ,active gnus-active-hashtb))
3191
3192 ;; Info access macros.
3193
3194 (defmacro gnus-info-group (info)
3195   `(nth 0 ,info))
3196 (defmacro gnus-info-rank (info)
3197   `(nth 1 ,info))
3198 (defmacro gnus-info-read (info)
3199   `(nth 2 ,info))
3200 (defmacro gnus-info-marks (info)
3201   `(nth 3 ,info))
3202 (defmacro gnus-info-method (info)
3203   `(nth 4 ,info))
3204 (defmacro gnus-info-params (info)
3205   `(nth 5 ,info))
3206
3207 (defmacro gnus-info-level (info)
3208   `(let ((rank (gnus-info-rank ,info)))
3209      (if (consp rank)
3210          (car rank)
3211        rank)))
3212 (defmacro gnus-info-score (info)
3213   `(let ((rank (gnus-info-rank ,info)))
3214      (or (and (consp rank) (cdr rank)) 0)))
3215
3216 (defmacro gnus-info-set-group (info group)
3217   `(setcar ,info ,group))
3218 (defmacro gnus-info-set-rank (info rank)
3219   `(setcar (nthcdr 1 ,info) ,rank))
3220 (defmacro gnus-info-set-read (info read)
3221   `(setcar (nthcdr 2 ,info) ,read))
3222 (defmacro gnus-info-set-marks (info marks &optional extend)
3223   (if extend
3224       `(gnus-info-set-entry ,info ,marks 3)
3225     `(setcar (nthcdr 3 ,info) ,marks)))
3226 (defmacro gnus-info-set-method (info method &optional extend)
3227   (if extend
3228       `(gnus-info-set-entry ,info ,method 4)
3229     `(setcar (nthcdr 4 ,info) ,method)))
3230 (defmacro gnus-info-set-params (info params &optional extend)
3231   (if extend
3232       `(gnus-info-set-entry ,info ,params 5)
3233     `(setcar (nthcdr 5 ,info) ,params)))
3234
3235 (defun gnus-info-set-entry (info entry number)
3236   ;; Extend the info until we have enough elements.
3237   (while (<= (length info) number)
3238     (nconc info (list nil)))
3239   ;; Set the entry.
3240   (setcar (nthcdr number info) entry))
3241
3242 (defmacro gnus-info-set-level (info level)
3243   `(let ((rank (cdr ,info)))
3244      (if (consp (car rank))
3245          (setcar (car rank) ,level)
3246        (setcar rank ,level))))
3247 (defmacro gnus-info-set-score (info score)
3248   `(let ((rank (cdr ,info)))
3249      (if (consp (car rank))
3250          (setcdr (car rank) ,score)
3251        (setcar rank (cons (car rank) ,score)))))
3252
3253 (defmacro gnus-get-info (group)
3254   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3255
3256 ;;; Load the compatibility functions.
3257
3258 (require 'gnus-ems)
3259
3260 \f
3261 ;;;
3262 ;;; Shutdown
3263 ;;;
3264
3265 (defvar gnus-shutdown-alist nil)
3266
3267 (defun gnus-add-shutdown (function &rest symbols)
3268   "Run FUNCTION whenever one of SYMBOLS is shut down."
3269   (push (cons function symbols) gnus-shutdown-alist))
3270
3271 (defun gnus-shutdown (symbol)
3272   "Shut down everything that waits for SYMBOL."
3273   (dolist (entry gnus-shutdown-alist)
3274     (when (memq symbol (cdr entry))
3275       (funcall (car entry)))))
3276
3277 \f
3278 ;;;
3279 ;;; Gnus Utility Functions
3280 ;;;
3281
3282 (defun gnus-find-subscribed-addresses ()
3283   "Return a regexp matching the addresses of all subscribed mail groups.
3284 It consists of the `to-address' or `to-list' parameter of all groups
3285 with a `subscribed' parameter."
3286   (let (group address addresses)
3287     (dolist (entry (cdr gnus-newsrc-alist))
3288       (setq group (car entry))
3289       (when (gnus-parameter-subscribed group)
3290         (setq address (mail-strip-quoted-names
3291                        (or (gnus-group-fast-parameter group 'to-address)
3292                            (gnus-group-fast-parameter group 'to-list))))
3293         (when address
3294           (add-to-list 'addresses address))))
3295     (when addresses
3296       (list (mapconcat 'regexp-quote addresses "\\|")))))
3297
3298 (defmacro gnus-string-or (&rest strings)
3299   "Return the first element of STRINGS that is a non-blank string.
3300 STRINGS will be evaluated in normal `or' order."
3301   `(gnus-string-or-1 ',strings))
3302
3303 (defun gnus-string-or-1 (strings)
3304   (let (string)
3305     (while strings
3306       (setq string (eval (pop strings)))
3307       (if (string-match "^[ \t]*$" string)
3308           (setq string nil)
3309         (setq strings nil)))
3310     string))
3311
3312 (defun gnus-info-find-node (&optional nodename)
3313   "Find Info documentation of Gnus."
3314   (interactive)
3315   ;; Enlarge info window if needed.
3316   (let (gnus-info-buffer)
3317     (Info-goto-node
3318      (format "(%s)%s"
3319              (or gnus-info-filename
3320                  (get-language-info current-language-environment 'gnus-info)
3321                  "gnus")
3322              (or nodename
3323                  (cadr (assq major-mode gnus-info-nodes))
3324                  (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3325                       (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3326     (setq gnus-info-buffer (current-buffer))
3327     (gnus-configure-windows 'info)))
3328
3329 ;;;
3330 ;;; gnus-interactive
3331 ;;;
3332
3333 (defvar gnus-current-prefix-symbol nil
3334   "Current prefix symbol.")
3335
3336 (defvar gnus-current-prefix-symbols nil
3337   "List of current prefix symbols.")
3338
3339 (defun gnus-interactive (string &optional params)
3340   "Return a list that can be fed to `interactive'.
3341 See `interactive' for full documentation.
3342
3343 Adds the following specs:
3344
3345 y -- The current symbolic prefix.
3346 Y -- A list of the current symbolic prefix(es).
3347 A -- Article number.
3348 H -- Article header.
3349 g -- Group name."
3350   (let ((i 0)
3351         out c prompt)
3352     (while (< i (length string))
3353       (string-match ".\\([^\n]*\\)\n?" string i)
3354       (setq c (aref string i))
3355       (when (match-end 1)
3356         (setq prompt (match-string 1 string)))
3357       (setq i (match-end 0))
3358       ;; We basically emulate just about everything that
3359       ;; `interactive' does, but add the specs listed above.
3360       (push
3361        (cond
3362         ((= c ?a)
3363          (completing-read prompt obarray 'fboundp t))
3364         ((= c ?b)
3365          (read-buffer prompt (current-buffer) t))
3366         ((= c ?B)
3367          (read-buffer prompt (other-buffer (current-buffer))))
3368         ((= c ?c)
3369          (read-char))
3370         ((= c ?C)
3371          (completing-read prompt obarray 'commandp t))
3372         ((= c ?d)
3373          (point))
3374         ((= c ?D)
3375          (read-file-name prompt nil default-directory 'lambda))
3376         ((= c ?f)
3377          (read-file-name prompt nil nil 'lambda))
3378         ((= c ?F)
3379          (read-file-name prompt))
3380         ((= c ?k)
3381          (read-key-sequence prompt))
3382         ((= c ?K)
3383          (error "Not implemented spec"))
3384         ((= c ?e)
3385          (error "Not implemented spec"))
3386         ((= c ?m)
3387          (mark))
3388         ((= c ?N)
3389          (error "Not implemented spec"))
3390         ((= c ?n)
3391          (string-to-number (read-from-minibuffer prompt)))
3392         ((= c ?p)
3393          (prefix-numeric-value current-prefix-arg))
3394         ((= c ?P)
3395          current-prefix-arg)
3396         ((= c ?r)
3397          'gnus-prefix-nil)
3398         ((= c ?s)
3399          (read-string prompt))
3400         ((= c ?S)
3401          (intern (read-string prompt)))
3402         ((= c ?v)
3403          (read-variable prompt))
3404         ((= c ?x)
3405          (read-minibuffer prompt))
3406         ((= c ?x)
3407          (eval-minibuffer prompt))
3408         ;; And here the new specs come.
3409         ((= c ?y)
3410          gnus-current-prefix-symbol)
3411         ((= c ?Y)
3412          gnus-current-prefix-symbols)
3413         ((= c ?g)
3414          (gnus-group-group-name))
3415         ((= c ?A)
3416          (gnus-summary-skip-intangible)
3417          (or (get-text-property (point) 'gnus-number)
3418              (gnus-summary-last-subject)))
3419         ((= c ?H)
3420          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3421         (t
3422          (error "Non-implemented spec")))
3423        out)
3424       (cond
3425        ((= c ?r)
3426         (push (if (< (point) (mark)) (point) (mark)) out)
3427         (push (if (> (point) (mark)) (point) (mark)) out))))
3428     (setq out (delq 'gnus-prefix-nil out))
3429     (nreverse out)))
3430
3431 (defun gnus-symbolic-argument (&optional arg)
3432   "Read a symbolic argument and a command, and then execute command."
3433   (interactive "P")
3434   (let* ((in-command (this-command-keys))
3435          (command in-command)
3436          gnus-current-prefix-symbols
3437          gnus-current-prefix-symbol
3438          syms)
3439     (while (equal in-command command)
3440       (message "%s-" (key-description (this-command-keys)))
3441       (push (intern (char-to-string (read-char))) syms)
3442       (setq command (read-key-sequence nil t)))
3443     (setq gnus-current-prefix-symbols (nreverse syms)
3444           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3445     (call-interactively (key-binding command t))))
3446
3447 ;;; More various functions.
3448
3449 (defsubst gnus-check-backend-function (func group)
3450   "Check whether GROUP supports function FUNC.
3451 GROUP can either be a string (a group name) or a select method."
3452   (ignore-errors
3453     (let ((method (if (stringp group)
3454                       (car (gnus-find-method-for-group group))
3455                     group)))
3456       (unless (featurep method)
3457         (require method))
3458       (fboundp (intern (format "%s-%s" method func))))))
3459
3460 (defun gnus-group-read-only-p (&optional group)
3461   "Check whether GROUP supports editing or not.
3462 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3463 that that variable is buffer-local to the summary buffers."
3464   (let ((group (or group gnus-newsgroup-name)))
3465     (not (gnus-check-backend-function 'request-replace-article group))))
3466
3467 (defun gnus-virtual-group-p (group)
3468   "Say whether GROUP is virtual or not."
3469   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3470                         gnus-valid-select-methods)))
3471
3472 (defun gnus-news-group-p (group &optional article)
3473   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3474   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3475          t)                             ;is news of course.
3476         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3477          nil)                           ;must be mail then.
3478         ((vectorp article)              ;Has header info.
3479          (eq (gnus-request-type group (mail-header-id article)) 'news))
3480         ((null article)                 ;Hasn't header info
3481          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3482         ((< article 0)                  ;Virtual message
3483          nil)                           ;we don't know, guess mail.
3484         (t                              ;Has positive number
3485          (eq (gnus-request-type group article) 'news)))) ;use it.
3486
3487 ;; Returns a list of writable groups.
3488 (defun gnus-writable-groups ()
3489   (let ((alist gnus-newsrc-alist)
3490         groups group)
3491     (while (setq group (car (pop alist)))
3492       (unless (gnus-group-read-only-p group)
3493         (push group groups)))
3494     (nreverse groups)))
3495
3496 ;; Check whether to use long file names.
3497 (defun gnus-use-long-file-name (symbol)
3498   ;; The variable has to be set...
3499   (and gnus-use-long-file-name
3500        ;; If it isn't a list, then we return t.
3501        (or (not (listp gnus-use-long-file-name))
3502            ;; If it is a list, and the list contains `symbol', we
3503            ;; return nil.
3504            (not (memq symbol gnus-use-long-file-name)))))
3505
3506 ;; Generate a unique new group name.
3507 (defun gnus-generate-new-group-name (leaf)
3508   (let ((name leaf)
3509         (num 0))
3510     (while (gnus-group-entry name)
3511       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3512     name))
3513
3514 (defun gnus-ephemeral-group-p (group)
3515   "Say whether GROUP is ephemeral or not."
3516   (gnus-group-get-parameter group 'quit-config t))
3517
3518 (defun gnus-group-quit-config (group)
3519   "Return the quit-config of GROUP."
3520   (gnus-group-get-parameter group 'quit-config t))
3521
3522 (defun gnus-kill-ephemeral-group (group)
3523   "Remove ephemeral GROUP from relevant structures."
3524   (gnus-sethash group nil gnus-newsrc-hashtb))
3525
3526 (defun gnus-simplify-mode-line ()
3527   "Make mode lines a bit simpler."
3528   (setq mode-line-modified (cdr gnus-mode-line-modified))
3529   (when (listp mode-line-format)
3530     (make-local-variable 'mode-line-format)
3531     (setq mode-line-format (copy-sequence mode-line-format))
3532     (when (equal (nth 3 mode-line-format) "   ")
3533       (setcar (nthcdr 3 mode-line-format) " "))))
3534
3535 ;;; Servers and groups.
3536
3537 (defsubst gnus-server-add-address (method)
3538   (let ((method-name (symbol-name (car method))))
3539     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3540              (not (assq (intern (concat method-name "-address")) method))
3541              (memq 'physical-address (assq (car method)
3542                                            gnus-valid-select-methods)))
3543         (append method (list (list (intern (concat method-name "-address"))
3544                                    (nth 1 method))))
3545       method)))
3546
3547 (defsubst gnus-method-to-server (method)
3548   (catch 'server-name
3549     (setq method (or method gnus-select-method))
3550
3551     ;; Perhaps it is already in the cache.
3552     (mapc (lambda (name-method)
3553             (if (equal (cdr name-method) method)
3554                 (throw 'server-name (car name-method))))
3555           gnus-server-method-cache)
3556
3557     (mapc
3558      (lambda (server-alist)
3559        (mapc (lambda (name-method)
3560                (when (gnus-methods-equal-p (cdr name-method) method)
3561                  (unless (member name-method gnus-server-method-cache)
3562                    (push name-method gnus-server-method-cache))
3563                  (throw 'server-name (car name-method))))
3564              server-alist))
3565      (let ((alists (list gnus-server-alist
3566                          gnus-predefined-server-alist)))
3567        (if gnus-select-method
3568            (push (list (cons "native" gnus-select-method)) alists))
3569        alists))
3570
3571     (let* ((name (if (member (cadr method) '(nil ""))
3572                      (format "%s" (car method))
3573                    (format "%s:%s" (car method) (cadr method))))
3574            (name-method (cons name method)))
3575       (unless (member name-method gnus-server-method-cache)
3576         (push name-method gnus-server-method-cache))
3577       name)))
3578
3579 (defsubst gnus-server-to-method (server)
3580   "Map virtual server names to select methods."
3581   (or (and server (listp server) server)
3582       (cdr (assoc server gnus-server-method-cache))
3583       (let ((result
3584              (or
3585               ;; Perhaps this is the native server?
3586               (and (equal server "native") gnus-select-method)
3587               ;; It should be in the server alist.
3588               (cdr (assoc server gnus-server-alist))
3589               ;; It could be in the predefined server alist.
3590               (cdr (assoc server gnus-predefined-server-alist))
3591               ;; If not, we look through all the opened server
3592               ;; to see whether we can find it there.
3593               (let ((opened gnus-opened-servers))
3594                 (while (and opened
3595                             (not (equal server (format "%s:%s" (caaar opened)
3596                                                        (cadaar opened)))))
3597                   (pop opened))
3598                 (caar opened))
3599               ;; It could be a named method, search all servers
3600               (let ((servers gnus-secondary-select-methods))
3601                 (while (and servers
3602                             (not (equal server (format "%s:%s" (caar servers)
3603                                                        (cadar servers)))))
3604                   (pop servers))
3605                 (car servers))
3606               ;; This could be some sort of foreign server that I
3607               ;; simply haven't opened (yet).  Do a brute-force scan
3608               ;; of the entire gnus-newsrc-alist for the server name
3609               ;; of every method.  As a side-effect, loads the
3610               ;; gnus-server-method-cache so this only happens once,
3611               ;; if at all.
3612               (let (match)
3613                 (mapcar
3614                  (lambda (info)
3615                    (let ((info-method (gnus-info-method info)))
3616                      (unless (stringp info-method)
3617                        (let ((info-server (gnus-method-to-server info-method)))
3618                          (when (equal server info-server)
3619                            (setq match info-method))))))
3620                  (cdr gnus-newsrc-alist))
3621                 match))))
3622         (when result
3623           (push (cons server result) gnus-server-method-cache))
3624         result)))
3625
3626 (defsubst gnus-server-get-method (group method)
3627   ;; Input either a server name, and extended server name, or a
3628   ;; select method, and return a select method.
3629   (cond ((stringp method)
3630          (gnus-server-to-method method))
3631         ((equal method gnus-select-method)
3632          gnus-select-method)
3633         ((and (stringp (car method))
3634               group)
3635          (gnus-server-extend-method group method))
3636         ((and method
3637               (not group)
3638               (equal (cadr method) ""))
3639          method)
3640         (t
3641          (gnus-server-add-address method))))
3642
3643 (defmacro gnus-method-equal (ss1 ss2)
3644   "Say whether two servers are equal."
3645   `(let ((s1 ,ss1)
3646          (s2 ,ss2))
3647      (or (equal s1 s2)
3648          (and (= (length s1) (length s2))
3649               (progn
3650                 (while (and s1 (member (car s1) s2))
3651                   (setq s1 (cdr s1)))
3652                 (null s1))))))
3653
3654 (defun gnus-methods-equal-p (m1 m2)
3655   (let ((m1 (or m1 gnus-select-method))
3656         (m2 (or m2 gnus-select-method)))
3657     (or (equal m1 m2)
3658         (and (eq (car m1) (car m2))
3659              (or (not (memq 'address (assoc (symbol-name (car m1))
3660                                             gnus-valid-select-methods)))
3661                  (equal (nth 1 m1) (nth 1 m2)))))))
3662
3663 (defun gnus-server-equal (m1 m2)
3664   "Say whether two methods are equal."
3665   (let ((m1 (cond ((null m1) gnus-select-method)
3666                   ((stringp m1) (gnus-server-to-method m1))
3667                   (t m1)))
3668         (m2 (cond ((null m2) gnus-select-method)
3669                   ((stringp m2) (gnus-server-to-method m2))
3670                   (t m2))))
3671     (gnus-method-equal m1 m2)))
3672
3673 (defun gnus-servers-using-backend (backend)
3674   "Return a list of known servers using BACKEND."
3675   (let ((opened gnus-opened-servers)
3676         out)
3677     (while opened
3678       (when (eq backend (caaar opened))
3679         (push (caar opened) out))
3680       (pop opened))
3681     out))
3682
3683 (defun gnus-archive-server-wanted-p ()
3684   "Say whether the user wants to use the archive server."
3685   (cond
3686    ((or (not gnus-message-archive-method)
3687         (not gnus-message-archive-group))
3688     nil)
3689    ((and gnus-message-archive-method gnus-message-archive-group)
3690     t)
3691    (t
3692     (let ((active (cadr (assq 'nnfolder-active-file
3693                               gnus-message-archive-method))))
3694       (and active
3695            (file-exists-p active))))))
3696
3697 (defsubst gnus-method-to-server-name (method)
3698   (concat
3699    (format "%s" (car method))
3700    (when (and
3701           (or (assoc (format "%s" (car method))
3702                      (gnus-methods-using 'address))
3703               (gnus-server-equal method gnus-message-archive-method))
3704           (nth 1 method)
3705           (not (string= (nth 1 method) "")))
3706      (concat "+" (nth 1 method)))))
3707
3708 (defsubst gnus-method-to-full-server-name (method)
3709   (format "%s+%s" (car method) (nth 1 method)))
3710
3711 (defun gnus-group-prefixed-name (group method &optional full)
3712   "Return the whole name from GROUP and METHOD.
3713 Call with full set to get the fully qualified group name (even if the
3714 server is native)."
3715   (when (stringp method)
3716     (setq method (gnus-server-to-method method)))
3717   (if (or (not method)
3718           (and (not full) (gnus-server-equal method "native"))
3719           ;;;!!! This might not be right.  We'll see...
3720           ;(string-match ":" group)
3721           )
3722       group
3723     (concat (gnus-method-to-server-name method) ":" group)))
3724
3725 (defun gnus-group-guess-prefixed-name (group)
3726   "Guess the whole name from GROUP and METHOD."
3727   (gnus-group-prefixed-name group (gnus-find-method-for-group
3728                                group)))
3729
3730 (defun gnus-group-full-name (group method)
3731   "Return the full name from GROUP and METHOD, even if the method is native."
3732   (gnus-group-prefixed-name group method t))
3733
3734 (defun gnus-group-guess-full-name (group)
3735   "Guess the full name from GROUP, even if the method is native."
3736   (if (gnus-group-prefixed-p group)
3737       group
3738     (gnus-group-full-name group (gnus-find-method-for-group group))))
3739
3740 (defun gnus-group-guess-full-name-from-command-method (group)
3741   "Guess the full name from GROUP, even if the method is native."
3742   (if (gnus-group-prefixed-p group)
3743       group
3744     (gnus-group-full-name group gnus-command-method)))
3745
3746 (defun gnus-group-real-prefix (group)
3747   "Return the prefix of the current group name."
3748   (if (stringp group)
3749       (if (string-match "^[^:]+:" group)
3750           (substring group 0 (match-end 0))
3751         "")
3752     nil))
3753
3754 (defun gnus-group-short-name (group)
3755   "Return the short group name."
3756   (let ((prefix (gnus-group-real-prefix group)))
3757     (if (< 0 (length prefix))
3758         (substring group (length prefix) nil)
3759       group)))
3760
3761 (defun gnus-group-prefixed-p (group)
3762   "Return the prefix of the current group name."
3763   (< 0 (length (gnus-group-real-prefix group))))
3764
3765 (defun gnus-summary-buffer-name (group)
3766   "Return the summary buffer name of GROUP."
3767   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3768
3769 (defun gnus-group-method (group)
3770   "Return the server or method used for selecting GROUP.
3771 You should probably use `gnus-find-method-for-group' instead."
3772   (let ((prefix (gnus-group-real-prefix group)))
3773     (if (equal prefix "")
3774         gnus-select-method
3775       (let ((servers gnus-opened-servers)
3776             (server "")
3777             backend possible found)
3778         (if (string-match "^[^\\+]+\\+" prefix)
3779             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3780                   server (substring prefix (match-end 0) (1- (length prefix))))
3781           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3782         (while servers
3783           (when (eq (caaar servers) backend)
3784             (setq possible (caar servers))
3785             (when (equal (cadaar servers) server)
3786               (setq found (caar servers))))
3787           (pop servers))
3788         (or (car (rassoc found gnus-server-alist))
3789             found
3790             (car (rassoc possible gnus-server-alist))
3791             possible
3792             (list backend server))))))
3793
3794 (defsubst gnus-native-method-p (method)
3795   "Return whether METHOD is the native select method."
3796   (gnus-method-equal method gnus-select-method))
3797
3798 (defsubst gnus-secondary-method-p (method)
3799   "Return whether METHOD is a secondary select method."
3800   (let ((methods gnus-secondary-select-methods)
3801         (gmethod (inline (gnus-server-get-method nil method))))
3802     (while (and methods
3803                 (not (gnus-method-equal
3804                       (inline (gnus-server-get-method nil (car methods)))
3805                       gmethod)))
3806       (setq methods (cdr methods)))
3807     methods))
3808
3809 (defun gnus-method-simplify (method)
3810   "Return the shortest uniquely identifying string or method for METHOD."
3811   (cond ((stringp method)
3812          method)
3813         ((gnus-native-method-p method)
3814          nil)
3815         ((gnus-secondary-method-p method)
3816          (format "%s:%s" (nth 0 method) (nth 1 method)))
3817         (t
3818          method)))
3819
3820 (defun gnus-groups-from-server (server)
3821   "Return a list of all groups that are fetched from SERVER."
3822   (let ((alist (cdr gnus-newsrc-alist))
3823         info groups)
3824     (while (setq info (pop alist))
3825       (when (gnus-server-equal (gnus-info-method info) server)
3826         (push (gnus-info-group info) groups)))
3827     (sort groups 'string<)))
3828
3829 (defun gnus-group-foreign-p (group)
3830   "Say whether a group is foreign or not."
3831   (and (not (gnus-group-native-p group))
3832        (not (gnus-group-secondary-p group))))
3833
3834 (defun gnus-group-native-p (group)
3835   "Say whether the group is native or not."
3836   (not (string-match ":" group)))
3837
3838 (defun gnus-group-secondary-p (group)
3839   "Say whether the group is secondary or not."
3840   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3841
3842 (defun gnus-parameters-get-parameter (group)
3843   "Return the group parameters for GROUP from `gnus-parameters'."
3844   (let (params-list)
3845     (dolist (elem gnus-parameters)
3846       (when (string-match (car elem) group)
3847         (setq params-list
3848               (nconc (gnus-expand-group-parameters
3849                       (car elem) (cdr elem) group)
3850                      params-list))))
3851     params-list))
3852
3853 (defun gnus-expand-group-parameter (match value group)
3854   "Use MATCH to expand VALUE in GROUP."
3855   (with-temp-buffer
3856     (insert group)
3857     (goto-char (point-min))
3858     (while (re-search-forward match nil t)
3859       (replace-match value))
3860     (buffer-string)))
3861
3862 (defun gnus-expand-group-parameters (match parameters group)
3863   "Go through PARAMETERS and expand them according to the match data."
3864   (let (new)
3865     (dolist (elem parameters)
3866       (if (and (stringp (cdr elem))
3867                (string-match "\\\\[0-9&]" (cdr elem)))
3868           (push (cons (car elem)
3869                       (gnus-expand-group-parameter match (cdr elem) group))
3870                 new)
3871         (push elem new)))
3872     new))
3873
3874 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3875   "For GROUP, return the value of SYMBOL.
3876
3877 You should call this in the `gnus-group-buffer' buffer.
3878 The function `gnus-group-find-parameter' will do that for you."
3879   ;; The speed trick:  No cons'ing and quit early.
3880   (let* ((params (funcall gnus-group-get-parameter-function group))
3881          ;; Start easy, check the "real" group parameters.
3882          (simple-results
3883           (gnus-group-parameter-value params symbol allow-list t)))
3884     (if simple-results
3885         ;; Found results; return them.
3886         (car simple-results)
3887       ;; We didn't found it there, try `gnus-parameters'.
3888       (let ((result nil)
3889             (head nil)
3890             (tail gnus-parameters))
3891         ;; A good old-fashioned non-cl loop.
3892         (while tail
3893           (setq head (car tail)
3894                 tail (cdr tail))
3895           ;; The car is regexp matching for matching the group name.
3896           (when (string-match (car head) group)
3897             ;; The cdr is the parameters.
3898             (setq result (gnus-group-parameter-value (cdr head)
3899                                                      symbol allow-list))
3900             (when result
3901               ;; Expand if necessary.
3902               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3903                   (setq result (gnus-expand-group-parameter (car head)
3904                                                             result group)))
3905               ;; Exit the loop early.
3906               (setq tail nil))))
3907         ;; Done.
3908         result))))
3909
3910 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3911   "Return the group parameters for GROUP.
3912 If SYMBOL, return the value of that symbol in the group parameters.
3913
3914 If you call this function inside a loop, consider using the faster
3915 `gnus-group-fast-parameter' instead."
3916   (save-excursion
3917     (set-buffer gnus-group-buffer)
3918     (if symbol
3919         (gnus-group-fast-parameter group symbol allow-list)
3920       (nconc
3921        (copy-sequence
3922         (funcall gnus-group-get-parameter-function group))
3923        (gnus-parameters-get-parameter group)))))
3924
3925 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3926   "Return the group parameters for GROUP.
3927 If SYMBOL, return the value of that symbol in the group parameters.
3928 Most functions should use `gnus-group-find-parameter', which
3929 also examines the topic parameters."
3930   (let ((params (gnus-info-params (gnus-get-info group))))
3931     (if symbol
3932         (gnus-group-parameter-value params symbol allow-list)
3933       params)))
3934
3935 (defun gnus-group-parameter-value (params symbol &optional
3936                                           allow-list present-p)
3937   "Return the value of SYMBOL in group PARAMS."
3938   ;; We only wish to return group parameters (dotted lists) and
3939   ;; not local variables, which may have the same names.
3940   ;; But first we handle single elements...
3941   (or (car (memq symbol params))
3942       ;; Handle alist.
3943       (let (elem)
3944         (catch 'found
3945           (while (setq elem (pop params))
3946             (when (and (consp elem)
3947                        (eq (car elem) symbol)
3948                        (or allow-list
3949                            (atom (cdr elem))))
3950               (throw 'found (if present-p (list (cdr elem))
3951                               (cdr elem)))))))))
3952
3953 (defun gnus-group-add-parameter (group param)
3954   "Add parameter PARAM to GROUP."
3955   (let ((info (gnus-get-info group)))
3956     (when info
3957       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3958       ;; Cons the new param to the old one and update.
3959       (gnus-group-set-info (cons param (gnus-info-params info))
3960                            group 'params))))
3961
3962 (defun gnus-group-set-parameter (group name value)
3963   "Set parameter NAME to VALUE in GROUP."
3964   (let ((info (gnus-get-info group)))
3965     (when info
3966       (gnus-group-remove-parameter group name)
3967       (let ((old-params (gnus-info-params info))
3968             (new-params (list (cons name value))))
3969         (while old-params
3970           (when (or (not (listp (car old-params)))
3971                     (not (eq (caar old-params) name)))
3972             (setq new-params (append new-params (list (car old-params)))))
3973           (setq old-params (cdr old-params)))
3974         (gnus-group-set-info new-params group 'params)))))
3975
3976 (defun gnus-group-remove-parameter (group name)
3977   "Remove parameter NAME from GROUP."
3978   (let ((info (gnus-get-info group)))
3979     (when info
3980       (let ((params (gnus-info-params info)))
3981         (when params
3982           (setq params (delq name params))
3983           (while (assq name params)
3984             (gnus-pull name params))
3985           (gnus-info-set-params info params))))))
3986
3987 (defun gnus-group-add-score (group &optional score)
3988   "Add SCORE to the GROUP score.
3989 If SCORE is nil, add 1 to the score of GROUP."
3990   (let ((info (gnus-get-info group)))
3991     (when info
3992       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3993
3994 (defun gnus-short-group-name (group &optional levels)
3995   "Collapse GROUP name LEVELS.
3996 Select methods are stripped and any remote host name is stripped down to
3997 just the host name."
3998   (let* ((name "")
3999          (foreign "")
4000          (depth 0)
4001          (skip 1)
4002          (levels (or levels
4003                      gnus-group-uncollapsed-levels
4004                      (progn
4005                        (while (string-match "\\." group skip)
4006                          (setq skip (match-end 0)
4007                                depth (+ depth 1)))
4008                        depth))))
4009     ;; Separate foreign select method from group name and collapse.
4010     ;; If method contains a server, collapse to non-domain server name,
4011     ;; otherwise collapse to select method.
4012     (let* ((colon (string-match ":" group))
4013            (server (and colon (substring group 0 colon)))
4014            (plus (and server (string-match "+" server))))
4015       (when server
4016         (if plus
4017             (setq foreign (substring server (+ 1 plus)
4018                                      (string-match "\\." server))
4019                   group (substring group (+ 1 colon)))
4020           (setq foreign server
4021                 group (substring group (+ 1 colon))))
4022         (setq foreign (concat foreign ":")))
4023       ;; Collapse group name leaving LEVELS uncollapsed elements
4024       (let* ((slist (split-string group "/"))
4025              (slen (length slist))
4026              (dlist (split-string group "\\."))
4027              (dlen (length dlist))
4028              glist
4029              glen
4030              gsep
4031              res)
4032         (if (> slen dlen)
4033             (setq glist slist
4034                   glen slen
4035                   gsep "/")
4036           (setq glist dlist
4037                 glen dlen
4038                 gsep "."))
4039         (setq levels (- glen levels))
4040         (dolist (g glist)
4041           (push (if (>= (decf levels) 0)
4042                     (if (zerop (length g))
4043                         ""
4044                       (substring g 0 1))
4045                   g)
4046                 res))
4047         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
4048
4049 (defun gnus-narrow-to-body ()
4050   "Narrow to the body of an article."
4051   (narrow-to-region
4052    (progn
4053      (goto-char (point-min))
4054      (or (search-forward "\n\n" nil t)
4055          (point-max)))
4056    (point-max)))
4057
4058 \f
4059 ;;;
4060 ;;; Kill file handling.
4061 ;;;
4062
4063 (defun gnus-apply-kill-file ()
4064   "Apply a kill file to the current newsgroup.
4065 Returns the number of articles marked as read."
4066   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
4067           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4068       (gnus-apply-kill-file-internal)
4069     0))
4070
4071 (defun gnus-kill-save-kill-buffer ()
4072   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4073     (when (get-file-buffer file)
4074       (save-excursion
4075         (set-buffer (get-file-buffer file))
4076         (when (buffer-modified-p)
4077           (save-buffer))
4078         (kill-buffer (current-buffer))))))
4079
4080 (defcustom gnus-kill-file-name "KILL"
4081   "Suffix of the kill files."
4082   :group 'gnus-score-kill
4083   :group 'gnus-score-files
4084   :type 'string)
4085
4086 (defun gnus-newsgroup-kill-file (newsgroup)
4087   "Return the name of a kill file name for NEWSGROUP.
4088 If NEWSGROUP is nil, return the global kill file name instead."
4089   (cond
4090    ;; The global KILL file is placed at top of the directory.
4091    ((or (null newsgroup)
4092         (string-equal newsgroup ""))
4093     (expand-file-name gnus-kill-file-name
4094                       gnus-kill-files-directory))
4095    ;; Append ".KILL" to newsgroup name.
4096    ((gnus-use-long-file-name 'not-kill)
4097     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4098                               "." gnus-kill-file-name)
4099                       gnus-kill-files-directory))
4100    ;; Place "KILL" under the hierarchical directory.
4101    (t
4102     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4103                               "/" gnus-kill-file-name)
4104                       gnus-kill-files-directory))))
4105
4106 ;;; Server things.
4107
4108 (defun gnus-member-of-valid (symbol group)
4109   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4110   (memq symbol (assoc
4111                 (symbol-name (car (gnus-find-method-for-group group)))
4112                 gnus-valid-select-methods)))
4113
4114 (defun gnus-method-option-p (method option)
4115   "Return non-nil if select METHOD has OPTION as a parameter."
4116   (when (stringp method)
4117     (setq method (gnus-server-to-method method)))
4118   (memq option (assoc (format "%s" (car method))
4119                       gnus-valid-select-methods)))
4120
4121 (defun gnus-similar-server-opened (method)
4122   (let ((opened gnus-opened-servers))
4123     (while (and method opened)
4124       (when (and (equal (cadr method) (cadaar opened))
4125                  (equal (car method) (caaar opened))
4126                  (not (equal method (caar opened))))
4127         (setq method nil))
4128       (pop opened))
4129     (not method)))
4130
4131 (defun gnus-server-extend-method (group method)
4132   ;; This function "extends" a virtual server.  If the server is
4133   ;; "hello", and the select method is ("hello" (my-var "something"))
4134   ;; in the group "alt.alt", this will result in a new virtual server
4135   ;; called "hello+alt.alt".
4136   (if (or (not (inline (gnus-similar-server-opened method)))
4137           (not (cddr method)))
4138       method
4139     `(,(car method) ,(concat (cadr method) "+" group)
4140       (,(intern (format "%s-address" (car method))) ,(cadr method))
4141       ,@(cddr method))))
4142
4143 (defun gnus-server-status (method)
4144   "Return the status of METHOD."
4145   (nth 1 (assoc method gnus-opened-servers)))
4146
4147 (defun gnus-group-name-to-method (group)
4148   "Guess a select method based on GROUP."
4149   (if (string-match ":" group)
4150       (let ((server (substring group 0 (match-beginning 0))))
4151         (if (string-match "\\+" server)
4152             (list (intern (substring server 0 (match-beginning 0)))
4153                   (substring server (match-end 0)))
4154           (list (intern server) "")))
4155     gnus-select-method))
4156
4157 (defun gnus-server-string (server)
4158   "Return a readable string that describes SERVER."
4159   (let* ((server (gnus-server-to-method server))
4160          (address (nth 1 server)))
4161     (if (and address
4162              (not (zerop (length address))))
4163         (format "%s using %s" address (car server))
4164       (format "%s" (car server)))))
4165
4166 (defun gnus-find-method-for-group (group &optional info)
4167   "Find the select method that GROUP uses."
4168   (or gnus-override-method
4169       (and (not group)
4170            gnus-select-method)
4171       (and (not (gnus-group-entry group));; a new group
4172            (gnus-group-name-to-method group))
4173       (let ((info (or info (gnus-get-info group)))
4174             method)
4175         (if (or (not info)
4176                 (not (setq method (gnus-info-method info)))
4177                 (equal method "native"))
4178             gnus-select-method
4179           (setq method
4180                 (cond ((stringp method)
4181                        (inline (gnus-server-to-method method)))
4182                       ((stringp (cadr method))
4183                        (inline (gnus-server-extend-method group method)))
4184                       (t
4185                        method)))
4186           (cond ((equal (cadr method) "")
4187                  method)
4188                 ((null (cadr method))
4189                  (list (car method) ""))
4190                 (t
4191                  (gnus-server-add-address method)))))))
4192
4193 (defun gnus-methods-using (feature)
4194   "Find all methods that have FEATURE."
4195   (let ((valids gnus-valid-select-methods)
4196         outs)
4197     (while valids
4198       (when (memq feature (car valids))
4199         (push (car valids) outs))
4200       (setq valids (cdr valids)))
4201     outs))
4202
4203 (eval-and-compile
4204   (autoload 'message-y-or-n-p "message" nil nil 'macro))
4205
4206 (defun gnus-read-group (prompt &optional default)
4207   "Prompt the user for a group name.
4208 Disallow invalid group names."
4209   (let ((prefix "")
4210         group)
4211     (while (not group)
4212       (when (string-match
4213              gnus-invalid-group-regexp
4214              (setq group (read-string (concat prefix prompt)
4215                                       (cons (or default "") 0)
4216                                       'gnus-group-history)))
4217         (let ((match (match-string 0 group)))
4218           ;; Might be okay (e.g. for nnimap), so ask the user:
4219           (unless (and (not (string-match "^$\\|:" match))
4220                        (message-y-or-n-p
4221                         "Proceed and create group anyway? " t
4222 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4223
4224 Usually, it's dangerous to create a group with this name, because it's not
4225 supported by all back ends and servers.  On IMAP servers it should work,
4226 though.  If you are really sure, you can proceed anyway and create the group.
4227
4228 You may customize the variable `gnus-invalid-group-regexp', which currently is
4229 set to \"" gnus-invalid-group-regexp
4230 "\", if you want to get rid of this query permanently."))
4231             (setq prefix (format "Invalid group name: \"%s\".  " group)
4232                   group nil)))))
4233     group))
4234
4235 (defun gnus-read-method (prompt)
4236   "Prompt the user for a method.
4237 Allow completion over sensible values."
4238   (let* ((open-servers
4239           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4240                   gnus-opened-servers))
4241          (valid-methods
4242           (let (methods)
4243             (dolist (method gnus-valid-select-methods)
4244               (if (or (memq 'prompt-address method)
4245                       (not (assoc (format "%s:" (car method)) open-servers)))
4246                   (push method methods)))
4247             methods))
4248          (servers
4249           (append valid-methods
4250                   open-servers
4251                   gnus-predefined-server-alist
4252                   gnus-server-alist))
4253          (method
4254           (completing-read
4255            prompt servers
4256            nil t nil 'gnus-method-history)))
4257     (cond
4258      ((equal method "")
4259       (setq method gnus-select-method))
4260      ((assoc method gnus-valid-select-methods)
4261       (let ((address (if (memq 'prompt-address
4262                                (assoc method gnus-valid-select-methods))
4263                          (read-string "Address: ")
4264                        "")))
4265         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4266             (list (intern method) address))))
4267      ((assoc method servers)
4268       method)
4269      (t
4270       (list (intern method) "")))))
4271
4272 ;;; Agent functions
4273
4274 (defun gnus-agent-method-p (method)
4275   "Say whether METHOD is covered by the agent."
4276   (or (eq (car gnus-agent-method-p-cache) method)
4277       (setq gnus-agent-method-p-cache
4278             (cons method
4279                   (member (if (stringp method)
4280                               method
4281                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4282   (cdr gnus-agent-method-p-cache))
4283
4284 (defun gnus-online (method)
4285   (not
4286    (if gnus-plugged
4287        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4288      (gnus-agent-method-p method))))
4289
4290 ;;; User-level commands.
4291
4292 ;;;###autoload
4293 (defun gnus-slave-no-server (&optional arg)
4294   "Read network news as a slave, without connecting to the local server."
4295   (interactive "P")
4296   (gnus-no-server arg t))
4297
4298 ;;;###autoload
4299 (defun gnus-no-server (&optional arg slave)
4300   "Read network news.
4301 If ARG is a positive number, Gnus will use that as the startup
4302 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4303 non-nil and not a positive number, Gnus will prompt the user for the
4304 name of an NNTP server to use.
4305 As opposed to `gnus', this command will not connect to the local
4306 server."
4307   (interactive "P")
4308   (gnus-no-server-1 arg slave))
4309
4310 ;;;###autoload
4311 (defun gnus-slave (&optional arg)
4312   "Read news as a slave."
4313   (interactive "P")
4314   (gnus arg nil 'slave))
4315
4316 (defcustom gnus-frame-properties nil
4317   "The properties of the frame in which gnus is displayed. Under XEmacs,
4318 the variable `toolbar-news-frame-plist' will be refered instead."
4319   :type '(repeat (cons :format "%v"
4320                        (symbol :tag "Parameter")
4321                        (sexp :tag "Value")))
4322   :group 'gnus)
4323
4324 ;;;###autoload
4325 (defun gnus-other-frame (&optional arg display)
4326   "Pop up a frame to read news.
4327 This will call one of the Gnus commands which is specified by the user
4328 option `gnus-other-frame-function' (default `gnus') with the argument
4329 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4330 optional second argument DISPLAY should be a standard display string
4331 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4332 omitted or the function `make-frame-on-display' is not available, the
4333 current display is used."
4334   (interactive "P")
4335   (if (fboundp 'make-frame-on-display)
4336       (unless display
4337         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4338     (setq display nil))
4339   (let ((alive (gnus-alive-p)))
4340     (unless (and alive
4341                  (catch 'found
4342                    (walk-windows
4343                     (lambda (window)
4344                       (when (and (or (not display)
4345                                      (equal display
4346                                             (gnus-frame-or-window-display-name
4347                                              window)))
4348                                  (with-current-buffer (window-buffer window)
4349                                    (string-match "\\`gnus-"
4350                                                  (symbol-name major-mode))))
4351                         (gnus-select-frame-set-input-focus
4352                          (setq gnus-other-frame-object (window-frame window)))
4353                         (select-window window)
4354                         (throw 'found t)))
4355                     'ignore t)))
4356       (gnus-select-frame-set-input-focus
4357        (setq gnus-other-frame-object
4358              (if display
4359                  (make-frame-on-display display gnus-other-frame-parameters)
4360                (make-frame gnus-other-frame-parameters))))
4361       (if alive
4362           (switch-to-buffer gnus-group-buffer)
4363         (funcall gnus-other-frame-function arg)
4364         (add-hook 'gnus-exit-gnus-hook
4365                   '(lambda nil
4366                      (when (and (frame-live-p gnus-other-frame-object)
4367                                 (cdr (frame-list)))
4368                        (delete-frame gnus-other-frame-object))
4369                      (setq gnus-other-frame-object nil)))))))
4370
4371 ;;;###autoload
4372 (defun gnus (&optional arg dont-connect slave)
4373   "Read network news.
4374 If ARG is non-nil and a positive number, Gnus will use that as the
4375 startup level.  If ARG is non-nil and not a positive number, Gnus will
4376 prompt the user for the name of an NNTP server to use."
4377   (interactive "P")
4378   (unless (byte-code-function-p (symbol-function 'gnus))
4379     (message "You should byte-compile Gnus")
4380     (sit-for 2))
4381   (gnus-1 arg dont-connect slave))
4382
4383 ;; Allow redefinition of Gnus functions.
4384
4385 (gnus-ems-redefine)
4386
4387 (product-provide (provide 'gnus) 'gnus-vers)
4388
4389 ;;; gnus.el ends here