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 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))
38 ;; Make sure it was the right mm-util.
39 (unless (fboundp 'mm-guess-mime-charset)
40 (error "Wrong `mm-util' found in `load-path'. Make sure the Gnus one is found first."))
43 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
47 (defgroup gnus-format nil
48 "Dealing with formatting issues."
51 (defgroup gnus-charset nil
52 "Group character set issues."
53 :link '(custom-manual "(gnus)Charsets")
57 (defgroup gnus-cache nil
59 :link '(custom-manual "(gnus)Article Caching")
62 (defgroup gnus-registry nil
66 (defgroup gnus-start nil
67 "Starting your favorite newsreader."
70 (defgroup gnus-start-server nil
71 "Server options at startup."
74 ;; These belong to gnus-group.el.
75 (defgroup gnus-group nil
77 :link '(custom-manual "(gnus)The Group Buffer")
80 (defgroup gnus-group-foreign nil
82 :link '(custom-manual "(gnus)Foreign Groups")
85 (defgroup gnus-group-new nil
86 "Automatic subscription of new groups."
89 (defgroup gnus-group-levels nil
91 :link '(custom-manual "(gnus)Group Levels")
94 (defgroup gnus-group-select nil
96 :link '(custom-manual "(gnus)Selecting a Group")
99 (defgroup gnus-group-listing nil
100 "Showing slices of the group list."
101 :link '(custom-manual "(gnus)Listing Groups")
104 (defgroup gnus-group-visual nil
105 "Sorting the group buffer."
106 :link '(custom-manual "(gnus)Group Buffer Format")
110 (defgroup gnus-group-various nil
111 "Various group options."
112 :link '(custom-manual "(gnus)Scanning New Messages")
115 ;; These belong to gnus-sum.el.
116 (defgroup gnus-summary nil
118 :link '(custom-manual "(gnus)The Summary Buffer")
121 (defgroup gnus-summary-exit nil
122 "Leaving summary buffers."
123 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
124 :group 'gnus-summary)
126 (defgroup gnus-summary-marks nil
127 "Marks used in summary buffers."
128 :link '(custom-manual "(gnus)Marking Articles")
129 :group 'gnus-summary)
131 (defgroup gnus-thread nil
132 "Ordering articles according to replies."
133 :link '(custom-manual "(gnus)Threading")
134 :group 'gnus-summary)
136 (defgroup gnus-summary-format nil
137 "Formatting of the summary buffer."
138 :link '(custom-manual "(gnus)Summary Buffer Format")
139 :group 'gnus-summary)
141 (defgroup gnus-summary-choose nil
143 :link '(custom-manual "(gnus)Choosing Articles")
144 :group 'gnus-summary)
146 (defgroup gnus-summary-maneuvering nil
147 "Summary movement commands."
148 :link '(custom-manual "(gnus)Summary Maneuvering")
149 :group 'gnus-summary)
151 (defgroup gnus-picon nil
152 "Show pictures of people, domains, and newsgroups."
155 (defgroup gnus-summary-mail nil
156 "Mail group commands."
157 :link '(custom-manual "(gnus)Mail Group Commands")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-sort nil
161 "Sorting the summary buffer."
162 :link '(custom-manual "(gnus)Sorting")
163 :group 'gnus-summary)
165 (defgroup gnus-summary-visual nil
166 "Highlighting and menus in the summary buffer."
167 :link '(custom-manual "(gnus)Summary Highlighting")
169 :group 'gnus-summary)
171 (defgroup gnus-summary-various nil
172 "Various summary buffer options."
173 :link '(custom-manual "(gnus)Various Summary Stuff")
174 :group 'gnus-summary)
176 (defgroup gnus-summary-pick nil
177 "Pick mode in the summary buffer."
178 :link '(custom-manual "(gnus)Pick and Read")
180 :group 'gnus-summary)
182 (defgroup gnus-summary-tree nil
183 "Tree display of threads in the summary buffer."
184 :link '(custom-manual "(gnus)Tree Display")
186 :group 'gnus-summary)
188 ;; Belongs to gnus-uu.el
189 (defgroup gnus-extract-view nil
190 "Viewing extracted files."
191 :link '(custom-manual "(gnus)Viewing Files")
192 :group 'gnus-extract)
194 ;; Belongs to gnus-score.el
195 (defgroup gnus-score nil
196 "Score and kill file handling."
199 (defgroup gnus-score-kill nil
203 (defgroup gnus-score-adapt nil
204 "Adaptive score files."
207 (defgroup gnus-score-default nil
208 "Default values for score files."
211 (defgroup gnus-score-expire nil
212 "Expiring score rules."
215 (defgroup gnus-score-decay nil
216 "Decaying score rules."
219 (defgroup gnus-score-files nil
220 "Score and kill file names."
224 (defgroup gnus-score-various nil
225 "Various scoring and killing options."
229 (defgroup gnus-visual nil
230 "Options controlling the visual fluff."
234 (defgroup gnus-agent nil
235 "Offline support for Gnus."
238 (defgroup gnus-files nil
239 "Files used by Gnus."
242 (defgroup gnus-dribble-file nil
244 :link '(custom-manual "(gnus)Auto Save")
247 (defgroup gnus-newsrc nil
248 "Storing Gnus state."
251 (defgroup gnus-server nil
252 "Options related to newsservers and other servers used by Gnus."
255 (defgroup gnus-server-visual nil
256 "Highlighting and menus in the server buffer."
260 (defgroup gnus-message '((message custom-group))
261 "Composing replies and followups in Gnus."
264 (defgroup gnus-meta nil
265 "Meta variables controlling major portions of Gnus.
266 In general, modifying these variables does not take affect until Gnus
267 is restarted, and sometimes reloaded."
270 (defgroup gnus-various nil
271 "Other Gnus options."
272 :link '(custom-manual "(gnus)Various Various")
275 (defgroup gnus-mime nil
276 "Variables for controlling the Gnus MIME interface."
279 (defgroup gnus-exit nil
281 :link '(custom-manual "(gnus)Exiting Gnus")
284 (defgroup gnus-fun nil
285 "Frivolous Gnus extensions."
286 :link '(custom-manual "(gnus)Exiting Gnus")
289 (defconst gnus-version-number "0.15"
290 "Version number for this version of Gnus.")
292 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
293 "Version string for this version of Gnus.")
295 (defcustom gnus-inhibit-startup-message nil
296 "If non-nil, the startup message will not be displayed.
297 This variable is used before `.gnus.el' is loaded, so it should
298 be set in `.emacs' instead."
302 (defcustom gnus-play-startup-jingle nil
303 "If non-nil, play the Gnus jingle at startup."
307 (unless (fboundp 'gnus-group-remove-excess-properties)
308 (defalias 'gnus-group-remove-excess-properties 'ignore))
310 (unless (fboundp 'gnus-set-text-properties)
311 (defalias 'gnus-set-text-properties 'set-text-properties))
313 (unless (featurep 'gnus-xmas)
314 (defalias 'gnus-make-overlay 'make-overlay)
315 (defalias 'gnus-delete-overlay 'delete-overlay)
316 (defalias 'gnus-overlay-put 'overlay-put)
317 (defalias 'gnus-move-overlay 'move-overlay)
318 (defalias 'gnus-overlay-buffer 'overlay-buffer)
319 (defalias 'gnus-overlay-start 'overlay-start)
320 (defalias 'gnus-overlay-end 'overlay-end)
321 (defalias 'gnus-extent-detached-p 'ignore)
322 (defalias 'gnus-extent-start-open 'ignore)
323 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
324 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
325 (defalias 'gnus-character-to-event 'identity)
326 (defalias 'gnus-add-text-properties 'add-text-properties)
327 (defalias 'gnus-put-text-property 'put-text-property)
328 (defvar gnus-mode-line-image-cache t)
329 (if (fboundp 'find-image)
330 (defun gnus-mode-line-buffer-identification (line)
331 (let ((str (car-safe line)))
332 (if (and (stringp str)
333 (string-match "^Gnus:" str))
334 (progn (add-text-properties
337 (if (eq t gnus-mode-line-image-cache)
338 (setq gnus-mode-line-image-cache
340 '((:type xpm :file "gnus-pointer.xpm"
342 (:type xbm :file "gnus-pointer.xbm"
344 gnus-mode-line-image-cache)
345 'help-echo "This is Gnus")
349 (defalias 'gnus-mode-line-buffer-identification 'identity))
350 (defalias 'gnus-characterp 'numberp)
351 (defalias 'gnus-deactivate-mark 'deactivate-mark)
352 (defalias 'gnus-window-edges 'window-edges)
353 (defalias 'gnus-key-press-event-p 'numberp)
354 ;;(defalias 'gnus-decode-rfc1522 'ignore)
357 ;; We define these group faces here to avoid the display
358 ;; update forced when creating new faces.
360 (defface gnus-group-news-1-face
363 (:foreground "PaleTurquoise" :bold t))
366 (:foreground "ForestGreen" :bold t))
369 "Level 1 newsgroup face.")
371 (defface gnus-group-news-1-empty-face
374 (:foreground "PaleTurquoise"))
377 (:foreground "ForestGreen"))
380 "Level 1 empty newsgroup face.")
382 (defface gnus-group-news-2-face
385 (:foreground "turquoise" :bold t))
388 (:foreground "CadetBlue4" :bold t))
391 "Level 2 newsgroup face.")
393 (defface gnus-group-news-2-empty-face
396 (:foreground "turquoise"))
399 (:foreground "CadetBlue4"))
402 "Level 2 empty newsgroup face.")
404 (defface gnus-group-news-3-face
413 "Level 3 newsgroup face.")
415 (defface gnus-group-news-3-empty-face
424 "Level 3 empty newsgroup face.")
426 (defface gnus-group-news-4-face
435 "Level 4 newsgroup face.")
437 (defface gnus-group-news-4-empty-face
446 "Level 4 empty newsgroup face.")
448 (defface gnus-group-news-5-face
457 "Level 5 newsgroup face.")
459 (defface gnus-group-news-5-empty-face
468 "Level 5 empty newsgroup face.")
470 (defface gnus-group-news-6-face
479 "Level 6 newsgroup face.")
481 (defface gnus-group-news-6-empty-face
490 "Level 6 empty newsgroup face.")
492 (defface gnus-group-news-low-face
495 (:foreground "DarkTurquoise" :bold t))
498 (:foreground "DarkGreen" :bold t))
501 "Low level newsgroup face.")
503 (defface gnus-group-news-low-empty-face
506 (:foreground "DarkTurquoise"))
509 (:foreground "DarkGreen"))
512 "Low level empty newsgroup face.")
514 (defface gnus-group-mail-1-face
517 (:foreground "aquamarine1" :bold t))
520 (:foreground "DeepPink3" :bold t))
523 "Level 1 mailgroup face.")
525 (defface gnus-group-mail-1-empty-face
528 (:foreground "aquamarine1"))
531 (:foreground "DeepPink3"))
533 (:italic t :bold t)))
534 "Level 1 empty mailgroup face.")
536 (defface gnus-group-mail-2-face
539 (:foreground "aquamarine2" :bold t))
542 (:foreground "HotPink3" :bold t))
545 "Level 2 mailgroup face.")
547 (defface gnus-group-mail-2-empty-face
550 (:foreground "aquamarine2"))
553 (:foreground "HotPink3"))
556 "Level 2 empty mailgroup face.")
558 (defface gnus-group-mail-3-face
561 (:foreground "aquamarine3" :bold t))
564 (:foreground "magenta4" :bold t))
567 "Level 3 mailgroup face.")
569 (defface gnus-group-mail-3-empty-face
572 (:foreground "aquamarine3"))
575 (:foreground "magenta4"))
578 "Level 3 empty mailgroup face.")
580 (defface gnus-group-mail-low-face
583 (:foreground "aquamarine4" :bold t))
586 (:foreground "DeepPink4" :bold t))
589 "Low level mailgroup face.")
591 (defface gnus-group-mail-low-empty-face
594 (:foreground "aquamarine4"))
597 (:foreground "DeepPink4"))
600 "Low level empty mailgroup face.")
602 ;; Summary mode faces.
604 (defface gnus-summary-selected-face '((t
606 "Face used for selected articles.")
608 (defface gnus-summary-cancelled-face
610 (:foreground "yellow" :background "black")))
611 "Face used for cancelled articles.")
613 (defface gnus-summary-high-ticked-face
616 (:foreground "pink" :bold t))
619 (:foreground "firebrick" :bold t))
622 "Face used for high interest ticked articles.")
624 (defface gnus-summary-low-ticked-face
627 (:foreground "pink" :italic t))
630 (:foreground "firebrick" :italic t))
633 "Face used for low interest ticked articles.")
635 (defface gnus-summary-normal-ticked-face
638 (:foreground "pink"))
641 (:foreground "firebrick"))
644 "Face used for normal interest ticked articles.")
646 (defface gnus-summary-high-ancient-face
649 (:foreground "SkyBlue" :bold t))
652 (:foreground "RoyalBlue" :bold t))
655 "Face used for high interest ancient articles.")
657 (defface gnus-summary-low-ancient-face
660 (:foreground "SkyBlue" :italic t))
663 (:foreground "RoyalBlue" :italic t))
666 "Face used for low interest ancient articles.")
668 (defface gnus-summary-normal-ancient-face
671 (:foreground "SkyBlue"))
674 (:foreground "RoyalBlue"))
677 "Face used for normal interest ancient articles.")
679 (defface gnus-summary-high-undownloaded-face
682 (:bold t :foreground "cyan4" :bold nil))
683 (((class color) (background dark))
684 (:bold t :foreground "LightGray" :bold nil))
685 (t (:inverse-video t :bold t)))
686 "Face used for high interest uncached articles.")
688 (defface gnus-summary-low-undownloaded-face
691 (:italic t :foreground "cyan4" :bold nil))
692 (((class color) (background dark))
693 (:italic t :foreground "LightGray" :bold nil))
694 (t (:inverse-video t :italic t)))
695 "Face used for low interest uncached articles.")
697 (defface gnus-summary-normal-undownloaded-face
700 (:foreground "cyan4" :bold nil))
701 (((class color) (background dark))
702 (:foreground "LightGray" :bold nil))
703 (t (:inverse-video t)))
704 "Face used for normal interest uncached articles.")
706 (defface gnus-summary-high-unread-face
709 "Face used for high interest unread articles.")
711 (defface gnus-summary-low-unread-face
714 "Face used for low interest unread articles.")
716 (defface gnus-summary-normal-unread-face
719 "Face used for normal interest unread articles.")
721 (defface gnus-summary-high-read-face
724 (:foreground "PaleGreen"
728 (:foreground "DarkGreen"
732 "Face used for high interest read articles.")
734 (defface gnus-summary-low-read-face
737 (:foreground "PaleGreen"
741 (:foreground "DarkGreen"
745 "Face used for low interest read articles.")
747 (defface gnus-summary-normal-read-face
750 (:foreground "PaleGreen"))
753 (:foreground "DarkGreen"))
756 "Face used for normal interest read articles.")
763 (defvar gnus-buffers nil)
765 (defun gnus-get-buffer-create (name)
766 "Do the same as `get-buffer-create', but store the created buffer."
767 (or (get-buffer name)
768 (car (push (get-buffer-create name) gnus-buffers))))
770 (defun gnus-add-buffer ()
771 "Add the current buffer to the list of Gnus buffers."
772 (push (current-buffer) gnus-buffers))
774 (defun gnus-buffers ()
775 "Return a list of live Gnus buffers."
776 (while (and gnus-buffers
777 (not (buffer-name (car gnus-buffers))))
779 (let ((buffers gnus-buffers))
781 (if (buffer-name (cadr buffers))
783 (setcdr buffers (cddr buffers)))))
788 (defvar gnus-group-buffer "*Group*")
791 (autoload 'gnus-play-jingle "gnus-audio"))
793 (defface gnus-splash-face
796 (:foreground "#888888"))
799 (:foreground "#888888"))
802 "Face for the splash screen.")
804 (defun gnus-splash ()
806 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
807 (let ((buffer-read-only nil))
809 (unless gnus-inhibit-startup-message
810 (gnus-group-startup-message)
812 (when gnus-play-startup-jingle
813 (gnus-play-jingle))))))
815 (defun gnus-indent-rigidly (start end arg)
816 "Indent rigidly using only spaces and no tabs."
819 (narrow-to-region start end)
821 (indent-rigidly start end arg)
822 ;; We translate tabs into spaces -- not everybody uses
823 ;; an 8-character tab.
824 (goto-char (point-min))
825 (while (search-forward "\t" nil t)
826 (replace-match " " t t))))))
828 (defvar gnus-simple-splash nil)
830 ;;(format "%02x%02x%02x" 114 66 20) "724214"
832 (defvar gnus-logo-color-alist
833 '((flame "#cc3300" "#ff2200")
834 (pine "#c0cc93" "#f8ffb8")
835 (moss "#a1cc93" "#d2ffb8")
836 (irish "#04cc90" "#05ff97")
837 (sky "#049acc" "#05deff")
838 (tin "#6886cc" "#82b6ff")
839 (velvet "#7c68cc" "#8c82ff")
840 (grape "#b264cc" "#cf7df")
841 (labia "#cc64c2" "#fd7dff")
842 (berry "#cc6485" "#ff7db5")
843 (dino "#724214" "#1e3f03")
844 (oort "#cccccc" "#888888")
845 (storm "#666699" "#99ccff")
846 (pdino "#9999cc" "#99ccff")
847 (purp "#9999cc" "#666699")
848 (neutral "#b4b4b4" "#878787")
849 (september "#bf9900" "#ffcc00"))
850 "Color alist used for the Gnus logo.")
852 (defcustom gnus-logo-color-style 'oort
853 "*Color styles used for the Gnus logo."
854 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
855 gnus-logo-color-alist))
858 (defvar gnus-logo-colors
859 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
860 "Colors used for the Gnus logo.")
862 (defun gnus-group-startup-message (&optional x y)
863 "Insert startup message in current buffer."
864 ;; Insert the message.
868 (fboundp 'find-image)
870 (let* ((data-directory (nnheader-find-etc-directory "gnus"))
872 `((:type xpm :file "gnus.xpm"
874 (("thing" . ,(car gnus-logo-colors))
875 ("shadow" . ,(cadr gnus-logo-colors))
877 ("background" . ,(face-background 'default))))
878 (:type pbm :file "gnus.pbm"
879 ;; Account for the pbm's blackground.
880 :background ,(face-foreground 'gnus-splash-face)
881 :foreground ,(face-background 'default))
882 (:type xbm :file "gnus.xbm"
883 ;; Account for the xbm's blackground.
884 :background ,(face-foreground 'gnus-splash-face)
885 :foreground ,(face-background 'default))))))
887 (let ((size (image-size image)))
888 (insert-char ?\n (max 0 (round (- (window-height)
889 (or y (cdr size)) 1) 2)))
890 (insert-char ?\ (max 0 (round (- (window-width)
891 (or x (car size))) 2)))
892 (insert-image image))
893 (setq gnus-simple-splash nil)
899 _ ___ __ ___ __ _ ___
919 (gnus-indent-rigidly (point-min) (point-max)
920 (/ (max (- (window-width) (or x 46)) 0) 2))
921 (goto-char (point-min))
923 (let* ((pheight (count-lines (point-min) (point-max)))
924 (wheight (window-height))
925 (rest (- wheight pheight)))
926 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
928 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
929 (setq gnus-simple-splash t)))
930 (goto-char (point-min))
931 (setq mode-line-buffer-identification (concat " " gnus-version))
932 (set-buffer-modified-p t))
935 (let ((command (format "%s" this-command)))
936 (if (and (string-match "gnus" command)
937 (not (string-match "gnus-other-frame" command)))
939 (gnus-get-buffer-create gnus-group-buffer))))
946 (defcustom gnus-parameters nil
947 "Alist of group parameters.
950 ((\"mail\\\\..*\" (gnus-show-threads nil)
951 (gnus-use-scoring nil)
952 (gnus-summary-line-format
953 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
956 (\"mail\\\\.me\" (gnus-use-scoring t))
957 (\"list\\\\..*\" (total-expire . t)
958 (broken-reply-to . t)))"
959 :group 'gnus-group-various
960 :type '(repeat (cons regexp
963 (defvar gnus-group-parameters-more nil)
965 (defmacro gnus-define-group-parameter (param &rest rest)
966 "Define a group parameter PARAM.
967 REST is a plist of following:
968 :type One of `bool', `list' or nil.
969 :function The name of the function.
970 :function-document The documentation of the function.
971 :parameter-type The type for customizing the parameter.
972 :parameter-document The documentation for the parameter.
973 :variable The name of the variable.
974 :variable-document The documentation for the variable.
975 :variable-group The group for customizing the variable.
976 :variable-type The type for customizing the variable.
977 :variable-default The default value of the variable."
978 (let* ((type (plist-get rest :type))
979 (parameter-type (plist-get rest :parameter-type))
980 (parameter-document (plist-get rest :parameter-document))
981 (function (or (plist-get rest :function)
982 (intern (format "gnus-parameter-%s" param))))
983 (function-document (or (plist-get rest :function-document) ""))
984 (variable (or (plist-get rest :variable)
985 (intern (format "gnus-parameter-%s-alist" param))))
986 (variable-document (or (plist-get rest :variable-document) ""))
987 (variable-group (plist-get rest :variable-group))
988 (variable-type (or (plist-get rest :variable-type)
990 (list (regexp :tag "Group")
991 ,(car (cdr parameter-type)))))))
992 (variable-default (plist-get rest :variable-default)))
995 `(defcustom ,variable ,variable-default
997 :group 'gnus-group-parameter
998 :group ',variable-group
999 :type ,variable-type)
1000 `(setq gnus-group-parameters-more
1001 (delq (assq ',param gnus-group-parameters-more)
1002 gnus-group-parameters-more))
1003 `(add-to-list 'gnus-group-parameters-more
1006 ,parameter-document))
1008 `(defun ,function (name)
1010 (let ((params (gnus-group-find-parameter name))
1013 ((memq ',param params)
1015 ((setq val (assq ',param params))
1017 ((stringp ,variable)
1018 (string-match ,variable name))
1020 (let ((alist ,variable)
1022 (while (setq elem (pop alist))
1024 (string-match (car elem) name))
1027 (if (consp value) (car value) value))))))
1028 `(defun ,function (name)
1031 (or (gnus-group-find-parameter name ',param ,(and type t))
1032 (let ((alist ,variable)
1034 (while (setq elem (pop alist))
1036 (string-match (car elem) name))
1041 '(if (consp value) (car value) value))))))))))
1043 (defcustom gnus-home-directory "~/"
1044 "Directory variable that specifies the \"home\" directory.
1045 All other Gnus file and directory variables are initialized from this variable."
1049 (defcustom gnus-directory (or (getenv "SAVEDIR")
1050 (nnheader-concat gnus-home-directory "News/"))
1051 "*Directory variable from which all other Gnus file variables are derived.
1053 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1054 This means that other directory variables that are initialized from
1055 this variable won't be set properly if you set this variable in `.gnus.el'.
1056 Set this variable in `.emacs' instead."
1060 (defcustom gnus-default-directory nil
1061 "*Default directory for all Gnus buffers."
1063 :type '(choice (const :tag "current" nil)
1066 ;; Site dependent variables. These variables should be defined in
1069 (defvar gnus-default-nntp-server nil
1070 "Specify a default NNTP server.
1071 This variable should be defined in paths.el, and should never be set
1073 If you want to change servers, you should use `gnus-select-method'.
1074 See the documentation to that variable.")
1076 ;; Don't touch this variable.
1077 (defvar gnus-nntp-service "nntp"
1078 "NNTP service name (\"nntp\" or 119).
1079 This is an obsolete variable, which is scarcely used. If you use an
1080 nntp server for your newsgroup and want to change the port number
1081 used to 899, you would say something along these lines:
1083 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1085 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1086 "A file with only the name of the nntp server in it."
1091 ;; This function is used to check both the environment variable
1092 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1093 ;; an nntp server name default.
1094 (defun gnus-getenv-nntpserver ()
1095 (or (getenv "NNTPSERVER")
1096 (and (file-readable-p gnus-nntpserver-file)
1098 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1099 (insert-file-contents gnus-nntpserver-file)
1100 (let ((name (buffer-string)))
1102 (if (string-match "\\'[ \t\n]*$" name)
1105 (kill-buffer (current-buffer))))))))
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 'gnus-select-method)
1149 (defcustom gnus-message-archive-group nil
1150 "*Name of the group in which to save the messages you've written.
1151 This can either be a string; a list of strings; or an alist
1152 of regexps/functions/forms to be evaluated to return a string (or a list
1153 of strings). The functions are called with the name of the current
1154 group (or nil) as a parameter.
1156 If you want to save your mail in one group and the news articles you
1157 write in another group, you could say something like:
1159 \(setq gnus-message-archive-group
1160 '((if (message-news-p)
1164 Normally the group names returned by this variable should be
1165 unprefixed -- which implicitly means \"store on the archive server\".
1166 However, you may wish to store the message on some other server. In
1167 that case, just return a fully prefixed name of the group --
1168 \"nnml+private:mail.misc\", for instance."
1169 :group 'gnus-message
1170 :type '(choice (const :tag "none" nil)
1175 (defcustom gnus-secondary-servers nil
1176 "List of NNTP servers that the user can choose between interactively.
1177 To make Gnus query you for a server, you have to give `gnus' a
1178 non-numeric prefix - `C-u M-x gnus', in short."
1180 :type '(repeat string))
1182 (defcustom gnus-nntp-server nil
1183 "*The name of the host running the NNTP server.
1184 This variable is semi-obsolete. Use the `gnus-select-method'
1187 :type '(choice (const :tag "disable" nil)
1190 (defcustom gnus-secondary-select-methods nil
1191 "A list of secondary methods that will be used for reading news.
1192 This is a list where each element is a complete select method (see
1193 `gnus-select-method').
1195 If, for instance, you want to read your mail with the nnml back end,
1196 you could set this variable:
1198 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1200 :type '(repeat gnus-select-method))
1202 (defvar gnus-backup-default-subscribed-newsgroups
1203 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1204 "Default default new newsgroups the first time Gnus is run.
1205 Should be set in paths.el, and shouldn't be touched by the user.")
1207 (defcustom gnus-local-domain nil
1208 "Local domain name without a host name.
1209 The DOMAINNAME environment variable is used instead if it is defined.
1210 If the function `system-name' returns the full Internet name, there is
1211 no need to set this variable."
1212 :group 'gnus-message
1213 :type '(choice (const :tag "default" nil)
1216 (defvar gnus-local-organization nil
1217 "String with a description of what organization (if any) the user belongs to.
1218 Obsolete variable; use `message-user-organization' instead.")
1220 ;; Customization variables
1222 (defcustom gnus-refer-article-method nil
1223 "Preferred method for fetching an article by Message-ID.
1224 If you are reading news from the local spool (with nnspool), fetching
1225 articles by Message-ID is painfully slow. By setting this method to an
1226 nntp method, you might get acceptable results.
1228 The value of this variable must be a valid select method as discussed
1229 in the documentation of `gnus-select-method'.
1231 It can also be a list of select methods, as well as the special symbol
1232 `current', which means to use the current select method. If it is a
1233 list, Gnus will try all the methods in the list until it finds a match."
1235 :type '(choice (const :tag "default" nil)
1236 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1238 (repeat :menu-tag "Try multiple"
1240 :value (current (nnweb "refer" (nnweb-type google)))
1241 (choice :tag "Method"
1243 (const :tag "Google"
1244 (nnweb "refer" (nnweb-type google)))
1245 gnus-select-method))))
1247 (defcustom gnus-group-faq-directory
1248 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1249 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1250 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1251 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1252 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1253 "/ftp@rtfm.mit.edu:/pub/usenet/"
1254 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1255 "/ftp@ftp.sunet.se:/pub/usenet/"
1256 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1257 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1258 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1259 "*Directory where the group FAQs are stored.
1260 This will most commonly be on a remote machine, and the file will be
1261 fetched by ange-ftp.
1263 This variable can also be a list of directories. In that case, the
1264 first element in the list will be used by default. The others can
1265 be used when being prompted for a site.
1267 Note that Gnus uses an aol machine as the default directory. If this
1268 feels fundamentally unclean, just think of it as a way to finally get
1269 something of value back from them.
1271 If the default site is too slow, try one of these:
1273 North America: mirrors.aol.com /pub/rtfm/usenet
1274 ftp.seas.gwu.edu /pub/rtfm
1275 rtfm.mit.edu /pub/usenet
1276 Europe: ftp.uni-paderborn.de /pub/FAQ
1277 src.doc.ic.ac.uk /usenet/news-FAQS
1278 ftp.sunet.se /pub/usenet
1279 ftp.pasteur.fr /pub/FAQ
1280 Asia: nctuccca.edu.tw /USENET/FAQ
1281 hwarang.postech.ac.kr /pub/usenet
1282 ftp.hk.super.net /mirror/faqs"
1283 :group 'gnus-group-various
1284 :type '(choice directory
1285 (repeat directory)))
1287 (defcustom gnus-group-charter-alist
1288 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1289 ("de" . (concat "http://purl.net/charta/" name ".html"))
1290 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1291 ("england" . (concat "http://england.news-admin.org/charters/" name))
1292 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1293 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1294 (gnus-replace-in-string name "europa\\." "") ".html"))
1295 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1296 ("aus" . (concat "http://aus.news-admin.org/groupinfo.php/" name))
1297 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1298 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1299 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1300 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1301 ("wales" . (concat "http://www.wales-usenet.org/english/groups/" name ".html"))
1302 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1303 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1304 (gnus-replace-in-string name "\\." "_") ".html"))
1305 ("milw" . (concat "http://usenet.mil.wi.us/"
1306 (gnus-replace-in-string name "milw\\." "") "-charter"))
1307 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1308 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1309 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1310 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1311 When FORM is evaluated `name' is bound to the name of the group."
1312 :group 'gnus-group-various
1313 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1315 (defcustom gnus-group-fetch-control-use-browse-url nil
1316 "*Non-nil means that control messages are displayed using `browse-url'.
1317 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1319 :group 'gnus-group-various
1322 (defcustom gnus-use-cross-reference t
1323 "*Non-nil means that cross referenced articles will be marked as read.
1324 If nil, ignore cross references. If t, mark articles as read in
1325 subscribed newsgroups. If neither t nor nil, mark as read in all
1328 :type '(choice (const :tag "off" nil)
1329 (const :tag "subscribed" t)
1333 (defcustom gnus-process-mark ?#
1335 :group 'gnus-group-visual
1336 :group 'gnus-summary-marks
1339 (defcustom gnus-large-newsgroup 200
1340 "*The number of articles which indicates a large newsgroup.
1341 If the number of articles in a newsgroup is greater than this value,
1342 confirmation is required for selecting the newsgroup.
1343 If it is nil, no confirmation is required."
1344 :group 'gnus-group-select
1345 :type '(choice (const :tag "No limit" nil)
1348 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1349 "*Non-nil means that the default name of a file to save articles in is the group name.
1350 If it's nil, the directory form of the group name is used instead.
1352 If this variable is a list, and the list contains the element
1353 `not-score', long file names will not be used for score files; if it
1354 contains the element `not-save', long file names will not be used for
1355 saving; and if it contains the element `not-kill', long file names
1356 will not be used for kill files.
1358 Note that the default for this variable varies according to what system
1359 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1360 to nil while on all other systems it defaults to t."
1364 (defcustom gnus-kill-files-directory gnus-directory
1365 "*Name of the directory where kill files will be stored (default \"~/News\")."
1366 :group 'gnus-score-files
1367 :group 'gnus-score-kill
1370 (defcustom gnus-save-score nil
1371 "*If non-nil, save group scoring info."
1372 :group 'gnus-score-various
1376 (defcustom gnus-use-undo t
1377 "*If non-nil, allow undoing in Gnus group mode buffers."
1381 (defcustom gnus-use-adaptive-scoring nil
1382 "*If non-nil, use some adaptive scoring scheme.
1383 If a list, then the values `word' and `line' are meaningful. The
1384 former will perform adaption on individual words in the subject
1385 header while `line' will perform adaption on several headers."
1387 :group 'gnus-score-adapt
1388 :type '(set (const word) (const line)))
1390 (defcustom gnus-use-cache 'passive
1391 "*If nil, Gnus will ignore the article cache.
1392 If `passive', it will allow entering (and reading) articles
1393 explicitly entered into the cache. If anything else, use the
1394 cache to the full extent of the law."
1397 :type '(choice (const :tag "off" nil)
1398 (const :tag "passive" passive)
1399 (const :tag "active" t)))
1401 (defcustom gnus-use-trees nil
1402 "*If non-nil, display a thread tree buffer."
1406 (defcustom gnus-use-grouplens nil
1407 "*If non-nil, use GroupLens ratings."
1411 (defcustom gnus-keep-backlog 20
1412 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1413 If it is a number N, then Gnus will only keep the last N articles
1414 read. If it is neither nil nor a number, Gnus will keep all read
1415 articles. This is not a good idea."
1417 :type '(choice (const :tag "off" nil)
1422 (defcustom gnus-use-nocem nil
1423 "*If non-nil, Gnus will read NoCeM cancel messages."
1427 (defcustom gnus-suppress-duplicates nil
1428 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1432 (defcustom gnus-use-scoring t
1433 "*If non-nil, enable scoring."
1437 (defcustom gnus-summary-prepare-exit-hook
1438 '(gnus-summary-expire-articles)
1439 "*A hook called when preparing to exit from the summary buffer.
1440 It calls `gnus-summary-expire-articles' by default."
1441 :group 'gnus-summary-exit
1444 (defcustom gnus-novice-user t
1445 "*Non-nil means that you are a usenet novice.
1446 If non-nil, verbose messages may be displayed and confirmations may be
1451 (defcustom gnus-expert-user nil
1452 "*Non-nil means that you will never be asked for confirmation about anything.
1453 That doesn't mean *anything* anything; particularly destructive
1454 commands will still require prompting."
1458 (defcustom gnus-interactive-catchup t
1459 "*If non-nil, require your confirmation when catching up a group."
1460 :group 'gnus-group-select
1463 (defcustom gnus-interactive-exit t
1464 "*If non-nil, require your confirmation when exiting Gnus."
1468 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1469 "*Function for extracting address components from a From header.
1470 Two pre-defined function exist: `gnus-extract-address-components',
1471 which is the default, quite fast, and too simplistic solution, and
1472 `mail-extract-address-components', which works much better, but is
1474 :group 'gnus-summary-format
1475 :type '(radio (function-item gnus-extract-address-components)
1476 (function-item mail-extract-address-components)
1477 (function :tag "Other")))
1479 (defcustom gnus-carpal nil
1480 "*If non-nil, display clickable icons."
1484 (defcustom gnus-shell-command-separator ";"
1485 "String used to separate to shell commands."
1489 (defcustom gnus-valid-select-methods
1490 '(("nntp" post address prompt-address physical-address)
1491 ("nnspool" post address)
1492 ("nnvirtual" post-mail virtual prompt-address)
1493 ("nnmbox" mail respool address)
1494 ("nnml" post-mail respool address)
1495 ("nnmh" mail respool address)
1496 ("nndir" post-mail prompt-address physical-address)
1497 ("nneething" none address prompt-address physical-address)
1498 ("nndoc" none address prompt-address)
1499 ("nnbabyl" mail address respool)
1500 ("nnkiboze" post virtual)
1501 ("nnsoup" post-mail address)
1502 ("nndraft" post-mail)
1503 ("nnfolder" mail respool address)
1504 ("nngateway" post-mail address prompt-address physical-address)
1513 ("nnagent" post-mail)
1514 ("nnimap" post-mail address prompt-address physical-address)
1515 ("nnmaildir" mail respool address)
1517 "*An alist of valid select methods.
1518 The first element of each list lists should be a string with the name
1519 of the select method. The other elements may be the category of
1520 this method (i. e., `post', `mail', `none' or whatever) or other
1521 properties that this method has (like being respoolable).
1522 If you implement a new select method, all you should have to change is
1523 this variable. I think."
1525 :type '(repeat (group (string :tag "Name")
1526 (radio-button-choice (const :format "%v " post)
1527 (const :format "%v " mail)
1528 (const :format "%v " none)
1530 (checklist :inline t
1531 (const :format "%v " address)
1532 (const :format "%v " prompt-address)
1533 (const :format "%v " physical-address)
1534 (const :format "%v " virtual)
1537 (defun gnus-redefine-select-method-widget ()
1538 "Recomputes the select-method widget based on the value of
1539 `gnus-valid-select-methods'."
1540 (define-widget 'gnus-select-method 'list
1541 "Widget for entering a select method."
1543 :tag "Select Method"
1544 :args `((choice :tag "Method"
1545 ,@(mapcar (lambda (entry)
1546 (list 'const :format "%v\n"
1547 (intern (car entry))))
1548 gnus-valid-select-methods)
1549 (symbol :tag "other"))
1550 (string :tag "Address")
1551 (repeat :tag "Options"
1555 (sexp :tag "Value"))))))
1557 (gnus-redefine-select-method-widget)
1559 (defcustom gnus-updated-mode-lines '(group article summary tree)
1560 "List of buffers that should update their mode lines.
1561 The list may contain the symbols `group', `article', `tree' and
1562 `summary'. If the corresponding symbol is present, Gnus will keep
1563 that mode line updated with information that may be pertinent.
1564 If this variable is nil, screen refresh may be quicker."
1565 :group 'gnus-various
1566 :type '(set (const group)
1571 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1572 (defcustom gnus-mode-non-string-length nil
1573 "*Max length of mode-line non-string contents.
1574 If this is nil, Gnus will take space as is needed, leaving the rest
1575 of the modeline intact. Note that the default of nil is unlikely
1576 to be desirable; see the manual for further details."
1577 :group 'gnus-various
1578 :type '(choice (const nil)
1581 ;; There should be special validation for this.
1582 (define-widget 'gnus-email-address 'string
1585 (gnus-define-group-parameter
1588 "Return GROUP's to-address."
1590 "*Alist of group regexps and correspondent to-addresses."
1591 :parameter-type '(gnus-email-address :tag "To Address")
1592 :parameter-document "\
1593 This will be used when doing followups and posts.
1595 This is primarily useful in mail groups that represent closed
1596 mailing lists--mailing lists where it's expected that everybody that
1597 writes to the mailing list is subscribed to it. Since using this
1598 parameter ensures that the mail only goes to the mailing list itself,
1599 it means that members won't receive two copies of your followups.
1601 Using `to-address' will actually work whether the group is foreign or
1602 not. Let's say there's a group on the server that is called
1603 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1604 articles from a mail-to-news gateway. Posting directly to this group
1605 is therefore impossible--you have to send mail to the mailing list
1608 The gnus-group-split mail splitting mechanism will behave as if this
1609 address was listed in gnus-group-split Addresses (see below).")
1611 (gnus-define-group-parameter
1614 "Return GROUP's to-list."
1616 "*Alist of group regexps and correspondent to-lists."
1617 :parameter-type '(gnus-email-address :tag "To List")
1618 :parameter-document "\
1619 This address will be used when doing a `a' in the group.
1621 It is totally ignored when doing a followup--except that if it is
1622 present in a news group, you'll get mail group semantics when doing
1625 The gnus-group-split mail splitting mechanism will behave as if this
1626 address was listed in gnus-group-split Addresses (see below).")
1628 (gnus-define-group-parameter
1632 "Return GROUP's subscription status."
1634 "*Groups which are automatically considered subscribed."
1635 :parameter-type '(const :tag "Subscribed" t)
1636 :parameter-document "\
1637 Gnus assumed that you are subscribed to the To/List address.
1639 When constructing a list of subscribed groups using
1640 `gnus-find-subscribed-addresses', Gnus includes the To address given
1641 above, or the list address (if the To address has not been set).")
1643 (gnus-define-group-parameter
1646 :function gnus-group-auto-expirable-p
1648 "Check whether GROUP is auto-expirable or not."
1649 :variable gnus-auto-expirable-newsgroups
1650 :variable-default nil
1652 "*Groups in which to automatically mark read articles as expirable.
1653 If non-nil, this should be a regexp that should match all groups in
1654 which to perform auto-expiry. This only makes sense for mail groups."
1655 :variable-group nnmail-expire
1656 :variable-type '(choice (const nil)
1658 :parameter-type '(const :tag "Automatic Expire" t)
1660 "All articles that are read will be marked as expirable.")
1662 (gnus-define-group-parameter
1665 :function gnus-group-total-expirable-p
1667 "Check whether GROUP is total-expirable or not."
1668 :variable gnus-total-expirable-newsgroups
1669 :variable-default nil
1671 "*Groups in which to perform expiry of all read articles.
1672 Use with extreme caution. All groups that match this regexp will be
1673 expiring - which means that all read articles will be deleted after
1674 \(say) one week. (This only goes for mail groups and the like, of
1676 :variable-group nnmail-expire
1677 :variable-type '(choice (const nil)
1679 :parameter-type '(const :tag "Total Expire" t)
1681 "All read articles will be put through the expiry process
1683 This happens even if they are not marked as expirable.
1686 (gnus-define-group-parameter
1689 "Return the default charset of GROUP."
1690 :variable gnus-group-charset-alist
1692 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1693 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1694 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1695 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1696 ("\\(^\\|:\\)relcom\\>" koi8-r)
1697 ("\\(^\\|:\\)fido7\\>" koi8-r)
1698 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1699 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1700 ("\\(^\\|:\\)han\\>" euc-kr)
1701 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1702 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1703 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1705 "Alist of regexps (to match group names) and default charsets to be used when reading."
1706 :variable-group gnus-charset
1707 :variable-type '(repeat (list (regexp :tag "Group")
1708 (symbol :tag "Charset")))
1709 :parameter-type '(symbol :tag "Charset")
1710 :parameter-document "\
1711 The default charset to use in the group.")
1713 (gnus-define-group-parameter
1717 "Return a posting method for GROUP."
1718 :variable gnus-post-method-alist
1720 "Alist of regexps (to match group names) and method to be used when
1721 posting an article."
1722 :variable-group gnus-group-foreign
1724 '(choice :tag "Posting Method"
1725 (const :tag "Use native server" native)
1726 (const :tag "Use current server" current)
1727 (list :convert-widget
1729 (list 'sexp :tag "Methods"
1730 :value gnus-select-method))))
1732 "Posting method for this group.")
1734 (gnus-define-group-parameter
1735 large-newsgroup-initial
1738 "Return GROUP's initial input of the number of articles."
1740 "*Alist of group regexps and its initial input of the number of articles."
1741 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1742 (const :tag "All" nil)
1744 :parameter-document "\
1746 This number will be prompted as the initial value of the number of
1747 articles to list when the group is a large newsgroup (see
1748 `gnus-large-newsgroup'). If it is nil, the default value is the
1749 total number of articles in the group.")
1751 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1752 (defcustom gnus-install-group-spam-parameters t
1753 "*Disable the group parameters for spam detection.
1754 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1758 (when gnus-install-group-spam-parameters
1759 (defvar gnus-group-spam-classification-spam t
1760 "Spam group classification (requires spam.el).
1761 This group contains spam messages. On summary entry, unread messages
1762 will be marked as spam. On summary exit, the specified spam
1763 processors will be invoked on spam-marked messages, then those
1764 messages will be expired, so the spam processor will only see a
1765 spam-marked message once.")
1767 (defvar gnus-group-spam-classification-ham 'ask
1768 "The ham value for the spam group parameter (requires spam.el).
1769 On summary exit, the specified ham processors will be invoked on
1770 ham-marked messages. Exercise caution, since the ham processor will
1771 see the same message more than once because there is no ham message
1774 (gnus-define-group-parameter
1778 "The spam type (spam, ham, or neither) of the group."
1779 :variable gnus-spam-newsgroup-contents
1780 :variable-default nil
1782 "*Groups in which to automatically mark new articles as spam on
1783 summary entry. If non-nil, this should be a list of group name
1784 regexps that should match all groups in which to do automatic spam
1785 tagging, associated with a classification (spam, ham, or neither).
1786 This only makes sense for mail groups."
1787 :variable-group spam
1788 :variable-type '(repeat
1789 (list :tag "Group contents spam/ham classification"
1790 (regexp :tag "Group")
1792 (variable-item gnus-group-spam-classification-spam)
1793 (variable-item gnus-group-spam-classification-ham)
1794 (const :tag "Unclassified" nil))))
1796 :parameter-type '(list :tag "Group contents spam/ham classification"
1797 (choice :tag "Group contents classification for spam sorting"
1798 (variable-item gnus-group-spam-classification-spam)
1799 (variable-item gnus-group-spam-classification-ham)
1800 (const :tag "Unclassified" nil)))
1802 "The spam classification (spam, ham, or neither) of this group.
1803 When a spam group is entered, all unread articles are marked as spam.")
1805 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1806 "The ifile summary exit spam processor.
1807 Only applicable to spam groups.")
1809 (defvar gnus-group-spam-exit-processor-stat "stat"
1810 "The spam-stat summary exit spam processor.
1811 Only applicable to spam groups.")
1813 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1814 "The Bogofilter summary exit spam processor.
1815 Only applicable to spam groups.")
1817 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1818 "The Blacklist summary exit spam processor.
1819 Only applicable to spam groups.")
1821 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1822 "The ifile summary exit ham processor.
1823 Only applicable to non-spam (unclassified and ham) groups.")
1825 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1826 "The Bogofilter summary exit ham processor.
1827 Only applicable to non-spam (unclassified and ham) groups.")
1829 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1830 "The spam-stat summary exit ham processor.
1831 Only applicable to non-spam (unclassified and ham) groups.")
1833 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1834 "The whitelist summary exit ham processor.
1835 Only applicable to non-spam (unclassified and ham) groups.")
1837 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1838 "The BBDB summary exit ham processor.
1839 Only applicable to non-spam (unclassified and ham) groups.")
1841 (gnus-define-group-parameter
1844 :parameter-type '(choice :tag "Spam Summary Exit Processor"
1846 (list :tag "Spam Summary Exit Processor Choices"
1848 (variable-item gnus-group-spam-exit-processor-ifile)
1849 (variable-item gnus-group-spam-exit-processor-stat)
1850 (variable-item gnus-group-spam-exit-processor-bogofilter)
1851 (variable-item gnus-group-spam-exit-processor-blacklist)
1852 (variable-item gnus-group-ham-exit-processor-bogofilter)
1853 (variable-item gnus-group-ham-exit-processor-ifile)
1854 (variable-item gnus-group-ham-exit-processor-stat)
1855 (variable-item gnus-group-ham-exit-processor-whitelist)
1856 (variable-item gnus-group-ham-exit-processor-BBDB))))
1858 "Which spam or ham processors will be applied to the GROUP articles at summary exit."
1859 :variable gnus-spam-process-newsgroups
1860 :variable-default nil
1862 "*Groups in which to automatically process spam or ham articles with
1863 a backend on summary exit. If non-nil, this should be a list of group
1864 name regexps that should match all groups in which to do automatic
1865 spam processing, associated with the appropriate processor. This only makes sense
1867 :variable-group spam
1868 :variable-type '(repeat :tag "Spam/Ham Processors"
1869 (list :tag "Spam Summary Exit Processor Choices"
1870 (regexp :tag "Group Regexp")
1871 (set :tag "Spam/Ham Summary Exit Processor"
1872 (variable-item gnus-group-spam-exit-processor-ifile)
1873 (variable-item gnus-group-spam-exit-processor-stat)
1874 (variable-item gnus-group-spam-exit-processor-bogofilter)
1875 (variable-item gnus-group-spam-exit-processor-blacklist)
1876 (variable-item gnus-group-ham-exit-processor-bogofilter)
1877 (variable-item gnus-group-ham-exit-processor-ifile)
1878 (variable-item gnus-group-ham-exit-processor-stat)
1879 (variable-item gnus-group-ham-exit-processor-whitelist)
1880 (variable-item gnus-group-ham-exit-processor-BBDB))))
1882 "Which spam processors will be applied to the spam or ham GROUP articles at summary exit.")
1884 (gnus-define-group-parameter
1885 spam-process-destination
1886 :parameter-type '(choice :tag "Destination for spam-processed articles at summary exit"
1887 (string :tag "Move to a group")
1888 (const :tag "Expire" nil))
1890 "Where spam-processed articles will go at summary exit."
1891 :variable gnus-spam-process-destinations
1892 :variable-default nil
1894 "*Groups in which to explicitly send spam-processed articles to
1895 another group, or expire them (the default). If non-nil, this should
1896 be a list of group name regexps that should match all groups in which
1897 to do spam-processed article moving, associated with the destination
1898 group or nil for explicit expiration. This only makes sense for
1900 :variable-group spam
1901 :variable-type '(repeat
1902 :tag "Spam-processed articles destination"
1904 (regexp :tag "Group Regexp")
1906 :tag "Destination for spam-processed articles at summary exit"
1907 (string :tag "Move to a group")
1908 (const :tag "Expire" nil))))
1910 "Where spam-processed articles will go at summary exit.")
1912 (gnus-define-group-parameter
1913 ham-process-destination
1914 :parameter-type '(choice
1915 :tag "Destination for ham articles at summary exit from a spam group"
1916 (string :tag "Move to a group")
1917 (const :tag "Do nothing" nil))
1919 "Where ham articles will go at summary exit from a spam group."
1920 :variable gnus-ham-process-destinations
1921 :variable-default nil
1923 "*Groups in which to explicitly send ham articles to
1924 another group, or do nothing (the default). If non-nil, this should
1925 be a list of group name regexps that should match all groups in which
1926 to do ham article moving, associated with the destination
1927 group or nil for explicit ignoring. This only makes sense for
1928 mail groups, and only works in spam groups."
1929 :variable-group spam
1930 :variable-type '(repeat
1931 :tag "Ham articles destination"
1933 (regexp :tag "Group Regexp")
1935 :tag "Destination for ham articles at summary exit from spam group"
1936 (string :tag "Move to a group")
1937 (const :tag "Expire" nil))))
1939 "Where ham articles will go at summary exit from a spam group."))
1941 (defcustom gnus-group-uncollapsed-levels 1
1942 "Number of group name elements to leave alone when making a short group name."
1943 :group 'gnus-group-visual
1946 (defcustom gnus-group-use-permanent-levels nil
1947 "*If non-nil, once you set a level, Gnus will use this level."
1948 :group 'gnus-group-levels
1953 (defcustom gnus-load-hook nil
1954 "A hook run while Gnus is loaded."
1958 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1959 "A hook called to apply kill files to a group.
1960 This hook is intended to apply a kill file to the selected newsgroup.
1961 The function `gnus-apply-kill-file' is called by default.
1963 Since a general kill file is too heavy to use only for a few
1964 newsgroups, I recommend you to use a lighter hook function. For
1965 example, if you'd like to apply a kill file to articles which contains
1966 a string `rmgroup' in subject in newsgroup `control', you can use the
1969 (setq gnus-apply-kill-hook
1972 (cond ((string-match \"control\" gnus-newsgroup-name)
1973 (gnus-kill \"Subject\" \"rmgroup\")
1974 (gnus-expunge \"X\"))))))"
1975 :group 'gnus-score-kill
1976 :options '(gnus-apply-kill-file)
1979 (defcustom gnus-group-change-level-function nil
1980 "Function run when a group level is changed.
1981 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1982 :group 'gnus-group-levels
1987 (defcustom gnus-visual
1988 '(summary-highlight group-highlight article-highlight
1990 summary-menu group-menu article-menu
1991 tree-highlight menu highlight
1992 browse-menu server-menu
1993 page-marker tree-menu binary-menu pick-menu
1995 "*Enable visual features.
1996 If `visual' is disabled, there will be no menus and few faces. Most of
1997 the visual customization options below will be ignored. Gnus will use
1998 less space and be faster as a result.
2000 This variable can also be a list of visual elements to switch on. For
2001 instance, to switch off all visual things except menus, you can say:
2003 (setq gnus-visual '(menu))
2005 Valid elements include `summary-highlight', `group-highlight',
2006 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2007 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2008 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2009 and `grouplens-menu'."
2012 :type '(set (const summary-highlight)
2013 (const group-highlight)
2014 (const article-highlight)
2016 (const summary-menu)
2018 (const article-menu)
2019 (const tree-highlight)
2028 (const grouplens-menu)))
2030 ;; Byte-compiler warning.
2031 (defvar gnus-visual)
2032 ;; Find out whether the gnus-visual TYPE is wanted.
2033 (defun gnus-visual-p (&optional type class)
2034 (and gnus-visual ; Has to be non-nil, at least.
2035 (if (not type) ; We don't care about type.
2037 (if (listp gnus-visual) ; It's a list, so we check it.
2038 (or (memq type gnus-visual)
2039 (memq class gnus-visual))
2042 (defcustom gnus-mouse-face
2044 (if (gnus-visual-p 'mouse-face 'highlight)
2045 (if (boundp 'gnus-mouse-face)
2046 (or gnus-mouse-face 'highlight)
2050 "*Face used for group or summary buffer mouse highlighting.
2051 The line beneath the mouse pointer will be highlighted with this
2056 (defcustom gnus-article-save-directory gnus-directory
2057 "*Name of the directory articles will be saved in (default \"~/News\")."
2058 :group 'gnus-article-saving
2061 (defvar gnus-plugged t
2062 "Whether Gnus is plugged or not.")
2064 (defcustom gnus-agent-cache t
2065 "Whether Gnus use agent cache.
2066 You also need to enable `gnus-agent'."
2071 (defcustom gnus-default-charset (mm-guess-mime-charset)
2072 "Default charset assumed to be used when viewing non-ASCII characters.
2073 This variable is overridden on a group-to-group basis by the
2074 gnus-group-charset-alist variable and is only used on groups not
2075 covered by that variable."
2077 :group 'gnus-charset)
2079 (defcustom gnus-agent t
2080 "Whether we want to use the Gnus agent or not.
2081 Putting (gnus-agentize) in ~/.gnus is obsolete by (setq gnus-agent t)."
2086 (defcustom gnus-other-frame-function 'gnus
2087 "Function called by the command `gnus-other-frame'."
2089 :type '(choice (function-item gnus)
2090 (function-item gnus-no-server)
2091 (function-item gnus-slave)
2092 (function-item gnus-slave-no-server)))
2094 (defcustom gnus-other-frame-parameters nil
2095 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2096 This should be an alist for FSF Emacs, or a plist for XEmacs."
2098 :type (if (featurep 'xemacs)
2099 '(repeat (list :inline t :format "%v"
2100 (symbol :tag "Property")
2101 (sexp :tag "Value")))
2102 '(repeat (cons :format "%v"
2103 (symbol :tag "Parameter")
2104 (sexp :tag "Value")))))
2107 ;;; Internal variables
2109 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2110 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2111 (defvar gnus-draft-meta-information-header "X-Draft-From")
2112 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2113 (defvar gnus-original-article-buffer " *Original Article*")
2114 (defvar gnus-newsgroup-name nil)
2115 (defvar gnus-ephemeral-servers nil)
2116 (defvar gnus-server-method-cache nil)
2118 (defvar gnus-agent-fetching nil
2119 "Whether Gnus agent is in fetching mode.")
2121 (defvar gnus-agent-covered-methods nil)
2123 (defvar gnus-command-method nil
2124 "Dynamically bound variable that says what the current back end is.")
2126 (defvar gnus-current-select-method nil
2127 "The current method for selecting a newsgroup.")
2129 (defvar gnus-tree-buffer "*Tree*"
2130 "Buffer where Gnus thread trees are displayed.")
2133 (defvar gnus-use-generic-from nil)
2135 ;; Variable holding the user answers to all method prompts.
2136 (defvar gnus-method-history nil)
2138 ;; Variable holding the user answers to all mail method prompts.
2139 (defvar gnus-mail-method-history nil)
2141 ;; Variable holding the user answers to all group prompts.
2142 (defvar gnus-group-history nil)
2144 (defvar gnus-server-alist nil
2145 "List of available servers.")
2147 (defcustom gnus-cache-directory
2148 (nnheader-concat gnus-directory "cache/")
2149 "*The directory where cached articles will be stored."
2153 (defvar gnus-predefined-server-alist
2156 (nnspool-spool-directory ,gnus-cache-directory)
2157 (nnspool-nov-directory ,gnus-cache-directory)
2158 (nnspool-active-file
2159 ,(nnheader-concat gnus-cache-directory "active"))))
2160 "List of predefined (convenience) servers.")
2162 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2164 (defconst gnus-article-mark-lists
2165 '((marked . tick) (replied . reply)
2166 (expirable . expire) (killed . killed)
2167 (bookmarks . bookmark) (dormant . dormant)
2168 (scored . score) (saved . save)
2169 (cached . cache) (downloadable . download)
2170 (unsendable . unsend) (forwarded . forward)
2171 (recent . recent) (seen . seen)))
2173 (defconst gnus-article-special-mark-lists
2179 ;; Propagate flags to server, with the following exceptions:
2180 ;; `seen' is private to each gnus installation
2181 ;; `cache' is a internal gnus flag for each gnus installation
2182 ;; `download' is a agent flag private to each gnus installation
2183 ;; `unsend' are for nndraft groups only
2184 ;; `score' is not a proper mark
2185 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2186 (defconst gnus-article-unpropagated-mark-lists
2187 '(seen cache download unsend score bookmark)
2188 "Marks that shouldn't be propagated to back ends.
2189 Typical marks are those that make no sense in a standalone back end,
2190 such as a mark that says whether an article is stored in the cache
2191 \(which doesn't make sense in a standalone back end).")
2193 (defvar gnus-headers-retrieved-by nil)
2194 (defvar gnus-article-reply nil)
2195 (defvar gnus-override-method nil)
2196 (defvar gnus-article-check-size nil)
2197 (defvar gnus-opened-servers nil)
2199 (defvar gnus-current-kill-article nil)
2201 (defvar gnus-have-read-active-file nil)
2203 (defconst gnus-maintainer
2204 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2205 "The mail address of the Gnus maintainers.")
2207 (defvar gnus-info-nodes
2208 '((gnus-group-mode "(gnus)Group Buffer")
2209 (gnus-summary-mode "(gnus)Summary Buffer")
2210 (gnus-article-mode "(gnus)Article Buffer")
2211 (gnus-server-mode "(gnus)Server Buffer")
2212 (gnus-browse-mode "(gnus)Browse Foreign Server")
2213 (gnus-tree-mode "(gnus)Tree Display"))
2214 "Alist of major modes and related Info nodes.")
2216 (defvar gnus-group-buffer "*Group*")
2217 (defvar gnus-summary-buffer "*Summary*")
2218 (defvar gnus-article-buffer "*Article*")
2219 (defvar gnus-server-buffer "*Server*")
2221 (defvar gnus-slave nil
2222 "Whether this Gnus is a slave or not.")
2224 (defvar gnus-batch-mode nil
2225 "Whether this Gnus is running in batch mode or not.")
2227 (defvar gnus-variable-list
2228 '(gnus-newsrc-options gnus-newsrc-options-n
2229 gnus-newsrc-last-checked-date
2230 gnus-newsrc-alist gnus-server-alist
2231 gnus-killed-list gnus-zombie-list
2232 gnus-topic-topology gnus-topic-alist
2233 gnus-agent-covered-methods gnus-format-specs)
2234 "Gnus variables saved in the quick startup file.")
2236 (defvar gnus-newsrc-alist nil
2237 "Assoc list of read articles.
2238 gnus-newsrc-hashtb should be kept so that both hold the same information.")
2240 (defvar gnus-newsrc-hashtb nil
2241 "Hashtable of gnus-newsrc-alist.")
2243 (defvar gnus-killed-list nil
2244 "List of killed newsgroups.")
2246 (defvar gnus-killed-hashtb nil
2247 "Hash table equivalent of gnus-killed-list.")
2249 (defvar gnus-zombie-list nil
2250 "List of almost dead newsgroups.")
2252 (defvar gnus-description-hashtb nil
2253 "Descriptions of newsgroups.")
2255 (defvar gnus-list-of-killed-groups nil
2256 "List of newsgroups that have recently been killed by the user.")
2258 (defvar gnus-active-hashtb nil
2259 "Hashtable of active articles.")
2261 (defvar gnus-moderated-hashtb nil
2262 "Hashtable of moderated newsgroups.")
2264 ;; Save window configuration.
2265 (defvar gnus-prev-winconf nil)
2267 (defvar gnus-reffed-article-number nil)
2269 ;;; Let the byte-compiler know that we know about this variable.
2270 (defvar rmail-default-rmail-file)
2272 (defvar gnus-dead-summary nil)
2274 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2275 "Regexp matching invalid groups.")
2277 (defvar gnus-other-frame-object nil
2278 "A frame object which will be created by `gnus-other-frame'.")
2280 ;;; End of variables.
2282 ;; Define some autoload functions Gnus might use.
2285 ;; This little mapcar goes through the list below and marks the
2286 ;; symbols in question as autoloaded functions.
2289 (let ((interactive (nth 1 (memq ':interactive package))))
2293 (when (consp function)
2294 (setq keymap (car (memq 'keymap function)))
2295 (setq function (car function)))
2296 (unless (fboundp function)
2297 (autoload function (car package) nil interactive keymap))))
2298 (if (eq (nth 1 package) ':interactive)
2301 '(("info" :interactive t Info-goto-node)
2303 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2304 ("ps-print" ps-print-preprint)
2305 ("message" :interactive t
2306 message-send-and-exit message-yank-original)
2307 ("babel" babel-as-string)
2308 ("nnmail" nnmail-split-fancy nnmail-article-group)
2309 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2310 ("rmailout" rmail-output rmail-output-to-rmail-file)
2311 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2312 rmail-show-message rmail-summary-exists
2313 rmail-select-summary rmail-update-summary)
2314 ("gnus-audio" :interactive t gnus-audio-play)
2315 ("gnus-xmas" gnus-xmas-splash)
2316 ("gnus-soup" :interactive t
2317 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2318 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2319 ("nnsoup" nnsoup-pack-replies)
2320 ("score-mode" :interactive t gnus-score-mode)
2321 ("gnus-mh" gnus-summary-save-article-folder
2322 gnus-Folder-save-name gnus-folder-save-name)
2323 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2324 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2325 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2326 gnus-demon-add-disconnection gnus-demon-add-handler
2327 gnus-demon-remove-handler)
2328 ("gnus-demon" :interactive t
2329 gnus-demon-init gnus-demon-cancel)
2330 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2331 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2332 gnus-face-from-file)
2333 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2334 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2335 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2336 gnus-nocem-unwanted-article-p)
2337 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2338 gnus-server-server-name)
2339 ("gnus-srvr" gnus-browse-foreign-server)
2340 ("gnus-cite" :interactive t
2341 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2342 gnus-article-hide-citation gnus-article-fill-cited-article
2343 gnus-article-hide-citation-in-followups)
2344 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2345 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2346 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2347 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2348 gnus-cache-possibly-remove-articles gnus-cache-request-article
2349 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2350 gnus-cache-enter-remove-article gnus-cached-article-p
2351 gnus-cache-open gnus-cache-close gnus-cache-update-article
2352 gnus-cache-articles-in-group)
2353 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2354 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2355 ("gnus-score" :interactive t
2356 gnus-summary-increase-score gnus-summary-set-score
2357 gnus-summary-raise-thread gnus-summary-raise-same-subject
2358 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2359 gnus-summary-lower-thread gnus-summary-lower-same-subject
2360 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2361 gnus-summary-current-score gnus-score-delta-default
2362 gnus-score-flush-cache gnus-score-close
2363 gnus-possibly-score-headers gnus-score-followup-article
2364 gnus-score-followup-thread)
2366 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2367 gnus-current-score-file-nondirectory gnus-score-adaptive
2368 gnus-score-find-trace gnus-score-file-name)
2369 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2370 ("gnus-topic" :interactive t gnus-topic-mode)
2371 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2372 gnus-subscribe-topics)
2373 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2374 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2375 ("gnus-uu" :interactive t
2376 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2377 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2378 gnus-uu-mark-by-regexp gnus-uu-mark-all
2379 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2380 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2381 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2382 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2383 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2384 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2385 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2386 gnus-uu-mark-over gnus-uu-post-news)
2387 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2388 ("gnus-msg" (gnus-summary-send-map keymap)
2389 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2390 ("gnus-msg" :interactive t
2391 gnus-group-post-news gnus-group-mail gnus-group-news
2392 gnus-summary-post-news gnus-summary-news-other-window
2393 gnus-summary-followup gnus-summary-followup-with-original
2394 gnus-summary-cancel-article gnus-summary-supersede-article
2395 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2396 gnus-summary-mail-forward gnus-summary-mail-other-window
2397 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2398 gnus-summary-wide-reply gnus-summary-followup-to-mail
2399 gnus-summary-followup-to-mail-with-original gnus-bug
2400 gnus-summary-wide-reply-with-original
2401 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2402 gnus-summary-post-forward)
2403 ("gnus-picon" :interactive t gnus-treat-from-picon)
2404 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2405 gnus-grouplens-mode)
2406 ("smiley" :interactive t smiley-region)
2407 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2408 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2409 gnus-list-of-unread-articles gnus-list-of-read-articles
2410 gnus-offer-save-summaries gnus-make-thread-indent-array
2411 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2412 gnus-summary-skip-intangible gnus-summary-article-number
2413 gnus-data-header gnus-data-find)
2414 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2415 gnus-group-list-groups gnus-group-first-unread-group
2416 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2417 gnus-group-setup-buffer gnus-group-get-new-news
2418 gnus-group-make-help-group gnus-group-update-group
2419 gnus-group-iterate gnus-group-group-name)
2420 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2421 gnus-backlog-remove-article)
2422 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2423 gnus-article-prepare gnus-article-set-window-start
2424 gnus-article-next-page gnus-article-prev-page
2425 gnus-request-article-this-buffer gnus-article-mode
2426 gnus-article-setup-buffer gnus-narrow-to-page
2427 gnus-article-delete-invisible-text gnus-treat-article)
2428 ("gnus-art" :interactive t
2429 gnus-article-hide-headers gnus-article-hide-boring-headers
2430 gnus-article-treat-overstrike
2431 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2432 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2433 gnus-article-de-base64-unreadable
2434 gnus-article-decode-HZ
2435 gnus-article-wash-html
2436 gnus-article-unsplit-urls
2437 gnus-article-hide-pem gnus-article-hide-signature
2438 gnus-article-strip-leading-blank-lines gnus-article-date-local
2439 gnus-article-date-original gnus-article-date-lapsed
2440 ;; gnus-article-show-all-headers
2441 gnus-article-edit-mode gnus-article-edit-article
2442 gnus-article-edit-done gnus-article-decode-encoded-words
2443 gnus-start-date-timer gnus-stop-date-timer
2444 gnus-mime-view-all-parts)
2445 ("gnus-int" gnus-request-type)
2446 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2447 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2448 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2449 gnus-dup-enter-articles)
2450 ("gnus-range" gnus-copy-sequence)
2451 ("gnus-eform" gnus-edit-form)
2452 ("gnus-move" :interactive t
2453 gnus-group-move-group-to-server gnus-change-server)
2454 ("gnus-logic" gnus-score-advanced)
2455 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2456 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2457 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2458 gnus-async-halt-prefetch)
2459 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2460 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2461 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2462 gnus-summary-set-agent-mark gnus-agent-save-group-info
2463 gnus-agent-request-article gnus-agent-retrieve-headers)
2464 ("gnus-agent" :interactive t
2465 gnus-unplugged gnus-agentize gnus-agent-batch)
2466 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2467 gnus-summary-save-article-vm)
2468 ("compface" uncompface)
2469 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2470 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2471 ("gnus-mlspl" :interactive t gnus-group-split-setup
2472 gnus-group-split-update)
2473 ("gnus-delay" gnus-delay-initialize))))
2475 ;;; gnus-sum.el thingies
2478 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2479 "*The format specification of the lines in the summary buffer.
2481 It works along the same lines as a normal formatting string,
2482 with some simple extensions.
2484 %N Article number, left padded with spaces (string)
2486 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2487 %n Name of the poster (string)
2488 %a Extracted name of the poster (string)
2489 %A Extracted address of the poster (string)
2490 %F Contents of the From: header (string)
2491 %f Contents of the From: or To: headers (string)
2492 %x Contents of the Xref: header (string)
2493 %D Date of the article (string)
2494 %d Date of the article (string) in DD-MMM format
2495 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2496 %M Message-id of the article (string)
2497 %r References of the article (string)
2498 %c Number of characters in the article (integer)
2499 %k Pretty-printed version of the above (string)
2500 For example, \"1.2k\" or \"0.4M\".
2501 %L Number of lines in the article (integer)
2502 %I Indentation based on thread level (a string of spaces)
2503 %B A complex trn-style thread tree (string)
2504 The variables `gnus-sum-thread-*' can be used for customization.
2505 %T A string with two possible values: 80 spaces if the article
2506 is on thread level two or larger and 0 spaces on level one
2507 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2508 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2509 %[ Opening bracket (character, \"[\" or \"<\")
2510 %] Closing bracket (character, \"]\" or \">\")
2511 %> Spaces of length thread-level (string)
2512 %< Spaces of length (- 20 thread-level) (string)
2513 %i Article score (number)
2514 %z Article zcore (character)
2515 %t Number of articles under the current thread (number).
2516 %e Whether the thread is empty or not (character).
2517 %l GroupLens score (string).
2518 %V Total thread score (number).
2519 %P The line number (number).
2520 %O Download mark (character).
2521 %* If present, indicates desired cursor position
2522 (instead of after first colon).
2523 %u User defined specifier. The next character in the format string should
2524 be a letter. Gnus will call the function gnus-user-format-function-X,
2525 where X is the letter following %u. The function will be passed the
2526 current header as argument. The function should return a string, which
2527 will be inserted into the summary just like information from any other
2530 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2531 with care. For reasons of efficiency, Gnus will compute what column
2532 these characters will end up in, and \"hard-code\" that. This means that
2533 it is invalid to have these specs after a variable-length spec. Well,
2534 you might not be arrested, but your summary buffer will look strange,
2535 which is bad enough.
2537 The smart choice is to have these specs as far to the left as
2540 This restriction may disappear in later versions of Gnus.
2542 General format specifiers can also be used.
2543 See Info node `(gnus)Formatting Variables'."
2544 :link '(custom-manual "(gnus)Formatting Variables")
2546 :group 'gnus-summary-format)
2549 ;;; Skeleton keymaps
2552 (defun gnus-suppress-keymap (keymap)
2553 (suppress-keymap keymap)
2554 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2556 (define-key keymap (pop keys) 'undefined))))
2558 (defvar gnus-article-mode-map
2559 (let ((keymap (make-sparse-keymap)))
2560 (gnus-suppress-keymap keymap)
2562 (defvar gnus-summary-mode-map
2563 (let ((keymap (make-keymap)))
2564 (gnus-suppress-keymap keymap)
2566 (defvar gnus-group-mode-map
2567 (let ((keymap (make-keymap)))
2568 (gnus-suppress-keymap keymap)
2573 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2574 ;; If you want the cursor to go somewhere else, set these two
2575 ;; functions in some startup hook to whatever you want.
2576 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2577 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2579 ;;; Various macros and substs.
2581 (defun gnus-header-from (header)
2582 (mail-header-from header))
2584 (defmacro gnus-gethash (string hashtable)
2585 "Get hash value of STRING in HASHTABLE."
2586 `(symbol-value (intern-soft ,string ,hashtable)))
2588 (defmacro gnus-gethash-safe (string hashtable)
2589 "Get hash value of STRING in HASHTABLE.
2590 Return nil if not defined."
2591 `(let ((sym (intern-soft ,string ,hashtable)))
2592 (and (boundp sym) (symbol-value sym))))
2594 (defmacro gnus-sethash (string value hashtable)
2595 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2596 `(set (intern ,string ,hashtable) ,value))
2597 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2599 (defmacro gnus-group-unread (group)
2600 "Get the currently computed number of unread articles in GROUP."
2601 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2603 (defmacro gnus-group-entry (group)
2604 "Get the newsrc entry for GROUP."
2605 `(gnus-gethash ,group gnus-newsrc-hashtb))
2607 (defmacro gnus-active (group)
2608 "Get active info on GROUP."
2609 `(gnus-gethash ,group gnus-active-hashtb))
2611 (defmacro gnus-set-active (group active)
2612 "Set GROUP's active info."
2613 `(gnus-sethash ,group ,active gnus-active-hashtb))
2615 ;; Info access macros.
2617 (defmacro gnus-info-group (info)
2619 (defmacro gnus-info-rank (info)
2621 (defmacro gnus-info-read (info)
2623 (defmacro gnus-info-marks (info)
2625 (defmacro gnus-info-method (info)
2627 (defmacro gnus-info-params (info)
2630 (defmacro gnus-info-level (info)
2631 `(let ((rank (gnus-info-rank ,info)))
2635 (defmacro gnus-info-score (info)
2636 `(let ((rank (gnus-info-rank ,info)))
2637 (or (and (consp rank) (cdr rank)) 0)))
2639 (defmacro gnus-info-set-group (info group)
2640 `(setcar ,info ,group))
2641 (defmacro gnus-info-set-rank (info rank)
2642 `(setcar (nthcdr 1 ,info) ,rank))
2643 (defmacro gnus-info-set-read (info read)
2644 `(setcar (nthcdr 2 ,info) ,read))
2645 (defmacro gnus-info-set-marks (info marks &optional extend)
2647 `(gnus-info-set-entry ,info ,marks 3)
2648 `(setcar (nthcdr 3 ,info) ,marks)))
2649 (defmacro gnus-info-set-method (info method &optional extend)
2651 `(gnus-info-set-entry ,info ,method 4)
2652 `(setcar (nthcdr 4 ,info) ,method)))
2653 (defmacro gnus-info-set-params (info params &optional extend)
2655 `(gnus-info-set-entry ,info ,params 5)
2656 `(setcar (nthcdr 5 ,info) ,params)))
2658 (defun gnus-info-set-entry (info entry number)
2659 ;; Extend the info until we have enough elements.
2660 (while (<= (length info) number)
2661 (nconc info (list nil)))
2663 (setcar (nthcdr number info) entry))
2665 (defmacro gnus-info-set-level (info level)
2666 `(let ((rank (cdr ,info)))
2667 (if (consp (car rank))
2668 (setcar (car rank) ,level)
2669 (setcar rank ,level))))
2670 (defmacro gnus-info-set-score (info score)
2671 `(let ((rank (cdr ,info)))
2672 (if (consp (car rank))
2673 (setcdr (car rank) ,score)
2674 (setcar rank (cons (car rank) ,score)))))
2676 (defmacro gnus-get-info (group)
2677 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2679 ;;; Load the compatibility functions.
2688 (defvar gnus-shutdown-alist nil)
2690 (defun gnus-add-shutdown (function &rest symbols)
2691 "Run FUNCTION whenever one of SYMBOLS is shut down."
2692 (push (cons function symbols) gnus-shutdown-alist))
2694 (defun gnus-shutdown (symbol)
2695 "Shut down everything that waits for SYMBOL."
2696 (let ((alist gnus-shutdown-alist)
2698 (while (setq entry (pop alist))
2699 (when (memq symbol (cdr entry))
2700 (funcall (car entry))))))
2704 ;;; Gnus Utility Functions
2707 (defun gnus-find-subscribed-addresses ()
2708 "Return a regexp matching the addresses of all subscribed mail groups.
2709 It consists of the `to-address' or `to-list' parameter of all groups
2710 with a `subscribed' parameter."
2711 (let (group address addresses)
2712 (dolist (entry (cdr gnus-newsrc-alist))
2713 (setq group (car entry))
2714 (when (gnus-parameter-subscribed group)
2715 (setq address (mail-strip-quoted-names
2716 (or (gnus-group-fast-parameter group 'to-address)
2717 (gnus-group-fast-parameter group 'to-list))))
2719 (add-to-list 'addresses address))))
2721 (list (mapconcat 'regexp-quote addresses "\\|")))))
2723 (defmacro gnus-string-or (&rest strings)
2724 "Return the first element of STRINGS that is a non-blank string.
2725 STRINGS will be evaluated in normal `or' order."
2726 `(gnus-string-or-1 ',strings))
2728 (defun gnus-string-or-1 (strings)
2731 (setq string (eval (pop strings)))
2732 (if (string-match "^[ \t]*$" string)
2734 (setq strings nil)))
2737 (defun gnus-version (&optional arg)
2738 "Version number of this version of Gnus.
2739 If ARG, insert string at point."
2742 (insert (message gnus-version))
2743 (message gnus-version)))
2745 (defun gnus-continuum-version (&optional version)
2746 "Return VERSION as a floating point number."
2749 (setq version gnus-version))
2750 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2751 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2752 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2753 (number (match-string 2 version))
2755 (unless (string-match
2756 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2757 (error "Invalid version string: %s" version))
2758 (setq major (string-to-number (match-string 1 number))
2759 minor (string-to-number (match-string 2 number))
2760 least (if (match-beginning 3)
2761 (string-to-number (match-string 3 number))
2765 (format "%s00%02d%02d"
2766 (if (member alpha '("(ding)" "d"))
2770 (- (mm-char-int (aref (downcase alpha) 0))
2774 (format "%d.%02d%02d" major minor least))))))
2776 (defun gnus-info-find-node (&optional nodename)
2777 "Find Info documentation of Gnus."
2779 ;; Enlarge info window if needed.
2780 (let (gnus-info-buffer)
2781 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
2782 (setq gnus-info-buffer (current-buffer))
2783 (gnus-configure-windows 'info)))
2786 ;;; gnus-interactive
2789 (defvar gnus-current-prefix-symbol nil
2790 "Current prefix symbol.")
2792 (defvar gnus-current-prefix-symbols nil
2793 "List of current prefix symbols.")
2795 (defun gnus-interactive (string &optional params)
2796 "Return a list that can be fed to `interactive'.
2797 See `interactive' for full documentation.
2799 Adds the following specs:
2801 y -- The current symbolic prefix.
2802 Y -- A list of the current symbolic prefix(es).
2803 A -- Article number.
2804 H -- Article header.
2808 (while (< i (length string))
2809 (string-match ".\\([^\n]*\\)\n?" string i)
2810 (setq c (aref string i))
2812 (setq prompt (match-string 1 string)))
2813 (setq i (match-end 0))
2814 ;; We basically emulate just about everything that
2815 ;; `interactive' does, but add the specs listed above.
2819 (completing-read prompt obarray 'fboundp t))
2821 (read-buffer prompt (current-buffer) t))
2823 (read-buffer prompt (other-buffer (current-buffer))))
2827 (completing-read prompt obarray 'commandp t))
2831 (read-file-name prompt nil default-directory 'lambda))
2833 (read-file-name prompt nil nil 'lambda))
2835 (read-file-name prompt))
2837 (read-key-sequence prompt))
2839 (error "Not implemented spec"))
2841 (error "Not implemented spec"))
2845 (error "Not implemented spec"))
2847 (string-to-number (read-from-minibuffer prompt)))
2849 (prefix-numeric-value current-prefix-arg))
2855 (read-string prompt))
2857 (intern (read-string prompt)))
2859 (read-variable prompt))
2861 (read-minibuffer prompt))
2863 (eval-minibuffer prompt))
2864 ;; And here the new specs come.
2866 gnus-current-prefix-symbol)
2868 gnus-current-prefix-symbols)
2870 (gnus-group-group-name))
2872 (gnus-summary-skip-intangible)
2873 (or (get-text-property (point) 'gnus-number)
2874 (gnus-summary-last-subject)))
2876 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2878 (error "Non-implemented spec")))
2882 (push (if (< (point) (mark)) (point) (mark)) out)
2883 (push (if (> (point) (mark)) (point) (mark)) out))))
2884 (setq out (delq 'gnus-prefix-nil out))
2887 (defun gnus-symbolic-argument (&optional arg)
2888 "Read a symbolic argument and a command, and then execute command."
2890 (let* ((in-command (this-command-keys))
2891 (command in-command)
2892 gnus-current-prefix-symbols
2893 gnus-current-prefix-symbol
2895 (while (equal in-command command)
2896 (message "%s-" (key-description (this-command-keys)))
2897 (push (intern (char-to-string (read-char))) syms)
2898 (setq command (read-key-sequence nil t)))
2899 (setq gnus-current-prefix-symbols (nreverse syms)
2900 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2901 (call-interactively (key-binding command t))))
2903 ;;; More various functions.
2905 (defsubst gnus-check-backend-function (func group)
2906 "Check whether GROUP supports function FUNC.
2907 GROUP can either be a string (a group name) or a select method."
2909 (let ((method (if (stringp group)
2910 (car (gnus-find-method-for-group group))
2912 (unless (featurep method)
2914 (fboundp (intern (format "%s-%s" method func))))))
2916 (defun gnus-group-read-only-p (&optional group)
2917 "Check whether GROUP supports editing or not.
2918 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2919 that that variable is buffer-local to the summary buffers."
2920 (let ((group (or group gnus-newsgroup-name)))
2921 (not (gnus-check-backend-function 'request-replace-article group))))
2923 (defun gnus-virtual-group-p (group)
2924 "Say whether GROUP is virtual or not."
2925 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2926 gnus-valid-select-methods)))
2928 (defun gnus-news-group-p (group &optional article)
2929 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2930 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2931 t) ;is news of course.
2932 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2933 nil) ;must be mail then.
2934 ((vectorp article) ;Has header info.
2935 (eq (gnus-request-type group (mail-header-id article)) 'news))
2936 ((null article) ;Hasn't header info
2937 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2938 ((< article 0) ;Virtual message
2939 nil) ;we don't know, guess mail.
2940 (t ;Has positive number
2941 (eq (gnus-request-type group article) 'news)))) ;use it.
2943 ;; Returns a list of writable groups.
2944 (defun gnus-writable-groups ()
2945 (let ((alist gnus-newsrc-alist)
2947 (while (setq group (car (pop alist)))
2948 (unless (gnus-group-read-only-p group)
2949 (push group groups)))
2952 ;; Check whether to use long file names.
2953 (defun gnus-use-long-file-name (symbol)
2954 ;; The variable has to be set...
2955 (and gnus-use-long-file-name
2956 ;; If it isn't a list, then we return t.
2957 (or (not (listp gnus-use-long-file-name))
2958 ;; If it is a list, and the list contains `symbol', we
2960 (not (memq symbol gnus-use-long-file-name)))))
2962 ;; Generate a unique new group name.
2963 (defun gnus-generate-new-group-name (leaf)
2966 (while (gnus-gethash name gnus-newsrc-hashtb)
2967 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2970 (defun gnus-ephemeral-group-p (group)
2971 "Say whether GROUP is ephemeral or not."
2972 (gnus-group-get-parameter group 'quit-config t))
2974 (defun gnus-group-quit-config (group)
2975 "Return the quit-config of GROUP."
2976 (gnus-group-get-parameter group 'quit-config t))
2978 (defun gnus-kill-ephemeral-group (group)
2979 "Remove ephemeral GROUP from relevant structures."
2980 (gnus-sethash group nil gnus-newsrc-hashtb))
2982 (defun gnus-simplify-mode-line ()
2983 "Make mode lines a bit simpler."
2984 (setq mode-line-modified (cdr gnus-mode-line-modified))
2985 (when (listp mode-line-format)
2986 (make-local-variable 'mode-line-format)
2987 (setq mode-line-format (copy-sequence mode-line-format))
2988 (when (equal (nth 3 mode-line-format) " ")
2989 (setcar (nthcdr 3 mode-line-format) " "))))
2991 ;;; Servers and groups.
2993 (defsubst gnus-server-add-address (method)
2994 (let ((method-name (symbol-name (car method))))
2995 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2996 (not (assq (intern (concat method-name "-address")) method))
2997 (memq 'physical-address (assq (car method)
2998 gnus-valid-select-methods)))
2999 (append method (list (list (intern (concat method-name "-address"))
3003 (defsubst gnus-server-to-method (server)
3004 "Map virtual server names to select methods."
3005 (or (and server (listp server) server)
3006 (cdr (assoc server gnus-server-method-cache))
3009 ;; Perhaps this is the native server?
3010 (and (equal server "native") gnus-select-method)
3011 ;; It should be in the server alist.
3012 (cdr (assoc server gnus-server-alist))
3013 ;; It could be in the predefined server alist.
3014 (cdr (assoc server gnus-predefined-server-alist))
3015 ;; If not, we look through all the opened server
3016 ;; to see whether we can find it there.
3017 (let ((opened gnus-opened-servers))
3019 (not (equal server (format "%s:%s" (caaar opened)
3023 ;; It could be a named method, search all servers
3024 (let ((servers gnus-secondary-select-methods))
3026 (not (equal server (format "%s:%s" (caar servers)
3030 (push (cons server result) gnus-server-method-cache)
3033 (defsubst gnus-server-get-method (group method)
3034 ;; Input either a server name, and extended server name, or a
3035 ;; select method, and return a select method.
3036 (cond ((stringp method)
3037 (gnus-server-to-method method))
3038 ((equal method gnus-select-method)
3040 ((and (stringp (car method))
3042 (gnus-server-extend-method group method))
3045 (equal (cadr method) ""))
3048 (gnus-server-add-address method))))
3050 (defmacro gnus-method-equal (ss1 ss2)
3051 "Say whether two servers are equal."
3055 (and (= (length s1) (length s2))
3057 (while (and s1 (member (car s1) s2))
3061 (defun gnus-methods-equal-p (m1 m2)
3062 (let ((m1 (or m1 gnus-select-method))
3063 (m2 (or m2 gnus-select-method)))
3065 (and (eq (car m1) (car m2))
3066 (or (not (memq 'address (assoc (symbol-name (car m1))
3067 gnus-valid-select-methods)))
3068 (equal (nth 1 m1) (nth 1 m2)))))))
3070 (defun gnus-server-equal (m1 m2)
3071 "Say whether two methods are equal."
3072 (let ((m1 (cond ((null m1) gnus-select-method)
3073 ((stringp m1) (gnus-server-to-method m1))
3075 (m2 (cond ((null m2) gnus-select-method)
3076 ((stringp m2) (gnus-server-to-method m2))
3078 (gnus-method-equal m1 m2)))
3080 (defun gnus-servers-using-backend (backend)
3081 "Return a list of known servers using BACKEND."
3082 (let ((opened gnus-opened-servers)
3085 (when (eq backend (caaar opened))
3086 (push (caar opened) out))
3090 (defun gnus-archive-server-wanted-p ()
3091 "Say whether the user wants to use the archive server."
3093 ((or (not gnus-message-archive-method)
3094 (not gnus-message-archive-group))
3096 ((and gnus-message-archive-method gnus-message-archive-group)
3099 (let ((active (cadr (assq 'nnfolder-active-file
3100 gnus-message-archive-method))))
3102 (file-exists-p active))))))
3104 (defsubst gnus-method-to-server-name (method)
3106 (format "%s" (car method))
3108 (or (assoc (format "%s" (car method))
3109 (gnus-methods-using 'address))
3110 (gnus-server-equal method gnus-message-archive-method))
3112 (not (string= (nth 1 method) "")))
3113 (concat "+" (nth 1 method)))))
3115 (defsubst gnus-method-to-full-server-name (method)
3116 (format "%s+%s" (car method) (nth 1 method)))
3118 (defun gnus-group-prefixed-name (group method &optional full)
3119 "Return the whole name from GROUP and METHOD. Call with full set to
3120 get the fully qualified group name (even if the server is native)."
3121 (and (stringp method) (setq method (gnus-server-to-method method)))
3122 (if (or (not method)
3123 (and (not full) (gnus-server-equal method "native"))
3124 (string-match ":" group))
3126 (concat (gnus-method-to-server-name method) ":" group)))
3128 (defun gnus-group-guess-prefixed-name (group)
3129 "Guess the whole name from GROUP and METHOD."
3130 (gnus-group-prefixed-name group (gnus-find-method-for-group
3133 (defun gnus-group-full-name (group method)
3134 "Return the full name from GROUP and METHOD, even if the method is
3136 (gnus-group-prefixed-name group method t))
3138 (defun gnus-group-guess-full-name (group)
3139 "Guess the full name from GROUP, even if the method is native."
3140 (gnus-group-full-name group (gnus-find-method-for-group group)))
3142 (defun gnus-group-real-prefix (group)
3143 "Return the prefix of the current group name."
3144 (if (string-match "^[^:]+:" group)
3145 (substring group 0 (match-end 0))
3148 (defun gnus-group-method (group)
3149 "Return the server or method used for selecting GROUP.
3150 You should probably use `gnus-find-method-for-group' instead."
3151 (let ((prefix (gnus-group-real-prefix group)))
3152 (if (equal prefix "")
3154 (let ((servers gnus-opened-servers)
3156 backend possible found)
3157 (if (string-match "^[^\\+]+\\+" prefix)
3158 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3159 server (substring prefix (match-end 0) (1- (length prefix))))
3160 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3162 (when (eq (caaar servers) backend)
3163 (setq possible (caar servers))
3164 (when (equal (cadaar servers) server)
3165 (setq found (caar servers))))
3167 (or (car (rassoc found gnus-server-alist))
3169 (car (rassoc possible gnus-server-alist))
3171 (list backend server))))))
3173 (defsubst gnus-native-method-p (method)
3174 "Return whether METHOD is the native select method."
3175 (gnus-method-equal method gnus-select-method))
3177 (defsubst gnus-secondary-method-p (method)
3178 "Return whether METHOD is a secondary select method."
3179 (let ((methods gnus-secondary-select-methods)
3180 (gmethod (gnus-server-get-method nil method)))
3182 (not (gnus-method-equal
3183 (gnus-server-get-method nil (car methods))
3185 (setq methods (cdr methods)))
3188 (defun gnus-method-simplify (method)
3189 "Return the shortest uniquely identifying string or method for METHOD."
3190 (cond ((stringp method)
3192 ((gnus-native-method-p method)
3194 ((gnus-secondary-method-p method)
3195 (format "%s:%s" (nth 0 method) (nth 1 method)))
3199 (defun gnus-groups-from-server (server)
3200 "Return a list of all groups that are fetched from SERVER."
3201 (let ((alist (cdr gnus-newsrc-alist))
3203 (while (setq info (pop alist))
3204 (when (gnus-server-equal (gnus-info-method info) server)
3205 (push (gnus-info-group info) groups)))
3206 (sort groups 'string<)))
3208 (defun gnus-group-foreign-p (group)
3209 "Say whether a group is foreign or not."
3210 (and (not (gnus-group-native-p group))
3211 (not (gnus-group-secondary-p group))))
3213 (defun gnus-group-native-p (group)
3214 "Say whether the group is native or not."
3215 (not (string-match ":" group)))
3217 (defun gnus-group-secondary-p (group)
3218 "Say whether the group is secondary or not."
3219 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3221 (defun gnus-parameters-get-parameter (group)
3222 "Return the group parameters for GROUP from `gnus-parameters'."
3224 (dolist (elem gnus-parameters)
3225 (when (string-match (car elem) group)
3227 (nconc (gnus-expand-group-parameters
3228 (car elem) (cdr elem) group)
3232 (defun gnus-expand-group-parameter (match value group)
3233 "Use MATCH to expand VALUE in GROUP."
3236 (goto-char (point-min))
3237 (while (re-search-forward match nil t)
3238 (replace-match value))
3241 (defun gnus-expand-group-parameters (match parameters group)
3242 "Go through PARAMETERS and expand them according to the match data."
3244 (dolist (elem parameters)
3245 (if (and (stringp (cdr elem))
3246 (string-match "\\\\[0-9&]" (cdr elem)))
3247 (push (cons (car elem)
3248 (gnus-expand-group-parameter match (cdr elem) group))
3253 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3254 "For GROUP, return the value of SYMBOL.
3256 You should call this in the `gnus-group-buffer' buffer.
3257 The function `gnus-group-find-parameter' will do that for you."
3258 ;; The speed trick: No cons'ing and quit early.
3259 (let* ((params (funcall gnus-group-get-parameter-function group))
3260 ;; Start easy, check the "real" group parameters.
3262 (gnus-group-parameter-value params symbol allow-list t)))
3264 ;; Found results; return them.
3265 (car simple-results)
3266 ;; We didn't found it there, try `gnus-parameters'.
3269 (tail gnus-parameters))
3270 ;; A good old-fashioned non-cl loop.
3272 (setq head (car tail)
3274 ;; The car is regexp matching for matching the group name.
3275 (when (string-match (car head) group)
3276 ;; The cdr is the parameters.
3277 (setq result (gnus-group-parameter-value (cdr head)
3280 ;; Expand if necessary.
3281 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3282 (setq result (gnus-expand-group-parameter (car head)
3284 ;; Exit the loop early.
3289 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3290 "Return the group parameters for GROUP.
3291 If SYMBOL, return the value of that symbol in the group parameters.
3293 If you call this function inside a loop, consider using the faster
3294 `gnus-group-fast-parameter' instead."
3296 (set-buffer gnus-group-buffer)
3298 (gnus-group-fast-parameter group symbol allow-list)
3301 (funcall gnus-group-get-parameter-function group))
3302 (gnus-parameters-get-parameter group)))))
3304 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3305 "Return the group parameters for GROUP.
3306 If SYMBOL, return the value of that symbol in the group parameters.
3307 Most functions should use `gnus-group-find-parameter', which
3308 also examines the topic parameters."
3309 (let ((params (gnus-info-params (gnus-get-info group))))
3311 (gnus-group-parameter-value params symbol allow-list)
3314 (defun gnus-group-parameter-value (params symbol &optional
3315 allow-list present-p)
3316 "Return the value of SYMBOL in group PARAMS."
3317 ;; We only wish to return group parameters (dotted lists) and
3318 ;; not local variables, which may have the same names.
3319 ;; But first we handle single elements...
3320 (or (car (memq symbol params))
3324 (while (setq elem (pop params))
3325 (when (and (consp elem)
3326 (eq (car elem) symbol)
3329 (throw 'found (if present-p (list (cdr elem))
3332 (defun gnus-group-add-parameter (group param)
3333 "Add parameter PARAM to GROUP."
3334 (let ((info (gnus-get-info group)))
3336 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3337 ;; Cons the new param to the old one and update.
3338 (gnus-group-set-info (cons param (gnus-info-params info))
3341 (defun gnus-group-set-parameter (group name value)
3342 "Set parameter NAME to VALUE in GROUP."
3343 (let ((info (gnus-get-info group)))
3345 (gnus-group-remove-parameter group name)
3346 (let ((old-params (gnus-info-params info))
3347 (new-params (list (cons name value))))
3349 (when (or (not (listp (car old-params)))
3350 (not (eq (caar old-params) name)))
3351 (setq new-params (append new-params (list (car old-params)))))
3352 (setq old-params (cdr old-params)))
3353 (gnus-group-set-info new-params group 'params)))))
3355 (defun gnus-group-remove-parameter (group name)
3356 "Remove parameter NAME from GROUP."
3357 (let ((info (gnus-get-info group)))
3359 (let ((params (gnus-info-params info)))
3361 (setq params (delq name params))
3362 (while (assq name params)
3363 (gnus-pull name params))
3364 (gnus-info-set-params info params))))))
3366 (defun gnus-group-add-score (group &optional score)
3367 "Add SCORE to the GROUP score.
3368 If SCORE is nil, add 1 to the score of GROUP."
3369 (let ((info (gnus-get-info group)))
3371 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3373 (defun gnus-short-group-name (group &optional levels)
3374 "Collapse GROUP name LEVELS.
3375 Select methods are stripped and any remote host name is stripped down to
3376 just the host name."
3382 gnus-group-uncollapsed-levels
3384 (while (string-match "\\." group skip)
3385 (setq skip (match-end 0)
3388 ;; Separate foreign select method from group name and collapse.
3389 ;; If method contains a server, collapse to non-domain server name,
3390 ;; otherwise collapse to select method.
3391 (let* ((colon (string-match ":" group))
3392 (server (and colon (substring group 0 colon)))
3393 (plus (and server (string-match "+" server))))
3396 (setq foreign (substring server (+ 1 plus)
3397 (string-match "\\." server))
3398 group (substring group (+ 1 colon)))
3399 (setq foreign server
3400 group (substring group (+ 1 colon))))
3401 (setq foreign (concat foreign ":")))
3402 ;; Collapse group name leaving LEVELS uncollapsed elements
3403 (let* ((slist (split-string group "/"))
3404 (slen (length slist))
3405 (dlist (split-string group "\\."))
3406 (dlen (length dlist))
3418 (setq levels (- glen levels))
3420 (push (if (>= (decf levels) 0)
3421 (if (zerop (length g))
3426 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3428 (defun gnus-narrow-to-body ()
3429 "Narrow to the body of an article."
3432 (goto-char (point-min))
3433 (or (search-forward "\n\n" nil t)
3439 ;;; Kill file handling.
3442 (defun gnus-apply-kill-file ()
3443 "Apply a kill file to the current newsgroup.
3444 Returns the number of articles marked as read."
3445 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3446 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3447 (gnus-apply-kill-file-internal)
3450 (defun gnus-kill-save-kill-buffer ()
3451 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3452 (when (get-file-buffer file)
3454 (set-buffer (get-file-buffer file))
3455 (when (buffer-modified-p)
3457 (kill-buffer (current-buffer))))))
3459 (defcustom gnus-kill-file-name "KILL"
3460 "Suffix of the kill files."
3461 :group 'gnus-score-kill
3462 :group 'gnus-score-files
3465 (defun gnus-newsgroup-kill-file (newsgroup)
3466 "Return the name of a kill file name for NEWSGROUP.
3467 If NEWSGROUP is nil, return the global kill file name instead."
3469 ;; The global KILL file is placed at top of the directory.
3470 ((or (null newsgroup)
3471 (string-equal newsgroup ""))
3472 (expand-file-name gnus-kill-file-name
3473 gnus-kill-files-directory))
3474 ;; Append ".KILL" to newsgroup name.
3475 ((gnus-use-long-file-name 'not-kill)
3476 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3477 "." gnus-kill-file-name)
3478 gnus-kill-files-directory))
3479 ;; Place "KILL" under the hierarchical directory.
3481 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3482 "/" gnus-kill-file-name)
3483 gnus-kill-files-directory))))
3487 (defun gnus-member-of-valid (symbol group)
3488 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3490 (symbol-name (car (gnus-find-method-for-group group)))
3491 gnus-valid-select-methods)))
3493 (defun gnus-method-option-p (method option)
3494 "Return non-nil if select METHOD has OPTION as a parameter."
3495 (when (stringp method)
3496 (setq method (gnus-server-to-method method)))
3497 (memq option (assoc (format "%s" (car method))
3498 gnus-valid-select-methods)))
3500 (defun gnus-similar-server-opened (method)
3501 (let ((opened gnus-opened-servers))
3502 (while (and method opened)
3503 (when (and (equal (cadr method) (cadaar opened))
3504 (equal (car method) (caaar opened))
3505 (not (equal method (caar opened))))
3510 (defun gnus-server-extend-method (group method)
3511 ;; This function "extends" a virtual server. If the server is
3512 ;; "hello", and the select method is ("hello" (my-var "something"))
3513 ;; in the group "alt.alt", this will result in a new virtual server
3514 ;; called "hello+alt.alt".
3515 (if (or (not (inline (gnus-similar-server-opened method)))
3516 (not (cddr method)))
3518 `(,(car method) ,(concat (cadr method) "+" group)
3519 (,(intern (format "%s-address" (car method))) ,(cadr method))
3522 (defun gnus-server-status (method)
3523 "Return the status of METHOD."
3524 (nth 1 (assoc method gnus-opened-servers)))
3526 (defun gnus-group-name-to-method (group)
3527 "Guess a select method based on GROUP."
3528 (if (string-match ":" group)
3529 (let ((server (substring group 0 (match-beginning 0))))
3530 (if (string-match "\\+" server)
3531 (list (intern (substring server 0 (match-beginning 0)))
3532 (substring server (match-end 0)))
3533 (list (intern server) "")))
3534 gnus-select-method))
3536 (defun gnus-server-string (server)
3537 "Return a readable string that describes SERVER."
3538 (let* ((server (gnus-server-to-method server))
3539 (address (nth 1 server)))
3541 (not (zerop (length address))))
3542 (format "%s using %s" address (car server))
3543 (format "%s" (car server)))))
3545 (defun gnus-find-method-for-group (group &optional info)
3546 "Find the select method that GROUP uses."
3547 (or gnus-override-method
3550 (and (not (gnus-group-entry group)) ;; a new group
3551 (gnus-group-name-to-method group))
3552 (let ((info (or info (gnus-get-info group)))
3555 (not (setq method (gnus-info-method info)))
3556 (equal method "native"))
3559 (cond ((stringp method)
3560 (inline (gnus-server-to-method method)))
3561 ((stringp (cadr method))
3562 (inline (gnus-server-extend-method group method)))
3565 (cond ((equal (cadr method) "")
3567 ((null (cadr method))
3568 (list (car method) ""))
3570 (gnus-server-add-address method)))))))
3572 (defun gnus-methods-using (feature)
3573 "Find all methods that have FEATURE."
3574 (let ((valids gnus-valid-select-methods)
3577 (when (memq feature (car valids))
3578 (push (car valids) outs))
3579 (setq valids (cdr valids)))
3582 (defun gnus-read-group (prompt &optional default)
3583 "Prompt the user for a group name.
3584 Disallow invalid group names."
3589 gnus-invalid-group-regexp
3590 (setq group (read-string (concat prefix prompt)
3591 (cons (or default "") 0)
3592 'gnus-group-history)))
3593 (setq prefix (format "Invalid group name: \"%s\". " group)
3597 (defun gnus-read-method (prompt)
3598 "Prompt the user for a method.
3599 Allow completion over sensible values."
3600 (let* ((open-servers
3601 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3602 gnus-opened-servers))
3605 (dolist (method gnus-valid-select-methods)
3606 (if (or (memq 'prompt-address method)
3607 (not (assoc (format "%s:" (car method)) open-servers)))
3608 (push method methods)))
3611 (append valid-methods
3613 gnus-predefined-server-alist
3618 nil t nil 'gnus-method-history)))
3621 (setq method gnus-select-method))
3622 ((assoc method gnus-valid-select-methods)
3623 (let ((address (if (memq 'prompt-address
3624 (assoc method gnus-valid-select-methods))
3625 (read-string "Address: ")
3627 (or (cadr (assoc (format "%s:%s" method address) open-servers))
3628 (list (intern method) address))))
3629 ((assoc method servers)
3632 (list (intern method) "")))))
3636 (defun gnus-agent-method-p (method)
3637 "Say whether METHOD is covered by the agent."
3638 (member method gnus-agent-covered-methods))
3640 (defun gnus-online (method)
3643 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3644 (gnus-agent-method-p method))))
3646 ;;; User-level commands.
3649 (defun gnus-slave-no-server (&optional arg)
3650 "Read network news as a slave, without connecting to the local server."
3652 (gnus-no-server arg t))
3655 (defun gnus-no-server (&optional arg slave)
3657 If ARG is a positive number, Gnus will use that as the startup
3658 level. If ARG is nil, Gnus will be started at level 2. If ARG is
3659 non-nil and not a positive number, Gnus will prompt the user for the
3660 name of an NNTP server to use.
3661 As opposed to `gnus', this command will not connect to the local
3664 (gnus-no-server-1 arg slave))
3667 (defun gnus-slave (&optional arg)
3668 "Read news as a slave."
3670 (gnus arg nil 'slave))
3673 (defun gnus-other-frame (&optional arg display)
3674 "Pop up a frame to read news.
3675 This will call one of the Gnus commands which is specified by the user
3676 option `gnus-other-frame-function' (default `gnus') with the argument
3677 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
3678 optional second argument DISPLAY should be a standard display string
3679 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
3680 omitted or the function `make-frame-on-display' is not available, the
3681 current display is used."
3683 (if (fboundp 'make-frame-on-display)
3685 (setq display (gnus-frame-or-window-display-name (selected-frame))))
3687 (let ((alive (gnus-alive-p)))
3692 (when (and (or (not display)
3694 (gnus-frame-or-window-display-name
3696 (with-current-buffer (window-buffer window)
3697 (string-match "\\`gnus-"
3698 (symbol-name major-mode))))
3699 (gnus-select-frame-set-input-focus
3700 (setq gnus-other-frame-object (window-frame window)))
3701 (select-window window)
3704 (gnus-select-frame-set-input-focus
3705 (setq gnus-other-frame-object
3707 (make-frame-on-display display gnus-other-frame-parameters)
3708 (make-frame gnus-other-frame-parameters))))
3710 (switch-to-buffer gnus-group-buffer)
3711 (funcall gnus-other-frame-function arg)
3712 (add-hook 'gnus-exit-gnus-hook
3714 (when (and (frame-live-p gnus-other-frame-object)
3716 (delete-frame gnus-other-frame-object))
3717 (setq gnus-other-frame-object nil)))))))
3719 ;;(setq thing ? ; this is a comment
3723 (defun gnus (&optional arg dont-connect slave)
3725 If ARG is non-nil and a positive number, Gnus will use that as the
3726 startup level. If ARG is non-nil and not a positive number, Gnus will
3727 prompt the user for the name of an NNTP server to use."
3729 (unless (byte-code-function-p (symbol-function 'gnus))
3730 (message "You should byte-compile Gnus")
3732 (gnus-1 arg dont-connect slave))
3734 ;; Allow redefinition of Gnus functions.
3740 ;;; gnus.el ends here