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 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
39 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
43 (defgroup gnus-format nil
44 "Dealing with formatting issues."
47 (defgroup gnus-charset nil
48 "Group character set issues."
49 :link '(custom-manual "(gnus)Charsets")
53 (defgroup gnus-cache nil
55 :link '(custom-manual "(gnus)Article Caching")
58 (defgroup gnus-registry nil
62 (defgroup gnus-start nil
63 "Starting your favorite newsreader."
66 (defgroup gnus-start-server nil
67 "Server options at startup."
70 ;; These belong to gnus-group.el.
71 (defgroup gnus-group nil
73 :link '(custom-manual "(gnus)The Group Buffer")
76 (defgroup gnus-group-foreign nil
78 :link '(custom-manual "(gnus)Foreign Groups")
81 (defgroup gnus-group-new nil
82 "Automatic subscription of new groups."
85 (defgroup gnus-group-levels nil
87 :link '(custom-manual "(gnus)Group Levels")
90 (defgroup gnus-group-select nil
92 :link '(custom-manual "(gnus)Selecting a Group")
95 (defgroup gnus-group-listing nil
96 "Showing slices of the group list."
97 :link '(custom-manual "(gnus)Listing Groups")
100 (defgroup gnus-group-visual nil
101 "Sorting the group buffer."
102 :link '(custom-manual "(gnus)Group Buffer Format")
106 (defgroup gnus-group-various nil
107 "Various group options."
108 :link '(custom-manual "(gnus)Scanning New Messages")
111 ;; These belong to gnus-sum.el.
112 (defgroup gnus-summary nil
114 :link '(custom-manual "(gnus)The Summary Buffer")
117 (defgroup gnus-summary-exit nil
118 "Leaving summary buffers."
119 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-marks nil
123 "Marks used in summary buffers."
124 :link '(custom-manual "(gnus)Marking Articles")
125 :group 'gnus-summary)
127 (defgroup gnus-thread nil
128 "Ordering articles according to replies."
129 :link '(custom-manual "(gnus)Threading")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-format nil
133 "Formatting of the summary buffer."
134 :link '(custom-manual "(gnus)Summary Buffer Format")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-choose nil
139 :link '(custom-manual "(gnus)Choosing Articles")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-maneuvering nil
143 "Summary movement commands."
144 :link '(custom-manual "(gnus)Summary Maneuvering")
145 :group 'gnus-summary)
147 (defgroup gnus-picon nil
148 "Show pictures of people, domains, and newsgroups."
151 (defgroup gnus-summary-mail nil
152 "Mail group commands."
153 :link '(custom-manual "(gnus)Mail Group Commands")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-sort nil
157 "Sorting the summary buffer."
158 :link '(custom-manual "(gnus)Sorting")
159 :group 'gnus-summary)
161 (defgroup gnus-summary-visual nil
162 "Highlighting and menus in the summary buffer."
163 :link '(custom-manual "(gnus)Summary Highlighting")
165 :group 'gnus-summary)
167 (defgroup gnus-summary-various nil
168 "Various summary buffer options."
169 :link '(custom-manual "(gnus)Various Summary Stuff")
170 :group 'gnus-summary)
172 (defgroup gnus-summary-pick nil
173 "Pick mode in the summary buffer."
174 :link '(custom-manual "(gnus)Pick and Read")
176 :group 'gnus-summary)
178 (defgroup gnus-summary-tree nil
179 "Tree display of threads in the summary buffer."
180 :link '(custom-manual "(gnus)Tree Display")
182 :group 'gnus-summary)
184 ;; Belongs to gnus-uu.el
185 (defgroup gnus-extract-view nil
186 "Viewing extracted files."
187 :link '(custom-manual "(gnus)Viewing Files")
188 :group 'gnus-extract)
190 ;; Belongs to gnus-score.el
191 (defgroup gnus-score nil
192 "Score and kill file handling."
195 (defgroup gnus-score-kill nil
199 (defgroup gnus-score-adapt nil
200 "Adaptive score files."
203 (defgroup gnus-score-default nil
204 "Default values for score files."
207 (defgroup gnus-score-expire nil
208 "Expiring score rules."
211 (defgroup gnus-score-decay nil
212 "Decaying score rules."
215 (defgroup gnus-score-files nil
216 "Score and kill file names."
220 (defgroup gnus-score-various nil
221 "Various scoring and killing options."
225 (defgroup gnus-visual nil
226 "Options controlling the visual fluff."
230 (defgroup gnus-agent nil
231 "Offline support for Gnus."
234 (defgroup gnus-files nil
235 "Files used by Gnus."
238 (defgroup gnus-dribble-file nil
240 :link '(custom-manual "(gnus)Auto Save")
243 (defgroup gnus-newsrc nil
244 "Storing Gnus state."
247 (defgroup gnus-server nil
248 "Options related to newsservers and other servers used by Gnus."
251 (defgroup gnus-server-visual nil
252 "Highlighting and menus in the server buffer."
256 (defgroup gnus-message '((message custom-group))
257 "Composing replies and followups in Gnus."
260 (defgroup gnus-meta nil
261 "Meta variables controlling major portions of Gnus.
262 In general, modifying these variables does not take affect until Gnus
263 is restarted, and sometimes reloaded."
266 (defgroup gnus-various nil
267 "Other Gnus options."
268 :link '(custom-manual "(gnus)Various Various")
271 (defgroup gnus-mime nil
272 "Variables for controlling the Gnus MIME interface."
275 (defgroup gnus-exit nil
277 :link '(custom-manual "(gnus)Exiting Gnus")
280 (defgroup gnus-fun nil
281 "Frivolous Gnus extensions."
282 :link '(custom-manual "(gnus)Exiting Gnus")
285 (defconst gnus-version-number "0.2"
286 "Version number for this version of Gnus.")
288 (defconst gnus-version (format "No Gnus v%s" gnus-version-number)
289 "Version string for this version of Gnus.")
291 (defcustom gnus-inhibit-startup-message nil
292 "If non-nil, the startup message will not be displayed.
293 This variable is used before `.gnus.el' is loaded, so it should
294 be set in `.emacs' instead."
298 (defcustom gnus-play-startup-jingle nil
299 "If non-nil, play the Gnus jingle at startup."
303 (unless (fboundp 'gnus-group-remove-excess-properties)
304 (defalias 'gnus-group-remove-excess-properties 'ignore))
306 (unless (featurep 'gnus-xmas)
307 (defalias 'gnus-make-overlay 'make-overlay)
308 (defalias 'gnus-delete-overlay 'delete-overlay)
309 (defalias 'gnus-overlay-put 'overlay-put)
310 (defalias 'gnus-move-overlay 'move-overlay)
311 (defalias 'gnus-overlay-buffer 'overlay-buffer)
312 (defalias 'gnus-overlay-start 'overlay-start)
313 (defalias 'gnus-overlay-end 'overlay-end)
314 (defalias 'gnus-extent-detached-p 'ignore)
315 (defalias 'gnus-extent-start-open 'ignore)
316 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
317 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
318 (defalias 'gnus-character-to-event 'identity)
319 (defalias 'gnus-assq-delete-all 'assq-delete-all)
320 (defalias 'gnus-add-text-properties 'add-text-properties)
321 (defalias 'gnus-put-text-property 'put-text-property)
322 (defvar gnus-mode-line-image-cache t)
323 (if (fboundp 'find-image)
324 (defun gnus-mode-line-buffer-identification (line)
325 (let ((str (car-safe line)))
326 (if (and (stringp str)
327 (string-match "^Gnus:" str))
328 (progn (add-text-properties
331 (if (eq t gnus-mode-line-image-cache)
332 (setq gnus-mode-line-image-cache
334 '((:type xpm :file "gnus-pointer.xpm"
336 (:type xbm :file "gnus-pointer.xbm"
338 gnus-mode-line-image-cache)
341 gnus-version (gnus-emacs-version)))
345 (defalias 'gnus-mode-line-buffer-identification 'identity))
346 (defalias 'gnus-characterp 'numberp)
347 (defalias 'gnus-deactivate-mark 'deactivate-mark)
348 (defalias 'gnus-window-edges 'window-edges)
349 (defalias 'gnus-key-press-event-p 'numberp)
350 ;;(defalias 'gnus-decode-rfc1522 'ignore)
353 ;; We define these group faces here to avoid the display
354 ;; update forced when creating new faces.
356 (defface gnus-group-news-1-face
359 (:foreground "PaleTurquoise" :bold t))
362 (:foreground "ForestGreen" :bold t))
365 "Level 1 newsgroup face.")
367 (defface gnus-group-news-1-empty-face
370 (:foreground "PaleTurquoise"))
373 (:foreground "ForestGreen"))
376 "Level 1 empty newsgroup face.")
378 (defface gnus-group-news-2-face
381 (:foreground "turquoise" :bold t))
384 (:foreground "CadetBlue4" :bold t))
387 "Level 2 newsgroup face.")
389 (defface gnus-group-news-2-empty-face
392 (:foreground "turquoise"))
395 (:foreground "CadetBlue4"))
398 "Level 2 empty newsgroup face.")
400 (defface gnus-group-news-3-face
409 "Level 3 newsgroup face.")
411 (defface gnus-group-news-3-empty-face
420 "Level 3 empty newsgroup face.")
422 (defface gnus-group-news-4-face
431 "Level 4 newsgroup face.")
433 (defface gnus-group-news-4-empty-face
442 "Level 4 empty newsgroup face.")
444 (defface gnus-group-news-5-face
453 "Level 5 newsgroup face.")
455 (defface gnus-group-news-5-empty-face
464 "Level 5 empty newsgroup face.")
466 (defface gnus-group-news-6-face
475 "Level 6 newsgroup face.")
477 (defface gnus-group-news-6-empty-face
486 "Level 6 empty newsgroup face.")
488 (defface gnus-group-news-low-face
491 (:foreground "DarkTurquoise" :bold t))
494 (:foreground "DarkGreen" :bold t))
497 "Low level newsgroup face.")
499 (defface gnus-group-news-low-empty-face
502 (:foreground "DarkTurquoise"))
505 (:foreground "DarkGreen"))
508 "Low level empty newsgroup face.")
510 (defface gnus-group-mail-1-face
513 (:foreground "aquamarine1" :bold t))
516 (:foreground "DeepPink3" :bold t))
519 "Level 1 mailgroup face.")
521 (defface gnus-group-mail-1-empty-face
524 (:foreground "aquamarine1"))
527 (:foreground "DeepPink3"))
529 (:italic t :bold t)))
530 "Level 1 empty mailgroup face.")
532 (defface gnus-group-mail-2-face
535 (:foreground "aquamarine2" :bold t))
538 (:foreground "HotPink3" :bold t))
541 "Level 2 mailgroup face.")
543 (defface gnus-group-mail-2-empty-face
546 (:foreground "aquamarine2"))
549 (:foreground "HotPink3"))
552 "Level 2 empty mailgroup face.")
554 (defface gnus-group-mail-3-face
557 (:foreground "aquamarine3" :bold t))
560 (:foreground "magenta4" :bold t))
563 "Level 3 mailgroup face.")
565 (defface gnus-group-mail-3-empty-face
568 (:foreground "aquamarine3"))
571 (:foreground "magenta4"))
574 "Level 3 empty mailgroup face.")
576 (defface gnus-group-mail-low-face
579 (:foreground "aquamarine4" :bold t))
582 (:foreground "DeepPink4" :bold t))
585 "Low level mailgroup face.")
587 (defface gnus-group-mail-low-empty-face
590 (:foreground "aquamarine4"))
593 (:foreground "DeepPink4"))
596 "Low level empty mailgroup face.")
598 ;; Summary mode faces.
600 (defface gnus-summary-selected-face '((t
602 "Face used for selected articles.")
604 (defface gnus-summary-cancelled-face
606 (:foreground "yellow" :background "black")))
607 "Face used for cancelled articles.")
609 (defface gnus-summary-high-ticked-face
612 (:foreground "pink" :bold t))
615 (:foreground "firebrick" :bold t))
618 "Face used for high interest ticked articles.")
620 (defface gnus-summary-low-ticked-face
623 (:foreground "pink" :italic t))
626 (:foreground "firebrick" :italic t))
629 "Face used for low interest ticked articles.")
631 (defface gnus-summary-normal-ticked-face
634 (:foreground "pink"))
637 (:foreground "firebrick"))
640 "Face used for normal interest ticked articles.")
642 (defface gnus-summary-high-ancient-face
645 (:foreground "SkyBlue" :bold t))
648 (:foreground "RoyalBlue" :bold t))
651 "Face used for high interest ancient articles.")
653 (defface gnus-summary-low-ancient-face
656 (:foreground "SkyBlue" :italic t))
659 (:foreground "RoyalBlue" :italic t))
662 "Face used for low interest ancient articles.")
664 (defface gnus-summary-normal-ancient-face
667 (:foreground "SkyBlue"))
670 (:foreground "RoyalBlue"))
673 "Face used for normal interest ancient articles.")
675 (defface gnus-summary-high-undownloaded-face
678 (:bold t :foreground "cyan4"))
679 (((class color) (background dark))
680 (:bold t :foreground "LightGray"))
681 (t (:inverse-video t :bold t)))
682 "Face used for high interest uncached articles.")
684 (defface gnus-summary-low-undownloaded-face
687 (:italic t :foreground "cyan4" :bold nil))
688 (((class color) (background dark))
689 (:italic t :foreground "LightGray" :bold nil))
690 (t (:inverse-video t :italic t)))
691 "Face used for low interest uncached articles.")
693 (defface gnus-summary-normal-undownloaded-face
696 (:foreground "cyan4" :bold nil))
697 (((class color) (background dark))
698 (:foreground "LightGray" :bold nil))
699 (t (:inverse-video t)))
700 "Face used for normal interest uncached articles.")
702 (defface gnus-summary-high-unread-face
705 "Face used for high interest unread articles.")
707 (defface gnus-summary-low-unread-face
710 "Face used for low interest unread articles.")
712 (defface gnus-summary-normal-unread-face
715 "Face used for normal interest unread articles.")
717 (defface gnus-summary-high-read-face
720 (:foreground "PaleGreen"
724 (:foreground "DarkGreen"
728 "Face used for high interest read articles.")
730 (defface gnus-summary-low-read-face
733 (:foreground "PaleGreen"
737 (:foreground "DarkGreen"
741 "Face used for low interest read articles.")
743 (defface gnus-summary-normal-read-face
746 (:foreground "PaleGreen"))
749 (:foreground "DarkGreen"))
752 "Face used for normal interest read articles.")
759 (defvar gnus-buffers nil)
761 (defun gnus-get-buffer-create (name)
762 "Do the same as `get-buffer-create', but store the created buffer."
763 (or (get-buffer name)
764 (car (push (get-buffer-create name) gnus-buffers))))
766 (defun gnus-add-buffer ()
767 "Add the current buffer to the list of Gnus buffers."
768 (push (current-buffer) gnus-buffers))
770 (defmacro gnus-kill-buffer (buffer)
771 "Kill BUFFER and remove from the list of Gnus buffers."
772 `(let ((buf ,buffer))
773 (when (gnus-buffer-exists-p buf)
774 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
777 (defun gnus-buffers ()
778 "Return a list of live Gnus buffers."
779 (while (and gnus-buffers
780 (not (buffer-name (car gnus-buffers))))
782 (let ((buffers gnus-buffers))
784 (if (buffer-name (cadr buffers))
786 (setcdr buffers (cddr buffers)))))
791 (defvar gnus-group-buffer "*Group*")
794 (autoload 'gnus-play-jingle "gnus-audio"))
796 (defface gnus-splash-face
799 (:foreground "#888888"))
802 (:foreground "#888888"))
805 "Face for the splash screen.")
807 (defun gnus-splash ()
809 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
810 (let ((buffer-read-only nil))
812 (unless gnus-inhibit-startup-message
813 (gnus-group-startup-message)
815 (when gnus-play-startup-jingle
816 (gnus-play-jingle))))))
818 (defun gnus-indent-rigidly (start end arg)
819 "Indent rigidly using only spaces and no tabs."
822 (narrow-to-region start end)
824 (indent-rigidly start end arg)
825 ;; We translate tabs into spaces -- not everybody uses
826 ;; an 8-character tab.
827 (goto-char (point-min))
828 (while (search-forward "\t" nil t)
829 (replace-match " " t t))))))
831 (defvar gnus-simple-splash nil)
833 ;;(format "%02x%02x%02x" 114 66 20) "724214"
835 (defvar gnus-logo-color-alist
836 '((flame "#cc3300" "#ff2200")
837 (pine "#c0cc93" "#f8ffb8")
838 (moss "#a1cc93" "#d2ffb8")
839 (irish "#04cc90" "#05ff97")
840 (sky "#049acc" "#05deff")
841 (tin "#6886cc" "#82b6ff")
842 (velvet "#7c68cc" "#8c82ff")
843 (grape "#b264cc" "#cf7df")
844 (labia "#cc64c2" "#fd7dff")
845 (berry "#cc6485" "#ff7db5")
846 (dino "#724214" "#1e3f03")
847 (oort "#cccccc" "#888888")
848 (storm "#666699" "#99ccff")
849 (pdino "#9999cc" "#99ccff")
850 (purp "#9999cc" "#666699")
851 (no "#ff0000" "#ffff00")
852 (neutral "#b4b4b4" "#878787")
853 (september "#bf9900" "#ffcc00"))
854 "Color alist used for the Gnus logo.")
856 (defcustom gnus-logo-color-style 'no
857 "*Color styles used for the Gnus logo."
858 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
859 gnus-logo-color-alist))
862 (defvar gnus-logo-colors
863 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
864 "Colors used for the Gnus logo.")
866 (defun gnus-group-startup-message (&optional x y)
867 "Insert startup message in current buffer."
868 ;; Insert the message.
872 (fboundp 'find-image)
874 (let* ((data-directory (nnheader-find-etc-directory "gnus"))
876 `((:type xpm :file "gnus.xpm"
878 (("thing" . ,(car gnus-logo-colors))
879 ("shadow" . ,(cadr gnus-logo-colors))
881 ("background" . ,(face-background 'default))))
882 (:type pbm :file "gnus.pbm"
883 ;; Account for the pbm's blackground.
884 :background ,(face-foreground 'gnus-splash-face)
885 :foreground ,(face-background 'default))
886 (:type xbm :file "gnus.xbm"
887 ;; Account for the xbm's blackground.
888 :background ,(face-foreground 'gnus-splash-face)
889 :foreground ,(face-background 'default))))))
891 (let ((size (image-size image)))
892 (insert-char ?\n (max 0 (round (- (window-height)
893 (or y (cdr size)) 1) 2)))
894 (insert-char ?\ (max 0 (round (- (window-width)
895 (or x (car size))) 2)))
896 (insert-image image))
897 (setq gnus-simple-splash nil)
903 _ ___ __ ___ __ _ ___
923 (gnus-indent-rigidly (point-min) (point-max)
924 (/ (max (- (window-width) (or x 46)) 0) 2))
925 (goto-char (point-min))
927 (let* ((pheight (count-lines (point-min) (point-max)))
928 (wheight (window-height))
929 (rest (- wheight pheight)))
930 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
932 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
933 (setq gnus-simple-splash t)))
934 (goto-char (point-min))
935 (setq mode-line-buffer-identification (concat " " gnus-version))
936 (set-buffer-modified-p t))
939 (let ((command (format "%s" this-command)))
940 (when (string-match "gnus" command)
941 (if (string-match "gnus-other-frame" command)
942 (gnus-get-buffer-create gnus-group-buffer)
950 (defcustom gnus-parameters nil
951 "Alist of group parameters.
954 ((\"mail\\\\..*\" (gnus-show-threads nil)
955 (gnus-use-scoring nil)
956 (gnus-summary-line-format
957 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
960 (\"mail\\\\.me\" (gnus-use-scoring t))
961 (\"list\\\\..*\" (total-expire . t)
962 (broken-reply-to . t)))"
963 :group 'gnus-group-various
964 :type '(repeat (cons regexp
967 (defvar gnus-group-parameters-more nil)
969 (defmacro gnus-define-group-parameter (param &rest rest)
970 "Define a group parameter PARAM.
971 REST is a plist of following:
972 :type One of `bool', `list' or nil.
973 :function The name of the function.
974 :function-document The documentation of the function.
975 :parameter-type The type for customizing the parameter.
976 :parameter-document The documentation for the parameter.
977 :variable The name of the variable.
978 :variable-document The documentation for the variable.
979 :variable-group The group for customizing the variable.
980 :variable-type The type for customizing the variable.
981 :variable-default The default value of the variable."
982 (let* ((type (plist-get rest :type))
983 (parameter-type (plist-get rest :parameter-type))
984 (parameter-document (plist-get rest :parameter-document))
985 (function (or (plist-get rest :function)
986 (intern (format "gnus-parameter-%s" param))))
987 (function-document (or (plist-get rest :function-document) ""))
988 (variable (or (plist-get rest :variable)
989 (intern (format "gnus-parameter-%s-alist" param))))
990 (variable-document (or (plist-get rest :variable-document) ""))
991 (variable-group (plist-get rest :variable-group))
992 (variable-type (or (plist-get rest :variable-type)
994 (list (regexp :tag "Group")
995 ,(car (cdr parameter-type)))))))
996 (variable-default (plist-get rest :variable-default)))
999 `(defcustom ,variable ,variable-default
1001 :group 'gnus-group-parameter
1002 :group ',variable-group
1003 :type ,variable-type)
1004 `(setq gnus-group-parameters-more
1005 (delq (assq ',param gnus-group-parameters-more)
1006 gnus-group-parameters-more))
1007 `(add-to-list 'gnus-group-parameters-more
1010 ,parameter-document))
1012 `(defun ,function (name)
1014 (let ((params (gnus-group-find-parameter name))
1017 ((memq ',param params)
1019 ((setq val (assq ',param params))
1021 ((stringp ,variable)
1022 (string-match ,variable name))
1024 (let ((alist ,variable)
1026 (while (setq elem (pop alist))
1028 (string-match (car elem) name))
1031 (if (consp value) (car value) value))))))
1032 `(defun ,function (name)
1035 (or (gnus-group-find-parameter name ',param ,(and type t))
1036 (let ((alist ,variable)
1038 (while (setq elem (pop alist))
1040 (string-match (car elem) name))
1045 '(if (consp value) (car value) value))))))))))
1047 (defcustom gnus-home-directory "~/"
1048 "Directory variable that specifies the \"home\" directory.
1049 All other Gnus file and directory variables are initialized from this variable."
1053 (defcustom gnus-directory (or (getenv "SAVEDIR")
1054 (nnheader-concat gnus-home-directory "News/"))
1055 "*Directory variable from which all other Gnus file variables are derived.
1057 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1058 This means that other directory variables that are initialized from
1059 this variable won't be set properly if you set this variable in `.gnus.el'.
1060 Set this variable in `.emacs' instead."
1064 (defcustom gnus-default-directory nil
1065 "*Default directory for all Gnus buffers."
1067 :type '(choice (const :tag "current" nil)
1070 ;; Site dependent variables. These variables should be defined in
1073 (defvar gnus-default-nntp-server nil
1074 "Specify a default NNTP server.
1075 This variable should be defined in paths.el, and should never be set
1077 If you want to change servers, you should use `gnus-select-method'.
1078 See the documentation to that variable.")
1080 ;; Don't touch this variable.
1081 (defvar gnus-nntp-service "nntp"
1082 "NNTP service name (\"nntp\" or 119).
1083 This is an obsolete variable, which is scarcely used. If you use an
1084 nntp server for your newsgroup and want to change the port number
1085 used to 899, you would say something along these lines:
1087 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1089 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1090 "A file with only the name of the nntp server in it."
1095 (defun gnus-getenv-nntpserver ()
1096 "Find default nntp server.
1097 Check the NNTPSERVER environment variable and the
1098 `gnus-nntpserver-file' file."
1099 (or (getenv "NNTPSERVER")
1100 (and (file-readable-p gnus-nntpserver-file)
1102 (insert-file-contents gnus-nntpserver-file)
1103 (let ((name (buffer-string)))
1104 (unless (string-match "\\`[ \t\n]*$" name)
1107 (defcustom gnus-select-method
1110 (list 'nntp (or (condition-case nil
1111 (gnus-getenv-nntpserver)
1113 (when (and gnus-default-nntp-server
1114 (not (string= gnus-default-nntp-server "")))
1115 gnus-default-nntp-server)
1117 (if (or (null gnus-nntp-service)
1118 (equal gnus-nntp-service "nntp"))
1120 (list gnus-nntp-service)))
1122 "Default method for selecting a newsgroup.
1123 This variable should be a list, where the first element is how the
1124 news is to be fetched, the second is the address.
1126 For instance, if you want to get your news via \"flab.flab.edu\" using
1127 NNTP, you could say:
1129 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1131 If you want to use your local spool, say:
1133 \(setq gnus-select-method (list 'nnspool (system-name)))
1135 If you use this variable, you must set `gnus-nntp-server' to nil.
1137 There is a lot more to know about select methods and virtual servers -
1138 see the manual for details."
1140 :type 'gnus-select-method)
1142 (defcustom gnus-message-archive-method "archive"
1143 "*Method used for archiving messages you've sent.
1144 This should be a mail method."
1146 :group 'gnus-message
1147 :type '(choice (const :tag "Default archive method" "archive")
1148 gnus-select-method))
1150 (defcustom gnus-message-archive-group nil
1151 "*Name of the group in which to save the messages you've written.
1152 This can either be a string; a list of strings; or an alist
1153 of regexps/functions/forms to be evaluated to return a string (or a list
1154 of strings). The functions are called with the name of the current
1155 group (or nil) as a parameter.
1157 If you want to save your mail in one group and the news articles you
1158 write in another group, you could say something like:
1160 \(setq gnus-message-archive-group
1161 '((if (message-news-p)
1165 Normally the group names returned by this variable should be
1166 unprefixed -- which implicitly means \"store on the archive server\".
1167 However, you may wish to store the message on some other server. In
1168 that case, just return a fully prefixed name of the group --
1169 \"nnml+private:mail.misc\", for instance."
1170 :group 'gnus-message
1171 :type '(choice (const :tag "none" nil)
1176 (defcustom gnus-secondary-servers nil
1177 "List of NNTP servers that the user can choose between interactively.
1178 To make Gnus query you for a server, you have to give `gnus' a
1179 non-numeric prefix - `C-u M-x gnus', in short."
1181 :type '(repeat string))
1183 (defcustom gnus-nntp-server nil
1184 "*The name of the host running the NNTP server.
1185 This variable is semi-obsolete. Use the `gnus-select-method'
1188 :type '(choice (const :tag "disable" nil)
1191 (defcustom gnus-secondary-select-methods nil
1192 "A list of secondary methods that will be used for reading news.
1193 This is a list where each element is a complete select method (see
1194 `gnus-select-method').
1196 If, for instance, you want to read your mail with the nnml back end,
1197 you could set this variable:
1199 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1201 :type '(repeat gnus-select-method))
1203 (defvar gnus-backup-default-subscribed-newsgroups
1204 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1205 "Default default new newsgroups the first time Gnus is run.
1206 Should be set in paths.el, and shouldn't be touched by the user.")
1208 (defcustom gnus-local-domain nil
1209 "Local domain name without a host name.
1210 The DOMAINNAME environment variable is used instead if it is defined.
1211 If the function `system-name' returns the full Internet name, there is
1212 no need to set this variable."
1213 :group 'gnus-message
1214 :type '(choice (const :tag "default" nil)
1217 (defvar gnus-local-organization nil
1218 "String with a description of what organization (if any) the user belongs to.
1219 Obsolete variable; use `message-user-organization' instead.")
1221 ;; Customization variables
1223 (defcustom gnus-refer-article-method nil
1224 "Preferred method for fetching an article by Message-ID.
1225 If you are reading news from the local spool (with nnspool), fetching
1226 articles by Message-ID is painfully slow. By setting this method to an
1227 nntp method, you might get acceptable results.
1229 The value of this variable must be a valid select method as discussed
1230 in the documentation of `gnus-select-method'.
1232 It can also be a list of select methods, as well as the special symbol
1233 `current', which means to use the current select method. If it is a
1234 list, Gnus will try all the methods in the list until it finds a match."
1236 :type '(choice (const :tag "default" nil)
1238 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1240 (repeat :menu-tag "Try multiple"
1242 :value (current (nnweb "refer" (nnweb-type google)))
1243 (choice :tag "Method"
1245 (const :tag "Google"
1246 (nnweb "refer" (nnweb-type google)))
1247 gnus-select-method))))
1249 (defcustom gnus-group-faq-directory
1250 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1251 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1252 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1253 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1254 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1255 "/ftp@rtfm.mit.edu:/pub/usenet/"
1256 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1257 "/ftp@ftp.sunet.se:/pub/usenet/"
1258 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1259 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1260 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1261 "*Directory where the group FAQs are stored.
1262 This will most commonly be on a remote machine, and the file will be
1263 fetched by ange-ftp.
1265 This variable can also be a list of directories. In that case, the
1266 first element in the list will be used by default. The others can
1267 be used when being prompted for a site.
1269 Note that Gnus uses an aol machine as the default directory. If this
1270 feels fundamentally unclean, just think of it as a way to finally get
1271 something of value back from them.
1273 If the default site is too slow, try one of these:
1275 North America: mirrors.aol.com /pub/rtfm/usenet
1276 ftp.seas.gwu.edu /pub/rtfm
1277 rtfm.mit.edu /pub/usenet
1278 Europe: ftp.uni-paderborn.de /pub/FAQ
1279 src.doc.ic.ac.uk /usenet/news-FAQS
1280 ftp.sunet.se /pub/usenet
1281 ftp.pasteur.fr /pub/FAQ
1282 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1283 hwarang.postech.ac.kr /pub/usenet
1284 ftp.hk.super.net /mirror/faqs"
1285 :group 'gnus-group-various
1286 :type '(choice directory
1287 (repeat directory)))
1289 (defcustom gnus-group-charter-alist
1290 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1291 ("de" . (concat "http://purl.net/charta/" name ".html"))
1292 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1293 ("england" . (concat "http://england.news-admin.org/charters/" name))
1294 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1295 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1296 (gnus-replace-in-string name "europa\\." "") ".html"))
1297 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1298 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1299 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1300 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1301 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1302 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1303 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1304 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1305 (gnus-replace-in-string name "\\." "_") ".html"))
1306 ("milw" . (concat "http://usenet.mil.wi.us/"
1307 (gnus-replace-in-string name "milw\\." "") "-charter"))
1308 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1309 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1310 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1311 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1312 When FORM is evaluated `name' is bound to the name of the group."
1313 :group 'gnus-group-various
1314 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1316 (defcustom gnus-group-fetch-control-use-browse-url nil
1317 "*Non-nil means that control messages are displayed using `browse-url'.
1318 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1320 :group 'gnus-group-various
1323 (defcustom gnus-use-cross-reference t
1324 "*Non-nil means that cross referenced articles will be marked as read.
1325 If nil, ignore cross references. If t, mark articles as read in
1326 subscribed newsgroups. If neither t nor nil, mark as read in all
1329 :type '(choice (const :tag "off" nil)
1330 (const :tag "subscribed" t)
1334 (defcustom gnus-process-mark ?#
1336 :group 'gnus-group-visual
1337 :group 'gnus-summary-marks
1340 (defcustom gnus-large-newsgroup 200
1341 "*The number of articles which indicates a large newsgroup.
1342 If the number of articles in a newsgroup is greater than this value,
1343 confirmation is required for selecting the newsgroup.
1344 If it is nil, no confirmation is required."
1345 :group 'gnus-group-select
1346 :type '(choice (const :tag "No limit" nil)
1349 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1350 "*Non-nil means that the default name of a file to save articles in is the group name.
1351 If it's nil, the directory form of the group name is used instead.
1353 If this variable is a list, and the list contains the element
1354 `not-score', long file names will not be used for score files; if it
1355 contains the element `not-save', long file names will not be used for
1356 saving; and if it contains the element `not-kill', long file names
1357 will not be used for kill files.
1359 Note that the default for this variable varies according to what system
1360 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1361 to nil while on all other systems it defaults to t."
1363 :type '(radio (sexp :format "Non-nil\n"
1364 :match (lambda (widget value)
1365 (and value (not (listp value))))
1368 (checklist (const :format "%v " not-score)
1369 (const :format "%v " not-save)
1372 (defcustom gnus-kill-files-directory gnus-directory
1373 "*Name of the directory where kill files will be stored (default \"~/News\")."
1374 :group 'gnus-score-files
1375 :group 'gnus-score-kill
1378 (defcustom gnus-save-score nil
1379 "*If non-nil, save group scoring info."
1380 :group 'gnus-score-various
1384 (defcustom gnus-use-undo t
1385 "*If non-nil, allow undoing in Gnus group mode buffers."
1389 (defcustom gnus-use-adaptive-scoring nil
1390 "*If non-nil, use some adaptive scoring scheme.
1391 If a list, then the values `word' and `line' are meaningful. The
1392 former will perform adaption on individual words in the subject
1393 header while `line' will perform adaption on several headers."
1395 :group 'gnus-score-adapt
1396 :type '(set (const word) (const line)))
1398 (defcustom gnus-use-cache 'passive
1399 "*If nil, Gnus will ignore the article cache.
1400 If `passive', it will allow entering (and reading) articles
1401 explicitly entered into the cache. If anything else, use the
1402 cache to the full extent of the law."
1405 :type '(choice (const :tag "off" nil)
1406 (const :tag "passive" passive)
1407 (const :tag "active" t)))
1409 (defcustom gnus-use-trees nil
1410 "*If non-nil, display a thread tree buffer."
1414 (defcustom gnus-keep-backlog 20
1415 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1416 If it is a number N, then Gnus will only keep the last N articles
1417 read. If it is neither nil nor a number, Gnus will keep all read
1418 articles. This is not a good idea."
1420 :type '(choice (const :tag "off" nil)
1425 (defcustom gnus-use-nocem nil
1426 "*If non-nil, Gnus will read NoCeM cancel messages."
1430 (defcustom gnus-suppress-duplicates nil
1431 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1435 (defcustom gnus-use-scoring t
1436 "*If non-nil, enable scoring."
1440 (defcustom gnus-summary-prepare-exit-hook
1441 '(gnus-summary-expire-articles)
1442 "*A hook called when preparing to exit from the summary buffer.
1443 It calls `gnus-summary-expire-articles' by default."
1444 :group 'gnus-summary-exit
1447 (defcustom gnus-novice-user t
1448 "*Non-nil means that you are a Usenet novice.
1449 If non-nil, verbose messages may be displayed and confirmations may be
1454 (defcustom gnus-expert-user nil
1455 "*Non-nil means that you will never be asked for confirmation about anything.
1456 That doesn't mean *anything* anything; particularly destructive
1457 commands will still require prompting."
1461 (defcustom gnus-interactive-catchup t
1462 "*If non-nil, require your confirmation when catching up a group."
1463 :group 'gnus-group-select
1466 (defcustom gnus-interactive-exit t
1467 "*If non-nil, require your confirmation when exiting Gnus."
1471 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1472 "*Function for extracting address components from a From header.
1473 Two pre-defined function exist: `gnus-extract-address-components',
1474 which is the default, quite fast, and too simplistic solution, and
1475 `mail-extract-address-components', which works much better, but is
1477 :group 'gnus-summary-format
1478 :type '(radio (function-item gnus-extract-address-components)
1479 (function-item mail-extract-address-components)
1480 (function :tag "Other")))
1482 (defcustom gnus-carpal nil
1483 "*If non-nil, display clickable icons."
1487 (defcustom gnus-shell-command-separator ";"
1488 "String used to separate shell commands."
1492 (defcustom gnus-valid-select-methods
1493 '(("nntp" post address prompt-address physical-address)
1494 ("nnspool" post address)
1495 ("nnvirtual" post-mail virtual prompt-address)
1496 ("nnmbox" mail respool address)
1497 ("nnml" post-mail respool address)
1498 ("nnmh" mail respool address)
1499 ("nndir" post-mail prompt-address physical-address)
1500 ("nneething" none address prompt-address physical-address)
1501 ("nndoc" none address prompt-address)
1502 ("nnbabyl" mail address respool)
1503 ("nnkiboze" post virtual)
1504 ("nnsoup" post-mail address)
1505 ("nndraft" post-mail)
1506 ("nnfolder" mail respool address)
1507 ("nngateway" post-mail address prompt-address physical-address)
1516 ("nnagent" post-mail)
1517 ("nnimap" post-mail address prompt-address physical-address)
1518 ("nnmaildir" mail respool address)
1520 "*An alist of valid select methods.
1521 The first element of each list lists should be a string with the name
1522 of the select method. The other elements may be the category of
1523 this method (i. e., `post', `mail', `none' or whatever) or other
1524 properties that this method has (like being respoolable).
1525 If you implement a new select method, all you should have to change is
1526 this variable. I think."
1528 :type '(repeat (group (string :tag "Name")
1529 (radio-button-choice (const :format "%v " post)
1530 (const :format "%v " mail)
1531 (const :format "%v " none)
1533 (checklist :inline t
1534 (const :format "%v " address)
1535 (const :format "%v " prompt-address)
1536 (const :format "%v " physical-address)
1537 (const :format "%v " virtual)
1540 (defun gnus-redefine-select-method-widget ()
1541 "Recomputes the select-method widget based on the value of
1542 `gnus-valid-select-methods'."
1543 (define-widget 'gnus-select-method 'list
1544 "Widget for entering a select method."
1546 :tag "Select Method"
1547 :args `((choice :tag "Method"
1548 ,@(mapcar (lambda (entry)
1549 (list 'const :format "%v\n"
1550 (intern (car entry))))
1551 gnus-valid-select-methods)
1552 (symbol :tag "other"))
1553 (string :tag "Address")
1554 (repeat :tag "Options"
1558 (sexp :tag "Value"))))))
1560 (gnus-redefine-select-method-widget)
1562 (defcustom gnus-updated-mode-lines '(group article summary tree)
1563 "List of buffers that should update their mode lines.
1564 The list may contain the symbols `group', `article', `tree' and
1565 `summary'. If the corresponding symbol is present, Gnus will keep
1566 that mode line updated with information that may be pertinent.
1567 If this variable is nil, screen refresh may be quicker."
1568 :group 'gnus-various
1569 :type '(set (const group)
1574 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1575 (defcustom gnus-mode-non-string-length nil
1576 "*Max length of mode-line non-string contents.
1577 If this is nil, Gnus will take space as is needed, leaving the rest
1578 of the mode line intact. Note that the default of nil is unlikely
1579 to be desirable; see the manual for further details."
1580 :group 'gnus-various
1581 :type '(choice (const nil)
1584 ;; There should be special validation for this.
1585 (define-widget 'gnus-email-address 'string
1586 "An email address.")
1588 (gnus-define-group-parameter
1591 "Return GROUP's to-address."
1593 "*Alist of group regexps and correspondent to-addresses."
1594 :parameter-type '(gnus-email-address :tag "To Address")
1595 :parameter-document "\
1596 This will be used when doing followups and posts.
1598 This is primarily useful in mail groups that represent closed
1599 mailing lists--mailing lists where it's expected that everybody that
1600 writes to the mailing list is subscribed to it. Since using this
1601 parameter ensures that the mail only goes to the mailing list itself,
1602 it means that members won't receive two copies of your followups.
1604 Using `to-address' will actually work whether the group is foreign or
1605 not. Let's say there's a group on the server that is called
1606 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1607 articles from a mail-to-news gateway. Posting directly to this group
1608 is therefore impossible--you have to send mail to the mailing list
1611 The gnus-group-split mail splitting mechanism will behave as if this
1612 address was listed in gnus-group-split Addresses (see below).")
1614 (gnus-define-group-parameter
1617 "Return GROUP's to-list."
1619 "*Alist of group regexps and correspondent to-lists."
1620 :parameter-type '(gnus-email-address :tag "To List")
1621 :parameter-document "\
1622 This address will be used when doing a `a' in the group.
1624 It is totally ignored when doing a followup--except that if it is
1625 present in a news group, you'll get mail group semantics when doing
1628 The gnus-group-split mail splitting mechanism will behave as if this
1629 address was listed in gnus-group-split Addresses (see below).")
1631 (gnus-define-group-parameter
1635 "Return GROUP's subscription status."
1637 "*Groups which are automatically considered subscribed."
1638 :parameter-type '(const :tag "Subscribed" t)
1639 :parameter-document "\
1640 Gnus assumed that you are subscribed to the To/List address.
1642 When constructing a list of subscribed groups using
1643 `gnus-find-subscribed-addresses', Gnus includes the To address given
1644 above, or the list address (if the To address has not been set).")
1646 (gnus-define-group-parameter
1649 :function gnus-group-auto-expirable-p
1651 "Check whether GROUP is auto-expirable or not."
1652 :variable gnus-auto-expirable-newsgroups
1653 :variable-default nil
1655 "*Groups in which to automatically mark read articles as expirable.
1656 If non-nil, this should be a regexp that should match all groups in
1657 which to perform auto-expiry. This only makes sense for mail groups."
1658 :variable-group nnmail-expire
1659 :variable-type '(choice (const nil)
1661 :parameter-type '(const :tag "Automatic Expire" t)
1663 "All articles that are read will be marked as expirable.")
1665 (gnus-define-group-parameter
1668 :function gnus-group-total-expirable-p
1670 "Check whether GROUP is total-expirable or not."
1671 :variable gnus-total-expirable-newsgroups
1672 :variable-default nil
1674 "*Groups in which to perform expiry of all read articles.
1675 Use with extreme caution. All groups that match this regexp will be
1676 expiring - which means that all read articles will be deleted after
1677 \(say) one week. (This only goes for mail groups and the like, of
1679 :variable-group nnmail-expire
1680 :variable-type '(choice (const nil)
1682 :parameter-type '(const :tag "Total Expire" t)
1684 "All read articles will be put through the expiry process
1686 This happens even if they are not marked as expirable.
1689 (gnus-define-group-parameter
1692 "Return the default charset of GROUP."
1693 :variable gnus-group-charset-alist
1695 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1696 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1697 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1698 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1699 ("\\(^\\|:\\)relcom\\>" koi8-r)
1700 ("\\(^\\|:\\)fido7\\>" koi8-r)
1701 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1702 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1703 ("\\(^\\|:\\)han\\>" euc-kr)
1704 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1705 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1706 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1708 "Alist of regexps (to match group names) and default charsets to be used when reading."
1709 :variable-group gnus-charset
1710 :variable-type '(repeat (list (regexp :tag "Group")
1711 (symbol :tag "Charset")))
1712 :parameter-type '(symbol :tag "Charset")
1713 :parameter-document "\
1714 The default charset to use in the group.")
1716 (gnus-define-group-parameter
1720 "Return a posting method for GROUP."
1721 :variable gnus-post-method-alist
1723 "Alist of regexps (to match group names) and method to be used when
1724 posting an article."
1725 :variable-group gnus-group-foreign
1727 '(choice :tag "Posting Method"
1728 (const :tag "Use native server" native)
1729 (const :tag "Use current server" current)
1730 (list :convert-widget
1732 (list 'sexp :tag "Methods"
1733 :value gnus-select-method))))
1735 "Posting method for this group.")
1737 (gnus-define-group-parameter
1738 large-newsgroup-initial
1741 "Return GROUP's initial input of the number of articles."
1743 "*Alist of group regexps and its initial input of the number of articles."
1744 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1745 (const :tag "All" nil)
1747 :parameter-document "\
1749 This number will be prompted as the initial value of the number of
1750 articles to list when the group is a large newsgroup (see
1751 `gnus-large-newsgroup'). If it is nil, the default value is the
1752 total number of articles in the group.")
1754 ;; The Gnus registry's ignored groups
1755 (gnus-define-group-parameter
1759 "Whether this group should be ignored by the registry."
1760 :variable gnus-registry-ignored-groups
1761 :variable-default nil
1763 "*Groups in which the registry should be turned off."
1764 :variable-group gnus-registry
1765 :variable-type '(repeat
1767 (regexp :tag "Group Name Regular Expression")
1768 (boolean :tag "Ignored")))
1770 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1772 "Whether the Gnus Registry should ignore this group.")
1774 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1775 (defcustom gnus-install-group-spam-parameters t
1776 "*Disable the group parameters for spam detection.
1777 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1781 (when gnus-install-group-spam-parameters
1782 (defvar gnus-group-spam-classification-spam t
1783 "Spam group classification (requires spam.el).
1784 This group contains spam messages. On summary entry, unread messages
1785 will be marked as spam. On summary exit, the specified spam
1786 processors will be invoked on spam-marked messages, then those
1787 messages will be expired, so the spam processor will only see a
1788 spam-marked message once.")
1790 (defvar gnus-group-spam-classification-ham 'ask
1791 "The ham value for the spam group parameter (requires spam.el).
1792 On summary exit, the specified ham processors will be invoked on
1793 ham-marked messages. Exercise caution, since the ham processor will
1794 see the same message more than once because there is no ham message
1797 (gnus-define-group-parameter
1801 "The spam type (spam, ham, or neither) of the group."
1802 :variable gnus-spam-newsgroup-contents
1803 :variable-default nil
1805 "*Groups in which to automatically mark new articles as spam on
1806 summary entry. If non-nil, this should be a list of group name
1807 regexps that should match all groups in which to do automatic spam
1808 tagging, associated with a classification (spam, ham, or neither).
1809 This only makes sense for mail groups."
1810 :variable-group spam
1811 :variable-type '(repeat
1812 (list :tag "Group contents spam/ham classification"
1813 (regexp :tag "Group")
1815 (variable-item gnus-group-spam-classification-spam)
1816 (variable-item gnus-group-spam-classification-ham)
1817 (const :tag "Unclassified" nil))))
1819 :parameter-type '(list :tag "Group contents spam/ham classification"
1820 (choice :tag "Group contents classification for spam sorting"
1821 (variable-item gnus-group-spam-classification-spam)
1822 (variable-item gnus-group-spam-classification-ham)
1823 (const :tag "Unclassified" nil)))
1825 "The spam classification (spam, ham, or neither) of this group.
1826 When a spam group is entered, all unread articles are marked as spam.")
1828 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1829 "OBSOLETE: The ifile summary exit spam processor.")
1831 (defvar gnus-group-spam-exit-processor-stat "stat"
1832 "OBSOLETE: The spam-stat summary exit spam processor.")
1834 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1835 "OBSOLETE: The Bogofilter summary exit spam processor.")
1837 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1838 "OBSOLETE: The Blacklist summary exit spam processor.")
1840 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1841 "OBSOLETE: The Gmane reporting summary exit spam processor.
1842 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1844 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1845 "OBSOLETE: The spamoracle summary exit spam processor.")
1847 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1848 "OBSOLETE: The ifile summary exit ham processor.
1849 Only applicable to non-spam (unclassified and ham) groups.")
1851 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1852 "OBSOLETE: The Bogofilter summary exit ham processor.
1853 Only applicable to non-spam (unclassified and ham) groups.")
1855 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1856 "OBSOLETE: The spam-stat summary exit ham processor.
1857 Only applicable to non-spam (unclassified and ham) groups.")
1859 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1860 "OBSOLETE: The whitelist summary exit ham processor.
1861 Only applicable to non-spam (unclassified and ham) groups.")
1863 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1864 "OBSOLETE: The BBDB summary exit ham processor.
1865 Only applicable to non-spam (unclassified and ham) groups.")
1867 (defvar gnus-group-ham-exit-processor-copy "copy"
1868 "OBSOLETE: The ham copy exit ham processor.
1869 Only applicable to non-spam (unclassified and ham) groups.")
1871 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1872 "OBSOLETE: The spamoracle summary exit ham processor.
1873 Only applicable to non-spam (unclassified and ham) groups.")
1875 (gnus-define-group-parameter
1880 :tag "Spam Summary Exit Processor"
1882 (list :tag "Spam Summary Exit Processor Choices"
1884 (variable-item gnus-group-spam-exit-processor-ifile)
1885 (variable-item gnus-group-spam-exit-processor-stat)
1886 (variable-item gnus-group-spam-exit-processor-bogofilter)
1887 (variable-item gnus-group-spam-exit-processor-blacklist)
1888 (variable-item gnus-group-spam-exit-processor-spamoracle)
1889 (variable-item gnus-group-spam-exit-processor-report-gmane)
1890 (variable-item gnus-group-ham-exit-processor-bogofilter)
1891 (variable-item gnus-group-ham-exit-processor-ifile)
1892 (variable-item gnus-group-ham-exit-processor-stat)
1893 (variable-item gnus-group-ham-exit-processor-whitelist)
1894 (variable-item gnus-group-ham-exit-processor-BBDB)
1895 (variable-item gnus-group-ham-exit-processor-spamoracle)
1896 (variable-item gnus-group-ham-exit-processor-copy)
1897 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1898 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1899 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1900 (const :tag "Spam: ifile" (spam spam-use-ifile))
1901 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1902 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1903 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1904 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1905 (const :tag "Ham: ifile" (ham spam-use-ifile))
1906 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1907 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1908 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1909 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1910 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1911 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1913 "Which spam or ham processors will be applied when the summary is exited."
1914 :variable gnus-spam-process-newsgroups
1915 :variable-default nil
1917 "*Groups in which to automatically process spam or ham articles with
1918 a backend on summary exit. If non-nil, this should be a list of group
1919 name regexps that should match all groups in which to do automatic
1920 spam processing, associated with the appropriate processor."
1921 :variable-group spam
1923 '(repeat :tag "Spam/Ham Processors"
1924 (list :tag "Spam Summary Exit Processor Choices"
1925 (regexp :tag "Group Regexp")
1927 :tag "Spam/Ham Summary Exit Processor"
1928 (variable-item gnus-group-spam-exit-processor-ifile)
1929 (variable-item gnus-group-spam-exit-processor-stat)
1930 (variable-item gnus-group-spam-exit-processor-bogofilter)
1931 (variable-item gnus-group-spam-exit-processor-blacklist)
1932 (variable-item gnus-group-spam-exit-processor-spamoracle)
1933 (variable-item gnus-group-spam-exit-processor-report-gmane)
1934 (variable-item gnus-group-ham-exit-processor-bogofilter)
1935 (variable-item gnus-group-ham-exit-processor-ifile)
1936 (variable-item gnus-group-ham-exit-processor-stat)
1937 (variable-item gnus-group-ham-exit-processor-whitelist)
1938 (variable-item gnus-group-ham-exit-processor-BBDB)
1939 (variable-item gnus-group-ham-exit-processor-spamoracle)
1940 (variable-item gnus-group-ham-exit-processor-copy)
1941 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1942 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1943 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1944 (const :tag "Spam: ifile" (spam spam-use-ifile))
1945 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1946 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1947 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1948 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1949 (const :tag "Ham: ifile" (ham spam-use-ifile))
1950 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1951 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1952 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1953 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1954 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1955 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle)))))
1958 "Which spam or ham processors will be applied when the summary is exited.")
1960 (gnus-define-group-parameter
1964 '(boolean :tag "Spam autodetection")
1966 "Should spam be autodetected (with spam-split) in this group?"
1967 :variable gnus-spam-autodetect
1968 :variable-default nil
1970 "*Groups in which spam should be autodetected when they are entered.
1971 Only unseen articles will be examined, unless
1972 spam-autodetect-recheck-messages is set."
1973 :variable-group spam
1976 :tag "Autodetection setting"
1978 (regexp :tag "Group Regexp")
1981 "Spam autodetection.
1982 Only unseen articles will be examined, unless
1983 spam-autodetect-recheck-messages is set.")
1985 (gnus-define-group-parameter
1986 spam-autodetect-methods
1989 '(choice :tag "Spam autodetection-specific methods"
1992 (set :tag "Use specific methods"
1993 (variable-item spam-use-blacklist)
1994 (variable-item spam-use-regex-headers)
1995 (variable-item spam-use-regex-body)
1996 (variable-item spam-use-whitelist)
1997 (variable-item spam-use-BBDB)
1998 (variable-item spam-use-ifile)
1999 (variable-item spam-use-spamoracle)
2000 (variable-item spam-use-spamassassin)
2001 (variable-item spam-use-spamassassin-headers)
2002 (variable-item spam-use-stat)
2003 (variable-item spam-use-blackholes)
2004 (variable-item spam-use-hashcash)
2005 (variable-item spam-use-bogofilter-headers)
2006 (variable-item spam-use-bogofilter)))
2008 "Methods to be used for autodetection in each group"
2009 :variable gnus-spam-autodetect-methods
2010 :variable-default nil
2012 "*Methods for autodetecting spam per group.
2013 Requires the spam-autodetect parameter. Only unseen articles
2014 will be examined, unless spam-autodetect-recheck-messages is
2016 :variable-group spam
2019 :tag "Autodetection methods"
2021 (regexp :tag "Group Regexp")
2025 (set :tag "Use specific methods"
2026 (variable-item spam-use-blacklist)
2027 (variable-item spam-use-regex-headers)
2028 (variable-item spam-use-regex-body)
2029 (variable-item spam-use-whitelist)
2030 (variable-item spam-use-BBDB)
2031 (variable-item spam-use-ifile)
2032 (variable-item spam-use-spamoracle)
2033 (variable-item spam-use-stat)
2034 (variable-item spam-use-blackholes)
2035 (variable-item spam-use-hashcash)
2036 (variable-item spam-use-spamassassin)
2037 (variable-item spam-use-spamassassin-headers)
2038 (variable-item spam-use-bogofilter-headers)
2039 (variable-item spam-use-bogofilter)))))
2041 "Spam autodetection methods.
2042 Requires the spam-autodetect parameter. Only unseen articles
2043 will be examined, unless spam-autodetect-recheck-messages is
2046 (gnus-define-group-parameter
2047 spam-process-destination
2050 '(choice :tag "Destination for spam-processed articles at summary exit"
2051 (string :tag "Move to a group")
2052 (repeat :tag "Move to multiple groups"
2053 (string :tag "Destination group"))
2054 (const :tag "Expire" nil))
2056 "Where spam-processed articles will go at summary exit."
2057 :variable gnus-spam-process-destinations
2058 :variable-default nil
2060 "*Groups in which to explicitly send spam-processed articles to
2061 another group, or expire them (the default). If non-nil, this should
2062 be a list of group name regexps that should match all groups in which
2063 to do spam-processed article moving, associated with the destination
2064 group or nil for explicit expiration. This only makes sense for
2066 :variable-group spam
2069 :tag "Spam-processed articles destination"
2071 (regexp :tag "Group Regexp")
2073 :tag "Destination for spam-processed articles at summary exit"
2074 (string :tag "Move to a group")
2075 (repeat :tag "Move to multiple groups"
2076 (string :tag "Destination group"))
2077 (const :tag "Expire" nil))))
2079 "Where spam-processed articles will go at summary exit.")
2081 (gnus-define-group-parameter
2082 ham-process-destination
2086 :tag "Destination for ham articles at summary exit from a spam group"
2087 (string :tag "Move to a group")
2088 (repeat :tag "Move to multiple groups"
2089 (string :tag "Destination group"))
2090 (const :tag "Respool" respool)
2091 (const :tag "Do nothing" nil))
2093 "Where ham articles will go at summary exit from a spam group."
2094 :variable gnus-ham-process-destinations
2095 :variable-default nil
2097 "*Groups in which to explicitly send ham articles to
2098 another group, or do nothing (the default). If non-nil, this should
2099 be a list of group name regexps that should match all groups in which
2100 to do ham article moving, associated with the destination
2101 group or nil for explicit ignoring. This only makes sense for
2102 mail groups, and only works in spam groups."
2103 :variable-group spam
2106 :tag "Ham articles destination"
2108 (regexp :tag "Group Regexp")
2110 :tag "Destination for ham articles at summary exit from spam group"
2111 (string :tag "Move to a group")
2112 (repeat :tag "Move to multiple groups"
2113 (string :tag "Destination group"))
2114 (const :tag "Respool" respool)
2115 (const :tag "Expire" nil))))
2117 "Where ham articles will go at summary exit from a spam group.")
2119 (gnus-define-group-parameter
2122 :parameter-type '(list :tag "Ham mark choices"
2124 (variable-item gnus-del-mark)
2125 (variable-item gnus-read-mark)
2126 (variable-item gnus-ticked-mark)
2127 (variable-item gnus-killed-mark)
2128 (variable-item gnus-kill-file-mark)
2129 (variable-item gnus-low-score-mark)))
2132 "Marks considered ham (positively not spam). Such articles will be
2133 processed as ham (non-spam) on group exit. When nil, the global
2134 spam-ham-marks variable takes precedence."
2135 :variable-default '((".*" ((gnus-del-mark
2139 gnus-low-score-mark))))
2140 :variable-group spam
2142 "*Groups in which to explicitly set the ham marks to some value.")
2144 (gnus-define-group-parameter
2147 :parameter-type '(list :tag "Spam mark choices"
2149 (variable-item gnus-spam-mark)
2150 (variable-item gnus-killed-mark)
2151 (variable-item gnus-kill-file-mark)
2152 (variable-item gnus-low-score-mark)))
2155 "Marks considered spam.
2156 Such articles will be processed as spam on group exit. When nil, the global
2157 spam-spam-marks variable takes precedence."
2158 :variable-default '((".*" ((gnus-spam-mark))))
2159 :variable-group spam
2161 "*Groups in which to explicitly set the spam marks to some value."))
2163 (defcustom gnus-group-uncollapsed-levels 1
2164 "Number of group name elements to leave alone when making a short group name."
2165 :group 'gnus-group-visual
2168 (defcustom gnus-group-use-permanent-levels nil
2169 "*If non-nil, once you set a level, Gnus will use this level."
2170 :group 'gnus-group-levels
2175 (defcustom gnus-load-hook nil
2176 "A hook run while Gnus is loaded."
2180 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2181 "A hook called to apply kill files to a group.
2182 This hook is intended to apply a kill file to the selected newsgroup.
2183 The function `gnus-apply-kill-file' is called by default.
2185 Since a general kill file is too heavy to use only for a few
2186 newsgroups, I recommend you to use a lighter hook function. For
2187 example, if you'd like to apply a kill file to articles which contains
2188 a string `rmgroup' in subject in newsgroup `control', you can use the
2191 (setq gnus-apply-kill-hook
2194 (cond ((string-match \"control\" gnus-newsgroup-name)
2195 (gnus-kill \"Subject\" \"rmgroup\")
2196 (gnus-expunge \"X\"))))))"
2197 :group 'gnus-score-kill
2198 :options '(gnus-apply-kill-file)
2201 (defcustom gnus-group-change-level-function nil
2202 "Function run when a group level is changed.
2203 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2204 :group 'gnus-group-levels
2209 (defcustom gnus-visual
2210 '(summary-highlight group-highlight article-highlight
2212 summary-menu group-menu article-menu
2213 tree-highlight menu highlight
2214 browse-menu server-menu
2215 page-marker tree-menu binary-menu pick-menu)
2216 "*Enable visual features.
2217 If `visual' is disabled, there will be no menus and few faces. Most of
2218 the visual customization options below will be ignored. Gnus will use
2219 less space and be faster as a result.
2221 This variable can also be a list of visual elements to switch on. For
2222 instance, to switch off all visual things except menus, you can say:
2224 (setq gnus-visual '(menu))
2226 Valid elements include `summary-highlight', `group-highlight',
2227 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2228 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2229 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2232 :type '(set (const summary-highlight)
2233 (const group-highlight)
2234 (const article-highlight)
2236 (const summary-menu)
2238 (const article-menu)
2239 (const tree-highlight)
2249 ;; Byte-compiler warning.
2250 (defvar gnus-visual)
2251 ;; Find out whether the gnus-visual TYPE is wanted.
2252 (defun gnus-visual-p (&optional type class)
2253 (and gnus-visual ; Has to be non-nil, at least.
2254 (if (not type) ; We don't care about type.
2256 (if (listp gnus-visual) ; It's a list, so we check it.
2257 (or (memq type gnus-visual)
2258 (memq class gnus-visual))
2261 (defcustom gnus-mouse-face
2263 (if (gnus-visual-p 'mouse-face 'highlight)
2264 (if (boundp 'gnus-mouse-face)
2265 (or gnus-mouse-face 'highlight)
2269 "*Face used for group or summary buffer mouse highlighting.
2270 The line beneath the mouse pointer will be highlighted with this
2275 (defcustom gnus-article-save-directory gnus-directory
2276 "*Name of the directory articles will be saved in (default \"~/News\")."
2277 :group 'gnus-article-saving
2280 (defvar gnus-plugged t
2281 "Whether Gnus is plugged or not.")
2283 (defcustom gnus-agent-cache t
2284 "Controls use of the agent cache while plugged.
2285 When set, Gnus will prefer using the locally stored content rather
2286 than re-fetching it from the server. You also need to enable
2287 `gnus-agent' for this to have any affect."
2292 (defcustom gnus-default-charset 'undecided
2293 "Default charset assumed to be used when viewing non-ASCII characters.
2294 This variable is overridden on a group-to-group basis by the
2295 `gnus-group-charset-alist' variable and is only used on groups not
2296 covered by that variable."
2298 :group 'gnus-charset)
2300 ;; Fixme: Doc reference to agent.
2301 (defcustom gnus-agent t
2302 "Whether we want to use the Gnus agent or not.
2304 You may customize gnus-agent to disable its use. However, some
2305 back ends have started to use the agent as a client-side cache.
2306 Disabling the agent may result in noticeable loss of performance."
2311 (defcustom gnus-other-frame-function 'gnus
2312 "Function called by the command `gnus-other-frame'."
2314 :type '(choice (function-item gnus)
2315 (function-item gnus-no-server)
2316 (function-item gnus-slave)
2317 (function-item gnus-slave-no-server)))
2319 (defcustom gnus-other-frame-parameters nil
2320 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2321 This should be an alist for Emacs, or a plist for XEmacs."
2323 :type (if (featurep 'xemacs)
2324 '(repeat (list :inline t :format "%v"
2325 (symbol :tag "Property")
2326 (sexp :tag "Value")))
2327 '(repeat (cons :format "%v"
2328 (symbol :tag "Parameter")
2329 (sexp :tag "Value")))))
2331 (defcustom gnus-user-agent 'emacs-gnus-type
2332 "Which information should be exposed in the User-Agent header.
2334 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2335 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2336 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2337 `emacs-gnus' plus system type\) or a custom string. If you set it to a
2338 string, be sure to use a valid format, see RFC 2616."
2339 :group 'gnus-message
2341 (item :tag "Show Gnus and Emacs versions and system type"
2343 (item :tag "Show Gnus and Emacs versions and system configuration"
2345 (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2346 (item :tag "Show only Gnus version" gnus)
2347 (string :tag "Other")))
2350 ;;; Internal variables
2352 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2353 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2354 (defvar gnus-agent-method-p-cache nil
2355 ; Reset each time gnus-agent-covered-methods is changed else
2356 ; gnus-agent-method-p may mis-report a methods status.
2358 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2359 (defvar gnus-draft-meta-information-header "X-Draft-From")
2360 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2361 (defvar gnus-original-article-buffer " *Original Article*")
2362 (defvar gnus-newsgroup-name nil)
2363 (defvar gnus-ephemeral-servers nil)
2364 (defvar gnus-server-method-cache nil)
2366 (defvar gnus-agent-fetching nil
2367 "Whether Gnus agent is in fetching mode.")
2369 (defvar gnus-agent-covered-methods nil
2370 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2372 (defvar gnus-command-method nil
2373 "Dynamically bound variable that says what the current back end is.")
2375 (defvar gnus-current-select-method nil
2376 "The current method for selecting a newsgroup.")
2378 (defvar gnus-tree-buffer "*Tree*"
2379 "Buffer where Gnus thread trees are displayed.")
2382 (defvar gnus-use-generic-from nil)
2384 ;; Variable holding the user answers to all method prompts.
2385 (defvar gnus-method-history nil)
2387 ;; Variable holding the user answers to all mail method prompts.
2388 (defvar gnus-mail-method-history nil)
2390 ;; Variable holding the user answers to all group prompts.
2391 (defvar gnus-group-history nil)
2393 (defvar gnus-server-alist nil
2394 "List of available servers.")
2396 (defcustom gnus-cache-directory
2397 (nnheader-concat gnus-directory "cache/")
2398 "*The directory where cached articles will be stored."
2402 (defvar gnus-predefined-server-alist
2405 (nnspool-spool-directory ,gnus-cache-directory)
2406 (nnspool-nov-directory ,gnus-cache-directory)
2407 (nnspool-active-file
2408 ,(nnheader-concat gnus-cache-directory "active"))))
2409 "List of predefined (convenience) servers.")
2411 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2413 (defconst gnus-article-mark-lists
2414 '((marked . tick) (replied . reply)
2415 (expirable . expire) (killed . killed)
2416 (bookmarks . bookmark) (dormant . dormant)
2417 (scored . score) (saved . save)
2418 (cached . cache) (downloadable . download)
2419 (unsendable . unsend) (forwarded . forward)
2420 (recent . recent) (seen . seen)))
2422 (defconst gnus-article-special-mark-lists
2428 ;; Propagate flags to server, with the following exceptions:
2429 ;; `seen' is private to each gnus installation
2430 ;; `cache' is a internal gnus flag for each gnus installation
2431 ;; `download' is a agent flag private to each gnus installation
2432 ;; `unsend' are for nndraft groups only
2433 ;; `score' is not a proper mark
2434 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2435 (defconst gnus-article-unpropagated-mark-lists
2436 '(seen cache download unsend score bookmark)
2437 "Marks that shouldn't be propagated to back ends.
2438 Typical marks are those that make no sense in a standalone back end,
2439 such as a mark that says whether an article is stored in the cache
2440 \(which doesn't make sense in a standalone back end).")
2442 (defvar gnus-headers-retrieved-by nil)
2443 (defvar gnus-article-reply nil)
2444 (defvar gnus-override-method nil)
2445 (defvar gnus-article-check-size nil)
2446 (defvar gnus-opened-servers nil)
2448 (defvar gnus-current-kill-article nil)
2450 (defvar gnus-have-read-active-file nil)
2452 (defconst gnus-maintainer
2453 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2454 "The mail address of the Gnus maintainers.")
2456 (defvar gnus-info-nodes
2457 '((gnus-group-mode "(gnus)Group Buffer")
2458 (gnus-summary-mode "(gnus)Summary Buffer")
2459 (gnus-article-mode "(gnus)Article Buffer")
2460 (gnus-server-mode "(gnus)Server Buffer")
2461 (gnus-browse-mode "(gnus)Browse Foreign Server")
2462 (gnus-tree-mode "(gnus)Tree Display"))
2463 "Alist of major modes and related Info nodes.")
2465 (defvar gnus-group-buffer "*Group*")
2466 (defvar gnus-summary-buffer "*Summary*")
2467 (defvar gnus-article-buffer "*Article*")
2468 (defvar gnus-server-buffer "*Server*")
2470 (defvar gnus-slave nil
2471 "Whether this Gnus is a slave or not.")
2473 (defvar gnus-batch-mode nil
2474 "Whether this Gnus is running in batch mode or not.")
2476 (defvar gnus-variable-list
2477 '(gnus-newsrc-options gnus-newsrc-options-n
2478 gnus-newsrc-last-checked-date
2479 gnus-newsrc-alist gnus-server-alist
2480 gnus-killed-list gnus-zombie-list
2481 gnus-topic-topology gnus-topic-alist
2483 "Gnus variables saved in the quick startup file.")
2485 (defvar gnus-newsrc-alist nil
2486 "Assoc list of read articles.
2487 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2489 (defvar gnus-registry-alist nil
2490 "Assoc list of registry data.
2491 gnus-registry.el will populate this if it's loaded.")
2493 (defvar gnus-newsrc-hashtb nil
2494 "Hashtable of `gnus-newsrc-alist'.")
2496 (defvar gnus-killed-list nil
2497 "List of killed newsgroups.")
2499 (defvar gnus-killed-hashtb nil
2500 "Hash table equivalent of `gnus-killed-list'.")
2502 (defvar gnus-zombie-list nil
2503 "List of almost dead newsgroups.")
2505 (defvar gnus-description-hashtb nil
2506 "Descriptions of newsgroups.")
2508 (defvar gnus-list-of-killed-groups nil
2509 "List of newsgroups that have recently been killed by the user.")
2511 (defvar gnus-active-hashtb nil
2512 "Hashtable of active articles.")
2514 (defvar gnus-moderated-hashtb nil
2515 "Hashtable of moderated newsgroups.")
2517 ;; Save window configuration.
2518 (defvar gnus-prev-winconf nil)
2520 (defvar gnus-reffed-article-number nil)
2522 ;;; Let the byte-compiler know that we know about this variable.
2523 (defvar rmail-default-rmail-file)
2525 (defvar gnus-dead-summary nil)
2527 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2528 "Regexp matching invalid groups.")
2530 (defvar gnus-other-frame-object nil
2531 "A frame object which will be created by `gnus-other-frame'.")
2533 ;;; End of variables.
2535 ;; Define some autoload functions Gnus might use.
2538 ;; This little mapcar goes through the list below and marks the
2539 ;; symbols in question as autoloaded functions.
2542 (let ((interactive (nth 1 (memq ':interactive package))))
2546 (when (consp function)
2547 (setq keymap (car (memq 'keymap function)))
2548 (setq function (car function)))
2549 (unless (fboundp function)
2550 (autoload function (car package) nil interactive keymap))))
2551 (if (eq (nth 1 package) ':interactive)
2554 '(("info" :interactive t Info-goto-node)
2556 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2557 ("ps-print" ps-print-preprint)
2558 ("message" :interactive t
2559 message-send-and-exit message-yank-original)
2560 ("babel" babel-as-string)
2561 ("nnmail" nnmail-split-fancy nnmail-article-group)
2562 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2563 ("rmailout" rmail-output rmail-output-to-rmail-file)
2564 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2565 rmail-show-message rmail-summary-exists
2566 rmail-select-summary rmail-update-summary)
2567 ("gnus-audio" :interactive t gnus-audio-play)
2568 ("gnus-xmas" gnus-xmas-splash)
2569 ("gnus-soup" :interactive t
2570 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2571 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2572 ("nnsoup" nnsoup-pack-replies)
2573 ("score-mode" :interactive t gnus-score-mode)
2574 ("gnus-mh" gnus-summary-save-article-folder
2575 gnus-Folder-save-name gnus-folder-save-name)
2576 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2577 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2578 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2579 gnus-demon-add-disconnection gnus-demon-add-handler
2580 gnus-demon-remove-handler)
2581 ("gnus-demon" :interactive t
2582 gnus-demon-init gnus-demon-cancel)
2583 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2584 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2585 gnus-face-from-file)
2586 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2587 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2588 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2589 gnus-nocem-unwanted-article-p)
2590 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2591 gnus-server-server-name)
2592 ("gnus-srvr" gnus-browse-foreign-server)
2593 ("gnus-cite" :interactive t
2594 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2595 gnus-article-hide-citation gnus-article-fill-cited-article
2596 gnus-article-hide-citation-in-followups)
2597 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2598 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2599 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2600 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2601 gnus-cache-possibly-remove-articles gnus-cache-request-article
2602 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2603 gnus-cache-enter-remove-article gnus-cached-article-p
2604 gnus-cache-open gnus-cache-close gnus-cache-update-article
2605 gnus-cache-articles-in-group)
2606 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2607 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2608 ("gnus-score" :interactive t
2609 gnus-summary-increase-score gnus-summary-set-score
2610 gnus-summary-raise-thread gnus-summary-raise-same-subject
2611 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2612 gnus-summary-lower-thread gnus-summary-lower-same-subject
2613 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2614 gnus-summary-current-score gnus-score-delta-default
2615 gnus-score-flush-cache gnus-score-close
2616 gnus-possibly-score-headers gnus-score-followup-article
2617 gnus-score-followup-thread)
2619 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2620 gnus-current-score-file-nondirectory gnus-score-adaptive
2621 gnus-score-find-trace gnus-score-file-name)
2622 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2623 ("gnus-topic" :interactive t gnus-topic-mode)
2624 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2625 gnus-subscribe-topics)
2626 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2627 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2628 ("gnus-uu" :interactive t
2629 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2630 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2631 gnus-uu-mark-by-regexp gnus-uu-mark-all
2632 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2633 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2634 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2635 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2636 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2637 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2638 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2639 gnus-uu-mark-over gnus-uu-post-news)
2640 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2641 ("gnus-msg" (gnus-summary-send-map keymap)
2642 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2643 ("gnus-msg" :interactive t
2644 gnus-group-post-news gnus-group-mail gnus-group-news
2645 gnus-summary-post-news gnus-summary-news-other-window
2646 gnus-summary-followup gnus-summary-followup-with-original
2647 gnus-summary-cancel-article gnus-summary-supersede-article
2648 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2649 gnus-summary-mail-forward gnus-summary-mail-other-window
2650 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2651 gnus-summary-wide-reply gnus-summary-followup-to-mail
2652 gnus-summary-followup-to-mail-with-original gnus-bug
2653 gnus-summary-wide-reply-with-original
2654 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2655 gnus-summary-post-forward)
2656 ("gnus-picon" :interactive t gnus-treat-from-picon)
2657 ("smiley" :interactive t smiley-region)
2658 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2659 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2660 gnus-list-of-unread-articles gnus-list-of-read-articles
2661 gnus-offer-save-summaries gnus-make-thread-indent-array
2662 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2663 gnus-summary-skip-intangible gnus-summary-article-number
2664 gnus-data-header gnus-data-find)
2665 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2666 gnus-group-list-groups gnus-group-first-unread-group
2667 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2668 gnus-group-setup-buffer gnus-group-get-new-news
2669 gnus-group-make-help-group gnus-group-update-group
2670 gnus-group-iterate gnus-group-group-name)
2671 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2672 gnus-backlog-remove-article)
2673 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2674 gnus-article-prepare gnus-article-set-window-start
2675 gnus-article-next-page gnus-article-prev-page
2676 gnus-request-article-this-buffer gnus-article-mode
2677 gnus-article-setup-buffer gnus-narrow-to-page
2678 gnus-article-delete-invisible-text gnus-treat-article)
2679 ("gnus-art" :interactive t
2680 gnus-article-hide-headers gnus-article-hide-boring-headers
2681 gnus-article-treat-overstrike
2682 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2683 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2684 gnus-article-de-base64-unreadable
2685 gnus-article-decode-HZ
2686 gnus-article-wash-html
2687 gnus-article-unsplit-urls
2688 gnus-article-hide-pem gnus-article-hide-signature
2689 gnus-article-strip-leading-blank-lines gnus-article-date-local
2690 gnus-article-date-original gnus-article-date-lapsed
2691 ;; gnus-article-show-all-headers
2692 gnus-article-edit-mode gnus-article-edit-article
2693 gnus-article-edit-done gnus-article-decode-encoded-words
2694 gnus-start-date-timer gnus-stop-date-timer
2695 gnus-mime-view-all-parts)
2696 ("gnus-int" gnus-request-type)
2697 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2698 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2699 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2700 gnus-dup-enter-articles)
2701 ("gnus-range" gnus-copy-sequence)
2702 ("gnus-eform" gnus-edit-form)
2703 ("gnus-move" :interactive t
2704 gnus-group-move-group-to-server gnus-change-server)
2705 ("gnus-logic" gnus-score-advanced)
2706 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2707 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2708 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2709 gnus-async-halt-prefetch)
2710 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2711 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2712 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2713 gnus-summary-set-agent-mark gnus-agent-save-group-info
2714 gnus-agent-request-article gnus-agent-retrieve-headers)
2715 ("gnus-agent" :interactive t
2716 gnus-unplugged gnus-agentize gnus-agent-batch)
2717 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2718 gnus-summary-save-article-vm)
2719 ("compface" uncompface)
2720 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2721 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2722 ("gnus-mlspl" :interactive t gnus-group-split-setup
2723 gnus-group-split-update)
2724 ("gnus-delay" gnus-delay-initialize))))
2726 ;;; gnus-sum.el thingies
2729 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2730 "*The format specification of the lines in the summary buffer.
2732 It works along the same lines as a normal formatting string,
2733 with some simple extensions.
2735 %N Article number, left padded with spaces (string)
2737 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2738 %n Name of the poster (string)
2739 %a Extracted name of the poster (string)
2740 %A Extracted address of the poster (string)
2741 %F Contents of the From: header (string)
2742 %f Contents of the From: or To: headers (string)
2743 %x Contents of the Xref: header (string)
2744 %D Date of the article (string)
2745 %d Date of the article (string) in DD-MMM format
2746 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2747 %M Message-id of the article (string)
2748 %r References of the article (string)
2749 %c Number of characters in the article (integer)
2750 %k Pretty-printed version of the above (string)
2751 For example, \"1.2k\" or \"0.4M\".
2752 %L Number of lines in the article (integer)
2753 %I Indentation based on thread level (a string of spaces)
2754 %B A complex trn-style thread tree (string)
2755 The variables `gnus-sum-thread-*' can be used for customization.
2756 %T A string with two possible values: 80 spaces if the article
2757 is on thread level two or larger and 0 spaces on level one
2758 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2759 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2760 %[ Opening bracket (character, \"[\" or \"<\")
2761 %] Closing bracket (character, \"]\" or \">\")
2762 %> Spaces of length thread-level (string)
2763 %< Spaces of length (- 20 thread-level) (string)
2764 %i Article score (number)
2765 %z Article zcore (character)
2766 %t Number of articles under the current thread (number).
2767 %e Whether the thread is empty or not (character).
2768 %l GroupLens score (string).
2769 %V Total thread score (number).
2770 %P The line number (number).
2771 %O Download mark (character).
2772 %* If present, indicates desired cursor position
2773 (instead of after first colon).
2774 %u User defined specifier. The next character in the format string should
2775 be a letter. Gnus will call the function gnus-user-format-function-X,
2776 where X is the letter following %u. The function will be passed the
2777 current header as argument. The function should return a string, which
2778 will be inserted into the summary just like information from any other
2781 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2782 with care. For reasons of efficiency, Gnus will compute what column
2783 these characters will end up in, and \"hard-code\" that. This means that
2784 it is invalid to have these specs after a variable-length spec. Well,
2785 you might not be arrested, but your summary buffer will look strange,
2786 which is bad enough.
2788 The smart choice is to have these specs as far to the left as
2791 This restriction may disappear in later versions of Gnus.
2793 General format specifiers can also be used.
2794 See Info node `(gnus)Formatting Variables'."
2795 :link '(custom-manual "(gnus)Formatting Variables")
2797 :group 'gnus-summary-format)
2800 ;;; Skeleton keymaps
2803 (defun gnus-suppress-keymap (keymap)
2804 (suppress-keymap keymap)
2805 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2807 (define-key keymap (pop keys) 'undefined))))
2809 (defvar gnus-article-mode-map
2810 (let ((keymap (make-sparse-keymap)))
2811 (gnus-suppress-keymap keymap)
2813 (defvar gnus-summary-mode-map
2814 (let ((keymap (make-keymap)))
2815 (gnus-suppress-keymap keymap)
2817 (defvar gnus-group-mode-map
2818 (let ((keymap (make-keymap)))
2819 (gnus-suppress-keymap keymap)
2824 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2825 ;; If you want the cursor to go somewhere else, set these two
2826 ;; functions in some startup hook to whatever you want.
2827 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2828 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2830 ;;; Various macros and substs.
2832 (defun gnus-header-from (header)
2833 (mail-header-from header))
2835 (defmacro gnus-gethash (string hashtable)
2836 "Get hash value of STRING in HASHTABLE."
2837 `(symbol-value (intern-soft ,string ,hashtable)))
2839 (defmacro gnus-gethash-safe (string hashtable)
2840 "Get hash value of STRING in HASHTABLE.
2841 Return nil if not defined."
2842 `(let ((sym (intern-soft ,string ,hashtable)))
2843 (and (boundp sym) (symbol-value sym))))
2845 (defmacro gnus-sethash (string value hashtable)
2846 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2847 `(set (intern ,string ,hashtable) ,value))
2848 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2850 (defmacro gnus-group-unread (group)
2851 "Get the currently computed number of unread articles in GROUP."
2852 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2854 (defmacro gnus-group-entry (group)
2855 "Get the newsrc entry for GROUP."
2856 `(gnus-gethash ,group gnus-newsrc-hashtb))
2858 (defmacro gnus-active (group)
2859 "Get active info on GROUP."
2860 `(gnus-gethash ,group gnus-active-hashtb))
2862 (defmacro gnus-set-active (group active)
2863 "Set GROUP's active info."
2864 `(gnus-sethash ,group ,active gnus-active-hashtb))
2866 ;; Info access macros.
2868 (defmacro gnus-info-group (info)
2870 (defmacro gnus-info-rank (info)
2872 (defmacro gnus-info-read (info)
2874 (defmacro gnus-info-marks (info)
2876 (defmacro gnus-info-method (info)
2878 (defmacro gnus-info-params (info)
2881 (defmacro gnus-info-level (info)
2882 `(let ((rank (gnus-info-rank ,info)))
2886 (defmacro gnus-info-score (info)
2887 `(let ((rank (gnus-info-rank ,info)))
2888 (or (and (consp rank) (cdr rank)) 0)))
2890 (defmacro gnus-info-set-group (info group)
2891 `(setcar ,info ,group))
2892 (defmacro gnus-info-set-rank (info rank)
2893 `(setcar (nthcdr 1 ,info) ,rank))
2894 (defmacro gnus-info-set-read (info read)
2895 `(setcar (nthcdr 2 ,info) ,read))
2896 (defmacro gnus-info-set-marks (info marks &optional extend)
2898 `(gnus-info-set-entry ,info ,marks 3)
2899 `(setcar (nthcdr 3 ,info) ,marks)))
2900 (defmacro gnus-info-set-method (info method &optional extend)
2902 `(gnus-info-set-entry ,info ,method 4)
2903 `(setcar (nthcdr 4 ,info) ,method)))
2904 (defmacro gnus-info-set-params (info params &optional extend)
2906 `(gnus-info-set-entry ,info ,params 5)
2907 `(setcar (nthcdr 5 ,info) ,params)))
2909 (defun gnus-info-set-entry (info entry number)
2910 ;; Extend the info until we have enough elements.
2911 (while (<= (length info) number)
2912 (nconc info (list nil)))
2914 (setcar (nthcdr number info) entry))
2916 (defmacro gnus-info-set-level (info level)
2917 `(let ((rank (cdr ,info)))
2918 (if (consp (car rank))
2919 (setcar (car rank) ,level)
2920 (setcar rank ,level))))
2921 (defmacro gnus-info-set-score (info score)
2922 `(let ((rank (cdr ,info)))
2923 (if (consp (car rank))
2924 (setcdr (car rank) ,score)
2925 (setcar rank (cons (car rank) ,score)))))
2927 (defmacro gnus-get-info (group)
2928 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2930 ;;; Load the compatibility functions.
2939 (defvar gnus-shutdown-alist nil)
2941 (defun gnus-add-shutdown (function &rest symbols)
2942 "Run FUNCTION whenever one of SYMBOLS is shut down."
2943 (push (cons function symbols) gnus-shutdown-alist))
2945 (defun gnus-shutdown (symbol)
2946 "Shut down everything that waits for SYMBOL."
2947 (let ((alist gnus-shutdown-alist)
2949 (while (setq entry (pop alist))
2950 (when (memq symbol (cdr entry))
2951 (funcall (car entry))))))
2955 ;;; Gnus Utility Functions
2958 (defun gnus-find-subscribed-addresses ()
2959 "Return a regexp matching the addresses of all subscribed mail groups.
2960 It consists of the `to-address' or `to-list' parameter of all groups
2961 with a `subscribed' parameter."
2962 (let (group address addresses)
2963 (dolist (entry (cdr gnus-newsrc-alist))
2964 (setq group (car entry))
2965 (when (gnus-parameter-subscribed group)
2966 (setq address (mail-strip-quoted-names
2967 (or (gnus-group-fast-parameter group 'to-address)
2968 (gnus-group-fast-parameter group 'to-list))))
2970 (add-to-list 'addresses address))))
2972 (list (mapconcat 'regexp-quote addresses "\\|")))))
2974 (defmacro gnus-string-or (&rest strings)
2975 "Return the first element of STRINGS that is a non-blank string.
2976 STRINGS will be evaluated in normal `or' order."
2977 `(gnus-string-or-1 ',strings))
2979 (defun gnus-string-or-1 (strings)
2982 (setq string (eval (pop strings)))
2983 (if (string-match "^[ \t]*$" string)
2985 (setq strings nil)))
2988 (defun gnus-version (&optional arg)
2989 "Version number of this version of Gnus.
2990 If ARG, insert string at point."
2993 (insert (message gnus-version))
2994 (message gnus-version)))
2996 (defun gnus-continuum-version (&optional version)
2997 "Return VERSION as a floating point number."
3000 (setq version gnus-version))
3001 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3002 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3003 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3004 (number (match-string 2 version))
3006 (unless (string-match
3007 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3008 (error "Invalid version string: %s" version))
3009 (setq major (string-to-number (match-string 1 number))
3010 minor (string-to-number (match-string 2 number))
3011 least (if (match-beginning 3)
3012 (string-to-number (match-string 3 number))
3016 (format "%s00%02d%02d"
3017 (if (member alpha '("(ding)" "d"))
3021 (- (mm-char-int (aref (downcase alpha) 0))
3025 (format "%d.%02d%02d" major minor least))))))
3027 (defun gnus-info-find-node (&optional nodename)
3028 "Find Info documentation of Gnus."
3030 ;; Enlarge info window if needed.
3031 (let (gnus-info-buffer)
3032 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3033 (setq gnus-info-buffer (current-buffer))
3034 (gnus-configure-windows 'info)))
3037 ;;; gnus-interactive
3040 (defvar gnus-current-prefix-symbol nil
3041 "Current prefix symbol.")
3043 (defvar gnus-current-prefix-symbols nil
3044 "List of current prefix symbols.")
3046 (defun gnus-interactive (string &optional params)
3047 "Return a list that can be fed to `interactive'.
3048 See `interactive' for full documentation.
3050 Adds the following specs:
3052 y -- The current symbolic prefix.
3053 Y -- A list of the current symbolic prefix(es).
3054 A -- Article number.
3055 H -- Article header.
3059 (while (< i (length string))
3060 (string-match ".\\([^\n]*\\)\n?" string i)
3061 (setq c (aref string i))
3063 (setq prompt (match-string 1 string)))
3064 (setq i (match-end 0))
3065 ;; We basically emulate just about everything that
3066 ;; `interactive' does, but add the specs listed above.
3070 (completing-read prompt obarray 'fboundp t))
3072 (read-buffer prompt (current-buffer) t))
3074 (read-buffer prompt (other-buffer (current-buffer))))
3078 (completing-read prompt obarray 'commandp t))
3082 (read-file-name prompt nil default-directory 'lambda))
3084 (read-file-name prompt nil nil 'lambda))
3086 (read-file-name prompt))
3088 (read-key-sequence prompt))
3090 (error "Not implemented spec"))
3092 (error "Not implemented spec"))
3096 (error "Not implemented spec"))
3098 (string-to-number (read-from-minibuffer prompt)))
3100 (prefix-numeric-value current-prefix-arg))
3106 (read-string prompt))
3108 (intern (read-string prompt)))
3110 (read-variable prompt))
3112 (read-minibuffer prompt))
3114 (eval-minibuffer prompt))
3115 ;; And here the new specs come.
3117 gnus-current-prefix-symbol)
3119 gnus-current-prefix-symbols)
3121 (gnus-group-group-name))
3123 (gnus-summary-skip-intangible)
3124 (or (get-text-property (point) 'gnus-number)
3125 (gnus-summary-last-subject)))
3127 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3129 (error "Non-implemented spec")))
3133 (push (if (< (point) (mark)) (point) (mark)) out)
3134 (push (if (> (point) (mark)) (point) (mark)) out))))
3135 (setq out (delq 'gnus-prefix-nil out))
3138 (defun gnus-symbolic-argument (&optional arg)
3139 "Read a symbolic argument and a command, and then execute command."
3141 (let* ((in-command (this-command-keys))
3142 (command in-command)
3143 gnus-current-prefix-symbols
3144 gnus-current-prefix-symbol
3146 (while (equal in-command command)
3147 (message "%s-" (key-description (this-command-keys)))
3148 (push (intern (char-to-string (read-char))) syms)
3149 (setq command (read-key-sequence nil t)))
3150 (setq gnus-current-prefix-symbols (nreverse syms)
3151 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3152 (call-interactively (key-binding command t))))
3154 ;;; More various functions.
3156 (defsubst gnus-check-backend-function (func group)
3157 "Check whether GROUP supports function FUNC.
3158 GROUP can either be a string (a group name) or a select method."
3160 (let ((method (if (stringp group)
3161 (car (gnus-find-method-for-group group))
3163 (unless (featurep method)
3165 (fboundp (intern (format "%s-%s" method func))))))
3167 (defun gnus-group-read-only-p (&optional group)
3168 "Check whether GROUP supports editing or not.
3169 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3170 that that variable is buffer-local to the summary buffers."
3171 (let ((group (or group gnus-newsgroup-name)))
3172 (not (gnus-check-backend-function 'request-replace-article group))))
3174 (defun gnus-virtual-group-p (group)
3175 "Say whether GROUP is virtual or not."
3176 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3177 gnus-valid-select-methods)))
3179 (defun gnus-news-group-p (group &optional article)
3180 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3181 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3182 t) ;is news of course.
3183 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3184 nil) ;must be mail then.
3185 ((vectorp article) ;Has header info.
3186 (eq (gnus-request-type group (mail-header-id article)) 'news))
3187 ((null article) ;Hasn't header info
3188 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3189 ((< article 0) ;Virtual message
3190 nil) ;we don't know, guess mail.
3191 (t ;Has positive number
3192 (eq (gnus-request-type group article) 'news)))) ;use it.
3194 ;; Returns a list of writable groups.
3195 (defun gnus-writable-groups ()
3196 (let ((alist gnus-newsrc-alist)
3198 (while (setq group (car (pop alist)))
3199 (unless (gnus-group-read-only-p group)
3200 (push group groups)))
3203 ;; Check whether to use long file names.
3204 (defun gnus-use-long-file-name (symbol)
3205 ;; The variable has to be set...
3206 (and gnus-use-long-file-name
3207 ;; If it isn't a list, then we return t.
3208 (or (not (listp gnus-use-long-file-name))
3209 ;; If it is a list, and the list contains `symbol', we
3211 (not (memq symbol gnus-use-long-file-name)))))
3213 ;; Generate a unique new group name.
3214 (defun gnus-generate-new-group-name (leaf)
3217 (while (gnus-group-entry name)
3218 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3221 (defun gnus-ephemeral-group-p (group)
3222 "Say whether GROUP is ephemeral or not."
3223 (gnus-group-get-parameter group 'quit-config t))
3225 (defun gnus-group-quit-config (group)
3226 "Return the quit-config of GROUP."
3227 (gnus-group-get-parameter group 'quit-config t))
3229 (defun gnus-kill-ephemeral-group (group)
3230 "Remove ephemeral GROUP from relevant structures."
3231 (gnus-sethash group nil gnus-newsrc-hashtb))
3233 (defun gnus-simplify-mode-line ()
3234 "Make mode lines a bit simpler."
3235 (setq mode-line-modified (cdr gnus-mode-line-modified))
3236 (when (listp mode-line-format)
3237 (make-local-variable 'mode-line-format)
3238 (setq mode-line-format (copy-sequence mode-line-format))
3239 (when (equal (nth 3 mode-line-format) " ")
3240 (setcar (nthcdr 3 mode-line-format) " "))))
3242 ;;; Servers and groups.
3244 (defsubst gnus-server-add-address (method)
3245 (let ((method-name (symbol-name (car method))))
3246 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3247 (not (assq (intern (concat method-name "-address")) method))
3248 (memq 'physical-address (assq (car method)
3249 gnus-valid-select-methods)))
3250 (append method (list (list (intern (concat method-name "-address"))
3254 (defsubst gnus-server-to-method (server)
3255 "Map virtual server names to select methods."
3256 (or (and server (listp server) server)
3257 (cdr (assoc server gnus-server-method-cache))
3260 ;; Perhaps this is the native server?
3261 (and (equal server "native") gnus-select-method)
3262 ;; It should be in the server alist.
3263 (cdr (assoc server gnus-server-alist))
3264 ;; It could be in the predefined server alist.
3265 (cdr (assoc server gnus-predefined-server-alist))
3266 ;; If not, we look through all the opened server
3267 ;; to see whether we can find it there.
3268 (let ((opened gnus-opened-servers))
3270 (not (equal server (format "%s:%s" (caaar opened)
3274 ;; It could be a named method, search all servers
3275 (let ((servers gnus-secondary-select-methods))
3277 (not (equal server (format "%s:%s" (caar servers)
3281 ;; This could be some sort of foreign server that I
3282 ;; simply haven't opened (yet). Do a brute-force scan
3283 ;; of the entire gnus-newsrc-alist for the server name
3284 ;; of every method. As a side-effect, loads the
3285 ;; gnus-server-method-cache so this only happens once,
3290 (let ((info-method (gnus-info-method info)))
3291 (unless (stringp info-method)
3292 (let ((info-server (gnus-method-to-server info-method)))
3293 (when (equal server info-server)
3294 (setq match info-method))))))
3295 (cdr gnus-newsrc-alist))
3298 (push (cons server result) gnus-server-method-cache))
3301 (defsubst gnus-method-to-server (method)
3303 (setq method (or method gnus-select-method))
3305 ;; Perhaps it is already in the cache.
3306 (mapc (lambda (name-method)
3307 (if (equal (cdr name-method) method)
3308 (throw 'server-name (car name-method))))
3309 gnus-server-method-cache)
3312 (lambda (server-alist)
3313 (mapc (lambda (name-method)
3314 (when (gnus-methods-equal-p (cdr name-method) method)
3315 (unless (member name-method gnus-server-method-cache)
3316 (push name-method gnus-server-method-cache))
3317 (throw 'server-name (car name-method))))
3319 (let ((alists (list gnus-server-alist
3320 gnus-predefined-server-alist)))
3321 (if gnus-select-method
3322 (push (list (cons "native" gnus-select-method)) alists))
3325 (let* ((name (if (member (cadr method) '(nil ""))
3326 (format "%s" (car method))
3327 (format "%s:%s" (car method) (cadr method))))
3328 (name-method (cons name method)))
3329 (unless (member name-method gnus-server-method-cache)
3330 (push name-method gnus-server-method-cache))
3333 (defsubst gnus-server-get-method (group method)
3334 ;; Input either a server name, and extended server name, or a
3335 ;; select method, and return a select method.
3336 (cond ((stringp method)
3337 (gnus-server-to-method method))
3338 ((equal method gnus-select-method)
3340 ((and (stringp (car method))
3342 (gnus-server-extend-method group method))
3345 (equal (cadr method) ""))
3348 (gnus-server-add-address method))))
3350 (defmacro gnus-method-equal (ss1 ss2)
3351 "Say whether two servers are equal."
3355 (and (= (length s1) (length s2))
3357 (while (and s1 (member (car s1) s2))
3361 (defun gnus-methods-equal-p (m1 m2)
3362 (let ((m1 (or m1 gnus-select-method))
3363 (m2 (or m2 gnus-select-method)))
3365 (and (eq (car m1) (car m2))
3366 (or (not (memq 'address (assoc (symbol-name (car m1))
3367 gnus-valid-select-methods)))
3368 (equal (nth 1 m1) (nth 1 m2)))))))
3370 (defun gnus-server-equal (m1 m2)
3371 "Say whether two methods are equal."
3372 (let ((m1 (cond ((null m1) gnus-select-method)
3373 ((stringp m1) (gnus-server-to-method m1))
3375 (m2 (cond ((null m2) gnus-select-method)
3376 ((stringp m2) (gnus-server-to-method m2))
3378 (gnus-method-equal m1 m2)))
3380 (defun gnus-servers-using-backend (backend)
3381 "Return a list of known servers using BACKEND."
3382 (let ((opened gnus-opened-servers)
3385 (when (eq backend (caaar opened))
3386 (push (caar opened) out))
3390 (defun gnus-archive-server-wanted-p ()
3391 "Say whether the user wants to use the archive server."
3393 ((or (not gnus-message-archive-method)
3394 (not gnus-message-archive-group))
3396 ((and gnus-message-archive-method gnus-message-archive-group)
3399 (let ((active (cadr (assq 'nnfolder-active-file
3400 gnus-message-archive-method))))
3402 (file-exists-p active))))))
3404 (defsubst gnus-method-to-server-name (method)
3406 (format "%s" (car method))
3408 (or (assoc (format "%s" (car method))
3409 (gnus-methods-using 'address))
3410 (gnus-server-equal method gnus-message-archive-method))
3412 (not (string= (nth 1 method) "")))
3413 (concat "+" (nth 1 method)))))
3415 (defsubst gnus-method-to-full-server-name (method)
3416 (format "%s+%s" (car method) (nth 1 method)))
3418 (defun gnus-group-prefixed-name (group method &optional full)
3419 "Return the whole name from GROUP and METHOD.
3420 Call with full set to get the fully qualified group name (even if the
3422 (when (stringp method)
3423 (setq method (gnus-server-to-method method)))
3424 (if (or (not method)
3425 (and (not full) (gnus-server-equal method "native"))
3426 ;;;!!! This might not be right. We'll see...
3427 ;(string-match ":" group)
3430 (concat (gnus-method-to-server-name method) ":" group)))
3432 (defun gnus-group-guess-prefixed-name (group)
3433 "Guess the whole name from GROUP and METHOD."
3434 (gnus-group-prefixed-name group (gnus-find-method-for-group
3437 (defun gnus-group-full-name (group method)
3438 "Return the full name from GROUP and METHOD, even if the method is native."
3439 (gnus-group-prefixed-name group method t))
3441 (defun gnus-group-guess-full-name (group)
3442 "Guess the full name from GROUP, even if the method is native."
3443 (if (gnus-group-prefixed-p group)
3445 (gnus-group-full-name group (gnus-find-method-for-group group))))
3447 (defun gnus-group-guess-full-name-from-command-method (group)
3448 "Guess the full name from GROUP, even if the method is native."
3449 (if (gnus-group-prefixed-p group)
3451 (gnus-group-full-name group gnus-command-method)))
3453 (defun gnus-group-real-prefix (group)
3454 "Return the prefix of the current group name."
3456 (if (string-match "^[^:]+:" group)
3457 (substring group 0 (match-end 0))
3461 (defun gnus-group-short-name (group)
3462 "Return the short group name."
3463 (let ((prefix (gnus-group-real-prefix group)))
3464 (if (< 0 (length prefix))
3465 (substring group (length prefix) nil)
3468 (defun gnus-group-prefixed-p (group)
3469 "Return the prefix of the current group name."
3470 (< 0 (length (gnus-group-real-prefix group))))
3472 (defun gnus-summary-buffer-name (group)
3473 "Return the summary buffer name of GROUP."
3474 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3476 (defun gnus-group-method (group)
3477 "Return the server or method used for selecting GROUP.
3478 You should probably use `gnus-find-method-for-group' instead."
3479 (let ((prefix (gnus-group-real-prefix group)))
3480 (if (equal prefix "")
3482 (let ((servers gnus-opened-servers)
3484 backend possible found)
3485 (if (string-match "^[^\\+]+\\+" prefix)
3486 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3487 server (substring prefix (match-end 0) (1- (length prefix))))
3488 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3490 (when (eq (caaar servers) backend)
3491 (setq possible (caar servers))
3492 (when (equal (cadaar servers) server)
3493 (setq found (caar servers))))
3495 (or (car (rassoc found gnus-server-alist))
3497 (car (rassoc possible gnus-server-alist))
3499 (list backend server))))))
3501 (defsubst gnus-native-method-p (method)
3502 "Return whether METHOD is the native select method."
3503 (gnus-method-equal method gnus-select-method))
3505 (defsubst gnus-secondary-method-p (method)
3506 "Return whether METHOD is a secondary select method."
3507 (let ((methods gnus-secondary-select-methods)
3508 (gmethod (inline (gnus-server-get-method nil method))))
3510 (not (gnus-method-equal
3511 (inline (gnus-server-get-method nil (car methods)))
3513 (setq methods (cdr methods)))
3516 (defun gnus-method-simplify (method)
3517 "Return the shortest uniquely identifying string or method for METHOD."
3518 (cond ((stringp method)
3520 ((gnus-native-method-p method)
3522 ((gnus-secondary-method-p method)
3523 (format "%s:%s" (nth 0 method) (nth 1 method)))
3527 (defun gnus-groups-from-server (server)
3528 "Return a list of all groups that are fetched from SERVER."
3529 (let ((alist (cdr gnus-newsrc-alist))
3531 (while (setq info (pop alist))
3532 (when (gnus-server-equal (gnus-info-method info) server)
3533 (push (gnus-info-group info) groups)))
3534 (sort groups 'string<)))
3536 (defun gnus-group-foreign-p (group)
3537 "Say whether a group is foreign or not."
3538 (and (not (gnus-group-native-p group))
3539 (not (gnus-group-secondary-p group))))
3541 (defun gnus-group-native-p (group)
3542 "Say whether the group is native or not."
3543 (not (string-match ":" group)))
3545 (defun gnus-group-secondary-p (group)
3546 "Say whether the group is secondary or not."
3547 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3549 (defun gnus-parameters-get-parameter (group)
3550 "Return the group parameters for GROUP from `gnus-parameters'."
3552 (dolist (elem gnus-parameters)
3553 (when (string-match (car elem) group)
3555 (nconc (gnus-expand-group-parameters
3556 (car elem) (cdr elem) group)
3560 (defun gnus-expand-group-parameter (match value group)
3561 "Use MATCH to expand VALUE in GROUP."
3564 (goto-char (point-min))
3565 (while (re-search-forward match nil t)
3566 (replace-match value))
3569 (defun gnus-expand-group-parameters (match parameters group)
3570 "Go through PARAMETERS and expand them according to the match data."
3572 (dolist (elem parameters)
3573 (if (and (stringp (cdr elem))
3574 (string-match "\\\\[0-9&]" (cdr elem)))
3575 (push (cons (car elem)
3576 (gnus-expand-group-parameter match (cdr elem) group))
3581 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3582 "For GROUP, return the value of SYMBOL.
3584 You should call this in the `gnus-group-buffer' buffer.
3585 The function `gnus-group-find-parameter' will do that for you."
3586 ;; The speed trick: No cons'ing and quit early.
3587 (let* ((params (funcall gnus-group-get-parameter-function group))
3588 ;; Start easy, check the "real" group parameters.
3590 (gnus-group-parameter-value params symbol allow-list t)))
3592 ;; Found results; return them.
3593 (car simple-results)
3594 ;; We didn't found it there, try `gnus-parameters'.
3597 (tail gnus-parameters))
3598 ;; A good old-fashioned non-cl loop.
3600 (setq head (car tail)
3602 ;; The car is regexp matching for matching the group name.
3603 (when (string-match (car head) group)
3604 ;; The cdr is the parameters.
3605 (setq result (gnus-group-parameter-value (cdr head)
3608 ;; Expand if necessary.
3609 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3610 (setq result (gnus-expand-group-parameter (car head)
3612 ;; Exit the loop early.
3617 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3618 "Return the group parameters for GROUP.
3619 If SYMBOL, return the value of that symbol in the group parameters.
3621 If you call this function inside a loop, consider using the faster
3622 `gnus-group-fast-parameter' instead."
3624 (set-buffer gnus-group-buffer)
3626 (gnus-group-fast-parameter group symbol allow-list)
3629 (funcall gnus-group-get-parameter-function group))
3630 (gnus-parameters-get-parameter group)))))
3632 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3633 "Return the group parameters for GROUP.
3634 If SYMBOL, return the value of that symbol in the group parameters.
3635 Most functions should use `gnus-group-find-parameter', which
3636 also examines the topic parameters."
3637 (let ((params (gnus-info-params (gnus-get-info group))))
3639 (gnus-group-parameter-value params symbol allow-list)
3642 (defun gnus-group-parameter-value (params symbol &optional
3643 allow-list present-p)
3644 "Return the value of SYMBOL in group PARAMS."
3645 ;; We only wish to return group parameters (dotted lists) and
3646 ;; not local variables, which may have the same names.
3647 ;; But first we handle single elements...
3648 (or (car (memq symbol params))
3652 (while (setq elem (pop params))
3653 (when (and (consp elem)
3654 (eq (car elem) symbol)
3657 (throw 'found (if present-p (list (cdr elem))
3660 (defun gnus-group-add-parameter (group param)
3661 "Add parameter PARAM to GROUP."
3662 (let ((info (gnus-get-info group)))
3664 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3665 ;; Cons the new param to the old one and update.
3666 (gnus-group-set-info (cons param (gnus-info-params info))
3669 (defun gnus-group-set-parameter (group name value)
3670 "Set parameter NAME to VALUE in GROUP."
3671 (let ((info (gnus-get-info group)))
3673 (gnus-group-remove-parameter group name)
3674 (let ((old-params (gnus-info-params info))
3675 (new-params (list (cons name value))))
3677 (when (or (not (listp (car old-params)))
3678 (not (eq (caar old-params) name)))
3679 (setq new-params (append new-params (list (car old-params)))))
3680 (setq old-params (cdr old-params)))
3681 (gnus-group-set-info new-params group 'params)))))
3683 (defun gnus-group-remove-parameter (group name)
3684 "Remove parameter NAME from GROUP."
3685 (let ((info (gnus-get-info group)))
3687 (let ((params (gnus-info-params info)))
3689 (setq params (delq name params))
3690 (while (assq name params)
3691 (gnus-pull name params))
3692 (gnus-info-set-params info params))))))
3694 (defun gnus-group-add-score (group &optional score)
3695 "Add SCORE to the GROUP score.
3696 If SCORE is nil, add 1 to the score of GROUP."
3697 (let ((info (gnus-get-info group)))
3699 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3701 (defun gnus-short-group-name (group &optional levels)
3702 "Collapse GROUP name LEVELS.
3703 Select methods are stripped and any remote host name is stripped down to
3704 just the host name."
3710 gnus-group-uncollapsed-levels
3712 (while (string-match "\\." group skip)
3713 (setq skip (match-end 0)
3716 ;; Separate foreign select method from group name and collapse.
3717 ;; If method contains a server, collapse to non-domain server name,
3718 ;; otherwise collapse to select method.
3719 (let* ((colon (string-match ":" group))
3720 (server (and colon (substring group 0 colon)))
3721 (plus (and server (string-match "+" server))))
3724 (setq foreign (substring server (+ 1 plus)
3725 (string-match "\\." server))
3726 group (substring group (+ 1 colon)))
3727 (setq foreign server
3728 group (substring group (+ 1 colon))))
3729 (setq foreign (concat foreign ":")))
3730 ;; Collapse group name leaving LEVELS uncollapsed elements
3731 (let* ((slist (split-string group "/"))
3732 (slen (length slist))
3733 (dlist (split-string group "\\."))
3734 (dlen (length dlist))
3746 (setq levels (- glen levels))
3748 (push (if (>= (decf levels) 0)
3749 (if (zerop (length g))
3754 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3756 (defun gnus-narrow-to-body ()
3757 "Narrow to the body of an article."
3760 (goto-char (point-min))
3761 (or (search-forward "\n\n" nil t)
3767 ;;; Kill file handling.
3770 (defun gnus-apply-kill-file ()
3771 "Apply a kill file to the current newsgroup.
3772 Returns the number of articles marked as read."
3773 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3774 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3775 (gnus-apply-kill-file-internal)
3778 (defun gnus-kill-save-kill-buffer ()
3779 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3780 (when (get-file-buffer file)
3782 (set-buffer (get-file-buffer file))
3783 (when (buffer-modified-p)
3785 (kill-buffer (current-buffer))))))
3787 (defcustom gnus-kill-file-name "KILL"
3788 "Suffix of the kill files."
3789 :group 'gnus-score-kill
3790 :group 'gnus-score-files
3793 (defun gnus-newsgroup-kill-file (newsgroup)
3794 "Return the name of a kill file name for NEWSGROUP.
3795 If NEWSGROUP is nil, return the global kill file name instead."
3797 ;; The global KILL file is placed at top of the directory.
3798 ((or (null newsgroup)
3799 (string-equal newsgroup ""))
3800 (expand-file-name gnus-kill-file-name
3801 gnus-kill-files-directory))
3802 ;; Append ".KILL" to newsgroup name.
3803 ((gnus-use-long-file-name 'not-kill)
3804 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3805 "." gnus-kill-file-name)
3806 gnus-kill-files-directory))
3807 ;; Place "KILL" under the hierarchical directory.
3809 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3810 "/" gnus-kill-file-name)
3811 gnus-kill-files-directory))))
3815 (defun gnus-member-of-valid (symbol group)
3816 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3818 (symbol-name (car (gnus-find-method-for-group group)))
3819 gnus-valid-select-methods)))
3821 (defun gnus-method-option-p (method option)
3822 "Return non-nil if select METHOD has OPTION as a parameter."
3823 (when (stringp method)
3824 (setq method (gnus-server-to-method method)))
3825 (memq option (assoc (format "%s" (car method))
3826 gnus-valid-select-methods)))
3828 (defun gnus-similar-server-opened (method)
3829 (let ((opened gnus-opened-servers))
3830 (while (and method opened)
3831 (when (and (equal (cadr method) (cadaar opened))
3832 (equal (car method) (caaar opened))
3833 (not (equal method (caar opened))))
3838 (defun gnus-server-extend-method (group method)
3839 ;; This function "extends" a virtual server. If the server is
3840 ;; "hello", and the select method is ("hello" (my-var "something"))
3841 ;; in the group "alt.alt", this will result in a new virtual server
3842 ;; called "hello+alt.alt".
3843 (if (or (not (inline (gnus-similar-server-opened method)))
3844 (not (cddr method)))
3846 `(,(car method) ,(concat (cadr method) "+" group)
3847 (,(intern (format "%s-address" (car method))) ,(cadr method))
3850 (defun gnus-server-status (method)
3851 "Return the status of METHOD."
3852 (nth 1 (assoc method gnus-opened-servers)))
3854 (defun gnus-group-name-to-method (group)
3855 "Guess a select method based on GROUP."
3856 (if (string-match ":" group)
3857 (let ((server (substring group 0 (match-beginning 0))))
3858 (if (string-match "\\+" server)
3859 (list (intern (substring server 0 (match-beginning 0)))
3860 (substring server (match-end 0)))
3861 (list (intern server) "")))
3862 gnus-select-method))
3864 (defun gnus-server-string (server)
3865 "Return a readable string that describes SERVER."
3866 (let* ((server (gnus-server-to-method server))
3867 (address (nth 1 server)))
3869 (not (zerop (length address))))
3870 (format "%s using %s" address (car server))
3871 (format "%s" (car server)))))
3873 (defun gnus-find-method-for-group (group &optional info)
3874 "Find the select method that GROUP uses."
3875 (or gnus-override-method
3878 (and (not (gnus-group-entry group)) ;; a new group
3879 (gnus-group-name-to-method group))
3880 (let ((info (or info (gnus-get-info group)))
3883 (not (setq method (gnus-info-method info)))
3884 (equal method "native"))
3887 (cond ((stringp method)
3888 (inline (gnus-server-to-method method)))
3889 ((stringp (cadr method))
3890 (inline (gnus-server-extend-method group method)))
3893 (cond ((equal (cadr method) "")
3895 ((null (cadr method))
3896 (list (car method) ""))
3898 (gnus-server-add-address method)))))))
3900 (defun gnus-methods-using (feature)
3901 "Find all methods that have FEATURE."
3902 (let ((valids gnus-valid-select-methods)
3905 (when (memq feature (car valids))
3906 (push (car valids) outs))
3907 (setq valids (cdr valids)))
3911 (autoload 'message-y-or-n-p "message" nil nil 'macro))
3913 (defun gnus-read-group (prompt &optional default)
3914 "Prompt the user for a group name.
3915 Disallow invalid group names."
3920 gnus-invalid-group-regexp
3921 (setq group (read-string (concat prefix prompt)
3922 (cons (or default "") 0)
3923 'gnus-group-history)))
3924 (let ((match (match-string 0 group)))
3925 ;; Might be okay (e.g. for nnimap), so ask the user:
3926 (unless (and (not (string-match "^$\\|:" match))
3928 "Proceed and create group anyway? " t
3929 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3931 Usually, it's dangerous to create a group with this name, because it's not
3932 supported by all back ends and servers. On IMAP servers it should work,
3933 though. If you are really sure, you can proceed anyway and create the group.
3935 You may customize the variable `gnus-invalid-group-regexp', which currently is
3936 set to \"" gnus-invalid-group-regexp
3937 "\", if you want to get rid of this query permanently."))
3938 (setq prefix (format "Invalid group name: \"%s\". " group)
3942 (defun gnus-read-method (prompt)
3943 "Prompt the user for a method.
3944 Allow completion over sensible values."
3945 (let* ((open-servers
3946 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3947 gnus-opened-servers))
3950 (dolist (method gnus-valid-select-methods)
3951 (if (or (memq 'prompt-address method)
3952 (not (assoc (format "%s:" (car method)) open-servers)))
3953 (push method methods)))
3956 (append valid-methods
3958 gnus-predefined-server-alist
3963 nil t nil 'gnus-method-history)))
3966 (setq method gnus-select-method))
3967 ((assoc method gnus-valid-select-methods)
3968 (let ((address (if (memq 'prompt-address
3969 (assoc method gnus-valid-select-methods))
3970 (read-string "Address: ")
3972 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3973 (list (intern method) address))))
3974 ((assoc method servers)
3977 (list (intern method) "")))))
3981 (defun gnus-agent-method-p (method)
3982 "Say whether METHOD is covered by the agent."
3983 (or (eq (car gnus-agent-method-p-cache) method)
3984 (setq gnus-agent-method-p-cache
3986 (member (if (stringp method)
3988 (gnus-method-to-server method)) gnus-agent-covered-methods))))
3989 (cdr gnus-agent-method-p-cache))
3991 (defun gnus-online (method)
3994 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3995 (gnus-agent-method-p method))))
3997 ;;; User-level commands.
4000 (defun gnus-slave-no-server (&optional arg)
4001 "Read network news as a slave, without connecting to the local server."
4003 (gnus-no-server arg t))
4006 (defun gnus-no-server (&optional arg slave)
4008 If ARG is a positive number, Gnus will use that as the startup
4009 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4010 non-nil and not a positive number, Gnus will prompt the user for the
4011 name of an NNTP server to use.
4012 As opposed to `gnus', this command will not connect to the local
4015 (gnus-no-server-1 arg slave))
4018 (defun gnus-slave (&optional arg)
4019 "Read news as a slave."
4021 (gnus arg nil 'slave))
4024 (defun gnus-other-frame (&optional arg display)
4025 "Pop up a frame to read news.
4026 This will call one of the Gnus commands which is specified by the user
4027 option `gnus-other-frame-function' (default `gnus') with the argument
4028 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4029 optional second argument DISPLAY should be a standard display string
4030 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4031 omitted or the function `make-frame-on-display' is not available, the
4032 current display is used."
4034 (if (fboundp 'make-frame-on-display)
4036 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4038 (let ((alive (gnus-alive-p)))
4043 (when (and (or (not display)
4045 (gnus-frame-or-window-display-name
4047 (with-current-buffer (window-buffer window)
4048 (string-match "\\`gnus-"
4049 (symbol-name major-mode))))
4050 (gnus-select-frame-set-input-focus
4051 (setq gnus-other-frame-object (window-frame window)))
4052 (select-window window)
4055 (gnus-select-frame-set-input-focus
4056 (setq gnus-other-frame-object
4058 (make-frame-on-display display gnus-other-frame-parameters)
4059 (make-frame gnus-other-frame-parameters))))
4061 (switch-to-buffer gnus-group-buffer)
4062 (funcall gnus-other-frame-function arg)
4063 (add-hook 'gnus-exit-gnus-hook
4065 (when (and (frame-live-p gnus-other-frame-object)
4067 (delete-frame gnus-other-frame-object))
4068 (setq gnus-other-frame-object nil)))))))
4070 ;;(setq thing ? ; this is a comment
4074 (defun gnus (&optional arg dont-connect slave)
4076 If ARG is non-nil and a positive number, Gnus will use that as the
4077 startup level. If ARG is non-nil and not a positive number, Gnus will
4078 prompt the user for the name of an NNTP server to use."
4080 (unless (byte-code-function-p (symbol-function 'gnus))
4081 (message "You should byte-compile Gnus")
4083 (gnus-1 arg dont-connect slave))
4085 ;; Allow redefinition of Gnus functions.
4091 ;;; gnus.el ends here
projects / gnus / blob