gnus-art.el 308 KB
Newer Older
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1
;;; gnus-art.el --- article mode commands for Gnus
2

3
;; Copyright (C) 1996-2011 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4

5
;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
6 7 8 9
;; Keywords: news

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
14 15 16

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
18 19 20
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
22 23 24 25 26

;;; Commentary:

;;; Code:

27
;; For Emacs <22.2 and XEmacs.
28 29
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
30
(eval-when-compile
Dan Nicolaescu's avatar
Dan Nicolaescu committed
31 32 33
  (require 'cl))
(defvar tool-bar-map)
(defvar w3m-minor-mode-map)
34

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
35
(require 'gnus)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
36
(require 'gnus-sum)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
37 38
(require 'gnus-spec)
(require 'gnus-int)
39
(require 'gnus-win)
40 41 42 43 44 45
(require 'mm-bodies)
(require 'mail-parse)
(require 'mm-decode)
(require 'mm-view)
(require 'wid-edit)
(require 'mm-uu)
46
(require 'message)
47
(require 'mouse)
48 49 50 51

(autoload 'gnus-msg-mail "gnus-msg" nil t)
(autoload 'gnus-button-mailto "gnus-msg")
(autoload 'gnus-button-reply "gnus-msg" nil t)
52
(autoload 'parse-time-string "parse-time" nil nil)
53 54
(autoload 'ansi-color-apply-on-region "ansi-color")
(autoload 'mm-url-insert-file-contents-external "mm-url")
55
(autoload 'mm-extern-cache-contents "mm-extern")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
56 57 58

(defgroup gnus-article nil
  "Article display."
59
  :link '(custom-manual "(gnus)Article Buffer")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
60 61
  :group 'gnus)

62 63 64 65 66
(defgroup gnus-article-treat nil
  "Treating article parts."
  :link '(custom-manual "(gnus)Article Hiding")
  :group 'gnus-article)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
(defgroup gnus-article-hiding nil
  "Hiding article parts."
  :link '(custom-manual "(gnus)Article Hiding")
  :group 'gnus-article)

(defgroup gnus-article-highlight nil
  "Article highlighting."
  :link '(custom-manual "(gnus)Article Highlighting")
  :group 'gnus-article
  :group 'gnus-visual)

(defgroup gnus-article-signature nil
  "Article signatures."
  :link '(custom-manual "(gnus)Article Signature")
  :group 'gnus-article)

(defgroup gnus-article-headers nil
  "Article headers."
  :link '(custom-manual "(gnus)Hiding Headers")
  :group 'gnus-article)

(defgroup gnus-article-washing nil
  "Special commands on articles."
  :link '(custom-manual "(gnus)Article Washing")
  :group 'gnus-article)

(defgroup gnus-article-emphasis nil
  "Fontisizing articles."
  :link '(custom-manual "(gnus)Article Fontisizing")
  :group 'gnus-article)

(defgroup gnus-article-saving nil
  "Saving articles."
  :link '(custom-manual "(gnus)Saving Articles")
  :group 'gnus-article)

(defgroup gnus-article-mime nil
  "Worshiping the MIME wonder."
  :link '(custom-manual "(gnus)Using MIME")
  :group 'gnus-article)

(defgroup gnus-article-buttons nil
  "Pushable buttons in the article buffer."
  :link '(custom-manual "(gnus)Article Buttons")
  :group 'gnus-article)

(defgroup gnus-article-various nil
  "Other article options."
  :link '(custom-manual "(gnus)Misc Article")
  :group 'gnus-article)

(defcustom gnus-ignored-headers
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
  (mapcar
   (lambda (header)
     (concat "^" header ":"))
   '("Path" "Expires" "Date-Received" "References" "Xref" "Lines"
     "Relay-Version" "Message-ID" "Approved" "Sender" "Received"
     "X-UIDL" "MIME-Version" "Return-Path" "In-Reply-To"
     "Content-Type" "Content-Transfer-Encoding" "X-WebTV-Signature"
     "X-MimeOLE" "X-MSMail-Priority" "X-Priority" "X-Loop"
     "X-Authentication-Warning" "X-MIME-Autoconverted" "X-Face"
     "X-Attribution" "X-Originating-IP" "Delivered-To"
     "NNTP-[-A-Za-z]+" "Distribution" "X-no-archive" "X-Trace"
     "X-Complaints-To" "X-NNTP-Posting-Host" "X-Orig.*"
     "Abuse-Reports-To" "Cache-Post-Path" "X-Article-Creation-Date"
     "X-Poster" "X-Mail2News-Path" "X-Server-Date" "X-Cache"
     "Originator" "X-Problems-To" "X-Auth-User" "X-Post-Time"
     "X-Admin" "X-UID" "Resent-[-A-Za-z]+" "X-Mailing-List"
     "Precedence" "Original-[-A-Za-z]+" "X-filename" "X-Orcpt"
     "Old-Received" "X-Pgp" "X-Auth" "X-From-Line"
     "X-Gnus-Article-Number" "X-Majordomo" "X-Url" "X-Sender"
     "MBOX-Line" "Priority" "X400-[-A-Za-z]+"
     "Status" "X-Gnus-Mail-Source" "Cancel-Lock"
     "X-FTN" "X-EXP32-SerialNo" "Encoding" "Importance"
     "Autoforwarded" "Original-Encoded-Information-Types" "X-Ya-Pop3"
     "X-Face-Version" "X-Vms-To" "X-ML-NAME" "X-ML-COUNT"
     "Mailing-List" "X-finfo" "X-md5sum" "X-md5sum-Origin"
     "X-Sun-Charset" "X-Accept-Language" "X-Envelope-Sender"
     "List-[A-Za-z]+" "X-Listprocessor-Version"
     "X-Received" "X-Distribute" "X-Sequence" "X-Juno-Line-Breaks"
     "X-Notes-Item" "X-MS-TNEF-Correlator" "x-uunet-gateway"
     "X-Received" "Content-length" "X-precedence"
     "X-Authenticated-User" "X-Comment" "X-Report" "X-Abuse-Info"
     "X-HTTP-Proxy" "X-Mydeja-Info" "X-Copyright" "X-No-Markup"
     "X-Abuse-Info" "X-From_" "X-Accept-Language" "Errors-To"
     "X-BeenThere" "X-Mailman-Version" "List-Help" "List-Post"
     "List-Subscribe" "List-Id" "List-Unsubscribe" "List-Archive"
     "X-Content-length" "X-Posting-Agent" "Original-Received"
     "X-Request-PGP" "X-Fingerprint" "X-WRIEnvto" "X-WRIEnvfrom"
     "X-Virus-Scanned" "X-Delivery-Agent" "Posted-Date" "X-Gateway"
     "X-Local-Origin" "X-Local-Destination" "X-UserInfo1"
     "X-Received-Date" "X-Hashcash" "Face" "X-DMCA-Notifications"
159 160 161 162
     "X-Abuse-and-DMCA-Info" "X-Postfilter" "X-Gpg-.*" "X-Disclaimer"
     "Envelope-To" "X-Spam-Score" "System-Type" "X-Injected-Via-Gmane"
     "X-Gmane-NNTP-Posting-Host" "Jabber-ID" "Archived-At"
     "Envelope-Sender" "Envelope-Recipients"))
163
  "*All headers that start with this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
164 165
This variable can also be a list of regexps of headers to be ignored.
If `gnus-visible-headers' is non-nil, this variable will be ignored."
166
  :type '(choice regexp
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
167 168 169 170
		 (repeat regexp))
  :group 'gnus-article-hiding)

(defcustom gnus-visible-headers
171
  "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^Followup-To:\\|^Reply-To:\\|^Organization:\\|^Summary:\\|^Keywords:\\|^To:\\|^[BGF]?Cc:\\|^Posted-To:\\|^Mail-Copies-To:\\|^Mail-Followup-To:\\|^Apparently-To:\\|^Gnus-Warning:\\|^Resent-From:"
172
  "*All headers that do not match this regexp will be hidden.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
173 174
This variable can also be a list of regexp of headers to remain visible.
If this variable is non-nil, `gnus-ignored-headers' will be ignored."
Miles Bader's avatar
Miles Bader committed
175 176 177 178 179 180 181 182 183
  :type '(choice
	  (repeat :value-to-internal (lambda (widget value)
				       (custom-split-regexp-maybe value))
		  :match (lambda (widget value)
			   (or (stringp value)
			       (widget-editable-list-match widget value)))
		  regexp)
	  (const :tag "Use gnus-ignored-headers" nil)
	  regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
184 185 186 187 188
  :group 'gnus-article-hiding)

(defcustom gnus-sorted-header-list
  '("^From:" "^Subject:" "^Summary:" "^Keywords:" "^Newsgroups:"
    "^Followup-To:" "^To:" "^Cc:" "^Date:" "^Organization:")
189
  "*This variable is a list of regular expressions.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
190 191 192 193 194 195 196 197
If it is non-nil, headers that match the regular expressions will
be placed first in the article buffer in the sequence specified by
this list."
  :type '(repeat regexp)
  :group 'gnus-article-hiding)

(defcustom gnus-boring-article-headers '(empty followup-to reply-to)
  "Headers that are only to be displayed if they have interesting data.
198 199 200 201 202 203 204 205 206 207 208 209
Possible values in this list are:

  'empty       Headers with no content.
  'newsgroups  Newsgroup identical to Gnus group.
  'to-address  To identical to To-address.
  'to-list     To identical to To-list.
  'cc-list     CC identical to To-list.
  'followup-to Followup-to identical to Newsgroups.
  'reply-to    Reply-to identical to From.
  'date        Date less than four days old.
  'long-to     To and/or Cc longer than 1024 characters.
  'many-to     Multiple To and/or Cc."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
210
  :type '(set (const :tag "Headers with no content." empty)
211 212 213 214 215 216
	      (const :tag "Newsgroups identical to Gnus group." newsgroups)
	      (const :tag "To identical to To-address." to-address)
	      (const :tag "To identical to To-list." to-list)
	      (const :tag "CC identical to To-list." cc-list)
	      (const :tag "Followup-to identical to Newsgroups." followup-to)
	      (const :tag "Reply-to identical to From." reply-to)
217
	      (const :tag "Date less than four days old." date)
218
	      (const :tag "To and/or Cc longer than 1024 characters." long-to)
219
	      (const :tag "Multiple To and/or Cc headers." many-to))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
220 221
  :group 'gnus-article-hiding)

222 223 224 225 226 227
(defcustom gnus-article-skip-boring nil
  "Skip over text that is not worth reading.
By default, if you set this t, then Gnus will display citations and
signatures, but will never scroll down to show you a page consisting
only of boring text.  Boring text is controlled by
`gnus-article-boring-faces'."
228
  :version "22.1"
229 230 231
  :type 'boolean
  :group 'gnus-article-hiding)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
232 233 234 235 236
(defcustom gnus-signature-separator '("^-- $" "^-- *$")
  "Regexp matching signature separator.
This can also be a list of regexps.  In that case, it will be checked
from head to tail looking for a separator.  Searches will be done from
the end of the buffer."
237 238 239
  :type '(choice :format "%{%t%}: %[Value Menu%]\n%v"
		 (regexp)
		 (repeat :tag "List of regexp" regexp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
240 241 242
  :group 'gnus-article-signature)

(defcustom gnus-signature-limit nil
243
  "Provide a limit to what is considered a signature.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
244 245 246 247 248
If it is a number, no signature may not be longer (in characters) than
that number.  If it is a floating point number, no signature may be
longer (in lines) than that number.  If it is a function, the function
will be called without any parameters, and if it returns nil, there is
no signature in the buffer.  If it is a string, it will be used as a
249 250 251
regexp.  If it matches, the text in question is not a signature.

This can also be a list of the above values."
252 253
  :type '(choice (const nil)
		 (integer :value 200)
254
		 (number :value 4.0)
Miles Bader's avatar
Miles Bader committed
255
		 function
256
		 (regexp :value ".*"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
257 258 259 260 261 262 263
  :group 'gnus-article-signature)

(defcustom gnus-hidden-properties '(invisible t intangible t)
  "Property list to use for hiding text."
  :type 'sexp
  :group 'gnus-article-hiding)

264 265
;; Fixme: This isn't the right thing for mixed graphical and non-graphical
;; frames in a session.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
266
(defcustom gnus-article-x-face-command
267 268 269 270
  (if (featurep 'xemacs)
      (if (or (gnus-image-type-available-p 'xface)
	      (gnus-image-type-available-p 'pbm))
	  'gnus-display-x-face-in-from
271 272 273
	"{ echo \
'/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
; uncompface; } | icontopbm | ee -")
274 275
    (if (gnus-image-type-available-p 'pbm)
	'gnus-display-x-face-in-from
276 277 278
      "{ echo \
'/* Format_version=1, Width=48, Height=48, Depth=1, Valid_bits_per_item=16 */'\
; uncompface; } | icontopbm | display -"))
279
  "*String or function to be executed to display an X-Face header.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
280
If it is a string, the command will be executed in a sub-shell
281
asynchronously.  The compressed face will be piped to this command."
282 283
  :type `(choice string
		 (function-item gnus-display-x-face-in-from)
284
		 function)
Dave Love's avatar
Dave Love committed
285
  :version "21.1"
286
  :group 'gnus-picon
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
287 288 289 290
  :group 'gnus-article-washing)

(defcustom gnus-article-x-face-too-ugly nil
  "Regexp matching posters whose face shouldn't be shown automatically."
291
  :type '(choice regexp (const nil))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
292 293
  :group 'gnus-article-washing)

294 295
(defcustom gnus-article-banner-alist nil
  "Banner alist for stripping.
296
For example,
297
     ((egroups . \"^[ \\t\\n]*-------------------+\\\\( \\\\(e\\\\|Yahoo! \\\\)Groups Sponsor -+\\\\)?....\\n\\\\(.+\\n\\\\)+\"))"
Dave Love's avatar
Dave Love committed
298
  :version "21.1"
299 300 301
  :type '(repeat (cons symbol regexp))
  :group 'gnus-article-washing)

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
(gnus-define-group-parameter
 banner
 :variable-document
 "Alist of regexps (to match group names) and banner."
 :variable-group gnus-article-washing
 :parameter-type
 '(choice :tag "Banner"
	  :value nil
	  (const :tag "Remove signature" signature)
	  (symbol :tag "Item in `gnus-article-banner-alist'" none)
	  regexp
	  (const :tag "None" nil))
 :parameter-document
 "If non-nil, specify how to remove `banners' from articles.

Symbol `signature' means to remove signatures delimited by
`gnus-signature-separator'.  Any other symbol is used to look up a
regular expression to match the banner in `gnus-article-banner-alist'.
A string is used as a regular expression to match the banner
directly.")

(defcustom gnus-article-address-banner-alist nil
  "Alist of mail addresses and banners.
Each element has the form (ADDRESS . BANNER), where ADDRESS is a regexp
to match a mail address in the From: header, BANNER is one of a symbol
`signature', an item in `gnus-article-banner-alist', a regexp and nil.
If ADDRESS matches author's mail address, it will remove things like
advertisements.  For example:

\((\"@yoo-hoo\\\\.co\\\\.jp\\\\'\" . \"\\n_+\\nDo You Yoo-hoo!\\\\?\\n.*\\n.*\\n\"))
"
  :type '(repeat
	  (cons
	   (regexp :tag "Address")
	   (choice :tag "Banner" :value nil
		   (const :tag "Remove signature" signature)
		   (symbol :tag "Item in `gnus-article-banner-alist'" none)
		   regexp
		   (const :tag "None" nil))))
341
  :version "22.1"
342 343
  :group 'gnus-article-washing)

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
(defmacro gnus-emphasis-custom-with-format (&rest body)
  `(let ((format "\
\\(\\s-\\|^\\|\\=\\|[-\"]\\|\\s(\\)\\(%s\\(\\w+\\(\\s-+\\w+\\)*[.,]?\\)%s\\)\
\\(\\([-,.;:!?\"]\\|\\s)\\)+\\s-\\|[?!.]\\s-\\|\\s)\\|\\s-\\)"))
     ,@body))

(defun gnus-emphasis-custom-value-to-external (value)
  (gnus-emphasis-custom-with-format
   (if (consp (car value))
       (list (format format (car (car value)) (cdr (car value)))
	     2
	     (if (nth 1 value) 2 3)
	     (nth 2 value))
     value)))

(defun gnus-emphasis-custom-value-to-internal (value)
  (gnus-emphasis-custom-with-format
   (let ((regexp (concat "\\`"
			 (format (regexp-quote format)
				 "\\([^()]+\\)" "\\([^()]+\\)")
			 "\\'"))
	 pattern)
     (if (string-match regexp (setq pattern (car value)))
	 (list (cons (match-string 1 pattern) (match-string 2 pattern))
	       (= (nth 2 value) 2)
	       (nth 3 value))
       value))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
372
(defcustom gnus-emphasis-alist
373 374
  (let ((types
	 '(("\\*" "\\*" bold nil 2)
375
	   ("_" "_" underline)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
376 377 378 379 380
	   ("/" "/" italic)
	   ("_/" "/_" underline-italic)
	   ("_\\*" "\\*_" underline-bold)
	   ("\\*/" "/\\*" bold-italic)
	   ("_\\*/" "/\\*_" underline-bold-italic))))
381 382 383 384 385 386 387 388
    (nconc
     (gnus-emphasis-custom-with-format
      (mapcar (lambda (spec)
		(list (format format (car spec) (cadr spec))
		      (or (nth 3 spec) 2)
		      (or (nth 4 spec) 3)
		      (intern (format "gnus-emphasis-%s" (nth 2 spec)))))
	      types))
389 390 391 392 393 394
     '(;; I've never seen anyone use this strikethru convention whereas I've
       ;; several times seen it triggered by normal text.  --Stef
       ;; Miles suggests that this form is sometimes used but for italics,
       ;; so maybe we should map it to `italic'.
       ;; ("\\(\\s-\\|^\\)\\(-\\(\\(\\w\\|-[^-]\\)+\\)-\\)\\(\\s-\\|[?!.,;]\\)"
       ;; 2 3 gnus-emphasis-strikethru)
395 396
       ("\\(\\s-\\|^\\)\\(_\\(\\(\\w\\|_[^_]\\)+\\)_\\)\\(\\s-\\|[?!.,;]\\)"
	2 3 gnus-emphasis-underline))))
397
  "*Alist that says how to fontify certain phrases.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
398 399 400 401 402 403 404 405 406
Each item looks like this:

  (\"_\\\\(\\\\w+\\\\)_\" 0 1 'underline)

The first element is a regular expression to be matched.  The second
is a number that says what regular expression grouping used to find
the entire emphasized word.  The third is a number that says what
regexp grouping should be displayed and highlighted.  The fourth
is the face used for highlighting."
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  :type
  '(repeat
    (menu-choice
     :format "%[Customizing Style%]\n%v"
     :indent 2
     (group :tag "Default"
	    :value ("" 0 0 default)
	    :value-create
	    (lambda (widget)
	      (let ((value (widget-get
			    (cadr (widget-get (widget-get widget :parent)
					      :args))
			    :value)))
		(if (not (eq (nth 2 value) 'default))
		    (widget-put
		     widget
		     :value
		     (gnus-emphasis-custom-value-to-external value))))
	      (widget-group-value-create widget))
426 427
	    regexp
	    (integer :format "Match group: %v")
428
	    (integer :format "Emphasize group: %v")
429 430 431 432
	    face)
     (group :tag "Simple"
	    :value (("_" . "_") nil default)
	    (cons :format "%v"
433 434
		  (regexp :format "Start regexp: %v")
		  (regexp :format "End regexp: %v"))
435 436 437 438 439 440 441 442 443
	    (boolean :format "Show start and end patterns: %[%v%]\n"
		     :on " On " :off " Off ")
	    face)))
  :get (lambda (symbol)
	 (mapcar 'gnus-emphasis-custom-value-to-internal
		 (default-value symbol)))
  :set (lambda (symbol value)
	 (set-default symbol (mapcar 'gnus-emphasis-custom-value-to-external
				     value)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
444 445
  :group 'gnus-article-emphasis)

446 447 448 449 450
(defcustom gnus-emphasize-whitespace-regexp "^[ \t]+\\|[ \t]*\n"
  "A regexp to describe whitespace which should not be emphasized.
Typical values are \"^[ \\t]+\\\\|[ \\t]*\\n\" and \"[ \\t]+\\\\|[ \\t]*\\n\".
The former avoids underlining of leading and trailing whitespace,
and the latter avoids underlining any whitespace at all."
Dave Love's avatar
Dave Love committed
451
  :version "21.1"
452 453 454
  :group 'gnus-article-emphasis
  :type 'regexp)

455
(defface gnus-emphasis-bold '((t (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
456 457 458
  "Face used for displaying strong emphasized text (*word*)."
  :group 'gnus-article-emphasis)

459
(defface gnus-emphasis-italic '((t (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
460 461 462 463 464 465 466
  "Face used for displaying italic emphasized text (/word/)."
  :group 'gnus-article-emphasis)

(defface gnus-emphasis-underline '((t (:underline t)))
  "Face used for displaying underlined emphasized text (_word_)."
  :group 'gnus-article-emphasis)

467
(defface gnus-emphasis-underline-bold '((t (:bold t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
468 469 470
  "Face used for displaying underlined bold emphasized text (_*word*_)."
  :group 'gnus-article-emphasis)

471
(defface gnus-emphasis-underline-italic '((t (:italic t :underline t)))
472
  "Face used for displaying underlined italic emphasized text (_/word/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
473 474
  :group 'gnus-article-emphasis)

475
(defface gnus-emphasis-bold-italic '((t (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
476 477 478 479
  "Face used for displaying bold italic emphasized text (/*word*/)."
  :group 'gnus-article-emphasis)

(defface gnus-emphasis-underline-bold-italic
480
  '((t (:bold t :italic t :underline t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
481
  "Face used for displaying underlined bold italic emphasized text.
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
482
Example: (_/*word*/_)."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
483 484
  :group 'gnus-article-emphasis)

485 486 487 488 489 490
(defface gnus-emphasis-strikethru (if (featurep 'xemacs)
				      '((t (:strikethru t)))
				    '((t (:strike-through t))))
  "Face used for displaying strike-through text (-word-)."
  :group 'gnus-article-emphasis)

491 492 493 494 495
(defface gnus-emphasis-highlight-words
  '((t (:background "black" :foreground "yellow")))
  "Face used for displaying highlighted words."
  :group 'gnus-article-emphasis)

496
(defcustom gnus-article-time-format "%a, %d %b %Y %T %Z"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
497
  "Format for display of Date headers in article bodies.
498 499 500 501 502
See `format-time-string' for the possible values.

The variable can also be function, which should return a complete Date
header.  The function is called with one argument, the time, which can
be fed to `format-time-string'."
503
  :type '(choice string function)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
504 505 506 507
  :link '(custom-manual "(gnus)Article Date")
  :group 'gnus-article-washing)

(defcustom gnus-save-all-headers t
Miles Bader's avatar
Miles Bader committed
508 509 510 511
  "*If non-nil, don't remove any headers before saving.
This will be overridden by the `:headers' property that the symbol of
the saver function, which is specified by `gnus-default-article-saver',
might have."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
512 513 514 515 516 517 518 519 520 521 522 523 524 525
  :group 'gnus-article-saving
  :type 'boolean)

(defcustom gnus-prompt-before-saving 'always
  "*This variable says how much prompting is to be done when saving articles.
If it is nil, no prompting will be done, and the articles will be
saved to the default files.  If this variable is `always', each and
every article that is saved will be preceded by a prompt, even when
saving large batches of articles.  If this variable is neither nil not
`always', there the user will be prompted once for a file name for
each invocation of the saving commands."
  :group 'gnus-article-saving
  :type '(choice (item always)
		 (item :tag "never" nil)
526
		 (sexp :tag "once" :format "%t\n" :value t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
527 528 529 530 531

(defcustom gnus-saved-headers gnus-visible-headers
  "Headers to keep if `gnus-save-all-headers' is nil.
If `gnus-save-all-headers' is non-nil, this variable will be ignored.
If that variable is nil, however, all headers that match this regexp
Miles Bader's avatar
Miles Bader committed
532 533 534 535
will be kept while the rest will be deleted before saving.  This and
`gnus-save-all-headers' will be overridden by the `:headers' property
that the symbol of the saver function, which is specified by
`gnus-default-article-saver', might have."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
536
  :group 'gnus-article-saving
537
  :type 'regexp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
538

539
;; Note that "Rmail format" is mbox since Emacs 23, but Babyl before.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
540
(defcustom gnus-default-article-saver 'gnus-summary-save-in-rmail
Paul Eggert's avatar
Paul Eggert committed
541
  "A function to save articles in your favorite format.
Miles Bader's avatar
Miles Bader committed
542 543
The function will be called by way of the `gnus-summary-save-article'
command, and friends such as `gnus-summary-save-article-rmail'.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
544 545 546 547 548 549 550

Gnus provides the following functions:

* gnus-summary-save-in-rmail (Rmail format)
* gnus-summary-save-in-mail (Unix mail format)
* gnus-summary-save-in-folder (MH folder)
* gnus-summary-save-in-file (article format)
551
* gnus-summary-save-body-in-file (article body)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
552
* gnus-summary-save-in-vm (use VM's folder format)
Miles Bader's avatar
Miles Bader committed
553 554
* gnus-summary-write-to-file (article format -- overwrite)
* gnus-summary-write-body-to-file (article body -- overwrite)
Miles Bader's avatar
Miles Bader committed
555
* gnus-summary-save-in-pipe (article format)
Miles Bader's avatar
Miles Bader committed
556 557 558 559 560 561

The symbol of each function may have the following properties:

* :decode
The value non-nil means save decoded articles.  This is meaningful
only with `gnus-summary-save-in-file', `gnus-summary-save-body-in-file',
Miles Bader's avatar
Miles Bader committed
562 563
`gnus-summary-write-to-file', `gnus-summary-write-body-to-file', and
`gnus-summary-save-in-pipe'.
Miles Bader's avatar
Miles Bader committed
564 565 566 567 568 569 570 571 572 573 574 575 576

* :function
The value specifies an alternative function which appends, not
overwrites, articles to a file.  This implies that when saving many
articles at a time, `gnus-prompt-before-saving' is bound to t and all
articles are saved in a single file.  This is meaningful only with
`gnus-summary-write-to-file' and `gnus-summary-write-body-to-file'.

* :headers
The value specifies the symbol of a variable of which the value
specifies headers to be saved.  If it is omitted,
`gnus-save-all-headers' and `gnus-saved-headers' control what
headers should be saved."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
577 578 579 580 581
  :group 'gnus-article-saving
  :type '(radio (function-item gnus-summary-save-in-rmail)
		(function-item gnus-summary-save-in-mail)
		(function-item gnus-summary-save-in-folder)
		(function-item gnus-summary-save-in-file)
582
		(function-item gnus-summary-save-body-in-file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
583
		(function-item gnus-summary-save-in-vm)
584
		(function-item gnus-summary-write-to-file)
Miles Bader's avatar
Miles Bader committed
585
		(function-item gnus-summary-write-body-to-file)
Miles Bader's avatar
Miles Bader committed
586
		(function-item gnus-summary-save-in-pipe)
587
		(function)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
588

Miles Bader's avatar
Miles Bader committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
(defcustom gnus-article-save-coding-system
  (or (and (mm-coding-system-p 'utf-8) 'utf-8)
      (and (mm-coding-system-p 'iso-2022-7bit) 'iso-2022-7bit)
      (and (mm-coding-system-p 'emacs-mule) 'emacs-mule)
      (and (mm-coding-system-p 'escape-quoted) 'escape-quoted))
  "Coding system used to save decoded articles to a file.

The recommended coding systems are `utf-8', `iso-2022-7bit' and so on,
which can safely encode any characters in text.  This is used by the
commands including:

* gnus-summary-save-article-file
* gnus-summary-save-article-body-file
* gnus-summary-write-article-file
* gnus-summary-write-article-body-file

and the functions to which you may set `gnus-default-article-saver':

* gnus-summary-save-in-file
* gnus-summary-save-body-in-file
* gnus-summary-write-to-file
* gnus-summary-write-body-to-file

Those commands and functions save just text displayed in the article
buffer to a file if the value of this variable is non-nil.  Note that
buttonized MIME parts will be lost in a saved file in that case.
Otherwise, raw articles will be saved."
  :group 'gnus-article-saving
  :type `(choice
	  :format "%{%t%}:\n %[Value Menu%] %v"
	  (const :tag "Save raw articles" nil)
	  ,@(delq nil
		  (mapcar
		   (lambda (arg) (if (mm-coding-system-p (nth 3 arg)) arg))
		   '((const :tag "UTF-8" utf-8)
		     (const :tag "iso-2022-7bit" iso-2022-7bit)
		     (const :tag "Emacs internal" emacs-mule)
		     (const :tag "escape-quoted" escape-quoted))))
	  (symbol :tag "Coding system")))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
(defcustom gnus-rmail-save-name 'gnus-plain-save-name
  "A function generating a file name to save articles in Rmail format.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-mail-save-name 'gnus-plain-save-name
  "A function generating a file name to save articles in Unix mail format.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-folder-save-name 'gnus-folder-save-name
  "A function generating a file name to save articles in MH folder.
The function is called with NEWSGROUP, HEADERS, and optional LAST-FOLDER."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-file-save-name 'gnus-numeric-save-name
  "A function generating a file name to save articles in article format.
The function is called with NEWSGROUP, HEADERS, and optional
LAST-FILE."
  :group 'gnus-article-saving
  :type 'function)

(defcustom gnus-split-methods
  '((gnus-article-archive-name)
    (gnus-article-nndoc-name))
657
  "*Variable used to suggest where articles are to be saved.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
658 659 660 661 662 663 664
For instance, if you would like to save articles related to Gnus in
the file \"gnus-stuff\", and articles related to VM in \"vm-stuff\",
you could set this variable to something like:

 '((\"^Subject:.*gnus\\|^Newsgroups:.*gnus\" \"gnus-stuff\")
   (\"^Subject:.*vm\\|^Xref:.*vm\" \"vm-stuff\"))

665 666 667
This variable is an alist where the key is the match and the
value is a list of possible files to save in if the match is
non-nil.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
668 669 670 671

If the match is a string, it is used as a regexp match on the
article.  If the match is a symbol, that symbol will be funcalled
from the buffer of the article to be saved with the newsgroup as the
Paul Eggert's avatar
Paul Eggert committed
672
parameter.  If it is a list, it will be evalled in the same buffer.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
673

674 675 676
If this form or function returns a string, this string will be used as a
possible file name; and if it returns a non-nil list, that list will be
used as possible file names."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
677
  :group 'gnus-article-saving
678 679 680
  :type '(repeat (choice (list :value (fun) function)
			 (cons :value ("" "") regexp (repeat string))
			 (sexp :value nil))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
681 682 683 684 685 686 687 688

(defcustom gnus-page-delimiter "^\^L"
  "*Regexp describing what to use as article page delimiters.
The default value is \"^\^L\", which is a form linefeed at the
beginning of a line."
  :type 'regexp
  :group 'gnus-article-various)

689
(defcustom gnus-article-mode-line-format "Gnus: %g %S%m"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
690
  "*The format specification for the article mode line.
691 692 693 694 695 696
See `gnus-summary-mode-line-format' for a closer description.

The following additional specs are available:

%w  The article washing status.
%m  The number of MIME parts in the article."
697
  :version "24.1"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
698 699 700 701 702 703 704 705
  :type 'string
  :group 'gnus-article-various)

(defcustom gnus-article-mode-hook nil
  "*A hook for Gnus article mode."
  :type 'hook
  :group 'gnus-article-various)

706 707 708 709 710 711 712
(when (featurep 'xemacs)
  ;; Extracted from gnus-xmas-define in order to preserve user settings
  (when (fboundp 'turn-off-scroll-in-place)
    (add-hook 'gnus-article-mode-hook 'turn-off-scroll-in-place))
  ;; Extracted from gnus-xmas-redefine in order to preserve user settings
  (add-hook 'gnus-article-mode-hook 'gnus-xmas-article-menu-add))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
713 714 715 716 717 718
(defcustom gnus-article-menu-hook nil
  "*Hook run after the creation of the article mode menu."
  :type 'hook
  :group 'gnus-article-various)

(defcustom gnus-article-prepare-hook nil
719
  "*A hook called after an article has been prepared in the article buffer."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
720 721 722
  :type 'hook
  :group 'gnus-article-various)

723 724 725
(defcustom gnus-copy-article-ignored-headers nil
  "List of headers to be removed when copying an article.
Each element is a regular expression."
726
  :version "23.1" ;; No Gnus
727 728 729
  :type '(repeat regexp)
  :group 'gnus-article-various)

730
(make-obsolete-variable 'gnus-article-hide-pgp-hook nil
731
			"Gnus 5.10 (Emacs 22.1)")
732

733 734 735 736 737 738
(defface gnus-button
  '((t (:weight bold)))
  "Face used for highlighting a button in the article buffer."
  :group 'gnus-article-buttons)

(defcustom gnus-article-button-face 'gnus-button
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
  "Face used for highlighting buttons in the article buffer.

An article button is a piece of text that you can activate by pressing
`RET' or `mouse-2' above it."
  :type 'face
  :group 'gnus-article-buttons)

(defcustom gnus-article-mouse-face 'highlight
  "Face used for mouse highlighting in the article buffer.

Article buttons will be displayed in this face when the cursor is
above them."
  :type 'face
  :group 'gnus-article-buttons)

754
(defcustom gnus-signature-face 'gnus-signature
755
  "Face used for highlighting a signature in the article buffer.
756
Obsolete; use the face `gnus-signature' for customizations instead."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
757 758 759 760
  :type 'face
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)

761
(defface gnus-signature
762
  '((t
763
     (:italic t)))
764 765 766
  "Face used for highlighting a signature in the article buffer."
  :group 'gnus-article-highlight
  :group 'gnus-article-signature)
767 768
;; backward-compatibility alias
(put 'gnus-signature-face 'face-alias 'gnus-signature)
769
(put 'gnus-signature-face 'obsolete-face "22.1")
770

771
(defface gnus-header-from
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
772 773
  '((((class color)
      (background dark))
774
     (:foreground "PaleGreen1"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
775 776
    (((class color)
      (background light))
777
     (:foreground "red3"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
778
    (t
779
     (:italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
780 781 782
  "Face used for displaying from headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
783 784
;; backward-compatibility alias
(put 'gnus-header-from-face 'face-alias 'gnus-header-from)
785
(put 'gnus-header-from-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
786

787
(defface gnus-header-subject
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
788 789
  '((((class color)
      (background dark))
790
     (:foreground "SeaGreen1"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
791 792
    (((class color)
      (background light))
793
     (:foreground "red4"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
794
    (t
795
     (:bold t :italic t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
796 797 798
  "Face used for displaying subject headers."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
799 800
;; backward-compatibility alias
(put 'gnus-header-subject-face 'face-alias 'gnus-header-subject)
801
(put 'gnus-header-subject-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
802

803
(defface gnus-header-newsgroups
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
804 805
  '((((class color)
      (background dark))
806
     (:foreground "yellow" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
807 808
    (((class color)
      (background light))
809
     (:foreground "MidnightBlue" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
810
    (t
811 812 813 814
     (:italic t)))
  "Face used for displaying newsgroups headers.
In the default setup this face is only used for crossposted
articles."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
815 816
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
817 818
;; backward-compatibility alias
(put 'gnus-header-newsgroups-face 'face-alias 'gnus-header-newsgroups)
819
(put 'gnus-header-newsgroups-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
820

821
(defface gnus-header-name
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
822 823
  '((((class color)
      (background dark))
824
     (:foreground "SpringGreen2"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
825 826 827 828
    (((class color)
      (background light))
     (:foreground "maroon"))
    (t
829
     (:bold t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
830 831 832
  "Face used for displaying header names."
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
833 834
;; backward-compatibility alias
(put 'gnus-header-name-face 'face-alias 'gnus-header-name)
835
(put 'gnus-header-name-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
836

837
(defface gnus-header-content
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
838 839
  '((((class color)
      (background dark))
840
     (:foreground "SpringGreen1" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842
    (((class color)
      (background light))
843
     (:foreground "indianred4" :italic t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
844
    (t
845
     (:italic t)))  "Face used for displaying header content."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
846 847
  :group 'gnus-article-headers
  :group 'gnus-article-highlight)
848 849
;; backward-compatibility alias
(put 'gnus-header-content-face 'face-alias 'gnus-header-content)
850
(put 'gnus-header-content-face 'obsolete-face "22.1")
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
851 852

(defcustom gnus-header-face-alist
853 854 855 856
  '(("From" nil gnus-header-from)
    ("Subject" nil gnus-header-subject)
    ("Newsgroups:.*," nil gnus-header-newsgroups)
    ("" gnus-header-name gnus-header-content))
857
  "*Controls highlighting of article headers.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
858 859 860

An alist of the form (HEADER NAME CONTENT).

861 862
HEADER is a regular expression which should match the name of a
header and NAME and CONTENT are either face names or nil.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
863 864

The name of each header field will be displayed using the face
865 866 867
specified by the first element in the list where HEADER matches
the header name and NAME is non-nil.  Similarly, the content will
be displayed by the first non-nil matching CONTENT face."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
868 869 870 871 872 873 874 875 876 877
  :group 'gnus-article-headers
  :group 'gnus-article-highlight
  :type '(repeat (list (regexp :tag "Header")
		       (choice :tag "Name"
			       (item :tag "skip" nil)
			       (face :value default))
		       (choice :tag "Content"
			       (item :tag "skip" nil)
			       (face :value default)))))

878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
(defcustom gnus-face-properties-alist (if (featurep 'xemacs)
					  '((xface . (:face gnus-x-face)))
					'((pbm . (:face gnus-x-face))
					  (png . nil)))
  "Alist of image types and properties applied to Face and X-Face images.
Here are examples:

;; Specify the altitude of Face images in the From header.
\(setq gnus-face-properties-alist
      '((pbm . (:face gnus-x-face :ascent 80))
	(png . (:ascent 80))))

;; Show Face images as pressed buttons.
\(setq gnus-face-properties-alist
      '((pbm . (:face gnus-x-face :relief -2))
	(png . (:relief -2))))

See the manual for the valid properties for various image types.
Currently, `pbm' is used for X-Face images and `png' is used for Face
images in Emacs.  Only the `:face' property is effective on the `xface'
image type in XEmacs if it is built with the libcompface library."
899
  :version "23.1" ;; No Gnus
900 901 902
  :group 'gnus-article-headers
  :type '(repeat (cons :format "%v" (symbol :tag "Image type") plist)))

903
(defcustom gnus-article-decode-hook
904 905
  '(article-decode-charset article-decode-encoded-words
			   article-decode-group-name article-decode-idna-rhs)
906 907 908 909 910 911 912 913 914 915 916 917
  "*Hook run to decode charsets in articles."
  :group 'gnus-article-headers
  :type 'hook)

(defcustom gnus-display-mime-function 'gnus-display-mime
  "Function to display MIME articles."
  :group 'gnus-article-mime
  :type 'function)

(defvar gnus-decode-header-function 'mail-decode-encoded-word-region
  "Function used to decode headers.")

Miles Bader's avatar
Miles Bader committed
918 919 920
(defvar gnus-decode-address-function 'mail-decode-encoded-address-region
  "Function used to decode addresses.")

921
(defvar gnus-article-dumbquotes-map
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
  '((?\200 "EUR")
    (?\202 ",")
    (?\203 "f")
    (?\204 ",,")
    (?\205 "...")
    (?\213 "<")
    (?\214 "OE")
    (?\221 "`")
    (?\222 "'")
    (?\223 "``")
    (?\224 "\"")
    (?\225 "*")
    (?\226 "-")
    (?\227 "--")
    (?\230 "~")
    (?\231 "(TM)")
    (?\233 ">")
    (?\234 "oe")
    (?\264 "'"))
941 942 943 944
  "Table for MS-to-Latin1 translation.")

(defcustom gnus-ignored-mime-types nil
  "List of MIME types that should be ignored by Gnus."
Dave Love's avatar
Dave Love committed
945
  :version "21.1"
946 947 948 949
  :group 'gnus-article-mime
  :type '(repeat regexp))

(defcustom gnus-unbuttonized-mime-types '(".*/.*")
950 951 952 953 954 955 956 957 958 959 960
  "List of MIME types that should not be given buttons when rendered inline.
See also `gnus-buttonized-mime-types' which may override this variable.
This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
  :version "21.1"
  :group 'gnus-article-mime
  :type '(repeat regexp))

(defcustom gnus-buttonized-mime-types nil
  "List of MIME types that should be given buttons when rendered inline.
If set, this variable overrides `gnus-unbuttonized-mime-types'.
To see e.g. security buttons you could set this to
961 962 963
`(\"multipart/signed\")'.  You could also add \"multipart/alternative\" to
this list to display radio buttons that allow you to choose one of two
media types those mails include.  See also `mm-discouraged-alternatives'.
964
This variable is only used when `gnus-inhibit-mime-unbuttonizing' is nil."
965
  :version "22.1"
966 967 968
  :group 'gnus-article-mime
  :type '(repeat regexp))

969 970 971 972 973
(defcustom gnus-inhibit-mime-unbuttonizing nil
  "If non-nil, all MIME parts get buttons.
When nil (the default value), then some MIME parts do not get buttons,
as described by the variables `gnus-buttonized-mime-types' and
`gnus-unbuttonized-mime-types'."
974
  :version "22.1"
975
  :group 'gnus-article-mime
976 977 978 979 980 981
  :type 'boolean)

(defcustom gnus-body-boundary-delimiter "_"
  "String used to delimit header and body.
This variable is used by `gnus-article-treat-body-boundary' which can
be controlled by `gnus-treat-body-boundary'."
982
  :version "22.1"
983 984 985 986
  :group 'gnus-article-various
  :type '(choice (item :tag "None" :value nil)
		 string))

987 988
(defcustom gnus-picon-databases '("/usr/lib/picon" "/usr/local/faces"
				  "/usr/share/picons")
989 990 991
  "Defines the location of the faces database.
For information on obtaining this database of pretty pictures, please
see http://www.cs.indiana.edu/picons/ftp/index.html"
992
  :version "22.1"
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
  :type '(repeat directory)
  :link '(url-link :tag "download"
		   "http://www.cs.indiana.edu/picons/ftp/index.html")
  :link '(custom-manual "(gnus)Picons")
  :group 'gnus-picon)

(defun gnus-picons-installed-p ()
  "Say whether picons are installed on your machine."
  (let ((installed nil))
    (dolist (database gnus-picon-databases)
      (when (file-exists-p database)
	(setq installed t)))
    installed))

1007 1008 1009 1010 1011
(defcustom gnus-article-mime-part-function nil
  "Function called with a MIME handle as the argument.
This is meant for people who want to do something automatic based
on parts -- for instance, adding Vcard info to a database."
  :group 'gnus-article-mime
1012 1013
  :type '(choice (const nil)
		 function))
1014 1015

(defcustom gnus-mime-multipart-functions nil
Dave Love's avatar
Dave Love committed
1016 1017 1018
  "An alist of MIME types to functions to display them."
  :version "21.1"
  :group 'gnus-article-mime
1019
  :type '(repeat (cons :format "%v" (string :tag "MIME type") function)))
1020

1021
(defcustom gnus-article-date-headers '(combined-lapsed)
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
  "A list of Date header formats to display.
Valid formats are `ut' (universal time), `local' (local time
zone), `english' (readable English), `lapsed' (elapsed time),
`combined-lapsed' (both the original date and the elapsed time),
`original' (the original date header), `iso8601' (ISO8601
format), and `user-defined' (a user-defined format defined by the
`gnus-article-time-format' variable).

You have as many date headers as you want in the article buffer.
Some of these headers are updated automatically.  See
`gnus-article-update-date-headers' for details."
  :version "24.1"
1034
  :group 'gnus-article-headers
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
  :type '(repeat
	  (item :tag "Universal time (UT)" :value 'ut)
	  (item :tag "Local time zone" :value 'local)
	  (item :tag "Readable English" :value 'english)
	  (item :tag "Elapsed time" :value 'lapsed)
	  (item :tag "Original and elapsed time" :value 'combined-lapsed)
	  (item :tag "Original date header" :value 'original)
	  (item :tag "ISO8601 format" :value 'iso8601)
	  (item :tag "User-defined" :value 'user-defined)))

1045
(defcustom gnus-article-update-date-headers nil
1046
  "A number that says how often to update the date header (in seconds).
1047 1048 1049 1050 1051 1052 1053
If nil, don't update it at all."
  :version "24.1"
  :group 'gnus-article-headers
  :type '(choice
	  (item :tag "Don't update" :value nil)
	  integer))

1054 1055 1056
(defcustom gnus-article-mime-match-handle-function 'undisplayed-alternative
  "Function called with a MIME handle as the argument.
This is meant for people who want to view first matched part.
1057 1058 1059
For `undisplayed-alternative' (default), the first undisplayed
part or alternative part is used.  For `undisplayed', the first
undisplayed part is used.  For a function, the first part which
1060
the function return t is used.  For nil, the first part is
1061
used."
Dave Love's avatar
Dave Love committed
1062
  :version "21.1"
1063
  :group 'gnus-article-mime
1064
  :type '(choice
1065 1066
	  (item :tag "first" :value nil)
	  (item :tag "undisplayed" :value undisplayed)
1067
	  (item :tag "undisplayed or alternative"
1068 1069 1070
		:value undisplayed-alternative)
	  (function)))

1071 1072
(defcustom gnus-mime-action-alist
  '(("save to file" . gnus-mime-save-part)
1073
    ("save and strip" . gnus-mime-save-part-and-strip)
1074
    ("replace with file" . gnus-mime-replace-part)
1075
    ("delete part" . gnus-mime-delete-part)
1076 1077 1078 1079
    ("display as text" . gnus-mime-inline-part)
    ("view the part" . gnus-mime-view-part)
    ("pipe to command" . gnus-mime-pipe-part)
    ("toggle display" . gnus-article-press-button)
1080
    ("toggle display" . gnus-article-view-part-as-charset)
1081
    ("view as type" . gnus-mime-view-part-as-type)
1082 1083
    ("view internally" . gnus-mime-view-part-internally)
    ("view externally" . gnus-mime-view-part-externally))
1084 1085 1086 1087 1088
  "An alist of actions that run on the MIME attachment."
  :group 'gnus-article-mime
  :type '(repeat (cons (string :tag "name")
		       (function))))

1089 1090 1091 1092 1093 1094
(defcustom gnus-auto-select-part 1
  "Advance to next MIME part when deleting or stripping parts.

When 0, point will be placed on the same part as before.  When
positive (negative), move point forward (backwards) this many
parts.  When nil, redisplay article."
1095
  :version "23.1" ;; No Gnus
1096 1097 1098 1099 1100 1101
  :group 'gnus-article-mime
  :type '(choice (const nil :tag "Redisplay article.")
		 (const 1 :tag "Next part.")
		 (const 0 :tag "Current part.")
		 integer))

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
;;;
;;; The treatment variables
;;;

(defvar gnus-part-display-hook nil
  "Hook called on parts that are to receive treatment.")

(defvar gnus-article-treat-custom
  '(choice (const :tag "Off" nil)
	   (const :tag "On" t)
	   (const :tag "Header" head)
1113
	   (const :tag "First" first)
1114 1115 1116 1117 1118 1119 1120 1121 1122
	   (const :tag "Last" last)
	   (integer :tag "Less")
	   (repeat :tag "Groups" regexp)
	   (sexp :tag "Predicate")))

(defvar gnus-article-treat-head-custom
  '(choice (const :tag "Off" nil)
	   (const :tag "Header" head)))

1123 1124
(defvar gnus-article-treat-types '("text/plain" "text/x-verbatim"
				   "text/x-patch")
1125 1126 1127 1128 1129
  "Parts to treat.")

(defvar gnus-inhibit-treatment nil
  "Whether to inhibit treatment.")

1130
(defcustom gnus-treat-highlight-signature '(or t (typep "text/x-vcard"))
1131
  "Highlight the signature.
1132 1133
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1134
  :group 'gnus-article-treat
1135
  :link '(custom-manual "(gnus)Customizing Articles")
1136 1137 1138 1139 1140
  :type gnus-article-treat-custom)
(put 'gnus-treat-highlight-signature 'highlight t)

(defcustom gnus-treat-buttonize 100000
  "Add buttons.
1141 1142
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1143
  :group 'gnus-article-treat
1144
  :link '(custom-manual "(gnus)Customizing Articles")
1145 1146 1147 1148 1149
  :type gnus-article-treat-custom)
(put 'gnus-treat-buttonize 'highlight t)

(defcustom gnus-treat-buttonize-head 'head
  "Add buttons to the head.
1150 1151
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1152
  :group 'gnus-article-treat
1153
  :link '(custom-manual "(gnus)Customizing Articles")
1154 1155 1156
  :type gnus-article-treat-head-custom)
(put 'gnus-treat-buttonize-head 'highlight t)

1157 1158 1159 1160 1161 1162 1163 1164 1165
(defcustom gnus-treat-date 'head
  "Display dates according to the `gnus-article-date-headers' variable.
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
  :version "24.1"
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-head-custom)

Miles Bader's avatar
Miles Bader committed
1166
(defcustom gnus-treat-emphasize 50000
1167
  "Emphasize text.
1168 1169
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1170
  :group 'gnus-article-treat
1171
  :link '(custom-manual "(gnus)Customizing Articles")
1172 1173 1174 1175 1176
  :type gnus-article-treat-custom)
(put 'gnus-treat-emphasize 'highlight t)

(defcustom gnus-treat-strip-cr nil
  "Remove carriage returns.
1177 1178
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1179
  :version "22.1"
1180
  :group 'gnus-article-treat
1181 1182 1183 1184 1185
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-custom)

(defcustom gnus-treat-unsplit-urls nil
  "Remove newlines from within URLs.
1186 1187
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1188
  :version "22.1"
1189 1190 1191 1192 1193 1194
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
  :type gnus-article-treat-custom)

(defcustom gnus-treat-leading-whitespace nil
  "Remove leading whitespace in headers.
1195 1196
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1197
  :version "22.1"
1198 1199
  :group 'gnus-article-treat
  :link '(custom-manual "(gnus)Customizing Articles")
1200 1201 1202 1203
  :type gnus-article-treat-custom)

(defcustom gnus-treat-hide-headers 'head
  "Hide headers.
1204 1205
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1206
  :group 'gnus-article-treat
1207
  :link '(custom-manual "(gnus)Customizing Articles")
1208 1209 1210 1211
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-hide-boring-headers nil
  "Hide boring headers.
1212 1213
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1214
  :group 'gnus-article-treat
1215
  :link '(custom-manual "(gnus)Customizing Articles")
1216 1217 1218 1219
  :type gnus-article-treat-head-custom)

(defcustom gnus-treat-hide-signature nil
  "Hide the signature.
1220 1221
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1222
  :group 'gnus-article-treat
1223
  :link '(custom-manual "(gnus)Customizing Articles")
1224 1225 1226 1227
  :type gnus-article-treat-custom)

(defcustom gnus-treat-fill-article nil
  "Fill the article.
1228 1229
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1230
  :group 'gnus-article-treat
1231
  :link '(custom-manual "(gnus)Customizing Articles")
1232 1233 1234 1235
  :type gnus-article-treat-custom)

(defcustom gnus-treat-hide-citation nil
  "Hide cited text.
1236
Valid values are nil, t, `head', `first', `last', an integer or a
1237 1238 1239 1240
predicate.  See Info node `(gnus)Customizing Articles'.

See `gnus-article-highlight-citation' for variables used to
control what it hides."
1241
  :group 'gnus-article-treat
1242
  :link '(custom-manual "(gnus)Customizing Articles")
1243 1244
  :type gnus-article-treat-custom)

1245
(defcustom gnus-treat-hide-citation-maybe nil
1246
  "Hide cited text according to certain conditions.
1247
Valid values are nil, t, `head', `first', `last', an integer or a
1248 1249 1250 1251
predicate.  See Info node `(gnus)Customizing Articles'.

See `gnus-cite-hide-percentage' and `gnus-cite-hide-absolute' for
how to control what it hides."
1252
  :group 'gnus-article-treat
1253
  :link '(custom-manual "(gnus)Customizing Articles")
1254 1255
  :type gnus-article-treat-custom)

1256 1257
(defcustom gnus-treat-strip-list-identifiers 'head
  "Strip list identifiers from `gnus-list-identifiers`.
1258 1259
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
Dave Love's avatar
Dave Love committed
1260
  :version "21.1"
1261
  :group 'gnus-article-treat
1262
  :link '(custom-manual "(gnus)Customizing Articles")
1263 1264
  :type gnus-article-treat-custom)

1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282
(gnus-define-group-parameter
 list-identifier
 :variable-document
 "Alist of regexps and correspondent identifiers."
 :variable-group gnus-article-washing
 :parameter-type
 '(choice :tag "Identifier"
	  :value nil
	  (symbol :tag "Item in `gnus-list-identifiers'" none)
	  regexp
	  (const :tag "None" nil))
 :parameter-document
 "If non-nil, specify how to remove `identifiers' from articles' subject.

Any symbol is used to look up a regular expression to match the
banner in `gnus-list-identifiers'.  A string is used as a regular
expression to match the identifier directly.")

1283 1284
(make-obsolete-variable 'gnus-treat-strip-pgp nil
			"Gnus 5.10 (Emacs 22.1)")
1285 1286 1287

(defcustom gnus-treat-strip-pem nil
  "Strip PEM signatures.
1288 1289
Valid values are nil, t, `head', `first', `last', an integer or a
predicate.  See Info node `(gnus)Customizing Articles'."
1290
  :group 'gnus-article-treat
1291
  :link '(custom-manual "(gnus)Customizing Articles")
Gerd Moellmann's avatar