1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
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
12 ;; This file is part of GNU Emacs.
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)
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.
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., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
33 (eval '(run-hooks 'gnus-load-hook))
35 (eval-when-compile (require 'cl))
36 (eval-when-compile (require 'static))
40 (autoload 'message-y-or-n-p "message" nil nil 'macro)
45 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
49 (defgroup gnus-format nil
50 "Dealing with formatting issues."
53 (defgroup gnus-charset nil
54 "Group character set issues."
55 :link '(custom-manual "(gnus)Charsets")
59 (defgroup gnus-cache nil
61 :link '(custom-manual "(gnus)Article Caching")
64 (defgroup gnus-registry nil
68 (defgroup gnus-start nil
69 "Starting your favorite newsreader."
72 (defgroup gnus-start-server nil
73 "Server options at startup."
76 ;; These belong to gnus-group.el.
77 (defgroup gnus-group nil
79 :link '(custom-manual "(gnus)Group Buffer")
82 (defgroup gnus-group-foreign nil
84 :link '(custom-manual "(gnus)Foreign Groups")
87 (defgroup gnus-group-new nil
88 "Automatic subscription of new groups."
91 (defgroup gnus-group-levels nil
93 :link '(custom-manual "(gnus)Group Levels")
96 (defgroup gnus-group-select nil
98 :link '(custom-manual "(gnus)Selecting a Group")
101 (defgroup gnus-group-listing nil
102 "Showing slices of the group list."
103 :link '(custom-manual "(gnus)Listing Groups")
106 (defgroup gnus-group-visual nil
107 "Sorting the group buffer."
108 :link '(custom-manual "(gnus)Group Buffer Format")
112 (defgroup gnus-group-various nil
113 "Various group options."
114 :link '(custom-manual "(gnus)Scanning New Messages")
117 ;; These belong to gnus-sum.el.
118 (defgroup gnus-summary nil
120 :link '(custom-manual "(gnus)Summary Buffer")
123 (defgroup gnus-summary-exit nil
124 "Leaving summary buffers."
125 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
126 :group 'gnus-summary)
128 (defgroup gnus-summary-marks nil
129 "Marks used in summary buffers."
130 :link '(custom-manual "(gnus)Marking Articles")
131 :group 'gnus-summary)
133 (defgroup gnus-thread nil
134 "Ordering articles according to replies."
135 :link '(custom-manual "(gnus)Threading")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-format nil
139 "Formatting of the summary buffer."
140 :link '(custom-manual "(gnus)Summary Buffer Format")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-choose nil
145 :link '(custom-manual "(gnus)Choosing Articles")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-maneuvering nil
149 "Summary movement commands."
150 :link '(custom-manual "(gnus)Summary Maneuvering")
151 :group 'gnus-summary)
153 (defgroup gnus-picon nil
154 "Show pictures of people, domains, and newsgroups."
157 (defgroup gnus-summary-mail nil
158 "Mail group commands."
159 :link '(custom-manual "(gnus)Mail Group Commands")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-sort nil
163 "Sorting the summary buffer."
164 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-visual nil
168 "Highlighting and menus in the summary buffer."
169 :link '(custom-manual "(gnus)Summary Highlighting")
171 :group 'gnus-summary)
173 (defgroup gnus-summary-various nil
174 "Various summary buffer options."
175 :link '(custom-manual "(gnus)Various Summary Stuff")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-pick nil
179 "Pick mode in the summary buffer."
180 :link '(custom-manual "(gnus)Pick and Read")
182 :group 'gnus-summary)
184 (defgroup gnus-summary-tree nil
185 "Tree display of threads in the summary buffer."
186 :link '(custom-manual "(gnus)Tree Display")
188 :group 'gnus-summary)
190 ;; Belongs to gnus-uu.el
191 (defgroup gnus-extract-view nil
192 "Viewing extracted files."
193 :link '(custom-manual "(gnus)Viewing Files")
194 :group 'gnus-extract)
196 ;; Belongs to gnus-score.el
197 (defgroup gnus-score nil
198 "Score and kill file handling."
201 (defgroup gnus-score-kill nil
205 (defgroup gnus-score-adapt nil
206 "Adaptive score files."
209 (defgroup gnus-score-default nil
210 "Default values for score files."
213 (defgroup gnus-score-expire nil
214 "Expiring score rules."
217 (defgroup gnus-score-decay nil
218 "Decaying score rules."
221 (defgroup gnus-score-files nil
222 "Score and kill file names."
226 (defgroup gnus-score-various nil
227 "Various scoring and killing options."
231 (defgroup gnus-visual nil
232 "Options controlling the visual fluff."
236 (defgroup gnus-agent nil
237 "Offline support for Gnus."
240 (defgroup gnus-files nil
241 "Files used by Gnus."
244 (defgroup gnus-dribble-file nil
246 :link '(custom-manual "(gnus)Auto Save")
249 (defgroup gnus-newsrc nil
250 "Storing Gnus state."
253 (defgroup gnus-server nil
254 "Options related to newsservers and other servers used by Gnus."
257 (defgroup gnus-server-visual nil
258 "Highlighting and menus in the server buffer."
262 (defgroup gnus-message '((message custom-group))
263 "Composing replies and followups in Gnus."
266 (defgroup gnus-meta nil
267 "Meta variables controlling major portions of Gnus.
268 In general, modifying these variables does not take affect until Gnus
269 is restarted, and sometimes reloaded."
272 (defgroup gnus-various nil
273 "Other Gnus options."
274 :link '(custom-manual "(gnus)Various Various")
277 (defgroup gnus-mime nil
278 "Variables for controlling the Gnus MIME interface."
281 (defgroup gnus-exit nil
283 :link '(custom-manual "(gnus)Exiting Gnus")
286 (defgroup gnus-fun nil
287 "Frivolous Gnus extensions."
288 :link '(custom-manual "(gnus)Exiting Gnus")
291 (defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293 This variable is used before `.gnus.el' is loaded, so it should
294 be set in `.emacs' instead."
298 (defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
303 (unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
306 (unless (featurep 'gnus-xmas)
307 (defalias 'gnus-make-overlay 'make-overlay)
308 (defalias 'gnus-delete-overlay 'delete-overlay)
309 (defalias 'gnus-overlay-put 'overlay-put)
310 (defalias 'gnus-move-overlay 'move-overlay)
311 (defalias 'gnus-overlay-buffer 'overlay-buffer)
312 (defalias 'gnus-overlay-start 'overlay-start)
313 (defalias 'gnus-overlay-end 'overlay-end)
314 (defalias 'gnus-extent-detached-p 'ignore)
315 (defalias 'gnus-extent-start-open 'ignore)
316 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
317 (defalias 'gnus-character-to-event 'identity)
318 (defalias 'gnus-assq-delete-all 'assq-delete-all)
319 (defalias 'gnus-add-text-properties 'add-text-properties)
320 (defalias 'gnus-put-text-property 'put-text-property)
321 (defvar gnus-mode-line-image-cache t)
322 (if (fboundp 'find-image)
323 (defun gnus-mode-line-buffer-identification (line)
324 (let ((str (car-safe line))
325 (load-path (mm-image-load-path)))
326 (if (and (stringp str)
327 (string-match "^Gnus:" str))
328 (progn (add-text-properties
331 (if (eq t gnus-mode-line-image-cache)
332 (setq gnus-mode-line-image-cache
334 '((:type xpm :file "gnus-pointer.xpm"
336 (:type xbm :file "gnus-pointer.xbm"
338 gnus-mode-line-image-cache)
341 gnus-version (gnus-emacs-version)))
345 (defalias 'gnus-mode-line-buffer-identification 'identity))
346 (defalias 'gnus-characterp 'numberp)
347 (defalias 'gnus-deactivate-mark 'deactivate-mark)
348 (defalias 'gnus-window-edges 'window-edges)
349 (defalias 'gnus-key-press-event-p 'numberp)
350 ;;(defalias 'gnus-decode-rfc1522 'ignore)
353 ;; We define these group faces here to avoid the display
354 ;; update forced when creating new faces.
356 (defface gnus-group-news-1-face
359 (:foreground "PaleTurquoise" :bold t))
362 (:foreground "ForestGreen" :bold t))
365 "Level 1 newsgroup face.")
367 (defface gnus-group-news-1-empty-face
370 (:foreground "PaleTurquoise"))
373 (:foreground "ForestGreen"))
376 "Level 1 empty newsgroup face.")
378 (defface gnus-group-news-2-face
381 (:foreground "turquoise" :bold t))
384 (:foreground "CadetBlue4" :bold t))
387 "Level 2 newsgroup face.")
389 (defface gnus-group-news-2-empty-face
392 (:foreground "turquoise"))
395 (:foreground "CadetBlue4"))
398 "Level 2 empty newsgroup face.")
400 (defface gnus-group-news-3-face
409 "Level 3 newsgroup face.")
411 (defface gnus-group-news-3-empty-face
420 "Level 3 empty newsgroup face.")
422 (defface gnus-group-news-4-face
431 "Level 4 newsgroup face.")
433 (defface gnus-group-news-4-empty-face
442 "Level 4 empty newsgroup face.")
444 (defface gnus-group-news-5-face
453 "Level 5 newsgroup face.")
455 (defface gnus-group-news-5-empty-face
464 "Level 5 empty newsgroup face.")
466 (defface gnus-group-news-6-face
475 "Level 6 newsgroup face.")
477 (defface gnus-group-news-6-empty-face
486 "Level 6 empty newsgroup face.")
488 (defface gnus-group-news-low-face
491 (:foreground "DarkTurquoise" :bold t))
494 (:foreground "DarkGreen" :bold t))
497 "Low level newsgroup face.")
499 (defface gnus-group-news-low-empty-face
502 (:foreground "DarkTurquoise"))
505 (:foreground "DarkGreen"))
508 "Low level empty newsgroup face.")
510 (defface gnus-group-mail-1-face
513 (:foreground "aquamarine1" :bold t))
516 (:foreground "DeepPink3" :bold t))
519 "Level 1 mailgroup face.")
521 (defface gnus-group-mail-1-empty-face
524 (:foreground "aquamarine1"))
527 (:foreground "DeepPink3"))
529 (:italic t :bold t)))
530 "Level 1 empty mailgroup face.")
532 (defface gnus-group-mail-2-face
535 (:foreground "aquamarine2" :bold t))
538 (:foreground "HotPink3" :bold t))
541 "Level 2 mailgroup face.")
543 (defface gnus-group-mail-2-empty-face
546 (:foreground "aquamarine2"))
549 (:foreground "HotPink3"))
552 "Level 2 empty mailgroup face.")
554 (defface gnus-group-mail-3-face
557 (:foreground "aquamarine3" :bold t))
560 (:foreground "magenta4" :bold t))
563 "Level 3 mailgroup face.")
565 (defface gnus-group-mail-3-empty-face
568 (:foreground "aquamarine3"))
571 (:foreground "magenta4"))
574 "Level 3 empty mailgroup face.")
576 (defface gnus-group-mail-low-face
579 (:foreground "aquamarine4" :bold t))
582 (:foreground "DeepPink4" :bold t))
585 "Low level mailgroup face.")
587 (defface gnus-group-mail-low-empty-face
590 (:foreground "aquamarine4"))
593 (:foreground "DeepPink4"))
596 "Low level empty mailgroup face.")
598 ;; Summary mode faces.
600 (defface gnus-summary-selected-face '((t
602 "Face used for selected articles.")
604 (defface gnus-summary-cancelled-face
606 (:foreground "yellow" :background "black")))
607 "Face used for cancelled articles.")
609 (defface gnus-summary-high-ticked-face
612 (:foreground "pink" :bold t))
615 (:foreground "firebrick" :bold t))
618 "Face used for high interest ticked articles.")
620 (defface gnus-summary-low-ticked-face
623 (:foreground "pink" :italic t))
626 (:foreground "firebrick" :italic t))
629 "Face used for low interest ticked articles.")
631 (defface gnus-summary-normal-ticked-face
634 (:foreground "pink"))
637 (:foreground "firebrick"))
640 "Face used for normal interest ticked articles.")
642 (defface gnus-summary-high-ancient-face
645 (:foreground "SkyBlue" :bold t))
648 (:foreground "RoyalBlue" :bold t))
651 "Face used for high interest ancient articles.")
653 (defface gnus-summary-low-ancient-face
656 (:foreground "SkyBlue" :italic t))
659 (:foreground "RoyalBlue" :italic t))
662 "Face used for low interest ancient articles.")
664 (defface gnus-summary-normal-ancient-face
667 (:foreground "SkyBlue"))
670 (:foreground "RoyalBlue"))
673 "Face used for normal interest ancient articles.")
675 (defface gnus-summary-high-undownloaded-face
678 (:bold t :foreground "cyan4"))
679 (((class color) (background dark))
680 (:bold t :foreground "LightGray"))
681 (t (:inverse-video t :bold t)))
682 "Face used for high interest uncached articles.")
684 (defface gnus-summary-low-undownloaded-face
687 (:italic t :foreground "cyan4" :bold nil))
688 (((class color) (background dark))
689 (:italic t :foreground "LightGray" :bold nil))
690 (t (:inverse-video t :italic t)))
691 "Face used for low interest uncached articles.")
693 (defface gnus-summary-normal-undownloaded-face
696 (:foreground "cyan4" :bold nil))
697 (((class color) (background dark))
698 (:foreground "LightGray" :bold nil))
699 (t (:inverse-video t)))
700 "Face used for normal interest uncached articles.")
702 (defface gnus-summary-high-unread-face
705 "Face used for high interest unread articles.")
707 (defface gnus-summary-low-unread-face
710 "Face used for low interest unread articles.")
712 (defface gnus-summary-normal-unread-face
715 "Face used for normal interest unread articles.")
717 (defface gnus-summary-incorporated-face
720 "Face used for incorporated articles.")
722 (defface gnus-summary-high-read-face
725 (:foreground "PaleGreen"
729 (:foreground "DarkGreen"
733 "Face used for high interest read articles.")
735 (defface gnus-summary-low-read-face
738 (:foreground "PaleGreen"
742 (:foreground "DarkGreen"
746 "Face used for low interest read articles.")
748 (defface gnus-summary-normal-read-face
751 (:foreground "PaleGreen"))
754 (:foreground "DarkGreen"))
757 "Face used for normal interest read articles.")
764 (defvar gnus-buffers nil)
766 (defun gnus-get-buffer-create (name)
767 "Do the same as `get-buffer-create', but store the created buffer."
768 (or (get-buffer name)
769 (car (push (get-buffer-create name) gnus-buffers))))
771 (defun gnus-add-buffer ()
772 "Add the current buffer to the list of Gnus buffers."
773 (push (current-buffer) gnus-buffers))
775 (defmacro gnus-kill-buffer (buffer)
776 "Kill BUFFER and remove from the list of Gnus buffers."
777 `(let ((buf ,buffer))
778 (when (gnus-buffer-exists-p buf)
779 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
782 (defun gnus-buffers ()
783 "Return a list of live Gnus buffers."
784 (while (and gnus-buffers
785 (not (buffer-name (car gnus-buffers))))
787 (let ((buffers gnus-buffers))
789 (if (buffer-name (cadr buffers))
791 (setcdr buffers (cddr buffers)))))
796 (defvar gnus-group-buffer "*Group*")
799 (autoload 'gnus-play-jingle "gnus-audio"))
801 (defface gnus-splash-face
804 (:foreground "#888888"))
807 (:foreground "#888888"))
810 "Face for the splash screen.")
812 (defun gnus-splash ()
814 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
815 (let ((buffer-read-only nil))
817 (unless gnus-inhibit-startup-message
818 (gnus-group-startup-message)
820 (when gnus-play-startup-jingle
821 (gnus-play-jingle))))))
823 (defun gnus-indent-rigidly (start end arg)
824 "Indent rigidly using only spaces and no tabs."
827 (narrow-to-region start end)
829 (indent-rigidly start end arg)
830 ;; We translate tabs into spaces -- not everybody uses
831 ;; an 8-character tab.
832 (goto-char (point-min))
833 (while (search-forward "\t" nil t)
834 (replace-match " " t t))))))
836 (defvar gnus-simple-splash nil)
838 ;;(format "%02x%02x%02x" 114 66 20) "724214"
840 (defvar gnus-logo-color-alist
841 '((flame "#cc3300" "#ff2200")
842 (pine "#c0cc93" "#f8ffb8")
843 (moss "#a1cc93" "#d2ffb8")
844 (irish "#04cc90" "#05ff97")
845 (sky "#049acc" "#05deff")
846 (tin "#6886cc" "#82b6ff")
847 (velvet "#7c68cc" "#8c82ff")
848 (grape "#b264cc" "#cf7df")
849 (labia "#cc64c2" "#fd7dff")
850 (berry "#cc6485" "#ff7db5")
851 (dino "#724214" "#1e3f03")
852 (oort "#cccccc" "#888888")
853 (storm "#666699" "#99ccff")
854 (pdino "#9999cc" "#99ccff")
855 (purp "#9999cc" "#666699")
856 (no "#ff0000" "#ffff00")
857 (neutral "#b4b4b4" "#878787")
858 (september "#bf9900" "#ffcc00"))
859 "Color alist used for the Gnus logo.")
861 (defcustom gnus-logo-color-style 'no
862 "*Color styles used for the Gnus logo."
863 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
864 gnus-logo-color-alist))
867 (defvar gnus-logo-colors
868 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
869 "Colors used for the Gnus logo.")
871 (defun gnus-group-startup-message (&optional x y)
872 "Insert startup message in current buffer."
873 ;; Insert the message.
876 ((and (fboundp 'find-image)
878 (let* ((bg (face-background 'default))
879 (fg (face-foreground 'gnus-splash-face))
880 (data-directory (nnheader-find-etc-directory "images/gnus"))
882 `((:type xpm :file "gnus.xpm"
884 (("thing" . ,(car gnus-logo-colors))
885 ("shadow" . ,(cadr gnus-logo-colors))
887 ("background" . ,bg)))
888 (:type pbm :file "gnus.pbm"
889 ;; Account for the pbm's blackground.
890 :background ,bg :foreground ,fg)
891 (:type xbm :file "gnus.xbm"
892 ;; Account for the xbm's blackground.
893 :background ,bg :foreground ,fg)))))
897 (concat gnus-product-name " " gnus-version-number
898 (if (zerop (string-to-number gnus-revision-number))
900 (concat " (r" gnus-revision-number ")"))
901 " based on " gnus-original-product-name " v"
902 gnus-original-version-number)
903 'face `(variable-pitch :background ,bg :foreground ,fg)))
904 (let ((fill-column (window-width)))
905 (center-region (point-min) (point)))
906 (let ((size (image-size image)))
907 (insert-char ?\n (max 1 (round (- (window-height)
908 (or y (cdr size))) 2)))
910 (propertize " " 'display
912 ,(max 0 (round (- (window-width)
913 (or x (car size))) 2)))))
914 (insert-image image))
915 (setq gnus-simple-splash nil)
920 _ ___ __ ___ __ _ ___
939 (goto-char (point-min))
940 (insert gnus-product-name " " gnus-version-number
941 (if (zerop (string-to-number gnus-revision-number))
943 (concat " (r" gnus-revision-number ")"))
944 " based on " gnus-original-product-name " v"
945 gnus-original-version-number)
946 (insert-char ?\ (prog1
947 (max 0 (/ (- (window-width) (point)) 2))
948 (goto-char (point-min))))
951 (gnus-indent-rigidly (point) (point-max)
952 (/ (max (- (window-width) (or x 46)) 0) 2))
953 (goto-char (point-min))
955 (let* ((pheight (count-lines (point-min) (point-max)))
956 (wheight (window-height))
957 (rest (- wheight pheight)))
958 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
960 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
961 (setq gnus-simple-splash t)))
962 (goto-char (point-min))
963 (setq mode-line-buffer-identification (concat " " gnus-version))
964 (set-buffer-modified-p t))
967 (let ((command (format "%s" this-command)))
968 (when (string-match "gnus" command)
969 (if (string-match "gnus-other-frame" command)
970 (gnus-get-buffer-create gnus-group-buffer)
978 (defcustom gnus-parameters nil
979 "Alist of group parameters.
982 ((\"mail\\\\..*\" (gnus-show-threads nil)
983 (gnus-use-scoring nil)
984 (gnus-summary-line-format
985 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
988 (\"mail\\\\.me\" (gnus-use-scoring t))
989 (\"list\\\\..*\" (total-expire . t)
990 (broken-reply-to . t)))"
992 :group 'gnus-group-various
993 :type '(repeat (cons regexp
996 (defvar gnus-group-parameters-more nil)
998 (defvar gnus-colon-keywords
1000 (when (boundp 'dgnushack-colon-keywords)
1001 (symbol-value 'dgnushack-colon-keywords)))
1002 "List of the colon keywords should be bound at run-time. This variable
1003 defaults to a proper value only if this file is byte-compiled by make.")
1005 (dolist (keyword gnus-colon-keywords)
1006 (set keyword keyword))
1008 (defmacro gnus-define-group-parameter (param &rest rest)
1009 "Define a group parameter PARAM.
1010 REST is a plist of following:
1011 :type One of `bool', `list' or nil.
1012 :function The name of the function.
1013 :function-document The documentation of the function.
1014 :parameter-type The type for customizing the parameter.
1015 :parameter-document The documentation for the parameter.
1016 :variable The name of the variable.
1017 :variable-document The documentation for the variable.
1018 :variable-group The group for customizing the variable.
1019 :variable-type The type for customizing the variable.
1020 :variable-default The default value of the variable."
1021 (let* ((type (plist-get rest :type))
1022 (parameter-type (plist-get rest :parameter-type))
1023 (parameter-document (plist-get rest :parameter-document))
1024 (function (or (plist-get rest :function)
1025 (intern (format "gnus-parameter-%s" param))))
1026 (function-document (or (plist-get rest :function-document) ""))
1027 (variable (or (plist-get rest :variable)
1028 (intern (format "gnus-parameter-%s-alist" param))))
1029 (variable-document (or (plist-get rest :variable-document) ""))
1030 (variable-group (plist-get rest :variable-group))
1031 (variable-type (or (plist-get rest :variable-type)
1033 (list (regexp :tag "Group")
1034 ,(car (cdr parameter-type)))))))
1035 (variable-default (plist-get rest :variable-default)))
1038 `(defcustom ,variable ,variable-default
1040 :group 'gnus-group-parameter
1041 :group ',variable-group
1042 :type ,variable-type)
1043 `(setq gnus-group-parameters-more
1044 (delq (assq ',param gnus-group-parameters-more)
1045 gnus-group-parameters-more))
1046 `(add-to-list 'gnus-group-parameters-more
1049 ,parameter-document))
1051 `(defun ,function (name)
1053 (let ((params (gnus-group-find-parameter name))
1056 ((memq ',param params)
1058 ((setq val (assq ',param params))
1060 ((stringp ,variable)
1061 (string-match ,variable name))
1063 (let ((alist ,variable)
1065 (while (setq elem (pop alist))
1067 (string-match (car elem) name))
1070 (if (consp value) (car value) value))))))
1071 `(defun ,function (name)
1074 (or (gnus-group-find-parameter name ',param ,(and type t))
1075 (let ((alist ,variable)
1077 (while (setq elem (pop alist))
1079 (string-match (car elem) name))
1084 '(if (consp value) (car value) value))))))))))
1086 (defcustom gnus-home-directory "~/"
1087 "Directory variable that specifies the \"home\" directory.
1088 All other Gnus file and directory variables are initialized from this variable."
1092 (defcustom gnus-directory (or (getenv "SAVEDIR")
1093 (nnheader-concat gnus-home-directory "News/"))
1094 "*Directory variable from which all other Gnus file variables are derived.
1096 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1097 This means that other directory variables that are initialized from
1098 this variable won't be set properly if you set this variable in `.gnus.el'.
1099 Set this variable in `.emacs' instead."
1103 (defcustom gnus-default-directory nil
1104 "*Default directory for all Gnus buffers."
1106 :type '(choice (const :tag "current" nil)
1109 ;; Site dependent variables. These variables should be defined in
1112 (defvar gnus-default-nntp-server nil
1113 "Specify a default NNTP server.
1114 This variable should be defined in paths.el, and should never be set
1116 If you want to change servers, you should use `gnus-select-method'.
1117 See the documentation to that variable.")
1119 ;; Don't touch this variable.
1120 (defvar gnus-nntp-service "nntp"
1121 "NNTP service name (\"nntp\" or 119).
1122 This is an obsolete variable, which is scarcely used. If you use an
1123 nntp server for your newsgroup and want to change the port number
1124 used to 899, you would say something along these lines:
1126 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1128 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1129 "A file with only the name of the nntp server in it."
1134 (defun gnus-getenv-nntpserver ()
1135 "Find default nntp server.
1136 Check the NNTPSERVER environment variable and the
1137 `gnus-nntpserver-file' file."
1138 (or (getenv "NNTPSERVER")
1139 (and (file-readable-p gnus-nntpserver-file)
1141 (insert-file-contents gnus-nntpserver-file)
1142 (when (re-search-forward "[^ \t\n\r]+" nil t)
1143 (match-string 0))))))
1145 (defcustom gnus-select-method
1148 (list 'nntp (or (condition-case nil
1149 (gnus-getenv-nntpserver)
1151 (when (and gnus-default-nntp-server
1152 (not (string= gnus-default-nntp-server "")))
1153 gnus-default-nntp-server)
1155 (if (or (null gnus-nntp-service)
1156 (equal gnus-nntp-service "nntp"))
1158 (list gnus-nntp-service)))
1160 "Default method for selecting a newsgroup.
1161 This variable should be a list, where the first element is how the
1162 news is to be fetched, the second is the address.
1164 For instance, if you want to get your news via \"flab.flab.edu\" using
1165 NNTP, you could say:
1167 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1169 If you want to use your local spool, say:
1171 \(setq gnus-select-method (list 'nnspool (system-name)))
1173 If you use this variable, you must set `gnus-nntp-server' to nil.
1175 There is a lot more to know about select methods and virtual servers -
1176 see the manual for details."
1178 :type 'gnus-select-method)
1180 (defcustom gnus-message-archive-method "archive"
1181 "*Method used for archiving messages you've sent.
1182 This should be a mail method."
1184 :group 'gnus-message
1185 :type '(choice (const :tag "Default archive method" "archive")
1186 gnus-select-method))
1188 (defcustom gnus-message-archive-group nil
1189 "*Name of the group in which to save the messages you've written.
1190 This can either be a string; a list of strings; or an alist
1191 of regexps/functions/forms to be evaluated to return a string (or a list
1192 of strings). The functions are called with the name of the current
1193 group (or nil) as a parameter.
1195 If you want to save your mail in one group and the news articles you
1196 write in another group, you could say something like:
1198 \(setq gnus-message-archive-group
1199 '((if (message-news-p)
1203 Normally the group names returned by this variable should be
1204 unprefixed -- which implicitly means \"store on the archive server\".
1205 However, you may wish to store the message on some other server. In
1206 that case, just return a fully prefixed name of the group --
1207 \"nnml+private:mail.misc\", for instance."
1208 :group 'gnus-message
1209 :type '(choice (const :tag "none" nil)
1214 (defcustom gnus-secondary-servers nil
1215 "List of NNTP servers that the user can choose between interactively.
1216 To make Gnus query you for a server, you have to give `gnus' a
1217 non-numeric prefix - `C-u M-x gnus', in short."
1219 :type '(repeat string))
1221 (defcustom gnus-nntp-server nil
1222 "*The name of the host running the NNTP server.
1223 This variable is semi-obsolete. Use the `gnus-select-method'
1226 :type '(choice (const :tag "disable" nil)
1229 (defcustom gnus-secondary-select-methods nil
1230 "A list of secondary methods that will be used for reading news.
1231 This is a list where each element is a complete select method (see
1232 `gnus-select-method').
1234 If, for instance, you want to read your mail with the nnml back end,
1235 you could set this variable:
1237 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1239 :type '(repeat gnus-select-method))
1241 (defvar gnus-backup-default-subscribed-newsgroups
1242 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1243 "Default default new newsgroups the first time Gnus is run.
1244 Should be set in paths.el, and shouldn't be touched by the user.")
1246 (defcustom gnus-local-domain nil
1247 "Local domain name without a host name.
1248 The DOMAINNAME environment variable is used instead if it is defined.
1249 If the function `system-name' returns the full Internet name, there is
1250 no need to set this variable."
1251 :group 'gnus-message
1252 :type '(choice (const :tag "default" nil)
1255 (defvar gnus-local-organization nil
1256 "String with a description of what organization (if any) the user belongs to.
1257 Obsolete variable; use `message-user-organization' instead.")
1259 ;; Customization variables
1261 (defcustom gnus-refer-article-method nil
1262 "Preferred method for fetching an article by Message-ID.
1263 If you are reading news from the local spool (with nnspool), fetching
1264 articles by Message-ID is painfully slow. By setting this method to an
1265 nntp method, you might get acceptable results.
1267 The value of this variable must be a valid select method as discussed
1268 in the documentation of `gnus-select-method'.
1270 It can also be a list of select methods, as well as the special symbol
1271 `current', which means to use the current select method. If it is a
1272 list, Gnus will try all the methods in the list until it finds a match."
1274 :type '(choice (const :tag "default" nil)
1276 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1278 (repeat :menu-tag "Try multiple"
1280 :value (current (nnweb "refer" (nnweb-type google)))
1281 (choice :tag "Method"
1283 (const :tag "Google"
1284 (nnweb "refer" (nnweb-type google)))
1285 gnus-select-method))))
1287 (defcustom gnus-group-faq-directory
1288 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1289 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1290 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1291 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1292 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1293 "/ftp@rtfm.mit.edu:/pub/usenet/"
1294 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1295 "/ftp@ftp.sunet.se:/pub/usenet/"
1296 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1297 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1298 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1299 "*Directory where the group FAQs are stored.
1300 This will most commonly be on a remote machine, and the file will be
1301 fetched by ange-ftp.
1303 This variable can also be a list of directories. In that case, the
1304 first element in the list will be used by default. The others can
1305 be used when being prompted for a site.
1307 Note that Gnus uses an aol machine as the default directory. If this
1308 feels fundamentally unclean, just think of it as a way to finally get
1309 something of value back from them.
1311 If the default site is too slow, try one of these:
1313 North America: mirrors.aol.com /pub/rtfm/usenet
1314 ftp.seas.gwu.edu /pub/rtfm
1315 rtfm.mit.edu /pub/usenet
1316 Europe: ftp.uni-paderborn.de /pub/FAQ
1317 src.doc.ic.ac.uk /usenet/news-FAQS
1318 ftp.sunet.se /pub/usenet
1319 ftp.pasteur.fr /pub/FAQ
1320 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1321 hwarang.postech.ac.kr /pub/usenet
1322 ftp.hk.super.net /mirror/faqs"
1323 :group 'gnus-group-various
1324 :type '(choice directory
1325 (repeat directory)))
1327 (defcustom gnus-group-charter-alist
1328 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1329 ("de" . (concat "http://purl.net/charta/" name ".html"))
1330 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1331 ("england" . (concat "http://england.news-admin.org/charters/" name))
1332 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1333 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1334 (gnus-replace-in-string name "europa\\." "") ".html"))
1335 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1336 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1337 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1338 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1339 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1340 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1341 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1342 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1343 (gnus-replace-in-string name "\\." "_") ".html"))
1344 ("milw" . (concat "http://usenet.mil.wi.us/"
1345 (gnus-replace-in-string name "milw\\." "") "-charter"))
1346 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1347 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1348 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1349 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1350 When FORM is evaluated `name' is bound to the name of the group."
1352 :group 'gnus-group-various
1353 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1355 (defcustom gnus-group-fetch-control-use-browse-url nil
1356 "*Non-nil means that control messages are displayed using `browse-url'.
1357 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1360 :group 'gnus-group-various
1363 (defcustom gnus-use-cross-reference t
1364 "*Non-nil means that cross referenced articles will be marked as read.
1365 If nil, ignore cross references. If t, mark articles as read in
1366 subscribed newsgroups. If neither t nor nil, mark as read in all
1369 :type '(choice (const :tag "off" nil)
1370 (const :tag "subscribed" t)
1374 (defcustom gnus-process-mark ?#
1376 :group 'gnus-group-visual
1377 :group 'gnus-summary-marks
1380 (defcustom gnus-large-newsgroup 200
1381 "*The number of articles which indicates a large newsgroup.
1382 If the number of articles in a newsgroup is greater than this value,
1383 confirmation is required for selecting the newsgroup.
1384 If it is nil, no confirmation is required."
1385 :group 'gnus-group-select
1386 :type '(choice (const :tag "No limit" nil)
1389 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1390 "*Non-nil means that the default name of a file to save articles in is the group name.
1391 If it's nil, the directory form of the group name is used instead.
1393 If this variable is a list, and the list contains the element
1394 `not-score', long file names will not be used for score files; if it
1395 contains the element `not-save', long file names will not be used for
1396 saving; and if it contains the element `not-kill', long file names
1397 will not be used for kill files.
1399 Note that the default for this variable varies according to what system
1400 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1401 to nil while on all other systems it defaults to t."
1403 :type '(radio (sexp :format "Non-nil\n"
1404 :match (lambda (widget value)
1405 (and value (not (listp value))))
1408 (checklist (const :format "%v " not-score)
1409 (const :format "%v " not-save)
1412 (defcustom gnus-kill-files-directory gnus-directory
1413 "*Name of the directory where kill files will be stored (default \"~/News\")."
1414 :group 'gnus-score-files
1415 :group 'gnus-score-kill
1418 (defcustom gnus-save-score nil
1419 "*If non-nil, save group scoring info."
1420 :group 'gnus-score-various
1424 (defcustom gnus-use-undo t
1425 "*If non-nil, allow undoing in Gnus group mode buffers."
1429 (defcustom gnus-use-adaptive-scoring nil
1430 "*If non-nil, use some adaptive scoring scheme.
1431 If a list, then the values `word' and `line' are meaningful. The
1432 former will perform adaption on individual words in the subject
1433 header while `line' will perform adaption on several headers."
1435 :group 'gnus-score-adapt
1436 :type '(set (const word) (const line)))
1438 (defcustom gnus-use-cache 'passive
1439 "*If nil, Gnus will ignore the article cache.
1440 If `passive', it will allow entering (and reading) articles
1441 explicitly entered into the cache. If anything else, use the
1442 cache to the full extent of the law."
1445 :type '(choice (const :tag "off" nil)
1446 (const :tag "passive" passive)
1447 (const :tag "active" t)))
1449 (defcustom gnus-use-trees nil
1450 "*If non-nil, display a thread tree buffer."
1454 (defcustom gnus-keep-backlog 20
1455 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1456 If it is a number N, then Gnus will only keep the last N articles
1457 read. If it is neither nil nor a number, Gnus will keep all read
1458 articles. This is not a good idea."
1460 :type '(choice (const :tag "off" nil)
1465 (defcustom gnus-use-nocem nil
1466 "*If non-nil, Gnus will read NoCeM cancel messages."
1470 (defcustom gnus-suppress-duplicates nil
1471 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1475 (defcustom gnus-use-scoring t
1476 "*If non-nil, enable scoring."
1480 (defcustom gnus-summary-prepare-exit-hook
1481 '(gnus-summary-expire-articles)
1482 "*A hook called when preparing to exit from the summary buffer.
1483 It calls `gnus-summary-expire-articles' by default."
1484 :group 'gnus-summary-exit
1487 (defcustom gnus-novice-user t
1488 "*Non-nil means that you are a Usenet novice.
1489 If non-nil, verbose messages may be displayed and confirmations may be
1494 (defcustom gnus-expert-user nil
1495 "*Non-nil means that you will never be asked for confirmation about anything.
1496 That doesn't mean *anything* anything; particularly destructive
1497 commands will still require prompting."
1501 (defcustom gnus-interactive-catchup t
1502 "*If non-nil, require your confirmation when catching up a group."
1503 :group 'gnus-group-select
1506 (defcustom gnus-interactive-exit t
1507 "*If non-nil, require your confirmation when exiting Gnus."
1511 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1512 "Function for extracting address components from a From header.
1513 Three pre-defined functions exist: `gnus-extract-address-components',
1514 which is the default, quite fast, and too simplistic solution,
1515 `mail-extract-address-components', which works much better, but is
1516 slower, and `std11-extract-address-components'."
1517 :group 'gnus-summary-format
1518 :type '(radio (function-item gnus-extract-address-components)
1519 (function-item mail-extract-address-components)
1520 (function-item std11-extract-address-components)
1521 (function :tag "Other")))
1523 (defcustom gnus-carpal nil
1524 "*If non-nil, display clickable icons."
1528 (defcustom gnus-shell-command-separator ";"
1529 "String used to separate shell commands."
1533 (defcustom gnus-valid-select-methods
1534 '(("nntp" post address prompt-address physical-address)
1535 ("nnspool" post address)
1536 ("nnvirtual" post-mail virtual prompt-address)
1537 ("nnmbox" mail respool address)
1538 ("nnml" post-mail respool address)
1539 ("nnmh" mail respool address)
1540 ("nndir" post-mail prompt-address physical-address)
1541 ("nneething" none address prompt-address physical-address)
1542 ("nndoc" none address prompt-address)
1543 ("nnbabyl" mail address respool)
1544 ("nnkiboze" post virtual)
1545 ("nnsoup" post-mail address)
1546 ("nndraft" post-mail)
1547 ("nnfolder" mail respool address)
1548 ("nngateway" post-mail address prompt-address physical-address)
1557 ("nnagent" post-mail)
1558 ("nnimap" post-mail address prompt-address physical-address)
1559 ("nnmaildir" mail respool address)
1561 "*An alist of valid select methods.
1562 The first element of each list lists should be a string with the name
1563 of the select method. The other elements may be the category of
1564 this method (i. e., `post', `mail', `none' or whatever) or other
1565 properties that this method has (like being respoolable).
1566 If you implement a new select method, all you should have to change is
1567 this variable. I think."
1569 :type '(repeat (group (string :tag "Name")
1570 (radio-button-choice (const :format "%v " post)
1571 (const :format "%v " mail)
1572 (const :format "%v " none)
1574 (checklist :inline t
1575 (const :format "%v " address)
1576 (const :format "%v " prompt-address)
1577 (const :format "%v " physical-address)
1578 (const :format "%v " virtual)
1581 (defun gnus-redefine-select-method-widget ()
1582 "Recomputes the select-method widget based on the value of
1583 `gnus-valid-select-methods'."
1584 (define-widget 'gnus-select-method 'list
1585 "Widget for entering a select method."
1587 :tag "Select Method"
1588 :args `((choice :tag "Method"
1589 ,@(mapcar (lambda (entry)
1590 (list 'const :format "%v\n"
1591 (intern (car entry))))
1592 gnus-valid-select-methods)
1593 (symbol :tag "other"))
1594 (string :tag "Address")
1595 (repeat :tag "Options"
1599 (sexp :tag "Value"))))))
1601 (gnus-redefine-select-method-widget)
1603 (defcustom gnus-updated-mode-lines '(group article summary tree)
1604 "List of buffers that should update their mode lines.
1605 The list may contain the symbols `group', `article', `tree' and
1606 `summary'. If the corresponding symbol is present, Gnus will keep
1607 that mode line updated with information that may be pertinent.
1608 If this variable is nil, screen refresh may be quicker."
1609 :group 'gnus-various
1610 :type '(set (const group)
1615 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1616 (defcustom gnus-mode-non-string-length nil
1617 "*Max length of mode-line non-string contents.
1618 If this is nil, Gnus will take space as is needed, leaving the rest
1619 of the mode line intact. Note that the default of nil is unlikely
1620 to be desirable; see the manual for further details."
1621 :group 'gnus-various
1622 :type '(choice (const nil)
1625 ;; There should be special validation for this.
1626 (define-widget 'gnus-email-address 'string
1627 "An email address.")
1629 (gnus-define-group-parameter
1632 "Return GROUP's to-address."
1634 "*Alist of group regexps and correspondent to-addresses."
1635 :variable-group gnus-group-parameter
1636 :parameter-type '(gnus-email-address :tag "To Address")
1637 :parameter-document "\
1638 This will be used when doing followups and posts.
1640 This is primarily useful in mail groups that represent closed
1641 mailing lists--mailing lists where it's expected that everybody that
1642 writes to the mailing list is subscribed to it. Since using this
1643 parameter ensures that the mail only goes to the mailing list itself,
1644 it means that members won't receive two copies of your followups.
1646 Using `to-address' will actually work whether the group is foreign or
1647 not. Let's say there's a group on the server that is called
1648 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1649 articles from a mail-to-news gateway. Posting directly to this group
1650 is therefore impossible--you have to send mail to the mailing list
1653 The gnus-group-split mail splitting mechanism will behave as if this
1654 address was listed in gnus-group-split Addresses (see below).")
1656 (gnus-define-group-parameter
1659 "Return GROUP's to-list."
1661 "*Alist of group regexps and correspondent to-lists."
1662 :variable-group gnus-group-parameter
1663 :parameter-type '(gnus-email-address :tag "To List")
1664 :parameter-document "\
1665 This address will be used when doing a `a' in the group.
1667 It is totally ignored when doing a followup--except that if it is
1668 present in a news group, you'll get mail group semantics when doing
1671 The gnus-group-split mail splitting mechanism will behave as if this
1672 address was listed in gnus-group-split Addresses (see below).")
1674 (gnus-define-group-parameter
1678 "Return GROUP's subscription status."
1680 "*Groups which are automatically considered subscribed."
1681 :variable-group gnus-group-parameter
1682 :parameter-type '(const :tag "Subscribed" t)
1683 :parameter-document "\
1684 Gnus assumed that you are subscribed to the To/List address.
1686 When constructing a list of subscribed groups using
1687 `gnus-find-subscribed-addresses', Gnus includes the To address given
1688 above, or the list address (if the To address has not been set).")
1690 (gnus-define-group-parameter
1693 :function gnus-group-auto-expirable-p
1695 "Check whether GROUP is auto-expirable or not."
1696 :variable gnus-auto-expirable-newsgroups
1697 :variable-default nil
1699 "*Groups in which to automatically mark read articles as expirable.
1700 If non-nil, this should be a regexp that should match all groups in
1701 which to perform auto-expiry. This only makes sense for mail groups."
1702 :variable-group nnmail-expire
1703 :variable-type '(choice (const nil)
1705 :parameter-type '(const :tag "Automatic Expire" t)
1707 "All articles that are read will be marked as expirable.")
1709 (gnus-define-group-parameter
1712 :function gnus-group-total-expirable-p
1714 "Check whether GROUP is total-expirable or not."
1715 :variable gnus-total-expirable-newsgroups
1716 :variable-default nil
1718 "*Groups in which to perform expiry of all read articles.
1719 Use with extreme caution. All groups that match this regexp will be
1720 expiring - which means that all read articles will be deleted after
1721 \(say) one week. (This only goes for mail groups and the like, of
1723 :variable-group nnmail-expire
1724 :variable-type '(choice (const nil)
1726 :parameter-type '(const :tag "Total Expire" t)
1728 "All read articles will be put through the expiry process
1730 This happens even if they are not marked as expirable.
1733 (gnus-define-group-parameter
1736 "Return the default charset of GROUP."
1737 :variable gnus-group-charset-alist
1739 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1740 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1741 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1742 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1743 ("\\(^\\|:\\)relcom\\>" koi8-r)
1744 ("\\(^\\|:\\)fido7\\>" koi8-r)
1745 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1746 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1747 ("\\(^\\|:\\)han\\>" euc-kr)
1748 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1749 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1750 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1752 "Alist of regexps (to match group names) and default charsets to be used when reading."
1753 :variable-group gnus-charset
1754 :variable-type '(repeat (list (regexp :tag "Group")
1755 (symbol :tag "Charset")))
1756 :parameter-type '(symbol :tag "Charset")
1757 :parameter-document "\
1758 The default charset to use in the group.")
1760 (gnus-define-group-parameter
1764 "Return a posting method for GROUP."
1765 :variable gnus-post-method-alist
1767 "Alist of regexps (to match group names) and method to be used when
1768 posting an article."
1769 :variable-group gnus-group-foreign
1771 '(choice :tag "Posting Method"
1772 (const :tag "Use native server" native)
1773 (const :tag "Use current server" current)
1774 (list :convert-widget
1776 (list 'sexp :tag "Methods"
1777 :value gnus-select-method))))
1779 "Posting method for this group.")
1781 (gnus-define-group-parameter
1782 large-newsgroup-initial
1785 "Return GROUP's initial input of the number of articles."
1787 "*Alist of group regexps and its initial input of the number of articles."
1788 :variable-group gnus-group-parameter
1789 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1790 (const :tag "All" nil)
1792 :parameter-document "\
1794 This number will be prompted as the initial value of the number of
1795 articles to list when the group is a large newsgroup (see
1796 `gnus-large-newsgroup'). If it is nil, the default value is the
1797 total number of articles in the group.")
1799 ;; The Gnus registry's ignored groups
1800 (gnus-define-group-parameter
1804 "Whether this group should be ignored by the registry."
1805 :variable gnus-registry-ignored-groups
1806 :variable-default nil
1808 "*Groups in which the registry should be turned off."
1809 :variable-group gnus-registry
1810 :variable-type '(repeat
1812 (regexp :tag "Group Name Regular Expression")
1813 (boolean :tag "Ignored")))
1815 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1817 "Whether the Gnus Registry should ignore this group.")
1819 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1820 (defcustom gnus-install-group-spam-parameters t
1821 "*Disable the group parameters for spam detection.
1822 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1827 (when gnus-install-group-spam-parameters
1828 (defvar gnus-group-spam-classification-spam t
1829 "Spam group classification (requires spam.el).
1830 This group contains spam messages. On summary entry, unread messages
1831 will be marked as spam. On summary exit, the specified spam
1832 processors will be invoked on spam-marked messages, then those
1833 messages will be expired, so the spam processor will only see a
1834 spam-marked message once.")
1836 (defvar gnus-group-spam-classification-ham 'ask
1837 "The ham value for the spam group parameter (requires spam.el).
1838 On summary exit, the specified ham processors will be invoked on
1839 ham-marked messages. Exercise caution, since the ham processor will
1840 see the same message more than once because there is no ham message
1843 (gnus-define-group-parameter
1847 "The spam type (spam, ham, or neither) of the group."
1848 :variable gnus-spam-newsgroup-contents
1849 :variable-default nil
1851 "*Group classification (spam, ham, or neither). Only
1852 meaningful when spam.el is loaded. If non-nil, this should be a
1853 list of group name regexps associated with a classification for
1854 each one. In spam groups, new articles are marked as spam on
1855 summary entry. There is other behavior associated with ham and
1856 no classification when spam.el is loaded - see the manual."
1857 :variable-group spam
1858 :variable-type '(repeat
1859 (list :tag "Group contents spam/ham classification"
1860 (regexp :tag "Group")
1862 (variable-item gnus-group-spam-classification-spam)
1863 (variable-item gnus-group-spam-classification-ham)
1864 (const :tag "Unclassified" nil))))
1866 :parameter-type '(list :tag "Group contents spam/ham classification"
1867 (choice :tag "Group contents classification for spam sorting"
1868 (variable-item gnus-group-spam-classification-spam)
1869 (variable-item gnus-group-spam-classification-ham)
1870 (const :tag "Unclassified" nil)))
1872 "The spam classification (spam, ham, or neither) of this group.
1873 When a spam group is entered, all unread articles are marked as
1874 spam. There is other behavior associated with ham and no
1875 classification when spam.el is loaded - see the manual.")
1877 (gnus-define-group-parameter
1881 "The address to get spam resent (through spam-report-resend)."
1882 :variable gnus-spam-resend-to
1883 :variable-default nil
1885 "The address to get spam resent (through spam-report-resend)."
1886 :variable-group spam
1887 :variable-type '(repeat
1888 (list :tag "Group address for resending spam"
1889 (regexp :tag "Group")
1890 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1891 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1893 "The address to get spam resent (through spam-report-resend).")
1895 (gnus-define-group-parameter
1899 "The address to get ham resent (through spam-report-resend)."
1900 :variable gnus-ham-resend-to
1901 :variable-default nil
1903 "The address to get ham resent (through spam-report-resend)."
1904 :variable-group spam
1905 :variable-type '(repeat
1906 (list :tag "Group address for resending ham"
1907 (regexp :tag "Group")
1908 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1909 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1911 "The address to get ham resent (through spam-report-resend).")
1913 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1914 "OBSOLETE: The ifile summary exit spam processor.")
1916 (defvar gnus-group-spam-exit-processor-stat "stat"
1917 "OBSOLETE: The spam-stat summary exit spam processor.")
1919 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1920 "OBSOLETE: The Bogofilter summary exit spam processor.")
1922 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1923 "OBSOLETE: The Blacklist summary exit spam processor.")
1925 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1926 "OBSOLETE: The Gmane reporting summary exit spam processor.
1927 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1929 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1930 "OBSOLETE: The spamoracle summary exit spam processor.")
1932 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1933 "OBSOLETE: The ifile summary exit ham processor.
1934 Only applicable to non-spam (unclassified and ham) groups.")
1936 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1937 "OBSOLETE: The Bogofilter summary exit ham processor.
1938 Only applicable to non-spam (unclassified and ham) groups.")
1940 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1941 "OBSOLETE: The spam-stat summary exit ham processor.
1942 Only applicable to non-spam (unclassified and ham) groups.")
1944 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1945 "OBSOLETE: The whitelist summary exit ham processor.
1946 Only applicable to non-spam (unclassified and ham) groups.")
1948 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1949 "OBSOLETE: The BBDB summary exit ham processor.
1950 Only applicable to non-spam (unclassified and ham) groups.")
1952 (defvar gnus-group-ham-exit-processor-copy "copy"
1953 "OBSOLETE: The ham copy exit ham processor.
1954 Only applicable to non-spam (unclassified and ham) groups.")
1956 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1957 "OBSOLETE: The spamoracle summary exit ham processor.
1958 Only applicable to non-spam (unclassified and ham) groups.")
1960 (gnus-define-group-parameter
1965 :tag "Spam Summary Exit Processor"
1967 (list :tag "Spam Summary Exit Processor Choices"
1969 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1970 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1971 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1972 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1973 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1974 (const :tag "Spam: ifile" (spam spam-use-ifile))
1975 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1976 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1977 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1978 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1979 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1980 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1981 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1982 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1983 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1984 (const :tag "Ham: ifile" (ham spam-use-ifile))
1985 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1986 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1987 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1988 (const :tag "Ham: CRM114" (ham spam-use-crm114))
1989 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1990 (variable-item gnus-group-spam-exit-processor-ifile)
1991 (variable-item gnus-group-spam-exit-processor-stat)
1992 (variable-item gnus-group-spam-exit-processor-bogofilter)
1993 (variable-item gnus-group-spam-exit-processor-blacklist)
1994 (variable-item gnus-group-spam-exit-processor-spamoracle)
1995 (variable-item gnus-group-spam-exit-processor-report-gmane)
1996 (variable-item gnus-group-ham-exit-processor-bogofilter)
1997 (variable-item gnus-group-ham-exit-processor-ifile)
1998 (variable-item gnus-group-ham-exit-processor-stat)
1999 (variable-item gnus-group-ham-exit-processor-whitelist)
2000 (variable-item gnus-group-ham-exit-processor-BBDB)
2001 (variable-item gnus-group-ham-exit-processor-spamoracle)
2002 (variable-item gnus-group-ham-exit-processor-copy))))
2004 "Which spam or ham processors will be applied when the summary is exited."
2005 :variable gnus-spam-process-newsgroups
2006 :variable-default nil
2008 "*Groups in which to automatically process spam or ham articles with
2009 a backend on summary exit. If non-nil, this should be a list of group
2010 name regexps that should match all groups in which to do automatic
2011 spam processing, associated with the appropriate processor."
2012 :variable-group spam
2014 '(repeat :tag "Spam/Ham Processors"
2015 (list :tag "Spam Summary Exit Processor Choices"
2016 (regexp :tag "Group Regexp")
2018 :tag "Spam/Ham Summary Exit Processor"
2019 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
2020 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
2021 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
2022 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
2023 (const :tag "Spam: Resend Message"(spam spam-use-resend))
2024 (const :tag "Spam: ifile" (spam spam-use-ifile))
2025 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
2026 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
2027 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
2028 (const :tag "Spam: CRM114" (spam spam-use-crm114))
2029 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
2030 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
2031 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
2032 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
2033 (const :tag "Ham: Resend Message" (ham spam-use-resend))
2034 (const :tag "Ham: ifile" (ham spam-use-ifile))
2035 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
2036 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
2037 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2038 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2039 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2040 (variable-item gnus-group-spam-exit-processor-ifile)
2041 (variable-item gnus-group-spam-exit-processor-stat)
2042 (variable-item gnus-group-spam-exit-processor-bogofilter)
2043 (variable-item gnus-group-spam-exit-processor-blacklist)
2044 (variable-item gnus-group-spam-exit-processor-spamoracle)
2045 (variable-item gnus-group-spam-exit-processor-report-gmane)
2046 (variable-item gnus-group-ham-exit-processor-bogofilter)
2047 (variable-item gnus-group-ham-exit-processor-ifile)
2048 (variable-item gnus-group-ham-exit-processor-stat)
2049 (variable-item gnus-group-ham-exit-processor-whitelist)
2050 (variable-item gnus-group-ham-exit-processor-BBDB)
2051 (variable-item gnus-group-ham-exit-processor-spamoracle)
2052 (variable-item gnus-group-ham-exit-processor-copy))))
2055 "Which spam or ham processors will be applied when the summary is exited.")
2057 (gnus-define-group-parameter
2061 '(boolean :tag "Spam autodetection")
2063 "Should spam be autodetected (with spam-split) in this group?"
2064 :variable gnus-spam-autodetect
2065 :variable-default nil
2067 "*Groups in which spam should be autodetected when they are entered.
2068 Only unseen articles will be examined, unless
2069 spam-autodetect-recheck-messages is set."
2070 :variable-group spam
2073 :tag "Autodetection setting"
2075 (regexp :tag "Group Regexp")
2078 "Spam autodetection.
2079 Only unseen articles will be examined, unless
2080 spam-autodetect-recheck-messages is set.")
2082 (gnus-define-group-parameter
2083 spam-autodetect-methods
2086 '(choice :tag "Spam autodetection-specific methods"
2089 (set :tag "Use specific methods"
2090 (variable-item spam-use-blacklist)
2091 (variable-item spam-use-gmane-xref)
2092 (variable-item spam-use-regex-headers)
2093 (variable-item spam-use-regex-body)
2094 (variable-item spam-use-whitelist)
2095 (variable-item spam-use-BBDB)
2096 (variable-item spam-use-ifile)
2097 (variable-item spam-use-spamoracle)
2098 (variable-item spam-use-crm114)
2099 (variable-item spam-use-spamassassin)
2100 (variable-item spam-use-spamassassin-headers)
2101 (variable-item spam-use-bsfilter)
2102 (variable-item spam-use-bsfilter-headers)
2103 (variable-item spam-use-stat)
2104 (variable-item spam-use-blackholes)
2105 (variable-item spam-use-hashcash)
2106 (variable-item spam-use-bogofilter-headers)
2107 (variable-item spam-use-bogofilter)))
2109 "Methods to be used for autodetection in each group"
2110 :variable gnus-spam-autodetect-methods
2111 :variable-default nil
2113 "*Methods for autodetecting spam per group.
2114 Requires the spam-autodetect parameter. Only unseen articles
2115 will be examined, unless spam-autodetect-recheck-messages is
2117 :variable-group spam
2120 :tag "Autodetection methods"
2122 (regexp :tag "Group Regexp")
2126 (set :tag "Use specific methods"
2127 (variable-item spam-use-blacklist)
2128 (variable-item spam-use-gmane-xref)
2129 (variable-item spam-use-regex-headers)
2130 (variable-item spam-use-regex-body)
2131 (variable-item spam-use-whitelist)
2132 (variable-item spam-use-BBDB)
2133 (variable-item spam-use-ifile)
2134 (variable-item spam-use-spamoracle)
2135 (variable-item spam-use-crm114)
2136 (variable-item spam-use-stat)
2137 (variable-item spam-use-blackholes)
2138 (variable-item spam-use-hashcash)
2139 (variable-item spam-use-spamassassin)
2140 (variable-item spam-use-spamassassin-headers)
2141 (variable-item spam-use-bsfilter)
2142 (variable-item spam-use-bsfilter-headers)
2143 (variable-item spam-use-bogofilter-headers)
2144 (variable-item spam-use-bogofilter)))))
2146 "Spam autodetection methods.
2147 Requires the spam-autodetect parameter. Only unseen articles
2148 will be examined, unless spam-autodetect-recheck-messages is
2151 (gnus-define-group-parameter
2152 spam-process-destination
2155 '(choice :tag "Destination for spam-processed articles at summary exit"
2156 (string :tag "Move to a group")
2157 (repeat :tag "Move to multiple groups"
2158 (string :tag "Destination group"))
2159 (const :tag "Expire" nil))
2161 "Where spam-processed articles will go at summary exit."
2162 :variable gnus-spam-process-destinations
2163 :variable-default nil
2165 "*Groups in which to explicitly send spam-processed articles to
2166 another group, or expire them (the default). If non-nil, this should
2167 be a list of group name regexps that should match all groups in which
2168 to do spam-processed article moving, associated with the destination
2169 group or nil for explicit expiration. This only makes sense for
2171 :variable-group spam
2174 :tag "Spam-processed articles destination"
2176 (regexp :tag "Group Regexp")
2178 :tag "Destination for spam-processed articles at summary exit"
2179 (string :tag "Move to a group")
2180 (repeat :tag "Move to multiple groups"
2181 (string :tag "Destination group"))
2182 (const :tag "Expire" nil))))
2184 "Where spam-processed articles will go at summary exit.")
2186 (gnus-define-group-parameter
2187 ham-process-destination
2191 :tag "Destination for ham articles at summary exit from a spam group"
2192 (string :tag "Move to a group")
2193 (repeat :tag "Move to multiple groups"
2194 (string :tag "Destination group"))
2195 (const :tag "Respool" respool)
2196 (const :tag "Do nothing" nil))
2198 "Where ham articles will go at summary exit from a spam group."
2199 :variable gnus-ham-process-destinations
2200 :variable-default nil
2202 "*Groups in which to explicitly send ham articles to
2203 another group, or do nothing (the default). If non-nil, this should
2204 be a list of group name regexps that should match all groups in which
2205 to do ham article moving, associated with the destination
2206 group or nil for explicit ignoring. This only makes sense for
2207 mail groups, and only works in spam groups."
2208 :variable-group spam
2211 :tag "Ham articles destination"
2213 (regexp :tag "Group Regexp")
2215 :tag "Destination for ham articles at summary exit from spam group"
2216 (string :tag "Move to a group")
2217 (repeat :tag "Move to multiple groups"
2218 (string :tag "Destination group"))
2219 (const :tag "Respool" respool)
2220 (const :tag "Expire" nil))))
2222 "Where ham articles will go at summary exit from a spam group.")
2224 (gnus-define-group-parameter
2227 :parameter-type '(list :tag "Ham mark choices"
2229 (variable-item gnus-del-mark)
2230 (variable-item gnus-read-mark)
2231 (variable-item gnus-ticked-mark)
2232 (variable-item gnus-killed-mark)
2233 (variable-item gnus-kill-file-mark)
2234 (variable-item gnus-low-score-mark)))
2237 "Marks considered ham (positively not spam). Such articles will be
2238 processed as ham (non-spam) on group exit. When nil, the global
2239 spam-ham-marks variable takes precedence."
2240 :variable-default '((".*" ((gnus-del-mark
2244 gnus-low-score-mark))))
2245 :variable-group spam
2247 "*Groups in which to explicitly set the ham marks to some value.")
2249 (gnus-define-group-parameter
2252 :parameter-type '(list :tag "Spam mark choices"
2254 (variable-item gnus-spam-mark)
2255 (variable-item gnus-killed-mark)
2256 (variable-item gnus-kill-file-mark)
2257 (variable-item gnus-low-score-mark)))
2260 "Marks considered spam.
2261 Such articles will be processed as spam on group exit. When nil, the global
2262 spam-spam-marks variable takes precedence."
2263 :variable-default '((".*" ((gnus-spam-mark))))
2264 :variable-group spam
2266 "*Groups in which to explicitly set the spam marks to some value."))
2268 (defcustom gnus-group-uncollapsed-levels 1
2269 "Number of group name elements to leave alone when making a short group name."
2270 :group 'gnus-group-visual
2273 (defcustom gnus-group-use-permanent-levels nil
2274 "*If non-nil, once you set a level, Gnus will use this level."
2275 :group 'gnus-group-levels
2280 (defcustom gnus-load-hook nil
2281 "A hook run while Gnus is loaded."
2285 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2286 "A hook called to apply kill files to a group.
2287 This hook is intended to apply a kill file to the selected newsgroup.
2288 The function `gnus-apply-kill-file' is called by default.
2290 Since a general kill file is too heavy to use only for a few
2291 newsgroups, I recommend you to use a lighter hook function. For
2292 example, if you'd like to apply a kill file to articles which contains
2293 a string `rmgroup' in subject in newsgroup `control', you can use the
2296 (setq gnus-apply-kill-hook
2299 (cond ((string-match \"control\" gnus-newsgroup-name)
2300 (gnus-kill \"Subject\" \"rmgroup\")
2301 (gnus-expunge \"X\"))))))"
2302 :group 'gnus-score-kill
2303 :options '(gnus-apply-kill-file)
2306 (defcustom gnus-group-change-level-function nil
2307 "Function run when a group level is changed.
2308 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2309 :group 'gnus-group-levels
2314 (defcustom gnus-visual
2315 '(summary-highlight group-highlight article-highlight
2317 summary-menu group-menu article-menu
2318 tree-highlight menu highlight
2319 browse-menu server-menu
2320 page-marker tree-menu binary-menu pick-menu)
2321 "*Enable visual features.
2322 If `visual' is disabled, there will be no menus and few faces. Most of
2323 the visual customization options below will be ignored. Gnus will use
2324 less space and be faster as a result.
2326 This variable can also be a list of visual elements to switch on. For
2327 instance, to switch off all visual things except menus, you can say:
2329 (setq gnus-visual '(menu))
2331 Valid elements include `summary-highlight', `group-highlight',
2332 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2333 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2334 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2337 :type '(set (const summary-highlight)
2338 (const group-highlight)
2339 (const article-highlight)
2341 (const summary-menu)
2343 (const article-menu)
2344 (const tree-highlight)
2354 ;; Byte-compiler warning.
2355 (defvar gnus-visual)
2356 ;; Find out whether the gnus-visual TYPE is wanted.
2357 (defun gnus-visual-p (&optional type class)
2358 (and gnus-visual ; Has to be non-nil, at least.
2359 (if (not type) ; We don't care about type.
2361 (if (listp gnus-visual) ; It's a list, so we check it.
2362 (or (memq type gnus-visual)
2363 (memq class gnus-visual))
2366 (defcustom gnus-mouse-face
2368 (if (gnus-visual-p 'mouse-face 'highlight)
2369 (if (boundp 'gnus-mouse-face)
2370 (or gnus-mouse-face 'highlight)
2374 "*Face used for group or summary buffer mouse highlighting.
2375 The line beneath the mouse pointer will be highlighted with this
2380 (defcustom gnus-article-save-directory gnus-directory
2381 "*Name of the directory articles will be saved in (default \"~/News\")."
2382 :group 'gnus-article-saving
2385 (defvar gnus-plugged t
2386 "Whether Gnus is plugged or not.")
2388 (defcustom gnus-agent-cache t
2389 "Controls use of the agent cache while plugged.
2390 When set, Gnus will prefer using the locally stored content rather
2391 than re-fetching it from the server. You also need to enable
2392 `gnus-agent' for this to have any affect."
2397 (defcustom gnus-default-charset 'undecided
2398 "Default charset assumed to be used when viewing non-ASCII characters.
2399 This variable is overridden on a group-to-group basis by the
2400 `gnus-group-charset-alist' variable and is only used on groups not
2401 covered by that variable."
2403 :group 'gnus-charset)
2405 ;; Fixme: Doc reference to agent.
2406 (defcustom gnus-agent t
2407 "Whether we want to use the Gnus agent or not.
2409 You may customize gnus-agent to disable its use. However, some
2410 back ends have started to use the agent as a client-side cache.
2411 Disabling the agent may result in noticeable loss of performance."
2416 (defcustom gnus-other-frame-function 'gnus
2417 "Function called by the command `gnus-other-frame'."
2419 :type '(choice (function-item gnus)
2420 (function-item gnus-no-server)
2421 (function-item gnus-slave)
2422 (function-item gnus-slave-no-server)))
2424 (defcustom gnus-other-frame-parameters nil
2425 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2426 This should be an alist for Emacs, or a plist for XEmacs."
2428 :type (if (featurep 'xemacs)
2429 '(repeat (list :inline t :format "%v"
2430 (symbol :tag "Property")
2431 (sexp :tag "Value")))
2432 '(repeat (cons :format "%v"
2433 (symbol :tag "Parameter")
2434 (sexp :tag "Value")))))
2436 (defcustom gnus-user-agent '(emacs gnus mime config mule)
2437 "Which information should be exposed in the User-Agent header.
2439 Can be a list of symbols or a string. Valid symbols are `gnus' (show
2440 Gnus version), `emacs' (show Emacs version) and `mime' (show SEMI,
2441 FLIM and APEL versions). In addition to the Emacs version, you can
2442 add `codename' (show (S)XEmacs codename), `mule' (show Mule version
2443 and also Meadow version if it exists) or either `config' (show system
2444 configuration) or `type' (show system type). If you set it to a
2445 string, be sure to use a valid format, see RFC 2616."
2448 :group 'gnus-message
2449 :type '(choice (list (set :format "%v" :inline t
2450 (const gnus :tag "Gnus version")
2451 (const emacs :tag "Emacs version")
2452 (choice :tag "system"
2453 (const type :tag "system type")
2454 (const config :tag "system configuration"))
2455 (const codename :tag "Emacs codename")
2456 (const mime :tag "SEMI and FLIM versions")
2458 :tag "Mule version (and Meadow version)")))
2459 (string :format "%t:\n%v")))
2461 ;; Convert old (< 2005-01-10) symbol type values:
2462 (when (symbolp gnus-user-agent)
2463 (setq gnus-user-agent
2464 (cond ((eq gnus-user-agent 'gnus-mime-edit)
2465 '(emacs gnus mime config mule))
2466 ((eq gnus-user-agent 'emacs-gnus-config)
2467 '(emacs gnus config))
2468 ((eq gnus-user-agent 'emacs-gnus-type)
2470 ((eq gnus-user-agent 'emacs-gnus)
2472 ((eq gnus-user-agent 'gnus)
2474 (t gnus-user-agent)))
2475 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2477 (if (get 'gnus-user-agent 'saved-value)
2478 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2479 (gnus-message 1 "Edit your init file to make this change permanent.")
2483 ;;; Internal variables
2485 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2486 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2487 (defvar gnus-agent-method-p-cache nil
2488 ; Reset each time gnus-agent-covered-methods is changed else
2489 ; gnus-agent-method-p may mis-report a methods status.
2491 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2492 (defvar gnus-draft-meta-information-header "X-Draft-From")
2493 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2494 (defvar gnus-original-article-buffer " *Original Article*")
2495 (defvar gnus-newsgroup-name nil)
2496 (defvar gnus-ephemeral-servers nil)
2497 (defvar gnus-server-method-cache nil)
2499 (defvar gnus-agent-fetching nil
2500 "Whether Gnus agent is in fetching mode.")
2502 (defvar gnus-agent-covered-methods nil
2503 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2505 (defvar gnus-command-method nil
2506 "Dynamically bound variable that says what the current back end is.")
2508 (defvar gnus-current-select-method nil
2509 "The current method for selecting a newsgroup.")
2511 (defvar gnus-tree-buffer "*Tree*"
2512 "Buffer where Gnus thread trees are displayed.")
2515 (defvar gnus-use-generic-from nil)
2517 ;; Variable holding the user answers to all method prompts.
2518 (defvar gnus-method-history nil)
2520 ;; Variable holding the user answers to all mail method prompts.
2521 (defvar gnus-mail-method-history nil)
2523 ;; Variable holding the user answers to all group prompts.
2524 (defvar gnus-group-history nil)
2526 (defvar gnus-server-alist nil
2527 "List of available servers.")
2529 (defcustom gnus-cache-directory
2530 (nnheader-concat gnus-directory "cache/")
2531 "*The directory where cached articles will be stored."
2535 (defvar gnus-predefined-server-alist
2538 (nnspool-spool-directory ,gnus-cache-directory)
2539 (nnspool-nov-directory ,gnus-cache-directory)
2540 (nnspool-active-file
2541 ,(nnheader-concat gnus-cache-directory "active"))))
2542 "List of predefined (convenience) servers.")
2544 (defvar gnus-topic-indentation "");; Obsolete variable.
2546 (defconst gnus-article-mark-lists
2547 '((marked . tick) (replied . reply)
2548 (expirable . expire) (killed . killed)
2549 (bookmarks . bookmark) (dormant . dormant)
2550 (scored . score) (saved . save)
2551 (cached . cache) (downloadable . download)
2552 (unsendable . unsend) (forwarded . forward)
2553 (recent . recent) (seen . seen)))
2555 (defconst gnus-article-special-mark-lists
2561 ;; Propagate flags to server, with the following exceptions:
2562 ;; `seen' is private to each gnus installation
2563 ;; `cache' is a internal gnus flag for each gnus installation
2564 ;; `download' is a agent flag private to each gnus installation
2565 ;; `unsend' are for nndraft groups only
2566 ;; `score' is not a proper mark
2567 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2568 (defconst gnus-article-unpropagated-mark-lists
2569 '(seen cache download unsend score bookmark)
2570 "Marks that shouldn't be propagated to back ends.
2571 Typical marks are those that make no sense in a standalone back end,
2572 such as a mark that says whether an article is stored in the cache
2573 \(which doesn't make sense in a standalone back end).")
2575 (defvar gnus-headers-retrieved-by nil)
2576 (defvar gnus-article-reply nil)
2577 (defvar gnus-override-method nil)
2578 (defvar gnus-opened-servers nil)
2580 (defvar gnus-current-kill-article nil)
2582 (defvar gnus-have-read-active-file nil)
2584 (defconst gnus-maintainer
2585 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2586 "The mail address of the T-gnus maintainers.")
2588 (defcustom gnus-info-filename nil
2589 "*Controls language of gnus Info.
2590 If nil and current-language-environment is Japanese, go to gnus-ja.
2591 Otherwise go to corresponding Info.
2592 This variable can be nil, gnus or gnus-ja."
2594 :type '(choice (const nil)
2595 (const :tag "English" gnus)
2596 (const :tag "Japanese" gnus-ja)))
2598 (defvar gnus-info-nodes
2599 '((gnus-group-mode "Group Buffer")
2600 (gnus-summary-mode "Summary Buffer")
2601 (gnus-article-mode "Article Buffer")
2602 (gnus-server-mode "Server Buffer")
2603 (gnus-browse-mode "Browse Foreign Server")
2604 (gnus-tree-mode "Tree Display"))
2605 "Alist of major modes and related Info nodes.")
2607 (defvar gnus-group-buffer "*Group*")
2608 (defvar gnus-summary-buffer "*Summary*")
2609 (defvar gnus-article-buffer "*Article*")
2610 (defvar gnus-server-buffer "*Server*")
2612 (defvar gnus-slave nil
2613 "Whether this Gnus is a slave or not.")
2615 (defvar gnus-batch-mode nil
2616 "Whether this Gnus is running in batch mode or not.")
2618 (defvar gnus-variable-list
2619 '(gnus-newsrc-options gnus-newsrc-options-n
2620 gnus-newsrc-last-checked-date
2621 gnus-newsrc-alist gnus-server-alist
2622 gnus-killed-list gnus-zombie-list
2623 gnus-topic-topology gnus-topic-alist)
2624 "Gnus variables saved in the quick startup file.")
2626 (defvar gnus-product-variable-file-list
2627 (let ((version (product-version (product-find 'gnus-vers))))
2629 ((product-version ,version)
2631 (correct-string-widths))
2633 gnus-format-specs-compiled)
2635 ((product-version ,version)
2637 (correct-string-widths))
2639 gnus-format-specs)))
2640 "Alist of the methods for checking whether the contents of the T-gnus
2641 quick startup files are valid. One is for the byte-compiled format
2642 specifications, the other is for the source form. Each element should
2643 be a list which looks like follows:
2646 ((VARIABLE EXPECTED_VALUE_or_NIL)
2647 (VARIABLE EXPECTED_VALUE_or_NIL)
2649 CODING-SYSTEM_FOR_READING_FILE
2650 SYMBOL_OF_FORMAT_SPECS)")
2652 (defcustom gnus-compile-user-specs t
2653 "If non-nil, the user-defined format specs will be byte-compiled
2655 It has an effect on the values of `gnus-*-line-format-spec'."
2659 (defvar gnus-newsrc-alist nil
2660 "Assoc list of read articles.
2661 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2663 (defvar gnus-registry-alist nil
2664 "Assoc list of registry data.
2665 gnus-registry.el will populate this if it's loaded.")
2667 (defvar gnus-newsrc-hashtb nil
2668 "Hashtable of `gnus-newsrc-alist'.")
2670 (defvar gnus-killed-list nil
2671 "List of killed newsgroups.")
2673 (defvar gnus-killed-hashtb nil
2674 "Hash table equivalent of `gnus-killed-list'.")
2676 (defvar gnus-zombie-list nil
2677 "List of almost dead newsgroups.")
2679 (defvar gnus-description-hashtb nil
2680 "Descriptions of newsgroups.")
2682 (defvar gnus-list-of-killed-groups nil
2683 "List of newsgroups that have recently been killed by the user.")
2685 (defvar gnus-active-hashtb nil
2686 "Hashtable of active articles.")
2688 (defvar gnus-moderated-hashtb nil
2689 "Hashtable of moderated newsgroups.")
2691 ;; Save window configuration.
2692 (defvar gnus-prev-winconf nil)
2694 (defvar gnus-reffed-article-number nil)
2696 ;;; Let the byte-compiler know that we know about this variable.
2697 (defvar rmail-default-rmail-file)
2699 (defvar gnus-dead-summary nil)
2701 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2702 "Regexp matching invalid groups.")
2704 (defvar gnus-other-frame-object nil
2705 "A frame object which will be created by `gnus-other-frame'.")
2707 ;;; End of variables.
2709 ;; Define some autoload functions Gnus might use.
2712 ;; This little mapcar goes through the list below and marks the
2713 ;; symbols in question as autoloaded functions.
2716 (let ((interactive (nth 1 (memq ':interactive package))))
2720 (when (consp function)
2721 (setq keymap (car (memq 'keymap function)))
2722 (setq function (car function)))
2723 (unless (fboundp function)
2724 (autoload function (car package) nil interactive keymap))))
2725 (if (eq (nth 1 package) ':interactive)
2728 '(("info" :interactive t Info-goto-node)
2730 ("ps-print" ps-print-preprint)
2731 ("message" :interactive t
2732 message-send-and-exit message-yank-original)
2733 ("babel" babel-as-string)
2734 ("nnmail" nnmail-split-fancy nnmail-article-group)
2735 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2736 ("rmailout" rmail-output rmail-output-to-rmail-file)
2737 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2738 rmail-show-message rmail-summary-exists
2739 rmail-select-summary rmail-update-summary)
2740 ("gnus-audio" :interactive t gnus-audio-play)
2741 ("gnus-xmas" gnus-xmas-splash)
2742 ("gnus-soup" :interactive t
2743 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2744 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2745 ("nnsoup" nnsoup-pack-replies)
2746 ("score-mode" :interactive t gnus-score-mode)
2747 ("gnus-mh" gnus-summary-save-article-folder
2748 gnus-Folder-save-name gnus-folder-save-name)
2749 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2750 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2751 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2752 gnus-demon-add-disconnection gnus-demon-add-handler
2753 gnus-demon-remove-handler)
2754 ("gnus-demon" :interactive t
2755 gnus-demon-init gnus-demon-cancel)
2756 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2757 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2758 gnus-face-from-file)
2759 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2760 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2761 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2762 gnus-nocem-unwanted-article-p)
2763 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2764 gnus-server-server-name)
2765 ("gnus-srvr" gnus-browse-foreign-server)
2766 ("gnus-cite" :interactive t
2767 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2768 gnus-article-hide-citation gnus-article-fill-cited-article
2769 gnus-article-hide-citation-in-followups)
2770 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2771 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2772 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2773 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2774 gnus-cache-possibly-remove-articles gnus-cache-request-article
2775 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2776 gnus-cache-enter-remove-article gnus-cached-article-p
2777 gnus-cache-open gnus-cache-close gnus-cache-update-article
2778 gnus-cache-articles-in-group)
2779 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2780 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2781 ("gnus-score" :interactive t
2782 gnus-summary-increase-score gnus-summary-set-score
2783 gnus-summary-raise-thread gnus-summary-raise-same-subject
2784 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2785 gnus-summary-lower-thread gnus-summary-lower-same-subject
2786 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2787 gnus-summary-current-score gnus-score-delta-default
2788 gnus-score-flush-cache gnus-score-close
2789 gnus-possibly-score-headers gnus-score-followup-article
2790 gnus-score-followup-thread)
2792 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2793 gnus-current-score-file-nondirectory gnus-score-adaptive
2794 gnus-score-find-trace gnus-score-file-name)
2795 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2796 gnus-score-customize)
2797 ("gnus-topic" :interactive t gnus-topic-mode)
2798 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2799 gnus-subscribe-topics)
2800 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2801 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2802 ("gnus-uu" :interactive t
2803 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2804 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2805 gnus-uu-mark-by-regexp gnus-uu-mark-all
2806 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2807 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2808 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2809 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2810 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2811 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2812 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2813 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2814 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2815 gnus-uu-unmark-thread)
2816 ("gnus-msg" (gnus-summary-send-map keymap)
2817 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2818 ("gnus-msg" :interactive t
2819 gnus-group-post-news gnus-group-mail gnus-group-news
2820 gnus-summary-post-news gnus-summary-news-other-window
2821 gnus-summary-followup gnus-summary-followup-with-original
2822 gnus-summary-cancel-article gnus-summary-supersede-article
2823 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2824 gnus-summary-mail-forward gnus-summary-mail-other-window
2825 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2826 gnus-summary-wide-reply gnus-summary-followup-to-mail
2827 gnus-summary-followup-to-mail-with-original gnus-bug
2828 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2829 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2830 ("gnus-picon" :interactive t gnus-treat-from-picon)
2831 ("smiley" :interactive t smiley-region)
2832 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2833 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2834 gnus-list-of-unread-articles gnus-list-of-read-articles
2835 gnus-offer-save-summaries gnus-make-thread-indent-array
2836 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2837 gnus-summary-skip-intangible gnus-summary-article-number
2838 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2839 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2840 gnus-group-list-groups gnus-group-first-unread-group
2841 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2842 gnus-group-setup-buffer gnus-group-get-new-news
2843 gnus-group-make-help-group gnus-group-update-group
2844 gnus-group-iterate gnus-group-group-name)
2845 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2846 gnus-backlog-remove-article)
2847 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2848 gnus-article-prepare gnus-article-set-window-start
2849 gnus-article-next-page gnus-article-prev-page
2850 gnus-request-article-this-buffer gnus-article-mode
2851 gnus-article-setup-buffer gnus-narrow-to-page
2852 gnus-article-delete-invisible-text gnus-treat-article)
2853 ("gnus-art" :interactive t
2854 gnus-article-hide-headers gnus-article-hide-boring-headers
2855 gnus-article-treat-overstrike
2856 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2857 gnus-article-display-x-face
2858 gnus-article-decode-HZ
2859 gnus-article-wash-html
2860 gnus-article-unsplit-urls
2861 gnus-article-hide-pem gnus-article-hide-signature
2862 gnus-article-strip-leading-blank-lines gnus-article-date-local
2863 gnus-article-date-original gnus-article-date-lapsed
2864 gnus-article-show-all-headers
2865 ;; gnus-article-show-all
2866 gnus-article-edit-mode gnus-article-edit-article
2867 gnus-article-edit-done article-decode-encoded-words
2868 gnus-start-date-timer gnus-stop-date-timer)
2869 ("gnus-int" gnus-request-type)
2870 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2871 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2872 gnus-check-reasonable-setup)
2873 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2874 gnus-dup-enter-articles)
2875 ("gnus-range" gnus-copy-sequence)
2876 ("gnus-eform" gnus-edit-form)
2877 ("gnus-move" :interactive t
2878 gnus-group-move-group-to-server gnus-change-server)
2879 ("gnus-logic" gnus-score-advanced)
2880 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2881 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2882 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2883 gnus-async-halt-prefetch)
2886 ("gnus-offline" :interactive t
2887 gnus-offline-toggle-plugged
2888 gnus-offline-set-unplugged-state
2889 gnus-offline-toggle-auto-hangup
2890 gnus-offline-toggle-on/off-send-mail
2891 gnus-offline-toggle-articles-to-fetch
2892 gnus-offline-set-interval-time
2893 gnus-offline-agent-expire)
2894 ("miee" :interactive t gnspool-get-news
2895 mail-spool-send news-spool-post)
2896 ("international/mw32misc" define-process-argument-editing
2897 general-process-argument-editing-function)
2898 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2899 gnus-agent-save-active gnus-agent-method-p
2900 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2901 gnus-summary-set-agent-mark gnus-agent-save-group-info
2902 gnus-agent-request-article gnus-agent-retrieve-headers)
2903 ("gnus-agent" :interactive t
2904 gnus-unplugged gnus-agentize gnus-agent-batch)
2905 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2906 gnus-summary-save-article-vm)
2907 ("compface" uncompface)
2908 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2909 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2910 ("gnus-mlspl" :interactive t gnus-group-split-setup
2911 gnus-group-split-update)
2912 ("gnus-delay" gnus-delay-initialize))))
2915 (unless (featurep 'xemacs)
2916 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2918 (unless (and (fboundp 'base64-encode-string)
2919 (subrp (symbol-function 'base64-encode-string)))
2922 ;; To search articles with Namazu.
2923 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2924 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2925 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2926 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2928 ;; To make nnir groups.
2929 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2931 ;; To make shimbun groups.
2932 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2934 ;;; gnus-sum.el thingies
2936 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2937 "*The format specification of the lines in the summary buffer.
2939 It works along the same lines as a normal formatting string,
2940 with some simple extensions.
2942 %N Article number, left padded with spaces (string)
2944 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2945 %n Name of the poster (string)
2946 %a Extracted name of the poster (string)
2947 %A Extracted address of the poster (string)
2948 %F Contents of the From: header (string)
2949 %f Contents of the From: or To: headers (string)
2950 %x Contents of the Xref: header (string)
2951 %D Date of the article (string)
2952 %d Date of the article (string) in DD-MMM format
2953 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2954 %M Message-id of the article (string)
2955 %r References of the article (string)
2956 %c Number of characters in the article (integer)
2957 %k Pretty-printed version of the above (string)
2958 For example, \"1.2k\" or \"0.4M\".
2959 %L Number of lines in the article (integer)
2960 %I Indentation based on thread level (a string of spaces)
2961 %B A complex trn-style thread tree (string)
2962 The variables `gnus-sum-thread-*' can be used for customization.
2963 %T A string with two possible values: 80 spaces if the article
2964 is on thread level two or larger and 0 spaces on level one
2965 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2966 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2967 %[ Opening bracket (character, \"[\" or \"<\")
2968 %] Closing bracket (character, \"]\" or \">\")
2969 %> Spaces of length thread-level (string)
2970 %< Spaces of length (- 20 thread-level) (string)
2971 %i Article score (number)
2972 %z Article zcore (character)
2973 %t Number of articles under the current thread (number).
2974 %e Whether the thread is empty or not (character).
2975 %V Total thread score (number).
2976 %P The line number (number).
2977 %O Download mark (character).
2978 %* If present, indicates desired cursor position
2979 (instead of after first colon).
2980 %u User defined specifier. The next character in the format string should
2981 be a letter. Gnus will call the function gnus-user-format-function-X,
2982 where X is the letter following %u. The function will be passed the
2983 current header as argument. The function should return a string, which
2984 will be inserted into the summary just like information from any other
2987 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2988 with care. For reasons of efficiency, Gnus will compute what column
2989 these characters will end up in, and \"hard-code\" that. This means that
2990 it is invalid to have these specs after a variable-length spec. Well,
2991 you might not be arrested, but your summary buffer will look strange,
2992 which is bad enough.
2994 The smart choice is to have these specs as far to the left as
2997 This restriction may disappear in later versions of Gnus.
2999 General format specifiers can also be used.
3000 See Info node `(gnus)Formatting Variables'."
3001 :link '(custom-manual "(gnus)Formatting Variables")
3003 :group 'gnus-summary-format)
3006 ;;; Skeleton keymaps
3009 (defun gnus-suppress-keymap (keymap)
3010 (suppress-keymap keymap)
3011 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
3013 (define-key keymap (pop keys) 'undefined))))
3015 (defvar gnus-article-mode-map
3016 (let ((keymap (make-sparse-keymap)))
3017 (gnus-suppress-keymap keymap)
3019 (defvar gnus-summary-mode-map
3020 (let ((keymap (make-keymap)))
3021 (gnus-suppress-keymap keymap)
3023 (defvar gnus-group-mode-map
3024 (let ((keymap (make-keymap)))
3025 (gnus-suppress-keymap keymap)
3030 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
3031 ;; If you want the cursor to go somewhere else, set these two
3032 ;; functions in some startup hook to whatever you want.
3033 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3034 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3036 ;;; Various macros and substs.
3038 (defun gnus-header-from (header)
3039 (mail-header-from header))
3041 (defmacro gnus-gethash (string hashtable)
3042 "Get hash value of STRING in HASHTABLE."
3043 `(symbol-value (intern-soft ,string ,hashtable)))
3045 (defmacro gnus-gethash-safe (string hashtable)
3046 "Get hash value of STRING in HASHTABLE.
3047 Return nil if not defined."
3048 `(let ((sym (intern-soft ,string ,hashtable)))
3049 (and (boundp sym) (symbol-value sym))))
3051 (defmacro gnus-sethash (string value hashtable)
3052 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
3053 `(set (intern ,string ,hashtable) ,value))
3054 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3056 (defmacro gnus-group-unread (group)
3057 "Get the currently computed number of unread articles in GROUP."
3058 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3060 (defmacro gnus-group-entry (group)
3061 "Get the newsrc entry for GROUP."
3062 `(gnus-gethash ,group gnus-newsrc-hashtb))
3064 (defmacro gnus-active (group)
3065 "Get active info on GROUP."
3066 `(gnus-gethash ,group gnus-active-hashtb))
3068 (defmacro gnus-set-active (group active)
3069 "Set GROUP's active info."
3070 `(gnus-sethash ,group ,active gnus-active-hashtb))
3072 ;; Info access macros.
3074 (defmacro gnus-info-group (info)
3076 (defmacro gnus-info-rank (info)
3078 (defmacro gnus-info-read (info)
3080 (defmacro gnus-info-marks (info)
3082 (defmacro gnus-info-method (info)
3084 (defmacro gnus-info-params (info)
3087 (defmacro gnus-info-level (info)
3088 `(let ((rank (gnus-info-rank ,info)))
3092 (defmacro gnus-info-score (info)
3093 `(let ((rank (gnus-info-rank ,info)))
3094 (or (and (consp rank) (cdr rank)) 0)))
3096 (defmacro gnus-info-set-group (info group)
3097 `(setcar ,info ,group))
3098 (defmacro gnus-info-set-rank (info rank)
3099 `(setcar (nthcdr 1 ,info) ,rank))
3100 (defmacro gnus-info-set-read (info read)
3101 `(setcar (nthcdr 2 ,info) ,read))
3102 (defmacro gnus-info-set-marks (info marks &optional extend)
3104 `(gnus-info-set-entry ,info ,marks 3)
3105 `(setcar (nthcdr 3 ,info) ,marks)))
3106 (defmacro gnus-info-set-method (info method &optional extend)
3108 `(gnus-info-set-entry ,info ,method 4)
3109 `(setcar (nthcdr 4 ,info) ,method)))
3110 (defmacro gnus-info-set-params (info params &optional extend)
3112 `(gnus-info-set-entry ,info ,params 5)
3113 `(setcar (nthcdr 5 ,info) ,params)))
3115 (defun gnus-info-set-entry (info entry number)
3116 ;; Extend the info until we have enough elements.
3117 (while (<= (length info) number)
3118 (nconc info (list nil)))
3120 (setcar (nthcdr number info) entry))
3122 (defmacro gnus-info-set-level (info level)
3123 `(let ((rank (cdr ,info)))
3124 (if (consp (car rank))
3125 (setcar (car rank) ,level)
3126 (setcar rank ,level))))
3127 (defmacro gnus-info-set-score (info score)
3128 `(let ((rank (cdr ,info)))
3129 (if (consp (car rank))
3130 (setcdr (car rank) ,score)
3131 (setcar rank (cons (car rank) ,score)))))
3133 (defmacro gnus-get-info (group)
3134 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3136 ;;; Load the compatibility functions.
3145 (defvar gnus-shutdown-alist nil)
3147 (defun gnus-add-shutdown (function &rest symbols)
3148 "Run FUNCTION whenever one of SYMBOLS is shut down."
3149 (push (cons function symbols) gnus-shutdown-alist))
3151 (defun gnus-shutdown (symbol)
3152 "Shut down everything that waits for SYMBOL."
3153 (dolist (entry gnus-shutdown-alist)
3154 (when (memq symbol (cdr entry))
3155 (funcall (car entry)))))
3159 ;;; Gnus Utility Functions
3162 (defun gnus-find-subscribed-addresses ()
3163 "Return a regexp matching the addresses of all subscribed mail groups.
3164 It consists of the `to-address' or `to-list' parameter of all groups
3165 with a `subscribed' parameter."
3166 (let (group address addresses)
3167 (dolist (entry (cdr gnus-newsrc-alist))
3168 (setq group (car entry))
3169 (when (gnus-parameter-subscribed group)
3170 (setq address (mail-strip-quoted-names
3171 (or (gnus-group-fast-parameter group 'to-address)
3172 (gnus-group-fast-parameter group 'to-list))))
3174 (add-to-list 'addresses address))))
3176 (list (mapconcat 'regexp-quote addresses "\\|")))))
3178 (defmacro gnus-string-or (&rest strings)
3179 "Return the first element of STRINGS that is a non-blank string.
3180 STRINGS will be evaluated in normal `or' order."
3181 `(gnus-string-or-1 ',strings))
3183 (defun gnus-string-or-1 (strings)
3186 (setq string (eval (pop strings)))
3187 (if (string-match "^[ \t]*$" string)
3189 (setq strings nil)))
3192 (defun gnus-info-find-node (&optional nodename)
3193 "Find Info documentation of Gnus."
3195 ;; Enlarge info window if needed.
3196 (let (gnus-info-buffer)
3199 (or gnus-info-filename
3200 (get-language-info current-language-environment 'gnus-info)
3203 (cadr (assq major-mode gnus-info-nodes))
3204 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3205 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3206 (setq gnus-info-buffer (current-buffer))
3207 (gnus-configure-windows 'info)))
3210 ;;; gnus-interactive
3213 (defvar gnus-current-prefix-symbol nil
3214 "Current prefix symbol.")
3216 (defvar gnus-current-prefix-symbols nil
3217 "List of current prefix symbols.")
3219 (defun gnus-interactive (string &optional params)
3220 "Return a list that can be fed to `interactive'.
3221 See `interactive' for full documentation.
3223 Adds the following specs:
3225 y -- The current symbolic prefix.
3226 Y -- A list of the current symbolic prefix(es).
3227 A -- Article number.
3228 H -- Article header.
3232 (while (< i (length string))
3233 (string-match ".\\([^\n]*\\)\n?" string i)
3234 (setq c (aref string i))
3236 (setq prompt (match-string 1 string)))
3237 (setq i (match-end 0))
3238 ;; We basically emulate just about everything that
3239 ;; `interactive' does, but add the specs listed above.
3243 (completing-read prompt obarray 'fboundp t))
3245 (read-buffer prompt (current-buffer) t))
3247 (read-buffer prompt (other-buffer (current-buffer))))
3251 (completing-read prompt obarray 'commandp t))
3255 (read-file-name prompt nil default-directory 'lambda))
3257 (read-file-name prompt nil nil 'lambda))
3259 (read-file-name prompt))
3261 (read-key-sequence prompt))
3263 (error "Not implemented spec"))
3265 (error "Not implemented spec"))
3269 (error "Not implemented spec"))
3271 (string-to-number (read-from-minibuffer prompt)))
3273 (prefix-numeric-value current-prefix-arg))
3279 (read-string prompt))
3281 (intern (read-string prompt)))
3283 (read-variable prompt))
3285 (read-minibuffer prompt))
3287 (eval-minibuffer prompt))
3288 ;; And here the new specs come.
3290 gnus-current-prefix-symbol)
3292 gnus-current-prefix-symbols)
3294 (gnus-group-group-name))
3296 (gnus-summary-skip-intangible)
3297 (or (get-text-property (point) 'gnus-number)
3298 (gnus-summary-last-subject)))
3300 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3302 (error "Non-implemented spec")))
3306 (push (if (< (point) (mark)) (point) (mark)) out)
3307 (push (if (> (point) (mark)) (point) (mark)) out))))
3308 (setq out (delq 'gnus-prefix-nil out))
3311 (defun gnus-symbolic-argument (&optional arg)
3312 "Read a symbolic argument and a command, and then execute command."
3314 (let* ((in-command (this-command-keys))
3315 (command in-command)
3316 gnus-current-prefix-symbols
3317 gnus-current-prefix-symbol
3319 (while (equal in-command command)
3320 (message "%s-" (key-description (this-command-keys)))
3321 (push (intern (char-to-string (read-char))) syms)
3322 (setq command (read-key-sequence nil t)))
3323 (setq gnus-current-prefix-symbols (nreverse syms)
3324 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3325 (call-interactively (key-binding command t))))
3327 ;;; More various functions.
3329 (defsubst gnus-check-backend-function (func group)
3330 "Check whether GROUP supports function FUNC.
3331 GROUP can either be a string (a group name) or a select method."
3333 (let ((method (if (stringp group)
3334 (car (gnus-find-method-for-group group))
3336 (unless (featurep method)
3338 (fboundp (intern (format "%s-%s" method func))))))
3340 (defun gnus-group-read-only-p (&optional group)
3341 "Check whether GROUP supports editing or not.
3342 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3343 that that variable is buffer-local to the summary buffers."
3344 (let ((group (or group gnus-newsgroup-name)))
3345 (not (gnus-check-backend-function 'request-replace-article group))))
3347 (defun gnus-virtual-group-p (group)
3348 "Say whether GROUP is virtual or not."
3349 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3350 gnus-valid-select-methods)))
3352 (defun gnus-news-group-p (group &optional article)
3353 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3354 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3355 t) ;is news of course.
3356 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3357 nil) ;must be mail then.
3358 ((vectorp article) ;Has header info.
3359 (eq (gnus-request-type group (mail-header-id article)) 'news))
3360 ((null article) ;Hasn't header info
3361 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3362 ((< article 0) ;Virtual message
3363 nil) ;we don't know, guess mail.
3364 (t ;Has positive number
3365 (eq (gnus-request-type group article) 'news)))) ;use it.
3367 ;; Returns a list of writable groups.
3368 (defun gnus-writable-groups ()
3369 (let ((alist gnus-newsrc-alist)
3371 (while (setq group (car (pop alist)))
3372 (unless (gnus-group-read-only-p group)
3373 (push group groups)))
3376 ;; Check whether to use long file names.
3377 (defun gnus-use-long-file-name (symbol)
3378 ;; The variable has to be set...
3379 (and gnus-use-long-file-name
3380 ;; If it isn't a list, then we return t.
3381 (or (not (listp gnus-use-long-file-name))
3382 ;; If it is a list, and the list contains `symbol', we
3384 (not (memq symbol gnus-use-long-file-name)))))
3386 ;; Generate a unique new group name.
3387 (defun gnus-generate-new-group-name (leaf)
3390 (while (gnus-group-entry name)
3391 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3394 (defun gnus-ephemeral-group-p (group)
3395 "Say whether GROUP is ephemeral or not."
3396 (gnus-group-get-parameter group 'quit-config t))
3398 (defun gnus-group-quit-config (group)
3399 "Return the quit-config of GROUP."
3400 (gnus-group-get-parameter group 'quit-config t))
3402 (defun gnus-kill-ephemeral-group (group)
3403 "Remove ephemeral GROUP from relevant structures."
3404 (gnus-sethash group nil gnus-newsrc-hashtb))
3406 (defun gnus-simplify-mode-line ()
3407 "Make mode lines a bit simpler."
3408 (setq mode-line-modified (cdr gnus-mode-line-modified))
3409 (when (listp mode-line-format)
3410 (make-local-variable 'mode-line-format)
3411 (setq mode-line-format (copy-sequence mode-line-format))
3412 (when (equal (nth 3 mode-line-format) " ")
3413 (setcar (nthcdr 3 mode-line-format) " "))))
3415 ;;; Servers and groups.
3417 (defsubst gnus-server-add-address (method)
3418 (let ((method-name (symbol-name (car method))))
3419 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3420 (not (assq (intern (concat method-name "-address")) method))
3421 (memq 'physical-address (assq (car method)
3422 gnus-valid-select-methods)))
3423 (append method (list (list (intern (concat method-name "-address"))
3427 (defsubst gnus-method-to-server (method)
3429 (setq method (or method gnus-select-method))
3431 ;; Perhaps it is already in the cache.
3432 (mapc (lambda (name-method)
3433 (if (equal (cdr name-method) method)
3434 (throw 'server-name (car name-method))))
3435 gnus-server-method-cache)
3438 (lambda (server-alist)
3439 (mapc (lambda (name-method)
3440 (when (gnus-methods-equal-p (cdr name-method) method)
3441 (unless (member name-method gnus-server-method-cache)
3442 (push name-method gnus-server-method-cache))
3443 (throw 'server-name (car name-method))))
3445 (let ((alists (list gnus-server-alist
3446 gnus-predefined-server-alist)))
3447 (if gnus-select-method
3448 (push (list (cons "native" gnus-select-method)) alists))
3451 (let* ((name (if (member (cadr method) '(nil ""))
3452 (format "%s" (car method))
3453 (format "%s:%s" (car method) (cadr method))))
3454 (name-method (cons name method)))
3455 (unless (member name-method gnus-server-method-cache)
3456 (push name-method gnus-server-method-cache))
3459 (defsubst gnus-server-to-method (server)
3460 "Map virtual server names to select methods."
3461 (or (and server (listp server) server)
3462 (cdr (assoc server gnus-server-method-cache))
3465 ;; Perhaps this is the native server?
3466 (and (equal server "native") gnus-select-method)
3467 ;; It should be in the server alist.
3468 (cdr (assoc server gnus-server-alist))
3469 ;; It could be in the predefined server alist.
3470 (cdr (assoc server gnus-predefined-server-alist))
3471 ;; If not, we look through all the opened server
3472 ;; to see whether we can find it there.
3473 (let ((opened gnus-opened-servers))
3475 (not (equal server (format "%s:%s" (caaar opened)
3479 ;; It could be a named method, search all servers
3480 (let ((servers gnus-secondary-select-methods))
3482 (not (equal server (format "%s:%s" (caar servers)
3486 ;; This could be some sort of foreign server that I
3487 ;; simply haven't opened (yet). Do a brute-force scan
3488 ;; of the entire gnus-newsrc-alist for the server name
3489 ;; of every method. As a side-effect, loads the
3490 ;; gnus-server-method-cache so this only happens once,
3495 (let ((info-method (gnus-info-method info)))
3496 (unless (stringp info-method)
3497 (let ((info-server (gnus-method-to-server info-method)))
3498 (when (equal server info-server)
3499 (setq match info-method))))))
3500 (cdr gnus-newsrc-alist))
3503 (push (cons server result) gnus-server-method-cache))
3506 (defsubst gnus-server-get-method (group method)
3507 ;; Input either a server name, and extended server name, or a
3508 ;; select method, and return a select method.
3509 (cond ((stringp method)
3510 (gnus-server-to-method method))
3511 ((equal method gnus-select-method)
3513 ((and (stringp (car method))
3515 (gnus-server-extend-method group method))
3518 (equal (cadr method) ""))
3521 (gnus-server-add-address method))))
3523 (defmacro gnus-method-equal (ss1 ss2)
3524 "Say whether two servers are equal."
3528 (and (= (length s1) (length s2))
3530 (while (and s1 (member (car s1) s2))
3534 (defun gnus-methods-equal-p (m1 m2)
3535 (let ((m1 (or m1 gnus-select-method))
3536 (m2 (or m2 gnus-select-method)))
3538 (and (eq (car m1) (car m2))
3539 (or (not (memq 'address (assoc (symbol-name (car m1))
3540 gnus-valid-select-methods)))
3541 (equal (nth 1 m1) (nth 1 m2)))))))
3543 (defun gnus-server-equal (m1 m2)
3544 "Say whether two methods are equal."
3545 (let ((m1 (cond ((null m1) gnus-select-method)
3546 ((stringp m1) (gnus-server-to-method m1))
3548 (m2 (cond ((null m2) gnus-select-method)
3549 ((stringp m2) (gnus-server-to-method m2))
3551 (gnus-method-equal m1 m2)))
3553 (defun gnus-servers-using-backend (backend)
3554 "Return a list of known servers using BACKEND."
3555 (let ((opened gnus-opened-servers)
3558 (when (eq backend (caaar opened))
3559 (push (caar opened) out))
3563 (defun gnus-archive-server-wanted-p ()
3564 "Say whether the user wants to use the archive server."
3566 ((or (not gnus-message-archive-method)
3567 (not gnus-message-archive-group))
3569 ((and gnus-message-archive-method gnus-message-archive-group)
3572 (let ((active (cadr (assq 'nnfolder-active-file
3573 gnus-message-archive-method))))
3575 (file-exists-p active))))))
3577 (defsubst gnus-method-to-server-name (method)
3579 (format "%s" (car method))
3581 (or (assoc (format "%s" (car method))
3582 (gnus-methods-using 'address))
3583 (gnus-server-equal method gnus-message-archive-method))
3585 (not (string= (nth 1 method) "")))
3586 (concat "+" (nth 1 method)))))
3588 (defsubst gnus-method-to-full-server-name (method)
3589 (format "%s+%s" (car method) (nth 1 method)))
3591 (defun gnus-group-prefixed-name (group method &optional full)
3592 "Return the whole name from GROUP and METHOD.
3593 Call with full set to get the fully qualified group name (even if the
3595 (when (stringp method)
3596 (setq method (gnus-server-to-method method)))
3597 (if (or (not method)
3598 (and (not full) (gnus-server-equal method "native"))
3599 ;;;!!! This might not be right. We'll see...
3600 ;(string-match ":" group)
3603 (concat (gnus-method-to-server-name method) ":" group)))
3605 (defun gnus-group-guess-prefixed-name (group)
3606 "Guess the whole name from GROUP and METHOD."
3607 (gnus-group-prefixed-name group (gnus-find-method-for-group
3610 (defun gnus-group-full-name (group method)
3611 "Return the full name from GROUP and METHOD, even if the method is native."
3612 (gnus-group-prefixed-name group method t))
3614 (defun gnus-group-guess-full-name (group)
3615 "Guess the full name from GROUP, even if the method is native."
3616 (if (gnus-group-prefixed-p group)
3618 (gnus-group-full-name group (gnus-find-method-for-group group))))
3620 (defun gnus-group-guess-full-name-from-command-method (group)
3621 "Guess the full name from GROUP, even if the method is native."
3622 (if (gnus-group-prefixed-p group)
3624 (gnus-group-full-name group gnus-command-method)))
3626 (defun gnus-group-real-prefix (group)
3627 "Return the prefix of the current group name."
3629 (if (string-match "^[^:]+:" group)
3630 (substring group 0 (match-end 0))
3634 (defun gnus-group-short-name (group)
3635 "Return the short group name."
3636 (let ((prefix (gnus-group-real-prefix group)))
3637 (if (< 0 (length prefix))
3638 (substring group (length prefix) nil)
3641 (defun gnus-group-prefixed-p (group)
3642 "Return the prefix of the current group name."
3643 (< 0 (length (gnus-group-real-prefix group))))
3645 (defun gnus-summary-buffer-name (group)
3646 "Return the summary buffer name of GROUP."
3647 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3649 (defun gnus-group-method (group)
3650 "Return the server or method used for selecting GROUP.
3651 You should probably use `gnus-find-method-for-group' instead."
3652 (let ((prefix (gnus-group-real-prefix group)))
3653 (if (equal prefix "")
3655 (let ((servers gnus-opened-servers)
3657 backend possible found)
3658 (if (string-match "^[^\\+]+\\+" prefix)
3659 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3660 server (substring prefix (match-end 0) (1- (length prefix))))
3661 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3663 (when (eq (caaar servers) backend)
3664 (setq possible (caar servers))
3665 (when (equal (cadaar servers) server)
3666 (setq found (caar servers))))
3668 (or (car (rassoc found gnus-server-alist))
3670 (car (rassoc possible gnus-server-alist))
3672 (list backend server))))))
3674 (defsubst gnus-native-method-p (method)
3675 "Return whether METHOD is the native select method."
3676 (gnus-method-equal method gnus-select-method))
3678 (defsubst gnus-secondary-method-p (method)
3679 "Return whether METHOD is a secondary select method."
3680 (let ((methods gnus-secondary-select-methods)
3681 (gmethod (inline (gnus-server-get-method nil method))))
3683 (not (gnus-method-equal
3684 (inline (gnus-server-get-method nil (car methods)))
3686 (setq methods (cdr methods)))
3689 (defun gnus-method-simplify (method)
3690 "Return the shortest uniquely identifying string or method for METHOD."
3691 (cond ((stringp method)
3693 ((gnus-native-method-p method)
3695 ((gnus-secondary-method-p method)
3696 (format "%s:%s" (nth 0 method) (nth 1 method)))
3700 (defun gnus-groups-from-server (server)
3701 "Return a list of all groups that are fetched from SERVER."
3702 (let ((alist (cdr gnus-newsrc-alist))
3704 (while (setq info (pop alist))
3705 (when (gnus-server-equal (gnus-info-method info) server)
3706 (push (gnus-info-group info) groups)))
3707 (sort groups 'string<)))
3709 (defun gnus-group-foreign-p (group)
3710 "Say whether a group is foreign or not."
3711 (and (not (gnus-group-native-p group))
3712 (not (gnus-group-secondary-p group))))
3714 (defun gnus-group-native-p (group)
3715 "Say whether the group is native or not."
3716 (not (string-match ":" group)))
3718 (defun gnus-group-secondary-p (group)
3719 "Say whether the group is secondary or not."
3720 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3722 (defun gnus-parameters-get-parameter (group)
3723 "Return the group parameters for GROUP from `gnus-parameters'."
3725 (dolist (elem gnus-parameters)
3726 (when (string-match (car elem) group)
3728 (nconc (gnus-expand-group-parameters
3729 (car elem) (cdr elem) group)
3733 (defun gnus-expand-group-parameter (match value group)
3734 "Use MATCH to expand VALUE in GROUP."
3737 (goto-char (point-min))
3738 (while (re-search-forward match nil t)
3739 (replace-match value))
3742 (defun gnus-expand-group-parameters (match parameters group)
3743 "Go through PARAMETERS and expand them according to the match data."
3745 (dolist (elem parameters)
3746 (if (and (stringp (cdr elem))
3747 (string-match "\\\\[0-9&]" (cdr elem)))
3748 (push (cons (car elem)
3749 (gnus-expand-group-parameter match (cdr elem) group))
3754 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3755 "For GROUP, return the value of SYMBOL.
3757 You should call this in the `gnus-group-buffer' buffer.
3758 The function `gnus-group-find-parameter' will do that for you."
3759 ;; The speed trick: No cons'ing and quit early.
3760 (let* ((params (funcall gnus-group-get-parameter-function group))
3761 ;; Start easy, check the "real" group parameters.
3763 (gnus-group-parameter-value params symbol allow-list t)))
3765 ;; Found results; return them.
3766 (car simple-results)
3767 ;; We didn't found it there, try `gnus-parameters'.
3770 (tail gnus-parameters))
3771 ;; A good old-fashioned non-cl loop.
3773 (setq head (car tail)
3775 ;; The car is regexp matching for matching the group name.
3776 (when (string-match (car head) group)
3777 ;; The cdr is the parameters.
3778 (setq result (gnus-group-parameter-value (cdr head)
3781 ;; Expand if necessary.
3782 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3783 (setq result (gnus-expand-group-parameter (car head)
3785 ;; Exit the loop early.
3790 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3791 "Return the group parameters for GROUP.
3792 If SYMBOL, return the value of that symbol in the group parameters.
3794 If you call this function inside a loop, consider using the faster
3795 `gnus-group-fast-parameter' instead."
3797 (set-buffer gnus-group-buffer)
3799 (gnus-group-fast-parameter group symbol allow-list)
3802 (funcall gnus-group-get-parameter-function group))
3803 (gnus-parameters-get-parameter group)))))
3805 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3806 "Return the group parameters for GROUP.
3807 If SYMBOL, return the value of that symbol in the group parameters.
3808 Most functions should use `gnus-group-find-parameter', which
3809 also examines the topic parameters."
3810 (let ((params (gnus-info-params (gnus-get-info group))))
3812 (gnus-group-parameter-value params symbol allow-list)
3815 (defun gnus-group-parameter-value (params symbol &optional
3816 allow-list present-p)
3817 "Return the value of SYMBOL in group PARAMS."
3818 ;; We only wish to return group parameters (dotted lists) and
3819 ;; not local variables, which may have the same names.
3820 ;; But first we handle single elements...
3821 (or (car (memq symbol params))
3825 (while (setq elem (pop params))
3826 (when (and (consp elem)
3827 (eq (car elem) symbol)
3830 (throw 'found (if present-p (list (cdr elem))
3833 (defun gnus-group-add-parameter (group param)
3834 "Add parameter PARAM to GROUP."
3835 (let ((info (gnus-get-info group)))
3837 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3838 ;; Cons the new param to the old one and update.
3839 (gnus-group-set-info (cons param (gnus-info-params info))
3842 (defun gnus-group-set-parameter (group name value)
3843 "Set parameter NAME to VALUE in GROUP."
3844 (let ((info (gnus-get-info group)))
3846 (gnus-group-remove-parameter group name)
3847 (let ((old-params (gnus-info-params info))
3848 (new-params (list (cons name value))))
3850 (when (or (not (listp (car old-params)))
3851 (not (eq (caar old-params) name)))
3852 (setq new-params (append new-params (list (car old-params)))))
3853 (setq old-params (cdr old-params)))
3854 (gnus-group-set-info new-params group 'params)))))
3856 (defun gnus-group-remove-parameter (group name)
3857 "Remove parameter NAME from GROUP."
3858 (let ((info (gnus-get-info group)))
3860 (let ((params (gnus-info-params info)))
3862 (setq params (delq name params))
3863 (while (assq name params)
3864 (gnus-pull name params))
3865 (gnus-info-set-params info params))))))
3867 (defun gnus-group-add-score (group &optional score)
3868 "Add SCORE to the GROUP score.
3869 If SCORE is nil, add 1 to the score of GROUP."
3870 (let ((info (gnus-get-info group)))
3872 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3874 (defun gnus-short-group-name (group &optional levels)
3875 "Collapse GROUP name LEVELS.
3876 Select methods are stripped and any remote host name is stripped down to
3877 just the host name."
3883 gnus-group-uncollapsed-levels
3885 (while (string-match "\\." group skip)
3886 (setq skip (match-end 0)
3889 ;; Separate foreign select method from group name and collapse.
3890 ;; If method contains a server, collapse to non-domain server name,
3891 ;; otherwise collapse to select method.
3892 (let* ((colon (string-match ":" group))
3893 (server (and colon (substring group 0 colon)))
3894 (plus (and server (string-match "+" server))))
3897 (setq foreign (substring server (+ 1 plus)
3898 (string-match "\\." server))
3899 group (substring group (+ 1 colon)))
3900 (setq foreign server
3901 group (substring group (+ 1 colon))))
3902 (setq foreign (concat foreign ":")))
3903 ;; Collapse group name leaving LEVELS uncollapsed elements
3904 (let* ((slist (split-string group "/"))
3905 (slen (length slist))
3906 (dlist (split-string group "\\."))
3907 (dlen (length dlist))
3919 (setq levels (- glen levels))
3921 (push (if (>= (decf levels) 0)
3922 (if (zerop (length g))
3927 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3929 (defun gnus-narrow-to-body ()
3930 "Narrow to the body of an article."
3933 (goto-char (point-min))
3934 (or (search-forward "\n\n" nil t)
3940 ;;; Kill file handling.
3943 (defun gnus-apply-kill-file ()
3944 "Apply a kill file to the current newsgroup.
3945 Returns the number of articles marked as read."
3946 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3947 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3948 (gnus-apply-kill-file-internal)
3951 (defun gnus-kill-save-kill-buffer ()
3952 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3953 (when (get-file-buffer file)
3955 (set-buffer (get-file-buffer file))
3956 (when (buffer-modified-p)
3958 (kill-buffer (current-buffer))))))
3960 (defcustom gnus-kill-file-name "KILL"
3961 "Suffix of the kill files."
3962 :group 'gnus-score-kill
3963 :group 'gnus-score-files
3966 (defun gnus-newsgroup-kill-file (newsgroup)
3967 "Return the name of a kill file name for NEWSGROUP.
3968 If NEWSGROUP is nil, return the global kill file name instead."
3970 ;; The global KILL file is placed at top of the directory.
3971 ((or (null newsgroup)
3972 (string-equal newsgroup ""))
3973 (expand-file-name gnus-kill-file-name
3974 gnus-kill-files-directory))
3975 ;; Append ".KILL" to newsgroup name.
3976 ((gnus-use-long-file-name 'not-kill)
3977 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3978 "." gnus-kill-file-name)
3979 gnus-kill-files-directory))
3980 ;; Place "KILL" under the hierarchical directory.
3982 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3983 "/" gnus-kill-file-name)
3984 gnus-kill-files-directory))))
3988 (defun gnus-member-of-valid (symbol group)
3989 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3991 (symbol-name (car (gnus-find-method-for-group group)))
3992 gnus-valid-select-methods)))
3994 (defun gnus-method-option-p (method option)
3995 "Return non-nil if select METHOD has OPTION as a parameter."
3996 (when (stringp method)
3997 (setq method (gnus-server-to-method method)))
3998 (memq option (assoc (format "%s" (car method))
3999 gnus-valid-select-methods)))
4001 (defun gnus-similar-server-opened (method)
4002 (let ((opened gnus-opened-servers))
4003 (while (and method opened)
4004 (when (and (equal (cadr method) (cadaar opened))
4005 (equal (car method) (caaar opened))
4006 (not (equal method (caar opened))))
4011 (defun gnus-server-extend-method (group method)
4012 ;; This function "extends" a virtual server. If the server is
4013 ;; "hello", and the select method is ("hello" (my-var "something"))
4014 ;; in the group "alt.alt", this will result in a new virtual server
4015 ;; called "hello+alt.alt".
4016 (if (or (not (inline (gnus-similar-server-opened method)))
4017 (not (cddr method)))
4019 `(,(car method) ,(concat (cadr method) "+" group)
4020 (,(intern (format "%s-address" (car method))) ,(cadr method))
4023 (defun gnus-server-status (method)
4024 "Return the status of METHOD."
4025 (nth 1 (assoc method gnus-opened-servers)))
4027 (defun gnus-group-name-to-method (group)
4028 "Guess a select method based on GROUP."
4029 (if (string-match ":" group)
4030 (let ((server (substring group 0 (match-beginning 0))))
4031 (if (string-match "\\+" server)
4032 (list (intern (substring server 0 (match-beginning 0)))
4033 (substring server (match-end 0)))
4034 (list (intern server) "")))
4035 gnus-select-method))
4037 (defun gnus-server-string (server)
4038 "Return a readable string that describes SERVER."
4039 (let* ((server (gnus-server-to-method server))
4040 (address (nth 1 server)))
4042 (not (zerop (length address))))
4043 (format "%s using %s" address (car server))
4044 (format "%s" (car server)))))
4046 (defun gnus-find-method-for-group (group &optional info)
4047 "Find the select method that GROUP uses."
4048 (or gnus-override-method
4051 (and (not (gnus-group-entry group));; a new group
4052 (gnus-group-name-to-method group))
4053 (let ((info (or info (gnus-get-info group)))
4056 (not (setq method (gnus-info-method info)))
4057 (equal method "native"))
4060 (cond ((stringp method)
4061 (inline (gnus-server-to-method method)))
4062 ((stringp (cadr method))
4063 (inline (gnus-server-extend-method group method)))
4066 (cond ((equal (cadr method) "")
4068 ((null (cadr method))
4069 (list (car method) ""))
4071 (gnus-server-add-address method)))))))
4073 (defun gnus-methods-using (feature)
4074 "Find all methods that have FEATURE."
4075 (let ((valids gnus-valid-select-methods)
4078 (when (memq feature (car valids))
4079 (push (car valids) outs))
4080 (setq valids (cdr valids)))
4084 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4086 (defun gnus-read-group (prompt &optional default)
4087 "Prompt the user for a group name.
4088 Disallow invalid group names."
4093 gnus-invalid-group-regexp
4094 (setq group (read-string (concat prefix prompt)
4095 (cons (or default "") 0)
4096 'gnus-group-history)))
4097 (let ((match (match-string 0 group)))
4098 ;; Might be okay (e.g. for nnimap), so ask the user:
4099 (unless (and (not (string-match "^$\\|:" match))
4101 "Proceed and create group anyway? " t
4102 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4104 Usually, it's dangerous to create a group with this name, because it's not
4105 supported by all back ends and servers. On IMAP servers it should work,
4106 though. If you are really sure, you can proceed anyway and create the group.
4108 You may customize the variable `gnus-invalid-group-regexp', which currently is
4109 set to \"" gnus-invalid-group-regexp
4110 "\", if you want to get rid of this query permanently."))
4111 (setq prefix (format "Invalid group name: \"%s\". " group)
4115 (defun gnus-read-method (prompt)
4116 "Prompt the user for a method.
4117 Allow completion over sensible values."
4118 (let* ((open-servers
4119 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4120 gnus-opened-servers))
4123 (dolist (method gnus-valid-select-methods)
4124 (if (or (memq 'prompt-address method)
4125 (not (assoc (format "%s:" (car method)) open-servers)))
4126 (push method methods)))
4129 (append valid-methods
4131 gnus-predefined-server-alist
4136 nil t nil 'gnus-method-history)))
4139 (setq method gnus-select-method))
4140 ((assoc method gnus-valid-select-methods)
4141 (let ((address (if (memq 'prompt-address
4142 (assoc method gnus-valid-select-methods))
4143 (read-string "Address: ")
4145 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4146 (list (intern method) address))))
4147 ((assoc method servers)
4150 (list (intern method) "")))))
4154 (defun gnus-agent-method-p (method)
4155 "Say whether METHOD is covered by the agent."
4156 (or (eq (car gnus-agent-method-p-cache) method)
4157 (setq gnus-agent-method-p-cache
4159 (member (if (stringp method)
4161 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4162 (cdr gnus-agent-method-p-cache))
4164 (defun gnus-online (method)
4167 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4168 (gnus-agent-method-p method))))
4170 ;;; User-level commands.
4173 (defun gnus-slave-no-server (&optional arg)
4174 "Read network news as a slave, without connecting to the local server."
4176 (gnus-no-server arg t))
4179 (defun gnus-no-server (&optional arg slave)
4181 If ARG is a positive number, Gnus will use that as the startup
4182 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4183 non-nil and not a positive number, Gnus will prompt the user for the
4184 name of an NNTP server to use.
4185 As opposed to `gnus', this command will not connect to the local
4188 (gnus-no-server-1 arg slave))
4191 (defun gnus-slave (&optional arg)
4192 "Read news as a slave."
4194 (gnus arg nil 'slave))
4196 (defcustom gnus-frame-properties nil
4197 "The properties of the frame in which gnus is displayed. Under XEmacs,
4198 the variable `toolbar-news-frame-plist' will be refered instead."
4199 :type '(repeat (cons :format "%v"
4200 (symbol :tag "Parameter")
4201 (sexp :tag "Value")))
4205 (defun gnus-other-frame (&optional arg display)
4206 "Pop up a frame to read news.
4207 This will call one of the Gnus commands which is specified by the user
4208 option `gnus-other-frame-function' (default `gnus') with the argument
4209 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4210 optional second argument DISPLAY should be a standard display string
4211 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4212 omitted or the function `make-frame-on-display' is not available, the
4213 current display is used."
4215 (if (fboundp 'make-frame-on-display)
4217 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4219 (let ((alive (gnus-alive-p)))
4224 (when (and (or (not display)
4226 (gnus-frame-or-window-display-name
4228 (with-current-buffer (window-buffer window)
4229 (string-match "\\`gnus-"
4230 (symbol-name major-mode))))
4231 (gnus-select-frame-set-input-focus
4232 (setq gnus-other-frame-object (window-frame window)))
4233 (select-window window)
4236 (gnus-select-frame-set-input-focus
4237 (setq gnus-other-frame-object
4239 (make-frame-on-display display gnus-other-frame-parameters)
4240 (make-frame gnus-other-frame-parameters))))
4242 (switch-to-buffer gnus-group-buffer)
4243 (funcall gnus-other-frame-function arg)
4244 (add-hook 'gnus-exit-gnus-hook
4246 (when (and (frame-live-p gnus-other-frame-object)
4248 (delete-frame gnus-other-frame-object))
4249 (setq gnus-other-frame-object nil)))))))
4252 (defun gnus (&optional arg dont-connect slave)
4254 If ARG is non-nil and a positive number, Gnus will use that as the
4255 startup level. If ARG is non-nil and not a positive number, Gnus will
4256 prompt the user for the name of an NNTP server to use."
4258 (unless (byte-code-function-p (symbol-function 'gnus))
4259 (message "You should byte-compile Gnus")
4261 (gnus-1 arg dont-connect slave))
4263 ;; Allow redefinition of Gnus functions.
4267 (product-provide (provide 'gnus) 'gnus-vers)
4269 ;;; gnus.el ends here