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 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))
43 ;; For backward compatibility with old .newsrc.eld files.
44 (defvar gnus-tmp-grouplens "")
47 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
51 (defgroup gnus-format nil
52 "Dealing with formatting issues."
55 (defgroup gnus-charset nil
56 "Group character set issues."
57 :link '(custom-manual "(gnus)Charsets")
61 (defgroup gnus-cache nil
63 :link '(custom-manual "(gnus)Article Caching")
66 (defgroup gnus-registry nil
70 (defgroup gnus-start nil
71 "Starting your favorite newsreader."
74 (defgroup gnus-start-server nil
75 "Server options at startup."
78 ;; These belong to gnus-group.el.
79 (defgroup gnus-group nil
81 :link '(custom-manual "(gnus)The Group Buffer")
84 (defgroup gnus-group-foreign nil
86 :link '(custom-manual "(gnus)Foreign Groups")
89 (defgroup gnus-group-new nil
90 "Automatic subscription of new groups."
93 (defgroup gnus-group-levels nil
95 :link '(custom-manual "(gnus)Group Levels")
98 (defgroup gnus-group-select nil
100 :link '(custom-manual "(gnus)Selecting a Group")
103 (defgroup gnus-group-listing nil
104 "Showing slices of the group list."
105 :link '(custom-manual "(gnus)Listing Groups")
108 (defgroup gnus-group-visual nil
109 "Sorting the group buffer."
110 :link '(custom-manual "(gnus)Group Buffer Format")
114 (defgroup gnus-group-various nil
115 "Various group options."
116 :link '(custom-manual "(gnus)Scanning New Messages")
119 ;; These belong to gnus-sum.el.
120 (defgroup gnus-summary nil
122 :link '(custom-manual "(gnus)The Summary Buffer")
125 (defgroup gnus-summary-exit nil
126 "Leaving summary buffers."
127 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-marks nil
131 "Marks used in summary buffers."
132 :link '(custom-manual "(gnus)Marking Articles")
133 :group 'gnus-summary)
135 (defgroup gnus-thread nil
136 "Ordering articles according to replies."
137 :link '(custom-manual "(gnus)Threading")
138 :group 'gnus-summary)
140 (defgroup gnus-summary-format nil
141 "Formatting of the summary buffer."
142 :link '(custom-manual "(gnus)Summary Buffer Format")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-choose nil
147 :link '(custom-manual "(gnus)Choosing Articles")
148 :group 'gnus-summary)
150 (defgroup gnus-summary-maneuvering nil
151 "Summary movement commands."
152 :link '(custom-manual "(gnus)Summary Maneuvering")
153 :group 'gnus-summary)
155 (defgroup gnus-picon nil
156 "Show pictures of people, domains, and newsgroups."
159 (defgroup gnus-summary-mail nil
160 "Mail group commands."
161 :link '(custom-manual "(gnus)Mail Group Commands")
162 :group 'gnus-summary)
164 (defgroup gnus-summary-sort nil
165 "Sorting the summary buffer."
166 :link '(custom-manual "(gnus)Sorting")
167 :group 'gnus-summary)
169 (defgroup gnus-summary-visual nil
170 "Highlighting and menus in the summary buffer."
171 :link '(custom-manual "(gnus)Summary Highlighting")
173 :group 'gnus-summary)
175 (defgroup gnus-summary-various nil
176 "Various summary buffer options."
177 :link '(custom-manual "(gnus)Various Summary Stuff")
178 :group 'gnus-summary)
180 (defgroup gnus-summary-pick nil
181 "Pick mode in the summary buffer."
182 :link '(custom-manual "(gnus)Pick and Read")
184 :group 'gnus-summary)
186 (defgroup gnus-summary-tree nil
187 "Tree display of threads in the summary buffer."
188 :link '(custom-manual "(gnus)Tree Display")
190 :group 'gnus-summary)
192 ;; Belongs to gnus-uu.el
193 (defgroup gnus-extract-view nil
194 "Viewing extracted files."
195 :link '(custom-manual "(gnus)Viewing Files")
196 :group 'gnus-extract)
198 ;; Belongs to gnus-score.el
199 (defgroup gnus-score nil
200 "Score and kill file handling."
203 (defgroup gnus-score-kill nil
207 (defgroup gnus-score-adapt nil
208 "Adaptive score files."
211 (defgroup gnus-score-default nil
212 "Default values for score files."
215 (defgroup gnus-score-expire nil
216 "Expiring score rules."
219 (defgroup gnus-score-decay nil
220 "Decaying score rules."
223 (defgroup gnus-score-files nil
224 "Score and kill file names."
228 (defgroup gnus-score-various nil
229 "Various scoring and killing options."
233 (defgroup gnus-visual nil
234 "Options controlling the visual fluff."
238 (defgroup gnus-agent nil
239 "Offline support for Gnus."
242 (defgroup gnus-files nil
243 "Files used by Gnus."
246 (defgroup gnus-dribble-file nil
248 :link '(custom-manual "(gnus)Auto Save")
251 (defgroup gnus-newsrc nil
252 "Storing Gnus state."
255 (defgroup gnus-server nil
256 "Options related to newsservers and other servers used by Gnus."
259 (defgroup gnus-server-visual nil
260 "Highlighting and menus in the server buffer."
264 (defgroup gnus-message '((message custom-group))
265 "Composing replies and followups in Gnus."
268 (defgroup gnus-meta nil
269 "Meta variables controlling major portions of Gnus.
270 In general, modifying these variables does not take affect until Gnus
271 is restarted, and sometimes reloaded."
274 (defgroup gnus-various nil
275 "Other Gnus options."
276 :link '(custom-manual "(gnus)Various Various")
279 (defgroup gnus-mime nil
280 "Variables for controlling the Gnus MIME interface."
283 (defgroup gnus-exit nil
285 :link '(custom-manual "(gnus)Exiting Gnus")
288 (defgroup gnus-fun nil
289 "Frivolous Gnus extensions."
290 :link '(custom-manual "(gnus)Exiting Gnus")
293 (defcustom gnus-inhibit-startup-message nil
294 "If non-nil, the startup message will not be displayed.
295 This variable is used before `.gnus.el' is loaded, so it should
296 be set in `.emacs' instead."
300 (defcustom gnus-play-startup-jingle nil
301 "If non-nil, play the Gnus jingle at startup."
305 (unless (fboundp 'gnus-group-remove-excess-properties)
306 (defalias 'gnus-group-remove-excess-properties 'ignore))
308 (unless (featurep 'gnus-xmas)
309 (defalias 'gnus-make-overlay 'make-overlay)
310 (defalias 'gnus-delete-overlay 'delete-overlay)
311 (defalias 'gnus-overlay-put 'overlay-put)
312 (defalias 'gnus-move-overlay 'move-overlay)
313 (defalias 'gnus-overlay-buffer 'overlay-buffer)
314 (defalias 'gnus-overlay-start 'overlay-start)
315 (defalias 'gnus-overlay-end 'overlay-end)
316 (defalias 'gnus-extent-detached-p 'ignore)
317 (defalias 'gnus-extent-start-open 'ignore)
318 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
319 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
320 (defalias 'gnus-character-to-event 'identity)
321 (defalias 'gnus-assq-delete-all 'assq-delete-all)
322 (defalias 'gnus-add-text-properties 'add-text-properties)
323 (defalias 'gnus-put-text-property 'put-text-property)
324 (defvar gnus-mode-line-image-cache t)
325 (if (fboundp 'find-image)
326 (defun gnus-mode-line-buffer-identification (line)
327 (let ((str (car-safe line)))
328 (if (and (stringp str)
329 (string-match "^Gnus:" str))
330 (progn (add-text-properties
333 (if (eq t gnus-mode-line-image-cache)
334 (setq gnus-mode-line-image-cache
336 '((:type xpm :file "gnus-pointer.xpm"
338 (:type xbm :file "gnus-pointer.xbm"
340 gnus-mode-line-image-cache)
343 gnus-version (gnus-emacs-version)))
347 (defalias 'gnus-mode-line-buffer-identification 'identity))
348 (defalias 'gnus-characterp 'numberp)
349 (defalias 'gnus-deactivate-mark 'deactivate-mark)
350 (defalias 'gnus-window-edges 'window-edges)
351 (defalias 'gnus-key-press-event-p 'numberp)
352 ;;(defalias 'gnus-decode-rfc1522 'ignore)
355 ;; We define these group faces here to avoid the display
356 ;; update forced when creating new faces.
358 (defface gnus-group-news-1-face
361 (:foreground "PaleTurquoise" :bold t))
364 (:foreground "ForestGreen" :bold t))
367 "Level 1 newsgroup face.")
369 (defface gnus-group-news-1-empty-face
372 (:foreground "PaleTurquoise"))
375 (:foreground "ForestGreen"))
378 "Level 1 empty newsgroup face.")
380 (defface gnus-group-news-2-face
383 (:foreground "turquoise" :bold t))
386 (:foreground "CadetBlue4" :bold t))
389 "Level 2 newsgroup face.")
391 (defface gnus-group-news-2-empty-face
394 (:foreground "turquoise"))
397 (:foreground "CadetBlue4"))
400 "Level 2 empty newsgroup face.")
402 (defface gnus-group-news-3-face
411 "Level 3 newsgroup face.")
413 (defface gnus-group-news-3-empty-face
422 "Level 3 empty newsgroup face.")
424 (defface gnus-group-news-4-face
433 "Level 4 newsgroup face.")
435 (defface gnus-group-news-4-empty-face
444 "Level 4 empty newsgroup face.")
446 (defface gnus-group-news-5-face
455 "Level 5 newsgroup face.")
457 (defface gnus-group-news-5-empty-face
466 "Level 5 empty newsgroup face.")
468 (defface gnus-group-news-6-face
477 "Level 6 newsgroup face.")
479 (defface gnus-group-news-6-empty-face
488 "Level 6 empty newsgroup face.")
490 (defface gnus-group-news-low-face
493 (:foreground "DarkTurquoise" :bold t))
496 (:foreground "DarkGreen" :bold t))
499 "Low level newsgroup face.")
501 (defface gnus-group-news-low-empty-face
504 (:foreground "DarkTurquoise"))
507 (:foreground "DarkGreen"))
510 "Low level empty newsgroup face.")
512 (defface gnus-group-mail-1-face
515 (:foreground "aquamarine1" :bold t))
518 (:foreground "DeepPink3" :bold t))
521 "Level 1 mailgroup face.")
523 (defface gnus-group-mail-1-empty-face
526 (:foreground "aquamarine1"))
529 (:foreground "DeepPink3"))
531 (:italic t :bold t)))
532 "Level 1 empty mailgroup face.")
534 (defface gnus-group-mail-2-face
537 (:foreground "aquamarine2" :bold t))
540 (:foreground "HotPink3" :bold t))
543 "Level 2 mailgroup face.")
545 (defface gnus-group-mail-2-empty-face
548 (:foreground "aquamarine2"))
551 (:foreground "HotPink3"))
554 "Level 2 empty mailgroup face.")
556 (defface gnus-group-mail-3-face
559 (:foreground "aquamarine3" :bold t))
562 (:foreground "magenta4" :bold t))
565 "Level 3 mailgroup face.")
567 (defface gnus-group-mail-3-empty-face
570 (:foreground "aquamarine3"))
573 (:foreground "magenta4"))
576 "Level 3 empty mailgroup face.")
578 (defface gnus-group-mail-low-face
581 (:foreground "aquamarine4" :bold t))
584 (:foreground "DeepPink4" :bold t))
587 "Low level mailgroup face.")
589 (defface gnus-group-mail-low-empty-face
592 (:foreground "aquamarine4"))
595 (:foreground "DeepPink4"))
598 "Low level empty mailgroup face.")
600 ;; Summary mode faces.
602 (defface gnus-summary-selected-face '((t
604 "Face used for selected articles.")
606 (defface gnus-summary-cancelled-face
608 (:foreground "yellow" :background "black")))
609 "Face used for cancelled articles.")
611 (defface gnus-summary-high-ticked-face
614 (:foreground "pink" :bold t))
617 (:foreground "firebrick" :bold t))
620 "Face used for high interest ticked articles.")
622 (defface gnus-summary-low-ticked-face
625 (:foreground "pink" :italic t))
628 (:foreground "firebrick" :italic t))
631 "Face used for low interest ticked articles.")
633 (defface gnus-summary-normal-ticked-face
636 (:foreground "pink"))
639 (:foreground "firebrick"))
642 "Face used for normal interest ticked articles.")
644 (defface gnus-summary-high-ancient-face
647 (:foreground "SkyBlue" :bold t))
650 (:foreground "RoyalBlue" :bold t))
653 "Face used for high interest ancient articles.")
655 (defface gnus-summary-low-ancient-face
658 (:foreground "SkyBlue" :italic t))
661 (:foreground "RoyalBlue" :italic t))
664 "Face used for low interest ancient articles.")
666 (defface gnus-summary-normal-ancient-face
669 (:foreground "SkyBlue"))
672 (:foreground "RoyalBlue"))
675 "Face used for normal interest ancient articles.")
677 (defface gnus-summary-high-undownloaded-face
680 (:bold t :foreground "cyan4"))
681 (((class color) (background dark))
682 (:bold t :foreground "LightGray"))
683 (t (:inverse-video t :bold t)))
684 "Face used for high interest uncached articles.")
686 (defface gnus-summary-low-undownloaded-face
689 (:italic t :foreground "cyan4" :bold nil))
690 (((class color) (background dark))
691 (:italic t :foreground "LightGray" :bold nil))
692 (t (:inverse-video t :italic t)))
693 "Face used for low interest uncached articles.")
695 (defface gnus-summary-normal-undownloaded-face
698 (:foreground "cyan4" :bold nil))
699 (((class color) (background dark))
700 (:foreground "LightGray" :bold nil))
701 (t (:inverse-video t)))
702 "Face used for normal interest uncached articles.")
704 (defface gnus-summary-high-unread-face
707 "Face used for high interest unread articles.")
709 (defface gnus-summary-low-unread-face
712 "Face used for low interest unread articles.")
714 (defface gnus-summary-normal-unread-face
717 "Face used for normal interest unread articles.")
719 (defface gnus-summary-incorporated-face
722 "Face used for incorporated articles.")
724 (defface gnus-summary-high-read-face
727 (:foreground "PaleGreen"
731 (:foreground "DarkGreen"
735 "Face used for high interest read articles.")
737 (defface gnus-summary-low-read-face
740 (:foreground "PaleGreen"
744 (:foreground "DarkGreen"
748 "Face used for low interest read articles.")
750 (defface gnus-summary-normal-read-face
753 (:foreground "PaleGreen"))
756 (:foreground "DarkGreen"))
759 "Face used for normal interest read articles.")
766 (defvar gnus-buffers nil)
768 (defun gnus-get-buffer-create (name)
769 "Do the same as `get-buffer-create', but store the created buffer."
770 (or (get-buffer name)
771 (car (push (get-buffer-create name) gnus-buffers))))
773 (defun gnus-add-buffer ()
774 "Add the current buffer to the list of Gnus buffers."
775 (push (current-buffer) gnus-buffers))
777 (defmacro gnus-kill-buffer (buffer)
778 "Kill BUFFER and remove from the list of Gnus buffers."
779 `(let ((buf ,buffer))
780 (when (gnus-buffer-exists-p buf)
781 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
784 (defun gnus-buffers ()
785 "Return a list of live Gnus buffers."
786 (while (and gnus-buffers
787 (not (buffer-name (car gnus-buffers))))
789 (let ((buffers gnus-buffers))
791 (if (buffer-name (cadr buffers))
793 (setcdr buffers (cddr buffers)))))
798 (defvar gnus-group-buffer "*Group*")
801 (autoload 'gnus-play-jingle "gnus-audio"))
803 (defface gnus-splash-face
806 (:foreground "#888888"))
809 (:foreground "#888888"))
812 "Face for the splash screen.")
814 (defun gnus-splash ()
816 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
817 (let ((buffer-read-only nil))
819 (unless gnus-inhibit-startup-message
820 (gnus-group-startup-message)
822 (when gnus-play-startup-jingle
823 (gnus-play-jingle))))))
825 (defun gnus-indent-rigidly (start end arg)
826 "Indent rigidly using only spaces and no tabs."
829 (narrow-to-region start end)
831 (indent-rigidly start end arg)
832 ;; We translate tabs into spaces -- not everybody uses
833 ;; an 8-character tab.
834 (goto-char (point-min))
835 (while (search-forward "\t" nil t)
836 (replace-match " " t t))))))
838 (defvar gnus-simple-splash nil)
840 ;;(format "%02x%02x%02x" 114 66 20) "724214"
842 (defvar gnus-logo-color-alist
843 '((flame "#cc3300" "#ff2200")
844 (pine "#c0cc93" "#f8ffb8")
845 (moss "#a1cc93" "#d2ffb8")
846 (irish "#04cc90" "#05ff97")
847 (sky "#049acc" "#05deff")
848 (tin "#6886cc" "#82b6ff")
849 (velvet "#7c68cc" "#8c82ff")
850 (grape "#b264cc" "#cf7df")
851 (labia "#cc64c2" "#fd7dff")
852 (berry "#cc6485" "#ff7db5")
853 (dino "#724214" "#1e3f03")
854 (oort "#cccccc" "#888888")
855 (storm "#666699" "#99ccff")
856 (pdino "#9999cc" "#99ccff")
857 (purp "#9999cc" "#666699")
858 (no "#ff0000" "#ffff00")
859 (neutral "#b4b4b4" "#878787")
860 (september "#bf9900" "#ffcc00"))
861 "Color alist used for the Gnus logo.")
863 (defcustom gnus-logo-color-style 'no
864 "*Color styles used for the Gnus logo."
865 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
866 gnus-logo-color-alist))
869 (defvar gnus-logo-colors
870 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
871 "Colors used for the Gnus logo.")
873 (defun gnus-group-startup-message (&optional x y)
874 "Insert startup message in current buffer."
875 ;; Insert the message.
878 ((and (fboundp 'find-image)
880 (let* ((bg (face-background 'default))
881 (fg (face-foreground 'gnus-splash-face))
882 (data-directory (nnheader-find-etc-directory "gnus"))
884 `((:type xpm :file "gnus.xpm"
886 (("thing" . ,(car gnus-logo-colors))
887 ("shadow" . ,(cadr gnus-logo-colors))
889 ("background" . ,bg)))
890 (:type pbm :file "gnus.pbm"
891 ;; Account for the pbm's blackground.
892 :background ,bg :foreground ,fg)
893 (:type xbm :file "gnus.xbm"
894 ;; Account for the xbm's blackground.
895 :background ,bg :foreground ,fg)))))
899 (concat gnus-product-name " " gnus-version-number
900 (if (zerop (string-to-number gnus-revision-number))
902 (concat " (r" gnus-revision-number ")"))
903 " based on " gnus-original-product-name " v"
904 gnus-original-version-number)
905 'face `(variable-pitch :background ,bg :foreground ,fg)))
906 (let ((fill-column (window-width)))
907 (center-region (point-min) (point)))
908 (let ((size (image-size image)))
909 (insert-char ?\n (max 1 (round (- (window-height)
910 (or y (cdr size))) 2)))
912 (propertize " " 'display
914 ,(max 0 (round (- (window-width)
915 (or x (car size))) 2)))))
916 (insert-image image))
917 (setq gnus-simple-splash nil)
922 _ ___ __ ___ __ _ ___
941 (goto-char (point-min))
942 (insert gnus-product-name " " gnus-version-number
943 (if (zerop (string-to-number gnus-revision-number))
945 (concat " (r" gnus-revision-number ")"))
946 " based on " gnus-original-product-name " v"
947 gnus-original-version-number)
948 (insert-char ?\ (prog1
949 (max 0 (/ (- (window-width) (point)) 2))
950 (goto-char (point-min))))
953 (gnus-indent-rigidly (point) (point-max)
954 (/ (max (- (window-width) (or x 46)) 0) 2))
955 (goto-char (point-min))
957 (let* ((pheight (count-lines (point-min) (point-max)))
958 (wheight (window-height))
959 (rest (- wheight pheight)))
960 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
962 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
963 (setq gnus-simple-splash t)))
964 (goto-char (point-min))
965 (setq mode-line-buffer-identification (concat " " gnus-version))
966 (set-buffer-modified-p t))
969 (let ((command (format "%s" this-command)))
970 (when (string-match "gnus" command)
971 (if (string-match "gnus-other-frame" command)
972 (gnus-get-buffer-create gnus-group-buffer)
980 (defcustom gnus-parameters nil
981 "Alist of group parameters.
984 ((\"mail\\\\..*\" (gnus-show-threads nil)
985 (gnus-use-scoring nil)
986 (gnus-summary-line-format
987 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
990 (\"mail\\\\.me\" (gnus-use-scoring t))
991 (\"list\\\\..*\" (total-expire . t)
992 (broken-reply-to . t)))"
993 :group 'gnus-group-various
994 :type '(repeat (cons regexp
997 (defvar gnus-group-parameters-more nil)
999 (defvar gnus-colon-keywords
1001 (when (boundp 'dgnushack-colon-keywords)
1002 (symbol-value 'dgnushack-colon-keywords)))
1003 "List of the colon keywords should be bound at run-time. This variable
1004 defaults to a proper value only if this file is byte-compiled by make.")
1006 (dolist (keyword gnus-colon-keywords)
1007 (set keyword keyword))
1009 (defmacro gnus-define-group-parameter (param &rest rest)
1010 "Define a group parameter PARAM.
1011 REST is a plist of following:
1012 :type One of `bool', `list' or nil.
1013 :function The name of the function.
1014 :function-document The documentation of the function.
1015 :parameter-type The type for customizing the parameter.
1016 :parameter-document The documentation for the parameter.
1017 :variable The name of the variable.
1018 :variable-document The documentation for the variable.
1019 :variable-group The group for customizing the variable.
1020 :variable-type The type for customizing the variable.
1021 :variable-default The default value of the variable."
1022 (let* ((type (plist-get rest :type))
1023 (parameter-type (plist-get rest :parameter-type))
1024 (parameter-document (plist-get rest :parameter-document))
1025 (function (or (plist-get rest :function)
1026 (intern (format "gnus-parameter-%s" param))))
1027 (function-document (or (plist-get rest :function-document) ""))
1028 (variable (or (plist-get rest :variable)
1029 (intern (format "gnus-parameter-%s-alist" param))))
1030 (variable-document (or (plist-get rest :variable-document) ""))
1031 (variable-group (plist-get rest :variable-group))
1032 (variable-type (or (plist-get rest :variable-type)
1034 (list (regexp :tag "Group")
1035 ,(car (cdr parameter-type)))))))
1036 (variable-default (plist-get rest :variable-default)))
1039 `(defcustom ,variable ,variable-default
1041 :group 'gnus-group-parameter
1042 :group ',variable-group
1043 :type ,variable-type)
1044 `(setq gnus-group-parameters-more
1045 (delq (assq ',param gnus-group-parameters-more)
1046 gnus-group-parameters-more))
1047 `(add-to-list 'gnus-group-parameters-more
1050 ,parameter-document))
1052 `(defun ,function (name)
1054 (let ((params (gnus-group-find-parameter name))
1057 ((memq ',param params)
1059 ((setq val (assq ',param params))
1061 ((stringp ,variable)
1062 (string-match ,variable name))
1064 (let ((alist ,variable)
1066 (while (setq elem (pop alist))
1068 (string-match (car elem) name))
1071 (if (consp value) (car value) value))))))
1072 `(defun ,function (name)
1075 (or (gnus-group-find-parameter name ',param ,(and type t))
1076 (let ((alist ,variable)
1078 (while (setq elem (pop alist))
1080 (string-match (car elem) name))
1085 '(if (consp value) (car value) value))))))))))
1087 (defcustom gnus-home-directory "~/"
1088 "Directory variable that specifies the \"home\" directory.
1089 All other Gnus file and directory variables are initialized from this variable."
1093 (defcustom gnus-directory (or (getenv "SAVEDIR")
1094 (nnheader-concat gnus-home-directory "News/"))
1095 "*Directory variable from which all other Gnus file variables are derived.
1097 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1098 This means that other directory variables that are initialized from
1099 this variable won't be set properly if you set this variable in `.gnus.el'.
1100 Set this variable in `.emacs' instead."
1104 (defcustom gnus-default-directory nil
1105 "*Default directory for all Gnus buffers."
1107 :type '(choice (const :tag "current" nil)
1110 ;; Site dependent variables. These variables should be defined in
1113 (defvar gnus-default-nntp-server nil
1114 "Specify a default NNTP server.
1115 This variable should be defined in paths.el, and should never be set
1117 If you want to change servers, you should use `gnus-select-method'.
1118 See the documentation to that variable.")
1120 ;; Don't touch this variable.
1121 (defvar gnus-nntp-service "nntp"
1122 "NNTP service name (\"nntp\" or 119).
1123 This is an obsolete variable, which is scarcely used. If you use an
1124 nntp server for your newsgroup and want to change the port number
1125 used to 899, you would say something along these lines:
1127 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1129 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1130 "A file with only the name of the nntp server in it."
1135 (defun gnus-getenv-nntpserver ()
1136 "Find default nntp server.
1137 Check the NNTPSERVER environment variable and the
1138 `gnus-nntpserver-file' file."
1139 (or (getenv "NNTPSERVER")
1140 (and (file-readable-p gnus-nntpserver-file)
1142 (insert-file-contents gnus-nntpserver-file)
1143 (let ((name (buffer-string)))
1144 (unless (string-match "\\`[ \t\n]*$" name)
1147 (defcustom gnus-select-method
1150 (list 'nntp (or (condition-case nil
1151 (gnus-getenv-nntpserver)
1153 (when (and gnus-default-nntp-server
1154 (not (string= gnus-default-nntp-server "")))
1155 gnus-default-nntp-server)
1157 (if (or (null gnus-nntp-service)
1158 (equal gnus-nntp-service "nntp"))
1160 (list gnus-nntp-service)))
1162 "Default method for selecting a newsgroup.
1163 This variable should be a list, where the first element is how the
1164 news is to be fetched, the second is the address.
1166 For instance, if you want to get your news via \"flab.flab.edu\" using
1167 NNTP, you could say:
1169 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1171 If you want to use your local spool, say:
1173 \(setq gnus-select-method (list 'nnspool (system-name)))
1175 If you use this variable, you must set `gnus-nntp-server' to nil.
1177 There is a lot more to know about select methods and virtual servers -
1178 see the manual for details."
1180 :type 'gnus-select-method)
1182 (defcustom gnus-message-archive-method "archive"
1183 "*Method used for archiving messages you've sent.
1184 This should be a mail method."
1186 :group 'gnus-message
1187 :type '(choice (const :tag "Default archive method" "archive")
1188 gnus-select-method))
1190 (defcustom gnus-message-archive-group nil
1191 "*Name of the group in which to save the messages you've written.
1192 This can either be a string; a list of strings; or an alist
1193 of regexps/functions/forms to be evaluated to return a string (or a list
1194 of strings). The functions are called with the name of the current
1195 group (or nil) as a parameter.
1197 If you want to save your mail in one group and the news articles you
1198 write in another group, you could say something like:
1200 \(setq gnus-message-archive-group
1201 '((if (message-news-p)
1205 Normally the group names returned by this variable should be
1206 unprefixed -- which implicitly means \"store on the archive server\".
1207 However, you may wish to store the message on some other server. In
1208 that case, just return a fully prefixed name of the group --
1209 \"nnml+private:mail.misc\", for instance."
1210 :group 'gnus-message
1211 :type '(choice (const :tag "none" nil)
1216 (defcustom gnus-secondary-servers nil
1217 "List of NNTP servers that the user can choose between interactively.
1218 To make Gnus query you for a server, you have to give `gnus' a
1219 non-numeric prefix - `C-u M-x gnus', in short."
1221 :type '(repeat string))
1223 (defcustom gnus-nntp-server nil
1224 "*The name of the host running the NNTP server.
1225 This variable is semi-obsolete. Use the `gnus-select-method'
1228 :type '(choice (const :tag "disable" nil)
1231 (defcustom gnus-secondary-select-methods nil
1232 "A list of secondary methods that will be used for reading news.
1233 This is a list where each element is a complete select method (see
1234 `gnus-select-method').
1236 If, for instance, you want to read your mail with the nnml back end,
1237 you could set this variable:
1239 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1241 :type '(repeat gnus-select-method))
1243 (defvar gnus-backup-default-subscribed-newsgroups
1244 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1245 "Default default new newsgroups the first time Gnus is run.
1246 Should be set in paths.el, and shouldn't be touched by the user.")
1248 (defcustom gnus-local-domain nil
1249 "Local domain name without a host name.
1250 The DOMAINNAME environment variable is used instead if it is defined.
1251 If the function `system-name' returns the full Internet name, there is
1252 no need to set this variable."
1253 :group 'gnus-message
1254 :type '(choice (const :tag "default" nil)
1257 (defvar gnus-local-organization nil
1258 "String with a description of what organization (if any) the user belongs to.
1259 Obsolete variable; use `message-user-organization' instead.")
1261 ;; Customization variables
1263 (defcustom gnus-refer-article-method nil
1264 "Preferred method for fetching an article by Message-ID.
1265 If you are reading news from the local spool (with nnspool), fetching
1266 articles by Message-ID is painfully slow. By setting this method to an
1267 nntp method, you might get acceptable results.
1269 The value of this variable must be a valid select method as discussed
1270 in the documentation of `gnus-select-method'.
1272 It can also be a list of select methods, as well as the special symbol
1273 `current', which means to use the current select method. If it is a
1274 list, Gnus will try all the methods in the list until it finds a match."
1276 :type '(choice (const :tag "default" nil)
1278 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1280 (repeat :menu-tag "Try multiple"
1282 :value (current (nnweb "refer" (nnweb-type google)))
1283 (choice :tag "Method"
1285 (const :tag "Google"
1286 (nnweb "refer" (nnweb-type google)))
1287 gnus-select-method))))
1289 (defcustom gnus-group-faq-directory
1290 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1291 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1292 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1293 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1294 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1295 "/ftp@rtfm.mit.edu:/pub/usenet/"
1296 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1297 "/ftp@ftp.sunet.se:/pub/usenet/"
1298 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1299 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1300 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1301 "*Directory where the group FAQs are stored.
1302 This will most commonly be on a remote machine, and the file will be
1303 fetched by ange-ftp.
1305 This variable can also be a list of directories. In that case, the
1306 first element in the list will be used by default. The others can
1307 be used when being prompted for a site.
1309 Note that Gnus uses an aol machine as the default directory. If this
1310 feels fundamentally unclean, just think of it as a way to finally get
1311 something of value back from them.
1313 If the default site is too slow, try one of these:
1315 North America: mirrors.aol.com /pub/rtfm/usenet
1316 ftp.seas.gwu.edu /pub/rtfm
1317 rtfm.mit.edu /pub/usenet
1318 Europe: ftp.uni-paderborn.de /pub/FAQ
1319 src.doc.ic.ac.uk /usenet/news-FAQS
1320 ftp.sunet.se /pub/usenet
1321 ftp.pasteur.fr /pub/FAQ
1322 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1323 hwarang.postech.ac.kr /pub/usenet
1324 ftp.hk.super.net /mirror/faqs"
1325 :group 'gnus-group-various
1326 :type '(choice directory
1327 (repeat directory)))
1329 (defcustom gnus-group-charter-alist
1330 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1331 ("de" . (concat "http://purl.net/charta/" name ".html"))
1332 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1333 ("england" . (concat "http://england.news-admin.org/charters/" name))
1334 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1335 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1336 (gnus-replace-in-string name "europa\\." "") ".html"))
1337 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1338 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1339 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1340 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1341 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1342 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1343 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1344 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1345 (gnus-replace-in-string name "\\." "_") ".html"))
1346 ("milw" . (concat "http://usenet.mil.wi.us/"
1347 (gnus-replace-in-string name "milw\\." "") "-charter"))
1348 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1349 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1350 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1351 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1352 When FORM is evaluated `name' is bound to the name of the group."
1353 :group 'gnus-group-various
1354 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1356 (defcustom gnus-group-fetch-control-use-browse-url nil
1357 "*Non-nil means that control messages are displayed using `browse-url'.
1358 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 :parameter-type '(gnus-email-address :tag "To Address")
1636 :parameter-document "\
1637 This will be used when doing followups and posts.
1639 This is primarily useful in mail groups that represent closed
1640 mailing lists--mailing lists where it's expected that everybody that
1641 writes to the mailing list is subscribed to it. Since using this
1642 parameter ensures that the mail only goes to the mailing list itself,
1643 it means that members won't receive two copies of your followups.
1645 Using `to-address' will actually work whether the group is foreign or
1646 not. Let's say there's a group on the server that is called
1647 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1648 articles from a mail-to-news gateway. Posting directly to this group
1649 is therefore impossible--you have to send mail to the mailing list
1652 The gnus-group-split mail splitting mechanism will behave as if this
1653 address was listed in gnus-group-split Addresses (see below).")
1655 (gnus-define-group-parameter
1658 "Return GROUP's to-list."
1660 "*Alist of group regexps and correspondent to-lists."
1661 :parameter-type '(gnus-email-address :tag "To List")
1662 :parameter-document "\
1663 This address will be used when doing a `a' in the group.
1665 It is totally ignored when doing a followup--except that if it is
1666 present in a news group, you'll get mail group semantics when doing
1669 The gnus-group-split mail splitting mechanism will behave as if this
1670 address was listed in gnus-group-split Addresses (see below).")
1672 (gnus-define-group-parameter
1676 "Return GROUP's subscription status."
1678 "*Groups which are automatically considered subscribed."
1679 :parameter-type '(const :tag "Subscribed" t)
1680 :parameter-document "\
1681 Gnus assumed that you are subscribed to the To/List address.
1683 When constructing a list of subscribed groups using
1684 `gnus-find-subscribed-addresses', Gnus includes the To address given
1685 above, or the list address (if the To address has not been set).")
1687 (gnus-define-group-parameter
1690 :function gnus-group-auto-expirable-p
1692 "Check whether GROUP is auto-expirable or not."
1693 :variable gnus-auto-expirable-newsgroups
1694 :variable-default nil
1696 "*Groups in which to automatically mark read articles as expirable.
1697 If non-nil, this should be a regexp that should match all groups in
1698 which to perform auto-expiry. This only makes sense for mail groups."
1699 :variable-group nnmail-expire
1700 :variable-type '(choice (const nil)
1702 :parameter-type '(const :tag "Automatic Expire" t)
1704 "All articles that are read will be marked as expirable.")
1706 (gnus-define-group-parameter
1709 :function gnus-group-total-expirable-p
1711 "Check whether GROUP is total-expirable or not."
1712 :variable gnus-total-expirable-newsgroups
1713 :variable-default nil
1715 "*Groups in which to perform expiry of all read articles.
1716 Use with extreme caution. All groups that match this regexp will be
1717 expiring - which means that all read articles will be deleted after
1718 \(say) one week. (This only goes for mail groups and the like, of
1720 :variable-group nnmail-expire
1721 :variable-type '(choice (const nil)
1723 :parameter-type '(const :tag "Total Expire" t)
1725 "All read articles will be put through the expiry process
1727 This happens even if they are not marked as expirable.
1730 (gnus-define-group-parameter
1733 "Return the default charset of GROUP."
1734 :variable gnus-group-charset-alist
1736 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1737 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1738 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1739 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1740 ("\\(^\\|:\\)relcom\\>" koi8-r)
1741 ("\\(^\\|:\\)fido7\\>" koi8-r)
1742 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1743 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1744 ("\\(^\\|:\\)han\\>" euc-kr)
1745 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1746 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1747 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1749 "Alist of regexps (to match group names) and default charsets to be used when reading."
1750 :variable-group gnus-charset
1751 :variable-type '(repeat (list (regexp :tag "Group")
1752 (symbol :tag "Charset")))
1753 :parameter-type '(symbol :tag "Charset")
1754 :parameter-document "\
1755 The default charset to use in the group.")
1757 (gnus-define-group-parameter
1761 "Return a posting method for GROUP."
1762 :variable gnus-post-method-alist
1764 "Alist of regexps (to match group names) and method to be used when
1765 posting an article."
1766 :variable-group gnus-group-foreign
1768 '(choice :tag "Posting Method"
1769 (const :tag "Use native server" native)
1770 (const :tag "Use current server" current)
1771 (list :convert-widget
1773 (list 'sexp :tag "Methods"
1774 :value gnus-select-method))))
1776 "Posting method for this group.")
1778 (gnus-define-group-parameter
1779 large-newsgroup-initial
1782 "Return GROUP's initial input of the number of articles."
1784 "*Alist of group regexps and its initial input of the number of articles."
1785 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1786 (const :tag "All" nil)
1788 :parameter-document "\
1790 This number will be prompted as the initial value of the number of
1791 articles to list when the group is a large newsgroup (see
1792 `gnus-large-newsgroup'). If it is nil, the default value is the
1793 total number of articles in the group.")
1795 ;; The Gnus registry's ignored groups
1796 (gnus-define-group-parameter
1800 "Whether this group should be ignored by the registry."
1801 :variable gnus-registry-ignored-groups
1802 :variable-default nil
1804 "*Groups in which the registry should be turned off."
1805 :variable-group gnus-registry
1806 :variable-type '(repeat
1808 (regexp :tag "Group Name Regular Expression")
1809 (boolean :tag "Ignored")))
1811 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1813 "Whether the Gnus Registry should ignore this group.")
1815 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1816 (defcustom gnus-install-group-spam-parameters t
1817 "*Disable the group parameters for spam detection.
1818 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1822 (when gnus-install-group-spam-parameters
1823 (defvar gnus-group-spam-classification-spam t
1824 "Spam group classification (requires spam.el).
1825 This group contains spam messages. On summary entry, unread messages
1826 will be marked as spam. On summary exit, the specified spam
1827 processors will be invoked on spam-marked messages, then those
1828 messages will be expired, so the spam processor will only see a
1829 spam-marked message once.")
1831 (defvar gnus-group-spam-classification-ham 'ask
1832 "The ham value for the spam group parameter (requires spam.el).
1833 On summary exit, the specified ham processors will be invoked on
1834 ham-marked messages. Exercise caution, since the ham processor will
1835 see the same message more than once because there is no ham message
1838 (gnus-define-group-parameter
1842 "The spam type (spam, ham, or neither) of the group."
1843 :variable gnus-spam-newsgroup-contents
1844 :variable-default nil
1846 "*Groups in which to automatically mark new articles as spam on
1847 summary entry. If non-nil, this should be a list of group name
1848 regexps that should match all groups in which to do automatic spam
1849 tagging, associated with a classification (spam, ham, or neither).
1850 This only makes sense for mail groups."
1851 :variable-group spam
1852 :variable-type '(repeat
1853 (list :tag "Group contents spam/ham classification"
1854 (regexp :tag "Group")
1856 (variable-item gnus-group-spam-classification-spam)
1857 (variable-item gnus-group-spam-classification-ham)
1858 (const :tag "Unclassified" nil))))
1860 :parameter-type '(list :tag "Group contents spam/ham classification"
1861 (choice :tag "Group contents classification for spam sorting"
1862 (variable-item gnus-group-spam-classification-spam)
1863 (variable-item gnus-group-spam-classification-ham)
1864 (const :tag "Unclassified" nil)))
1866 "The spam classification (spam, ham, or neither) of this group.
1867 When a spam group is entered, all unread articles are marked as spam.")
1869 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1870 "OBSOLETE: The ifile summary exit spam processor.")
1872 (defvar gnus-group-spam-exit-processor-stat "stat"
1873 "OBSOLETE: The spam-stat summary exit spam processor.")
1875 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1876 "OBSOLETE: The Bogofilter summary exit spam processor.")
1878 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1879 "OBSOLETE: The Blacklist summary exit spam processor.")
1881 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1882 "OBSOLETE: The Gmane reporting summary exit spam processor.
1883 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1885 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1886 "OBSOLETE: The spamoracle summary exit spam processor.")
1888 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1889 "OBSOLETE: The ifile summary exit ham processor.
1890 Only applicable to non-spam (unclassified and ham) groups.")
1892 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1893 "OBSOLETE: The Bogofilter summary exit ham processor.
1894 Only applicable to non-spam (unclassified and ham) groups.")
1896 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1897 "OBSOLETE: The spam-stat summary exit ham processor.
1898 Only applicable to non-spam (unclassified and ham) groups.")
1900 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1901 "OBSOLETE: The whitelist summary exit ham processor.
1902 Only applicable to non-spam (unclassified and ham) groups.")
1904 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1905 "OBSOLETE: The BBDB summary exit ham processor.
1906 Only applicable to non-spam (unclassified and ham) groups.")
1908 (defvar gnus-group-ham-exit-processor-copy "copy"
1909 "OBSOLETE: The ham copy exit ham processor.
1910 Only applicable to non-spam (unclassified and ham) groups.")
1912 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1913 "OBSOLETE: The spamoracle summary exit ham processor.
1914 Only applicable to non-spam (unclassified and ham) groups.")
1916 (gnus-define-group-parameter
1921 :tag "Spam Summary Exit Processor"
1923 (list :tag "Spam Summary Exit Processor Choices"
1925 (variable-item gnus-group-spam-exit-processor-ifile)
1926 (variable-item gnus-group-spam-exit-processor-stat)
1927 (variable-item gnus-group-spam-exit-processor-bogofilter)
1928 (variable-item gnus-group-spam-exit-processor-blacklist)
1929 (variable-item gnus-group-spam-exit-processor-spamoracle)
1930 (variable-item gnus-group-spam-exit-processor-report-gmane)
1931 (variable-item gnus-group-ham-exit-processor-bogofilter)
1932 (variable-item gnus-group-ham-exit-processor-ifile)
1933 (variable-item gnus-group-ham-exit-processor-stat)
1934 (variable-item gnus-group-ham-exit-processor-whitelist)
1935 (variable-item gnus-group-ham-exit-processor-BBDB)
1936 (variable-item gnus-group-ham-exit-processor-spamoracle)
1937 (variable-item gnus-group-ham-exit-processor-copy)
1938 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1939 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1940 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1941 (const :tag "Spam: ifile" (spam spam-use-ifile))
1942 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1943 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1944 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1945 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1946 (const :tag "Ham: ifile" (ham spam-use-ifile))
1947 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1948 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1949 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1950 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1951 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1952 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1954 "Which spam or ham processors will be applied when the summary is exited."
1955 :variable gnus-spam-process-newsgroups
1956 :variable-default nil
1958 "*Groups in which to automatically process spam or ham articles with
1959 a backend on summary exit. If non-nil, this should be a list of group
1960 name regexps that should match all groups in which to do automatic
1961 spam processing, associated with the appropriate processor."
1962 :variable-group spam
1964 '(repeat :tag "Spam/Ham Processors"
1965 (list :tag "Spam Summary Exit Processor Choices"
1966 (regexp :tag "Group Regexp")
1968 :tag "Spam/Ham Summary Exit Processor"
1969 (variable-item gnus-group-spam-exit-processor-ifile)
1970 (variable-item gnus-group-spam-exit-processor-stat)
1971 (variable-item gnus-group-spam-exit-processor-bogofilter)
1972 (variable-item gnus-group-spam-exit-processor-blacklist)
1973 (variable-item gnus-group-spam-exit-processor-spamoracle)
1974 (variable-item gnus-group-spam-exit-processor-report-gmane)
1975 (variable-item gnus-group-ham-exit-processor-bogofilter)
1976 (variable-item gnus-group-ham-exit-processor-ifile)
1977 (variable-item gnus-group-ham-exit-processor-stat)
1978 (variable-item gnus-group-ham-exit-processor-whitelist)
1979 (variable-item gnus-group-ham-exit-processor-BBDB)
1980 (variable-item gnus-group-ham-exit-processor-spamoracle)
1981 (variable-item gnus-group-ham-exit-processor-copy)
1982 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1983 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1984 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1985 (const :tag "Spam: ifile" (spam spam-use-ifile))
1986 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1987 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1988 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1989 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1990 (const :tag "Ham: ifile" (ham spam-use-ifile))
1991 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1992 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1993 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1994 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1995 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1996 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1999 "Which spam or ham processors will be applied when the summary is exited.")
2001 (gnus-define-group-parameter
2005 '(boolean :tag "Spam autodetection")
2007 "Should spam be autodetected (with spam-split) in this group?"
2008 :variable gnus-spam-autodetect
2009 :variable-default nil
2011 "*Groups in which spam should be autodetected when they are entered.
2012 Only unseen articles will be examined, unless
2013 spam-autodetect-recheck-messages is set."
2014 :variable-group spam
2017 :tag "Autodetection setting"
2019 (regexp :tag "Group Regexp")
2022 "Spam autodetection.
2023 Only unseen articles will be examined, unless
2024 spam-autodetect-recheck-messages is set.")
2026 (gnus-define-group-parameter
2027 spam-autodetect-methods
2030 '(choice :tag "Spam autodetection-specific methods"
2033 (set :tag "Use specific methods"
2034 (variable-item spam-use-blacklist)
2035 (variable-item spam-use-regex-headers)
2036 (variable-item spam-use-regex-body)
2037 (variable-item spam-use-whitelist)
2038 (variable-item spam-use-BBDB)
2039 (variable-item spam-use-ifile)
2040 (variable-item spam-use-spamoracle)
2041 (variable-item spam-use-spamassassin)
2042 (variable-item spam-use-spamassassin-headers)
2043 (variable-item spam-use-stat)
2044 (variable-item spam-use-blackholes)
2045 (variable-item spam-use-hashcash)
2046 (variable-item spam-use-bogofilter-headers)
2047 (variable-item spam-use-bogofilter)))
2049 "Methods to be used for autodetection in each group"
2050 :variable gnus-spam-autodetect-methods
2051 :variable-default nil
2053 "*Methods for autodetecting spam per group.
2054 Requires the spam-autodetect parameter. Only unseen articles
2055 will be examined, unless spam-autodetect-recheck-messages is
2057 :variable-group spam
2060 :tag "Autodetection methods"
2062 (regexp :tag "Group Regexp")
2066 (set :tag "Use specific methods"
2067 (variable-item spam-use-blacklist)
2068 (variable-item spam-use-regex-headers)
2069 (variable-item spam-use-regex-body)
2070 (variable-item spam-use-whitelist)
2071 (variable-item spam-use-BBDB)
2072 (variable-item spam-use-ifile)
2073 (variable-item spam-use-spamoracle)
2074 (variable-item spam-use-stat)
2075 (variable-item spam-use-blackholes)
2076 (variable-item spam-use-hashcash)
2077 (variable-item spam-use-spamassassin)
2078 (variable-item spam-use-spamassassin-headers)
2079 (variable-item spam-use-bogofilter-headers)
2080 (variable-item spam-use-bogofilter)))))
2082 "Spam autodetection methods.
2083 Requires the spam-autodetect parameter. Only unseen articles
2084 will be examined, unless spam-autodetect-recheck-messages is
2087 (gnus-define-group-parameter
2088 spam-process-destination
2091 '(choice :tag "Destination for spam-processed articles at summary exit"
2092 (string :tag "Move to a group")
2093 (repeat :tag "Move to multiple groups"
2094 (string :tag "Destination group"))
2095 (const :tag "Expire" nil))
2097 "Where spam-processed articles will go at summary exit."
2098 :variable gnus-spam-process-destinations
2099 :variable-default nil
2101 "*Groups in which to explicitly send spam-processed articles to
2102 another group, or expire them (the default). If non-nil, this should
2103 be a list of group name regexps that should match all groups in which
2104 to do spam-processed article moving, associated with the destination
2105 group or nil for explicit expiration. This only makes sense for
2107 :variable-group spam
2110 :tag "Spam-processed articles destination"
2112 (regexp :tag "Group Regexp")
2114 :tag "Destination for spam-processed articles at summary exit"
2115 (string :tag "Move to a group")
2116 (repeat :tag "Move to multiple groups"
2117 (string :tag "Destination group"))
2118 (const :tag "Expire" nil))))
2120 "Where spam-processed articles will go at summary exit.")
2122 (gnus-define-group-parameter
2123 ham-process-destination
2127 :tag "Destination for ham articles at summary exit from a spam group"
2128 (string :tag "Move to a group")
2129 (repeat :tag "Move to multiple groups"
2130 (string :tag "Destination group"))
2131 (const :tag "Respool" respool)
2132 (const :tag "Do nothing" nil))
2134 "Where ham articles will go at summary exit from a spam group."
2135 :variable gnus-ham-process-destinations
2136 :variable-default nil
2138 "*Groups in which to explicitly send ham articles to
2139 another group, or do nothing (the default). If non-nil, this should
2140 be a list of group name regexps that should match all groups in which
2141 to do ham article moving, associated with the destination
2142 group or nil for explicit ignoring. This only makes sense for
2143 mail groups, and only works in spam groups."
2144 :variable-group spam
2147 :tag "Ham articles destination"
2149 (regexp :tag "Group Regexp")
2151 :tag "Destination for ham articles at summary exit from spam group"
2152 (string :tag "Move to a group")
2153 (repeat :tag "Move to multiple groups"
2154 (string :tag "Destination group"))
2155 (const :tag "Respool" respool)
2156 (const :tag "Expire" nil))))
2158 "Where ham articles will go at summary exit from a spam group.")
2160 (gnus-define-group-parameter
2163 :parameter-type '(list :tag "Ham mark choices"
2165 (variable-item gnus-del-mark)
2166 (variable-item gnus-read-mark)
2167 (variable-item gnus-ticked-mark)
2168 (variable-item gnus-killed-mark)
2169 (variable-item gnus-kill-file-mark)
2170 (variable-item gnus-low-score-mark)))
2173 "Marks considered ham (positively not spam). Such articles will be
2174 processed as ham (non-spam) on group exit. When nil, the global
2175 spam-ham-marks variable takes precedence."
2176 :variable-default '((".*" ((gnus-del-mark
2180 gnus-low-score-mark))))
2181 :variable-group spam
2183 "*Groups in which to explicitly set the ham marks to some value.")
2185 (gnus-define-group-parameter
2188 :parameter-type '(list :tag "Spam mark choices"
2190 (variable-item gnus-spam-mark)
2191 (variable-item gnus-killed-mark)
2192 (variable-item gnus-kill-file-mark)
2193 (variable-item gnus-low-score-mark)))
2196 "Marks considered spam.
2197 Such articles will be processed as spam on group exit. When nil, the global
2198 spam-spam-marks variable takes precedence."
2199 :variable-default '((".*" ((gnus-spam-mark))))
2200 :variable-group spam
2202 "*Groups in which to explicitly set the spam marks to some value."))
2204 (defcustom gnus-group-uncollapsed-levels 1
2205 "Number of group name elements to leave alone when making a short group name."
2206 :group 'gnus-group-visual
2209 (defcustom gnus-group-use-permanent-levels nil
2210 "*If non-nil, once you set a level, Gnus will use this level."
2211 :group 'gnus-group-levels
2216 (defcustom gnus-load-hook nil
2217 "A hook run while Gnus is loaded."
2221 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2222 "A hook called to apply kill files to a group.
2223 This hook is intended to apply a kill file to the selected newsgroup.
2224 The function `gnus-apply-kill-file' is called by default.
2226 Since a general kill file is too heavy to use only for a few
2227 newsgroups, I recommend you to use a lighter hook function. For
2228 example, if you'd like to apply a kill file to articles which contains
2229 a string `rmgroup' in subject in newsgroup `control', you can use the
2232 (setq gnus-apply-kill-hook
2235 (cond ((string-match \"control\" gnus-newsgroup-name)
2236 (gnus-kill \"Subject\" \"rmgroup\")
2237 (gnus-expunge \"X\"))))))"
2238 :group 'gnus-score-kill
2239 :options '(gnus-apply-kill-file)
2242 (defcustom gnus-group-change-level-function nil
2243 "Function run when a group level is changed.
2244 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2245 :group 'gnus-group-levels
2250 (defcustom gnus-visual
2251 '(summary-highlight group-highlight article-highlight
2253 summary-menu group-menu article-menu
2254 tree-highlight menu highlight
2255 browse-menu server-menu
2256 page-marker tree-menu binary-menu pick-menu)
2257 "*Enable visual features.
2258 If `visual' is disabled, there will be no menus and few faces. Most of
2259 the visual customization options below will be ignored. Gnus will use
2260 less space and be faster as a result.
2262 This variable can also be a list of visual elements to switch on. For
2263 instance, to switch off all visual things except menus, you can say:
2265 (setq gnus-visual '(menu))
2267 Valid elements include `summary-highlight', `group-highlight',
2268 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2269 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2270 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2273 :type '(set (const summary-highlight)
2274 (const group-highlight)
2275 (const article-highlight)
2277 (const summary-menu)
2279 (const article-menu)
2280 (const tree-highlight)
2290 ;; Byte-compiler warning.
2291 (defvar gnus-visual)
2292 ;; Find out whether the gnus-visual TYPE is wanted.
2293 (defun gnus-visual-p (&optional type class)
2294 (and gnus-visual ; Has to be non-nil, at least.
2295 (if (not type) ; We don't care about type.
2297 (if (listp gnus-visual) ; It's a list, so we check it.
2298 (or (memq type gnus-visual)
2299 (memq class gnus-visual))
2302 (defcustom gnus-mouse-face
2304 (if (gnus-visual-p 'mouse-face 'highlight)
2305 (if (boundp 'gnus-mouse-face)
2306 (or gnus-mouse-face 'highlight)
2310 "*Face used for group or summary buffer mouse highlighting.
2311 The line beneath the mouse pointer will be highlighted with this
2316 (defcustom gnus-article-save-directory gnus-directory
2317 "*Name of the directory articles will be saved in (default \"~/News\")."
2318 :group 'gnus-article-saving
2321 (defvar gnus-plugged t
2322 "Whether Gnus is plugged or not.")
2324 (defcustom gnus-agent-cache t
2325 "Controls use of the agent cache while plugged.
2326 When set, Gnus will prefer using the locally stored content rather
2327 than re-fetching it from the server. You also need to enable
2328 `gnus-agent' for this to have any affect."
2333 (defcustom gnus-default-charset 'undecided
2334 "Default charset assumed to be used when viewing non-ASCII characters.
2335 This variable is overridden on a group-to-group basis by the
2336 `gnus-group-charset-alist' variable and is only used on groups not
2337 covered by that variable."
2339 :group 'gnus-charset)
2341 ;; Fixme: Doc reference to agent.
2342 (defcustom gnus-agent t
2343 "Whether we want to use the Gnus agent or not.
2345 You may customize gnus-agent to disable its use. However, some
2346 back ends have started to use the agent as a client-side cache.
2347 Disabling the agent may result in noticeable loss of performance."
2352 (defcustom gnus-other-frame-function 'gnus
2353 "Function called by the command `gnus-other-frame'."
2355 :type '(choice (function-item gnus)
2356 (function-item gnus-no-server)
2357 (function-item gnus-slave)
2358 (function-item gnus-slave-no-server)))
2360 (defcustom gnus-other-frame-parameters nil
2361 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2362 This should be an alist for Emacs, or a plist for XEmacs."
2364 :type (if (featurep 'xemacs)
2365 '(repeat (list :inline t :format "%v"
2366 (symbol :tag "Property")
2367 (sexp :tag "Value")))
2368 '(repeat (cons :format "%v"
2369 (symbol :tag "Parameter")
2370 (sexp :tag "Value")))))
2372 (defcustom gnus-user-agent 'gnus-mime-edit
2373 "Which information should be exposed in the User-Agent header.
2375 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2376 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2377 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2378 `emacs-gnus' plus system type\), `gnus-mime-edit' \(show Gnus version and
2379 MIME Edit User-Agent\) or a custom string. If you set it to a string,
2380 be sure to use a valid format, see RFC 2616."
2381 :group 'gnus-message
2383 (item :tag "Show Gnus version and MIME Edit User-Agent"
2385 (item :tag "Show Gnus and Emacs versions and system type"
2387 (item :tag "Show Gnus and Emacs versions and system configuration"
2389 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2390 (item :tag "Show only Gnus version" gnus)
2391 (string :tag "Other")))
2394 ;;; Internal variables
2396 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2397 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2398 (defvar gnus-agent-method-p-cache nil
2399 ; Reset each time gnus-agent-covered-methods is changed else
2400 ; gnus-agent-method-p may mis-report a methods status.
2402 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2403 (defvar gnus-draft-meta-information-header "X-Draft-From")
2404 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2405 (defvar gnus-original-article-buffer " *Original Article*")
2406 (defvar gnus-newsgroup-name nil)
2407 (defvar gnus-ephemeral-servers nil)
2408 (defvar gnus-server-method-cache nil)
2410 (defvar gnus-agent-fetching nil
2411 "Whether Gnus agent is in fetching mode.")
2413 (defvar gnus-agent-covered-methods nil
2414 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2416 (defvar gnus-command-method nil
2417 "Dynamically bound variable that says what the current back end is.")
2419 (defvar gnus-current-select-method nil
2420 "The current method for selecting a newsgroup.")
2422 (defvar gnus-tree-buffer "*Tree*"
2423 "Buffer where Gnus thread trees are displayed.")
2426 (defvar gnus-use-generic-from nil)
2428 ;; Variable holding the user answers to all method prompts.
2429 (defvar gnus-method-history nil)
2431 ;; Variable holding the user answers to all mail method prompts.
2432 (defvar gnus-mail-method-history nil)
2434 ;; Variable holding the user answers to all group prompts.
2435 (defvar gnus-group-history nil)
2437 (defvar gnus-server-alist nil
2438 "List of available servers.")
2440 (defcustom gnus-cache-directory
2441 (nnheader-concat gnus-directory "cache/")
2442 "*The directory where cached articles will be stored."
2446 (defvar gnus-predefined-server-alist
2449 (nnspool-spool-directory ,gnus-cache-directory)
2450 (nnspool-nov-directory ,gnus-cache-directory)
2451 (nnspool-active-file
2452 ,(nnheader-concat gnus-cache-directory "active"))))
2453 "List of predefined (convenience) servers.")
2455 (defvar gnus-topic-indentation "");; Obsolete variable.
2457 (defconst gnus-article-mark-lists
2458 '((marked . tick) (replied . reply)
2459 (expirable . expire) (killed . killed)
2460 (bookmarks . bookmark) (dormant . dormant)
2461 (scored . score) (saved . save)
2462 (cached . cache) (downloadable . download)
2463 (unsendable . unsend) (forwarded . forward)
2464 (recent . recent) (seen . seen)))
2466 (defconst gnus-article-special-mark-lists
2472 ;; Propagate flags to server, with the following exceptions:
2473 ;; `seen' is private to each gnus installation
2474 ;; `cache' is a internal gnus flag for each gnus installation
2475 ;; `download' is a agent flag private to each gnus installation
2476 ;; `unsend' are for nndraft groups only
2477 ;; `score' is not a proper mark
2478 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2479 (defconst gnus-article-unpropagated-mark-lists
2480 '(seen cache download unsend score bookmark)
2481 "Marks that shouldn't be propagated to back ends.
2482 Typical marks are those that make no sense in a standalone back end,
2483 such as a mark that says whether an article is stored in the cache
2484 \(which doesn't make sense in a standalone back end).")
2486 (defvar gnus-headers-retrieved-by nil)
2487 (defvar gnus-article-reply nil)
2488 (defvar gnus-override-method nil)
2489 (defvar gnus-article-check-size nil)
2490 (defvar gnus-opened-servers nil)
2492 (defvar gnus-current-kill-article nil)
2494 (defvar gnus-have-read-active-file nil)
2496 (defconst gnus-maintainer
2497 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2498 "The mail address of the T-gnus maintainers.")
2500 (defcustom gnus-info-filename nil
2501 "*Controls language of gnus Info.
2502 If nil and current-language-environment is Japanese, go to gnus-ja.
2503 Otherwise go to corresponding Info.
2504 This variable can be nil, gnus or gnus-ja."
2506 :type '(choice (const nil)
2507 (const :tag "English" gnus)
2508 (const :tag "Japanese" gnus-ja)))
2510 (defvar gnus-info-nodes
2511 '((gnus-group-mode "Group Buffer")
2512 (gnus-summary-mode "Summary Buffer")
2513 (gnus-article-mode "Article Buffer")
2514 (gnus-server-mode "Server Buffer")
2515 (gnus-browse-mode "Browse Foreign Server")
2516 (gnus-tree-mode "Tree Display"))
2517 "Alist of major modes and related Info nodes.")
2519 (defvar gnus-group-buffer "*Group*")
2520 (defvar gnus-summary-buffer "*Summary*")
2521 (defvar gnus-article-buffer "*Article*")
2522 (defvar gnus-server-buffer "*Server*")
2524 (defvar gnus-slave nil
2525 "Whether this Gnus is a slave or not.")
2527 (defvar gnus-batch-mode nil
2528 "Whether this Gnus is running in batch mode or not.")
2530 (defvar gnus-variable-list
2531 '(gnus-newsrc-options gnus-newsrc-options-n
2532 gnus-newsrc-last-checked-date
2533 gnus-newsrc-alist gnus-server-alist
2534 gnus-killed-list gnus-zombie-list
2535 gnus-topic-topology gnus-topic-alist)
2536 "Gnus variables saved in the quick startup file.")
2538 (defvar gnus-product-variable-file-list
2539 (let ((version (product-version (product-find 'gnus-vers))))
2541 ((product-version ,version)
2543 (correct-string-widths))
2545 gnus-format-specs-compiled)
2547 ((product-version ,version)
2549 (correct-string-widths))
2551 gnus-format-specs)))
2552 "Alist of the methods for checking whether the contents of the T-gnus
2553 quick startup files are valid. One is for the byte-compiled format
2554 specifications, the other is for the source form. Each element should
2555 be a list which looks like follows:
2558 ((VARIABLE EXPECTED_VALUE_or_NIL)
2559 (VARIABLE EXPECTED_VALUE_or_NIL)
2561 CODING-SYSTEM_FOR_READING_FILE
2562 SYMBOL_OF_FORMAT_SPECS)")
2564 (defcustom gnus-compile-user-specs t
2565 "If non-nil, the user-defined format specs will be byte-compiled
2567 It has an effect on the values of `gnus-*-line-format-spec'."
2571 (defvar gnus-newsrc-alist nil
2572 "Assoc list of read articles.
2573 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2575 (defvar gnus-registry-alist nil
2576 "Assoc list of registry data.
2577 gnus-registry.el will populate this if it's loaded.")
2579 (defvar gnus-newsrc-hashtb nil
2580 "Hashtable of `gnus-newsrc-alist'.")
2582 (defvar gnus-killed-list nil
2583 "List of killed newsgroups.")
2585 (defvar gnus-killed-hashtb nil
2586 "Hash table equivalent of `gnus-killed-list'.")
2588 (defvar gnus-zombie-list nil
2589 "List of almost dead newsgroups.")
2591 (defvar gnus-description-hashtb nil
2592 "Descriptions of newsgroups.")
2594 (defvar gnus-list-of-killed-groups nil
2595 "List of newsgroups that have recently been killed by the user.")
2597 (defvar gnus-active-hashtb nil
2598 "Hashtable of active articles.")
2600 (defvar gnus-moderated-hashtb nil
2601 "Hashtable of moderated newsgroups.")
2603 ;; Save window configuration.
2604 (defvar gnus-prev-winconf nil)
2606 (defvar gnus-reffed-article-number nil)
2608 ;;; Let the byte-compiler know that we know about this variable.
2609 (defvar rmail-default-rmail-file)
2611 (defvar gnus-dead-summary nil)
2613 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2614 "Regexp matching invalid groups.")
2616 (defvar gnus-other-frame-object nil
2617 "A frame object which will be created by `gnus-other-frame'.")
2619 ;;; End of variables.
2621 ;; Define some autoload functions Gnus might use.
2624 ;; This little mapcar goes through the list below and marks the
2625 ;; symbols in question as autoloaded functions.
2628 (let ((interactive (nth 1 (memq ':interactive package))))
2632 (when (consp function)
2633 (setq keymap (car (memq 'keymap function)))
2634 (setq function (car function)))
2635 (unless (fboundp function)
2636 (autoload function (car package) nil interactive keymap))))
2637 (if (eq (nth 1 package) ':interactive)
2640 '(("info" :interactive t Info-goto-node)
2642 ("ps-print" ps-print-preprint)
2643 ("message" :interactive t
2644 message-send-and-exit message-yank-original)
2645 ("babel" babel-as-string)
2646 ("nnmail" nnmail-split-fancy nnmail-article-group)
2647 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2648 ("rmailout" rmail-output rmail-output-to-rmail-file)
2649 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2650 rmail-show-message rmail-summary-exists
2651 rmail-select-summary rmail-update-summary)
2652 ("gnus-audio" :interactive t gnus-audio-play)
2653 ("gnus-xmas" gnus-xmas-splash)
2654 ("gnus-soup" :interactive t
2655 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2656 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2657 ("nnsoup" nnsoup-pack-replies)
2658 ("score-mode" :interactive t gnus-score-mode)
2659 ("gnus-mh" gnus-summary-save-article-folder
2660 gnus-Folder-save-name gnus-folder-save-name)
2661 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2662 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2663 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2664 gnus-demon-add-disconnection gnus-demon-add-handler
2665 gnus-demon-remove-handler)
2666 ("gnus-demon" :interactive t
2667 gnus-demon-init gnus-demon-cancel)
2668 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2669 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2670 gnus-face-from-file)
2671 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2672 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2673 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2674 gnus-nocem-unwanted-article-p)
2675 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2676 gnus-server-server-name)
2677 ("gnus-srvr" gnus-browse-foreign-server)
2678 ("gnus-cite" :interactive t
2679 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2680 gnus-article-hide-citation gnus-article-fill-cited-article
2681 gnus-article-hide-citation-in-followups)
2682 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2683 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2684 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2685 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2686 gnus-cache-possibly-remove-articles gnus-cache-request-article
2687 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2688 gnus-cache-enter-remove-article gnus-cached-article-p
2689 gnus-cache-open gnus-cache-close gnus-cache-update-article
2690 gnus-cache-articles-in-group)
2691 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2692 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2693 ("gnus-score" :interactive t
2694 gnus-summary-increase-score gnus-summary-set-score
2695 gnus-summary-raise-thread gnus-summary-raise-same-subject
2696 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2697 gnus-summary-lower-thread gnus-summary-lower-same-subject
2698 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2699 gnus-summary-current-score gnus-score-delta-default
2700 gnus-score-flush-cache gnus-score-close
2701 gnus-possibly-score-headers gnus-score-followup-article
2702 gnus-score-followup-thread)
2704 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2705 gnus-current-score-file-nondirectory gnus-score-adaptive
2706 gnus-score-find-trace gnus-score-file-name)
2707 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2708 gnus-score-customize)
2709 ("gnus-topic" :interactive t gnus-topic-mode)
2710 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2711 gnus-subscribe-topics)
2712 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2713 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2714 ("gnus-uu" :interactive t
2715 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2716 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2717 gnus-uu-mark-by-regexp gnus-uu-mark-all
2718 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2719 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2720 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2721 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2722 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2723 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2724 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2725 gnus-uu-mark-over gnus-uu-post-news)
2726 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2727 gnus-uu-unmark-thread)
2728 ("gnus-msg" (gnus-summary-send-map keymap)
2729 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2730 ("gnus-msg" :interactive t
2731 gnus-group-post-news gnus-group-mail gnus-group-news
2732 gnus-summary-post-news gnus-summary-news-other-window
2733 gnus-summary-followup gnus-summary-followup-with-original
2734 gnus-summary-cancel-article gnus-summary-supersede-article
2735 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2736 gnus-summary-mail-forward gnus-summary-mail-other-window
2737 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2738 gnus-summary-wide-reply gnus-summary-followup-to-mail
2739 gnus-summary-followup-to-mail-with-original gnus-bug
2740 gnus-summary-wide-reply-with-original gnus-summary-post-forward
2741 gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2742 ("gnus-picon" :interactive t gnus-treat-from-picon)
2743 ("smiley" :interactive t smiley-region)
2744 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2745 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2746 gnus-list-of-unread-articles gnus-list-of-read-articles
2747 gnus-offer-save-summaries gnus-make-thread-indent-array
2748 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2749 gnus-summary-skip-intangible gnus-summary-article-number
2750 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2751 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2752 gnus-group-list-groups gnus-group-first-unread-group
2753 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2754 gnus-group-setup-buffer gnus-group-get-new-news
2755 gnus-group-make-help-group gnus-group-update-group
2756 gnus-group-iterate gnus-group-group-name)
2757 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2758 gnus-backlog-remove-article)
2759 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2760 gnus-article-prepare gnus-article-set-window-start
2761 gnus-article-next-page gnus-article-prev-page
2762 gnus-request-article-this-buffer gnus-article-mode
2763 gnus-article-setup-buffer gnus-narrow-to-page
2764 gnus-article-delete-invisible-text gnus-treat-article)
2765 ("gnus-art" :interactive t
2766 gnus-article-hide-headers gnus-article-hide-boring-headers
2767 gnus-article-treat-overstrike
2768 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2769 gnus-article-display-x-face
2770 gnus-article-decode-HZ
2771 gnus-article-wash-html
2772 gnus-article-unsplit-urls
2773 gnus-article-hide-pem gnus-article-hide-signature
2774 gnus-article-strip-leading-blank-lines gnus-article-date-local
2775 gnus-article-date-original gnus-article-date-lapsed
2776 gnus-article-show-all-headers
2777 ;; gnus-article-show-all
2778 gnus-article-edit-mode gnus-article-edit-article
2779 gnus-article-edit-done article-decode-encoded-words
2780 gnus-start-date-timer gnus-stop-date-timer)
2781 ("gnus-int" gnus-request-type)
2782 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2783 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2784 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2785 gnus-dup-enter-articles)
2786 ("gnus-range" gnus-copy-sequence)
2787 ("gnus-eform" gnus-edit-form)
2788 ("gnus-move" :interactive t
2789 gnus-group-move-group-to-server gnus-change-server)
2790 ("gnus-logic" gnus-score-advanced)
2791 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2792 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2793 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2794 gnus-async-halt-prefetch)
2797 ("gnus-offline" :interactive t
2798 gnus-offline-toggle-plugged
2799 gnus-offline-set-unplugged-state
2800 gnus-offline-toggle-auto-hangup
2801 gnus-offline-toggle-on/off-send-mail
2802 gnus-offline-toggle-articles-to-fetch
2803 gnus-offline-set-interval-time
2804 gnus-offline-agent-expire)
2805 ("miee" :interactive t gnspool-get-news
2806 mail-spool-send news-spool-post)
2807 ("international/mw32misc" define-process-argument-editing
2808 general-process-argument-editing-function)
2809 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2810 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2811 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2812 gnus-summary-set-agent-mark gnus-agent-save-group-info
2813 gnus-agent-request-article gnus-agent-retrieve-headers)
2814 ("gnus-agent" :interactive t
2815 gnus-unplugged gnus-agentize gnus-agent-batch)
2816 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2817 gnus-summary-save-article-vm)
2818 ("compface" uncompface)
2819 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2820 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2821 ("gnus-mlspl" :interactive t gnus-group-split-setup
2822 gnus-group-split-update)
2823 ("gnus-delay" gnus-delay-initialize))))
2826 (unless (featurep 'xemacs)
2827 (autoload 'x-face-decode-message-header "x-face-e21")
2828 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2830 (unless (and (fboundp 'base64-encode-string)
2831 (subrp (symbol-function 'base64-encode-string)))
2834 ;; To search articles with Namazu.
2835 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2836 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2837 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2838 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2840 ;; To make nnir groups.
2841 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2843 ;; To make shimbun groups.
2844 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2846 ;;; gnus-sum.el thingies
2848 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2849 "*The format specification of the lines in the summary buffer.
2851 It works along the same lines as a normal formatting string,
2852 with some simple extensions.
2854 %N Article number, left padded with spaces (string)
2856 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2857 %n Name of the poster (string)
2858 %a Extracted name of the poster (string)
2859 %A Extracted address of the poster (string)
2860 %F Contents of the From: header (string)
2861 %f Contents of the From: or To: headers (string)
2862 %x Contents of the Xref: header (string)
2863 %D Date of the article (string)
2864 %d Date of the article (string) in DD-MMM format
2865 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2866 %M Message-id of the article (string)
2867 %r References of the article (string)
2868 %c Number of characters in the article (integer)
2869 %k Pretty-printed version of the above (string)
2870 For example, \"1.2k\" or \"0.4M\".
2871 %L Number of lines in the article (integer)
2872 %I Indentation based on thread level (a string of spaces)
2873 %B A complex trn-style thread tree (string)
2874 The variables `gnus-sum-thread-*' can be used for customization.
2875 %T A string with two possible values: 80 spaces if the article
2876 is on thread level two or larger and 0 spaces on level one
2877 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2878 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2879 %[ Opening bracket (character, \"[\" or \"<\")
2880 %] Closing bracket (character, \"]\" or \">\")
2881 %> Spaces of length thread-level (string)
2882 %< Spaces of length (- 20 thread-level) (string)
2883 %i Article score (number)
2884 %z Article zcore (character)
2885 %t Number of articles under the current thread (number).
2886 %e Whether the thread is empty or not (character).
2887 %l GroupLens score (string).
2888 %V Total thread score (number).
2889 %P The line number (number).
2890 %O Download mark (character).
2891 %* If present, indicates desired cursor position
2892 (instead of after first colon).
2893 %u User defined specifier. The next character in the format string should
2894 be a letter. Gnus will call the function gnus-user-format-function-X,
2895 where X is the letter following %u. The function will be passed the
2896 current header as argument. The function should return a string, which
2897 will be inserted into the summary just like information from any other
2900 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2901 with care. For reasons of efficiency, Gnus will compute what column
2902 these characters will end up in, and \"hard-code\" that. This means that
2903 it is invalid to have these specs after a variable-length spec. Well,
2904 you might not be arrested, but your summary buffer will look strange,
2905 which is bad enough.
2907 The smart choice is to have these specs as far to the left as
2910 This restriction may disappear in later versions of Gnus.
2912 General format specifiers can also be used.
2913 See Info node `(gnus)Formatting Variables'."
2914 :link '(custom-manual "(gnus)Formatting Variables")
2916 :group 'gnus-summary-format)
2919 ;;; Skeleton keymaps
2922 (defun gnus-suppress-keymap (keymap)
2923 (suppress-keymap keymap)
2924 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2926 (define-key keymap (pop keys) 'undefined))))
2928 (defvar gnus-article-mode-map
2929 (let ((keymap (make-sparse-keymap)))
2930 (gnus-suppress-keymap keymap)
2932 (defvar gnus-summary-mode-map
2933 (let ((keymap (make-keymap)))
2934 (gnus-suppress-keymap keymap)
2936 (defvar gnus-group-mode-map
2937 (let ((keymap (make-keymap)))
2938 (gnus-suppress-keymap keymap)
2943 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2944 ;; If you want the cursor to go somewhere else, set these two
2945 ;; functions in some startup hook to whatever you want.
2946 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2947 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2949 ;;; Various macros and substs.
2951 (defun gnus-header-from (header)
2952 (mail-header-from header))
2954 (defmacro gnus-gethash (string hashtable)
2955 "Get hash value of STRING in HASHTABLE."
2956 `(symbol-value (intern-soft ,string ,hashtable)))
2958 (defmacro gnus-gethash-safe (string hashtable)
2959 "Get hash value of STRING in HASHTABLE.
2960 Return nil if not defined."
2961 `(let ((sym (intern-soft ,string ,hashtable)))
2962 (and (boundp sym) (symbol-value sym))))
2964 (defmacro gnus-sethash (string value hashtable)
2965 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2966 `(set (intern ,string ,hashtable) ,value))
2967 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2969 (defmacro gnus-group-unread (group)
2970 "Get the currently computed number of unread articles in GROUP."
2971 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2973 (defmacro gnus-group-entry (group)
2974 "Get the newsrc entry for GROUP."
2975 `(gnus-gethash ,group gnus-newsrc-hashtb))
2977 (defmacro gnus-active (group)
2978 "Get active info on GROUP."
2979 `(gnus-gethash ,group gnus-active-hashtb))
2981 (defmacro gnus-set-active (group active)
2982 "Set GROUP's active info."
2983 `(gnus-sethash ,group ,active gnus-active-hashtb))
2985 ;; Info access macros.
2987 (defmacro gnus-info-group (info)
2989 (defmacro gnus-info-rank (info)
2991 (defmacro gnus-info-read (info)
2993 (defmacro gnus-info-marks (info)
2995 (defmacro gnus-info-method (info)
2997 (defmacro gnus-info-params (info)
3000 (defmacro gnus-info-level (info)
3001 `(let ((rank (gnus-info-rank ,info)))
3005 (defmacro gnus-info-score (info)
3006 `(let ((rank (gnus-info-rank ,info)))
3007 (or (and (consp rank) (cdr rank)) 0)))
3009 (defmacro gnus-info-set-group (info group)
3010 `(setcar ,info ,group))
3011 (defmacro gnus-info-set-rank (info rank)
3012 `(setcar (nthcdr 1 ,info) ,rank))
3013 (defmacro gnus-info-set-read (info read)
3014 `(setcar (nthcdr 2 ,info) ,read))
3015 (defmacro gnus-info-set-marks (info marks &optional extend)
3017 `(gnus-info-set-entry ,info ,marks 3)
3018 `(setcar (nthcdr 3 ,info) ,marks)))
3019 (defmacro gnus-info-set-method (info method &optional extend)
3021 `(gnus-info-set-entry ,info ,method 4)
3022 `(setcar (nthcdr 4 ,info) ,method)))
3023 (defmacro gnus-info-set-params (info params &optional extend)
3025 `(gnus-info-set-entry ,info ,params 5)
3026 `(setcar (nthcdr 5 ,info) ,params)))
3028 (defun gnus-info-set-entry (info entry number)
3029 ;; Extend the info until we have enough elements.
3030 (while (<= (length info) number)
3031 (nconc info (list nil)))
3033 (setcar (nthcdr number info) entry))
3035 (defmacro gnus-info-set-level (info level)
3036 `(let ((rank (cdr ,info)))
3037 (if (consp (car rank))
3038 (setcar (car rank) ,level)
3039 (setcar rank ,level))))
3040 (defmacro gnus-info-set-score (info score)
3041 `(let ((rank (cdr ,info)))
3042 (if (consp (car rank))
3043 (setcdr (car rank) ,score)
3044 (setcar rank (cons (car rank) ,score)))))
3046 (defmacro gnus-get-info (group)
3047 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3049 ;;; Load the compatibility functions.
3058 (defvar gnus-shutdown-alist nil)
3060 (defun gnus-add-shutdown (function &rest symbols)
3061 "Run FUNCTION whenever one of SYMBOLS is shut down."
3062 (push (cons function symbols) gnus-shutdown-alist))
3064 (defun gnus-shutdown (symbol)
3065 "Shut down everything that waits for SYMBOL."
3066 (let ((alist gnus-shutdown-alist)
3068 (while (setq entry (pop alist))
3069 (when (memq symbol (cdr entry))
3070 (funcall (car entry))))))
3074 ;;; Gnus Utility Functions
3077 (defun gnus-find-subscribed-addresses ()
3078 "Return a regexp matching the addresses of all subscribed mail groups.
3079 It consists of the `to-address' or `to-list' parameter of all groups
3080 with a `subscribed' parameter."
3081 (let (group address addresses)
3082 (dolist (entry (cdr gnus-newsrc-alist))
3083 (setq group (car entry))
3084 (when (gnus-parameter-subscribed group)
3085 (setq address (mail-strip-quoted-names
3086 (or (gnus-group-fast-parameter group 'to-address)
3087 (gnus-group-fast-parameter group 'to-list))))
3089 (add-to-list 'addresses address))))
3091 (list (mapconcat 'regexp-quote addresses "\\|")))))
3093 (defmacro gnus-string-or (&rest strings)
3094 "Return the first element of STRINGS that is a non-blank string.
3095 STRINGS will be evaluated in normal `or' order."
3096 `(gnus-string-or-1 ',strings))
3098 (defun gnus-string-or-1 (strings)
3101 (setq string (eval (pop strings)))
3102 (if (string-match "^[ \t]*$" string)
3104 (setq strings nil)))
3107 (defun gnus-info-find-node (&optional nodename)
3108 "Find Info documentation of Gnus."
3110 ;; Enlarge info window if needed.
3111 (let (gnus-info-buffer)
3114 (or gnus-info-filename
3115 (get-language-info current-language-environment 'gnus-info)
3118 (cadr (assq major-mode gnus-info-nodes))
3119 (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3120 (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3121 (setq gnus-info-buffer (current-buffer))
3122 (gnus-configure-windows 'info)))
3125 ;;; gnus-interactive
3128 (defvar gnus-current-prefix-symbol nil
3129 "Current prefix symbol.")
3131 (defvar gnus-current-prefix-symbols nil
3132 "List of current prefix symbols.")
3134 (defun gnus-interactive (string &optional params)
3135 "Return a list that can be fed to `interactive'.
3136 See `interactive' for full documentation.
3138 Adds the following specs:
3140 y -- The current symbolic prefix.
3141 Y -- A list of the current symbolic prefix(es).
3142 A -- Article number.
3143 H -- Article header.
3147 (while (< i (length string))
3148 (string-match ".\\([^\n]*\\)\n?" string i)
3149 (setq c (aref string i))
3151 (setq prompt (match-string 1 string)))
3152 (setq i (match-end 0))
3153 ;; We basically emulate just about everything that
3154 ;; `interactive' does, but add the specs listed above.
3158 (completing-read prompt obarray 'fboundp t))
3160 (read-buffer prompt (current-buffer) t))
3162 (read-buffer prompt (other-buffer (current-buffer))))
3166 (completing-read prompt obarray 'commandp t))
3170 (read-file-name prompt nil default-directory 'lambda))
3172 (read-file-name prompt nil nil 'lambda))
3174 (read-file-name prompt))
3176 (read-key-sequence prompt))
3178 (error "Not implemented spec"))
3180 (error "Not implemented spec"))
3184 (error "Not implemented spec"))
3186 (string-to-number (read-from-minibuffer prompt)))
3188 (prefix-numeric-value current-prefix-arg))
3194 (read-string prompt))
3196 (intern (read-string prompt)))
3198 (read-variable prompt))
3200 (read-minibuffer prompt))
3202 (eval-minibuffer prompt))
3203 ;; And here the new specs come.
3205 gnus-current-prefix-symbol)
3207 gnus-current-prefix-symbols)
3209 (gnus-group-group-name))
3211 (gnus-summary-skip-intangible)
3212 (or (get-text-property (point) 'gnus-number)
3213 (gnus-summary-last-subject)))
3215 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3217 (error "Non-implemented spec")))
3221 (push (if (< (point) (mark)) (point) (mark)) out)
3222 (push (if (> (point) (mark)) (point) (mark)) out))))
3223 (setq out (delq 'gnus-prefix-nil out))
3226 (defun gnus-symbolic-argument (&optional arg)
3227 "Read a symbolic argument and a command, and then execute command."
3229 (let* ((in-command (this-command-keys))
3230 (command in-command)
3231 gnus-current-prefix-symbols
3232 gnus-current-prefix-symbol
3234 (while (equal in-command command)
3235 (message "%s-" (key-description (this-command-keys)))
3236 (push (intern (char-to-string (read-char))) syms)
3237 (setq command (read-key-sequence nil t)))
3238 (setq gnus-current-prefix-symbols (nreverse syms)
3239 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3240 (call-interactively (key-binding command t))))
3242 ;;; More various functions.
3244 (defsubst gnus-check-backend-function (func group)
3245 "Check whether GROUP supports function FUNC.
3246 GROUP can either be a string (a group name) or a select method."
3248 (let ((method (if (stringp group)
3249 (car (gnus-find-method-for-group group))
3251 (unless (featurep method)
3253 (fboundp (intern (format "%s-%s" method func))))))
3255 (defun gnus-group-read-only-p (&optional group)
3256 "Check whether GROUP supports editing or not.
3257 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3258 that that variable is buffer-local to the summary buffers."
3259 (let ((group (or group gnus-newsgroup-name)))
3260 (not (gnus-check-backend-function 'request-replace-article group))))
3262 (defun gnus-virtual-group-p (group)
3263 "Say whether GROUP is virtual or not."
3264 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3265 gnus-valid-select-methods)))
3267 (defun gnus-news-group-p (group &optional article)
3268 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3269 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3270 t) ;is news of course.
3271 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3272 nil) ;must be mail then.
3273 ((vectorp article) ;Has header info.
3274 (eq (gnus-request-type group (mail-header-id article)) 'news))
3275 ((null article) ;Hasn't header info
3276 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3277 ((< article 0) ;Virtual message
3278 nil) ;we don't know, guess mail.
3279 (t ;Has positive number
3280 (eq (gnus-request-type group article) 'news)))) ;use it.
3282 ;; Returns a list of writable groups.
3283 (defun gnus-writable-groups ()
3284 (let ((alist gnus-newsrc-alist)
3286 (while (setq group (car (pop alist)))
3287 (unless (gnus-group-read-only-p group)
3288 (push group groups)))
3291 ;; Check whether to use long file names.
3292 (defun gnus-use-long-file-name (symbol)
3293 ;; The variable has to be set...
3294 (and gnus-use-long-file-name
3295 ;; If it isn't a list, then we return t.
3296 (or (not (listp gnus-use-long-file-name))
3297 ;; If it is a list, and the list contains `symbol', we
3299 (not (memq symbol gnus-use-long-file-name)))))
3301 ;; Generate a unique new group name.
3302 (defun gnus-generate-new-group-name (leaf)
3305 (while (gnus-group-entry name)
3306 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3309 (defun gnus-ephemeral-group-p (group)
3310 "Say whether GROUP is ephemeral or not."
3311 (gnus-group-get-parameter group 'quit-config t))
3313 (defun gnus-group-quit-config (group)
3314 "Return the quit-config of GROUP."
3315 (gnus-group-get-parameter group 'quit-config t))
3317 (defun gnus-kill-ephemeral-group (group)
3318 "Remove ephemeral GROUP from relevant structures."
3319 (gnus-sethash group nil gnus-newsrc-hashtb))
3321 (defun gnus-simplify-mode-line ()
3322 "Make mode lines a bit simpler."
3323 (setq mode-line-modified (cdr gnus-mode-line-modified))
3324 (when (listp mode-line-format)
3325 (make-local-variable 'mode-line-format)
3326 (setq mode-line-format (copy-sequence mode-line-format))
3327 (when (equal (nth 3 mode-line-format) " ")
3328 (setcar (nthcdr 3 mode-line-format) " "))))
3330 ;;; Servers and groups.
3332 (defsubst gnus-server-add-address (method)
3333 (let ((method-name (symbol-name (car method))))
3334 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3335 (not (assq (intern (concat method-name "-address")) method))
3336 (memq 'physical-address (assq (car method)
3337 gnus-valid-select-methods)))
3338 (append method (list (list (intern (concat method-name "-address"))
3342 (defsubst gnus-server-to-method (server)
3343 "Map virtual server names to select methods."
3344 (or (and server (listp server) server)
3345 (cdr (assoc server gnus-server-method-cache))
3348 ;; Perhaps this is the native server?
3349 (and (equal server "native") gnus-select-method)
3350 ;; It should be in the server alist.
3351 (cdr (assoc server gnus-server-alist))
3352 ;; It could be in the predefined server alist.
3353 (cdr (assoc server gnus-predefined-server-alist))
3354 ;; If not, we look through all the opened server
3355 ;; to see whether we can find it there.
3356 (let ((opened gnus-opened-servers))
3358 (not (equal server (format "%s:%s" (caaar opened)
3362 ;; It could be a named method, search all servers
3363 (let ((servers gnus-secondary-select-methods))
3365 (not (equal server (format "%s:%s" (caar servers)
3369 ;; This could be some sort of foreign server that I
3370 ;; simply haven't opened (yet). Do a brute-force scan
3371 ;; of the entire gnus-newsrc-alist for the server name
3372 ;; of every method. As a side-effect, loads the
3373 ;; gnus-server-method-cache so this only happens once,
3378 (let ((info-method (gnus-info-method info)))
3379 (unless (stringp info-method)
3380 (let ((info-server (gnus-method-to-server info-method)))
3381 (when (equal server info-server)
3382 (setq match info-method))))))
3383 (cdr gnus-newsrc-alist))
3386 (push (cons server result) gnus-server-method-cache))
3389 (defsubst gnus-method-to-server (method)
3391 (setq method (or method gnus-select-method))
3393 ;; Perhaps it is already in the cache.
3394 (mapc (lambda (name-method)
3395 (if (equal (cdr name-method) method)
3396 (throw 'server-name (car name-method))))
3397 gnus-server-method-cache)
3400 (lambda (server-alist)
3401 (mapc (lambda (name-method)
3402 (when (gnus-methods-equal-p (cdr name-method) method)
3403 (unless (member name-method gnus-server-method-cache)
3404 (push name-method gnus-server-method-cache))
3405 (throw 'server-name (car name-method))))
3407 (let ((alists (list gnus-server-alist
3408 gnus-predefined-server-alist)))
3409 (if gnus-select-method
3410 (push (list (cons "native" gnus-select-method)) alists))
3413 (let* ((name (if (member (cadr method) '(nil ""))
3414 (format "%s" (car method))
3415 (format "%s:%s" (car method) (cadr method))))
3416 (name-method (cons name method)))
3417 (unless (member name-method gnus-server-method-cache)
3418 (push name-method gnus-server-method-cache))
3421 (defsubst gnus-server-get-method (group method)
3422 ;; Input either a server name, and extended server name, or a
3423 ;; select method, and return a select method.
3424 (cond ((stringp method)
3425 (gnus-server-to-method method))
3426 ((equal method gnus-select-method)
3428 ((and (stringp (car method))
3430 (gnus-server-extend-method group method))
3433 (equal (cadr method) ""))
3436 (gnus-server-add-address method))))
3438 (defmacro gnus-method-equal (ss1 ss2)
3439 "Say whether two servers are equal."
3443 (and (= (length s1) (length s2))
3445 (while (and s1 (member (car s1) s2))
3449 (defun gnus-methods-equal-p (m1 m2)
3450 (let ((m1 (or m1 gnus-select-method))
3451 (m2 (or m2 gnus-select-method)))
3453 (and (eq (car m1) (car m2))
3454 (or (not (memq 'address (assoc (symbol-name (car m1))
3455 gnus-valid-select-methods)))
3456 (equal (nth 1 m1) (nth 1 m2)))))))
3458 (defun gnus-server-equal (m1 m2)
3459 "Say whether two methods are equal."
3460 (let ((m1 (cond ((null m1) gnus-select-method)
3461 ((stringp m1) (gnus-server-to-method m1))
3463 (m2 (cond ((null m2) gnus-select-method)
3464 ((stringp m2) (gnus-server-to-method m2))
3466 (gnus-method-equal m1 m2)))
3468 (defun gnus-servers-using-backend (backend)
3469 "Return a list of known servers using BACKEND."
3470 (let ((opened gnus-opened-servers)
3473 (when (eq backend (caaar opened))
3474 (push (caar opened) out))
3478 (defun gnus-archive-server-wanted-p ()
3479 "Say whether the user wants to use the archive server."
3481 ((or (not gnus-message-archive-method)
3482 (not gnus-message-archive-group))
3484 ((and gnus-message-archive-method gnus-message-archive-group)
3487 (let ((active (cadr (assq 'nnfolder-active-file
3488 gnus-message-archive-method))))
3490 (file-exists-p active))))))
3492 (defsubst gnus-method-to-server-name (method)
3494 (format "%s" (car method))
3496 (or (assoc (format "%s" (car method))
3497 (gnus-methods-using 'address))
3498 (gnus-server-equal method gnus-message-archive-method))
3500 (not (string= (nth 1 method) "")))
3501 (concat "+" (nth 1 method)))))
3503 (defsubst gnus-method-to-full-server-name (method)
3504 (format "%s+%s" (car method) (nth 1 method)))
3506 (defun gnus-group-prefixed-name (group method &optional full)
3507 "Return the whole name from GROUP and METHOD.
3508 Call with full set to get the fully qualified group name (even if the
3510 (when (stringp method)
3511 (setq method (gnus-server-to-method method)))
3512 (if (or (not method)
3513 (and (not full) (gnus-server-equal method "native"))
3514 ;;;!!! This might not be right. We'll see...
3515 ;(string-match ":" group)
3518 (concat (gnus-method-to-server-name method) ":" group)))
3520 (defun gnus-group-guess-prefixed-name (group)
3521 "Guess the whole name from GROUP and METHOD."
3522 (gnus-group-prefixed-name group (gnus-find-method-for-group
3525 (defun gnus-group-full-name (group method)
3526 "Return the full name from GROUP and METHOD, even if the method is native."
3527 (gnus-group-prefixed-name group method t))
3529 (defun gnus-group-guess-full-name (group)
3530 "Guess the full name from GROUP, even if the method is native."
3531 (if (gnus-group-prefixed-p group)
3533 (gnus-group-full-name group (gnus-find-method-for-group group))))
3535 (defun gnus-group-guess-full-name-from-command-method (group)
3536 "Guess the full name from GROUP, even if the method is native."
3537 (if (gnus-group-prefixed-p group)
3539 (gnus-group-full-name group gnus-command-method)))
3541 (defun gnus-group-real-prefix (group)
3542 "Return the prefix of the current group name."
3544 (if (string-match "^[^:]+:" group)
3545 (substring group 0 (match-end 0))
3549 (defun gnus-group-short-name (group)
3550 "Return the short group name."
3551 (let ((prefix (gnus-group-real-prefix group)))
3552 (if (< 0 (length prefix))
3553 (substring group (length prefix) nil)
3556 (defun gnus-group-prefixed-p (group)
3557 "Return the prefix of the current group name."
3558 (< 0 (length (gnus-group-real-prefix group))))
3560 (defun gnus-summary-buffer-name (group)
3561 "Return the summary buffer name of GROUP."
3562 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3564 (defun gnus-group-method (group)
3565 "Return the server or method used for selecting GROUP.
3566 You should probably use `gnus-find-method-for-group' instead."
3567 (let ((prefix (gnus-group-real-prefix group)))
3568 (if (equal prefix "")
3570 (let ((servers gnus-opened-servers)
3572 backend possible found)
3573 (if (string-match "^[^\\+]+\\+" prefix)
3574 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3575 server (substring prefix (match-end 0) (1- (length prefix))))
3576 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3578 (when (eq (caaar servers) backend)
3579 (setq possible (caar servers))
3580 (when (equal (cadaar servers) server)
3581 (setq found (caar servers))))
3583 (or (car (rassoc found gnus-server-alist))
3585 (car (rassoc possible gnus-server-alist))
3587 (list backend server))))))
3589 (defsubst gnus-native-method-p (method)
3590 "Return whether METHOD is the native select method."
3591 (gnus-method-equal method gnus-select-method))
3593 (defsubst gnus-secondary-method-p (method)
3594 "Return whether METHOD is a secondary select method."
3595 (let ((methods gnus-secondary-select-methods)
3596 (gmethod (inline (gnus-server-get-method nil method))))
3598 (not (gnus-method-equal
3599 (inline (gnus-server-get-method nil (car methods)))
3601 (setq methods (cdr methods)))
3604 (defun gnus-method-simplify (method)
3605 "Return the shortest uniquely identifying string or method for METHOD."
3606 (cond ((stringp method)
3608 ((gnus-native-method-p method)
3610 ((gnus-secondary-method-p method)
3611 (format "%s:%s" (nth 0 method) (nth 1 method)))
3615 (defun gnus-groups-from-server (server)
3616 "Return a list of all groups that are fetched from SERVER."
3617 (let ((alist (cdr gnus-newsrc-alist))
3619 (while (setq info (pop alist))
3620 (when (gnus-server-equal (gnus-info-method info) server)
3621 (push (gnus-info-group info) groups)))
3622 (sort groups 'string<)))
3624 (defun gnus-group-foreign-p (group)
3625 "Say whether a group is foreign or not."
3626 (and (not (gnus-group-native-p group))
3627 (not (gnus-group-secondary-p group))))
3629 (defun gnus-group-native-p (group)
3630 "Say whether the group is native or not."
3631 (not (string-match ":" group)))
3633 (defun gnus-group-secondary-p (group)
3634 "Say whether the group is secondary or not."
3635 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3637 (defun gnus-parameters-get-parameter (group)
3638 "Return the group parameters for GROUP from `gnus-parameters'."
3640 (dolist (elem gnus-parameters)
3641 (when (string-match (car elem) group)
3643 (nconc (gnus-expand-group-parameters
3644 (car elem) (cdr elem) group)
3648 (defun gnus-expand-group-parameter (match value group)
3649 "Use MATCH to expand VALUE in GROUP."
3652 (goto-char (point-min))
3653 (while (re-search-forward match nil t)
3654 (replace-match value))
3657 (defun gnus-expand-group-parameters (match parameters group)
3658 "Go through PARAMETERS and expand them according to the match data."
3660 (dolist (elem parameters)
3661 (if (and (stringp (cdr elem))
3662 (string-match "\\\\[0-9&]" (cdr elem)))
3663 (push (cons (car elem)
3664 (gnus-expand-group-parameter match (cdr elem) group))
3669 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3670 "For GROUP, return the value of SYMBOL.
3672 You should call this in the `gnus-group-buffer' buffer.
3673 The function `gnus-group-find-parameter' will do that for you."
3674 ;; The speed trick: No cons'ing and quit early.
3675 (let* ((params (funcall gnus-group-get-parameter-function group))
3676 ;; Start easy, check the "real" group parameters.
3678 (gnus-group-parameter-value params symbol allow-list t)))
3680 ;; Found results; return them.
3681 (car simple-results)
3682 ;; We didn't found it there, try `gnus-parameters'.
3685 (tail gnus-parameters))
3686 ;; A good old-fashioned non-cl loop.
3688 (setq head (car tail)
3690 ;; The car is regexp matching for matching the group name.
3691 (when (string-match (car head) group)
3692 ;; The cdr is the parameters.
3693 (setq result (gnus-group-parameter-value (cdr head)
3696 ;; Expand if necessary.
3697 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3698 (setq result (gnus-expand-group-parameter (car head)
3700 ;; Exit the loop early.
3705 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3706 "Return the group parameters for GROUP.
3707 If SYMBOL, return the value of that symbol in the group parameters.
3709 If you call this function inside a loop, consider using the faster
3710 `gnus-group-fast-parameter' instead."
3712 (set-buffer gnus-group-buffer)
3714 (gnus-group-fast-parameter group symbol allow-list)
3717 (funcall gnus-group-get-parameter-function group))
3718 (gnus-parameters-get-parameter group)))))
3720 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3721 "Return the group parameters for GROUP.
3722 If SYMBOL, return the value of that symbol in the group parameters.
3723 Most functions should use `gnus-group-find-parameter', which
3724 also examines the topic parameters."
3725 (let ((params (gnus-info-params (gnus-get-info group))))
3727 (gnus-group-parameter-value params symbol allow-list)
3730 (defun gnus-group-parameter-value (params symbol &optional
3731 allow-list present-p)
3732 "Return the value of SYMBOL in group PARAMS."
3733 ;; We only wish to return group parameters (dotted lists) and
3734 ;; not local variables, which may have the same names.
3735 ;; But first we handle single elements...
3736 (or (car (memq symbol params))
3740 (while (setq elem (pop params))
3741 (when (and (consp elem)
3742 (eq (car elem) symbol)
3745 (throw 'found (if present-p (list (cdr elem))
3748 (defun gnus-group-add-parameter (group param)
3749 "Add parameter PARAM to GROUP."
3750 (let ((info (gnus-get-info group)))
3752 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3753 ;; Cons the new param to the old one and update.
3754 (gnus-group-set-info (cons param (gnus-info-params info))
3757 (defun gnus-group-set-parameter (group name value)
3758 "Set parameter NAME to VALUE in GROUP."
3759 (let ((info (gnus-get-info group)))
3761 (gnus-group-remove-parameter group name)
3762 (let ((old-params (gnus-info-params info))
3763 (new-params (list (cons name value))))
3765 (when (or (not (listp (car old-params)))
3766 (not (eq (caar old-params) name)))
3767 (setq new-params (append new-params (list (car old-params)))))
3768 (setq old-params (cdr old-params)))
3769 (gnus-group-set-info new-params group 'params)))))
3771 (defun gnus-group-remove-parameter (group name)
3772 "Remove parameter NAME from GROUP."
3773 (let ((info (gnus-get-info group)))
3775 (let ((params (gnus-info-params info)))
3777 (setq params (delq name params))
3778 (while (assq name params)
3779 (gnus-pull name params))
3780 (gnus-info-set-params info params))))))
3782 (defun gnus-group-add-score (group &optional score)
3783 "Add SCORE to the GROUP score.
3784 If SCORE is nil, add 1 to the score of GROUP."
3785 (let ((info (gnus-get-info group)))
3787 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3789 (defun gnus-short-group-name (group &optional levels)
3790 "Collapse GROUP name LEVELS.
3791 Select methods are stripped and any remote host name is stripped down to
3792 just the host name."
3798 gnus-group-uncollapsed-levels
3800 (while (string-match "\\." group skip)
3801 (setq skip (match-end 0)
3804 ;; Separate foreign select method from group name and collapse.
3805 ;; If method contains a server, collapse to non-domain server name,
3806 ;; otherwise collapse to select method.
3807 (let* ((colon (string-match ":" group))
3808 (server (and colon (substring group 0 colon)))
3809 (plus (and server (string-match "+" server))))
3812 (setq foreign (substring server (+ 1 plus)
3813 (string-match "\\." server))
3814 group (substring group (+ 1 colon)))
3815 (setq foreign server
3816 group (substring group (+ 1 colon))))
3817 (setq foreign (concat foreign ":")))
3818 ;; Collapse group name leaving LEVELS uncollapsed elements
3819 (let* ((slist (split-string group "/"))
3820 (slen (length slist))
3821 (dlist (split-string group "\\."))
3822 (dlen (length dlist))
3834 (setq levels (- glen levels))
3836 (push (if (>= (decf levels) 0)
3837 (if (zerop (length g))
3842 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3844 (defun gnus-narrow-to-body ()
3845 "Narrow to the body of an article."
3848 (goto-char (point-min))
3849 (or (search-forward "\n\n" nil t)
3855 ;;; Kill file handling.
3858 (defun gnus-apply-kill-file ()
3859 "Apply a kill file to the current newsgroup.
3860 Returns the number of articles marked as read."
3861 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3862 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3863 (gnus-apply-kill-file-internal)
3866 (defun gnus-kill-save-kill-buffer ()
3867 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3868 (when (get-file-buffer file)
3870 (set-buffer (get-file-buffer file))
3871 (when (buffer-modified-p)
3873 (kill-buffer (current-buffer))))))
3875 (defcustom gnus-kill-file-name "KILL"
3876 "Suffix of the kill files."
3877 :group 'gnus-score-kill
3878 :group 'gnus-score-files
3881 (defun gnus-newsgroup-kill-file (newsgroup)
3882 "Return the name of a kill file name for NEWSGROUP.
3883 If NEWSGROUP is nil, return the global kill file name instead."
3885 ;; The global KILL file is placed at top of the directory.
3886 ((or (null newsgroup)
3887 (string-equal newsgroup ""))
3888 (expand-file-name gnus-kill-file-name
3889 gnus-kill-files-directory))
3890 ;; Append ".KILL" to newsgroup name.
3891 ((gnus-use-long-file-name 'not-kill)
3892 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3893 "." gnus-kill-file-name)
3894 gnus-kill-files-directory))
3895 ;; Place "KILL" under the hierarchical directory.
3897 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3898 "/" gnus-kill-file-name)
3899 gnus-kill-files-directory))))
3903 (defun gnus-member-of-valid (symbol group)
3904 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3906 (symbol-name (car (gnus-find-method-for-group group)))
3907 gnus-valid-select-methods)))
3909 (defun gnus-method-option-p (method option)
3910 "Return non-nil if select METHOD has OPTION as a parameter."
3911 (when (stringp method)
3912 (setq method (gnus-server-to-method method)))
3913 (memq option (assoc (format "%s" (car method))
3914 gnus-valid-select-methods)))
3916 (defun gnus-similar-server-opened (method)
3917 (let ((opened gnus-opened-servers))
3918 (while (and method opened)
3919 (when (and (equal (cadr method) (cadaar opened))
3920 (equal (car method) (caaar opened))
3921 (not (equal method (caar opened))))
3926 (defun gnus-server-extend-method (group method)
3927 ;; This function "extends" a virtual server. If the server is
3928 ;; "hello", and the select method is ("hello" (my-var "something"))
3929 ;; in the group "alt.alt", this will result in a new virtual server
3930 ;; called "hello+alt.alt".
3931 (if (or (not (inline (gnus-similar-server-opened method)))
3932 (not (cddr method)))
3934 `(,(car method) ,(concat (cadr method) "+" group)
3935 (,(intern (format "%s-address" (car method))) ,(cadr method))
3938 (defun gnus-server-status (method)
3939 "Return the status of METHOD."
3940 (nth 1 (assoc method gnus-opened-servers)))
3942 (defun gnus-group-name-to-method (group)
3943 "Guess a select method based on GROUP."
3944 (if (string-match ":" group)
3945 (let ((server (substring group 0 (match-beginning 0))))
3946 (if (string-match "\\+" server)
3947 (list (intern (substring server 0 (match-beginning 0)))
3948 (substring server (match-end 0)))
3949 (list (intern server) "")))
3950 gnus-select-method))
3952 (defun gnus-server-string (server)
3953 "Return a readable string that describes SERVER."
3954 (let* ((server (gnus-server-to-method server))
3955 (address (nth 1 server)))
3957 (not (zerop (length address))))
3958 (format "%s using %s" address (car server))
3959 (format "%s" (car server)))))
3961 (defun gnus-find-method-for-group (group &optional info)
3962 "Find the select method that GROUP uses."
3963 (or gnus-override-method
3966 (and (not (gnus-group-entry group));; a new group
3967 (gnus-group-name-to-method group))
3968 (let ((info (or info (gnus-get-info group)))
3971 (not (setq method (gnus-info-method info)))
3972 (equal method "native"))
3975 (cond ((stringp method)
3976 (inline (gnus-server-to-method method)))
3977 ((stringp (cadr method))
3978 (inline (gnus-server-extend-method group method)))
3981 (cond ((equal (cadr method) "")
3983 ((null (cadr method))
3984 (list (car method) ""))
3986 (gnus-server-add-address method)))))))
3988 (defun gnus-methods-using (feature)
3989 "Find all methods that have FEATURE."
3990 (let ((valids gnus-valid-select-methods)
3993 (when (memq feature (car valids))
3994 (push (car valids) outs))
3995 (setq valids (cdr valids)))
3999 (autoload 'message-y-or-n-p "message" nil nil 'macro))
4001 (defun gnus-read-group (prompt &optional default)
4002 "Prompt the user for a group name.
4003 Disallow invalid group names."
4008 gnus-invalid-group-regexp
4009 (setq group (read-string (concat prefix prompt)
4010 (cons (or default "") 0)
4011 'gnus-group-history)))
4012 (let ((match (match-string 0 group)))
4013 ;; Might be okay (e.g. for nnimap), so ask the user:
4014 (unless (and (not (string-match "^$\\|:" match))
4016 "Proceed and create group anyway? " t
4017 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4019 Usually, it's dangerous to create a group with this name, because it's not
4020 supported by all back ends and servers. On IMAP servers it should work,
4021 though. If you are really sure, you can proceed anyway and create the group.
4023 You may customize the variable `gnus-invalid-group-regexp', which currently is
4024 set to \"" gnus-invalid-group-regexp
4025 "\", if you want to get rid of this query permanently."))
4026 (setq prefix (format "Invalid group name: \"%s\". " group)
4030 (defun gnus-read-method (prompt)
4031 "Prompt the user for a method.
4032 Allow completion over sensible values."
4033 (let* ((open-servers
4034 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4035 gnus-opened-servers))
4038 (dolist (method gnus-valid-select-methods)
4039 (if (or (memq 'prompt-address method)
4040 (not (assoc (format "%s:" (car method)) open-servers)))
4041 (push method methods)))
4044 (append valid-methods
4046 gnus-predefined-server-alist
4051 nil t nil 'gnus-method-history)))
4054 (setq method gnus-select-method))
4055 ((assoc method gnus-valid-select-methods)
4056 (let ((address (if (memq 'prompt-address
4057 (assoc method gnus-valid-select-methods))
4058 (read-string "Address: ")
4060 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4061 (list (intern method) address))))
4062 ((assoc method servers)
4065 (list (intern method) "")))))
4069 (defun gnus-agent-method-p (method)
4070 "Say whether METHOD is covered by the agent."
4071 (or (eq (car gnus-agent-method-p-cache) method)
4072 (setq gnus-agent-method-p-cache
4074 (member (if (stringp method)
4076 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4077 (cdr gnus-agent-method-p-cache))
4079 (defun gnus-online (method)
4082 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4083 (gnus-agent-method-p method))))
4085 ;;; User-level commands.
4088 (defun gnus-slave-no-server (&optional arg)
4089 "Read network news as a slave, without connecting to the local server."
4091 (gnus-no-server arg t))
4094 (defun gnus-no-server (&optional arg slave)
4096 If ARG is a positive number, Gnus will use that as the startup
4097 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4098 non-nil and not a positive number, Gnus will prompt the user for the
4099 name of an NNTP server to use.
4100 As opposed to `gnus', this command will not connect to the local
4103 (gnus-no-server-1 arg slave))
4106 (defun gnus-slave (&optional arg)
4107 "Read news as a slave."
4109 (gnus arg nil 'slave))
4111 (defcustom gnus-frame-properties nil
4112 "The properties of the frame in which gnus is displayed. Under XEmacs,
4113 the variable `toolbar-news-frame-plist' will be refered instead."
4114 :type '(repeat (cons :format "%v"
4115 (symbol :tag "Parameter")
4116 (sexp :tag "Value")))
4120 (defun gnus-other-frame (&optional arg display)
4121 "Pop up a frame to read news.
4122 This will call one of the Gnus commands which is specified by the user
4123 option `gnus-other-frame-function' (default `gnus') with the argument
4124 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4125 optional second argument DISPLAY should be a standard display string
4126 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4127 omitted or the function `make-frame-on-display' is not available, the
4128 current display is used."
4130 (if (fboundp 'make-frame-on-display)
4132 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4134 (let ((alive (gnus-alive-p)))
4139 (when (and (or (not display)
4141 (gnus-frame-or-window-display-name
4143 (with-current-buffer (window-buffer window)
4144 (string-match "\\`gnus-"
4145 (symbol-name major-mode))))
4146 (gnus-select-frame-set-input-focus
4147 (setq gnus-other-frame-object (window-frame window)))
4148 (select-window window)
4151 (gnus-select-frame-set-input-focus
4152 (setq gnus-other-frame-object
4154 (make-frame-on-display display gnus-other-frame-parameters)
4155 (make-frame gnus-other-frame-parameters))))
4157 (switch-to-buffer gnus-group-buffer)
4158 (funcall gnus-other-frame-function arg)
4159 (add-hook 'gnus-exit-gnus-hook
4161 (when (and (frame-live-p gnus-other-frame-object)
4163 (delete-frame gnus-other-frame-object))
4164 (setq gnus-other-frame-object nil)))))))
4167 (defun gnus (&optional arg dont-connect slave)
4169 If ARG is non-nil and a positive number, Gnus will use that as the
4170 startup level. If ARG is non-nil and not a positive number, Gnus will
4171 prompt the user for the name of an NNTP server to use."
4173 (unless (byte-code-function-p (symbol-function 'gnus))
4174 (message "You should byte-compile Gnus")
4176 (gnus-1 arg dont-connect slave))
4178 ;; Allow redefinition of Gnus functions.
4182 (product-provide (provide 'gnus) 'gnus-vers)
4184 ;;; gnus.el ends here