1 ;;; gnus.el --- a newsreader for GNU Emacs
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; 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))
37 (autoload 'message-y-or-n-p "message" nil nil 'macro)
40 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
44 (defgroup gnus-format nil
45 "Dealing with formatting issues."
48 (defgroup gnus-charset nil
49 "Group character set issues."
50 :link '(custom-manual "(gnus)Charsets")
54 (defgroup gnus-cache nil
56 :link '(custom-manual "(gnus)Article Caching")
59 (defgroup gnus-registry nil
63 (defgroup gnus-start nil
64 "Starting your favorite newsreader."
67 (defgroup gnus-start-server nil
68 "Server options at startup."
71 ;; These belong to gnus-group.el.
72 (defgroup gnus-group nil
74 :link '(custom-manual "(gnus)Group Buffer")
77 (defgroup gnus-group-foreign nil
79 :link '(custom-manual "(gnus)Foreign Groups")
82 (defgroup gnus-group-new nil
83 "Automatic subscription of new groups."
86 (defgroup gnus-group-levels nil
88 :link '(custom-manual "(gnus)Group Levels")
91 (defgroup gnus-group-select nil
93 :link '(custom-manual "(gnus)Selecting a Group")
96 (defgroup gnus-group-listing nil
97 "Showing slices of the group list."
98 :link '(custom-manual "(gnus)Listing Groups")
101 (defgroup gnus-group-visual nil
102 "Sorting the group buffer."
103 :link '(custom-manual "(gnus)Group Buffer Format")
107 (defgroup gnus-group-various nil
108 "Various group options."
109 :link '(custom-manual "(gnus)Scanning New Messages")
112 ;; These belong to gnus-sum.el.
113 (defgroup gnus-summary nil
115 :link '(custom-manual "(gnus)Summary Buffer")
118 (defgroup gnus-summary-exit nil
119 "Leaving summary buffers."
120 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
121 :group 'gnus-summary)
123 (defgroup gnus-summary-marks nil
124 "Marks used in summary buffers."
125 :link '(custom-manual "(gnus)Marking Articles")
126 :group 'gnus-summary)
128 (defgroup gnus-thread nil
129 "Ordering articles according to replies."
130 :link '(custom-manual "(gnus)Threading")
131 :group 'gnus-summary)
133 (defgroup gnus-summary-format nil
134 "Formatting of the summary buffer."
135 :link '(custom-manual "(gnus)Summary Buffer Format")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-choose nil
140 :link '(custom-manual "(gnus)Choosing Articles")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-maneuvering nil
144 "Summary movement commands."
145 :link '(custom-manual "(gnus)Summary Maneuvering")
146 :group 'gnus-summary)
148 (defgroup gnus-picon nil
149 "Show pictures of people, domains, and newsgroups."
152 (defgroup gnus-summary-mail nil
153 "Mail group commands."
154 :link '(custom-manual "(gnus)Mail Group Commands")
155 :group 'gnus-summary)
157 (defgroup gnus-summary-sort nil
158 "Sorting the summary buffer."
159 :link '(custom-manual "(gnus)Sorting the Summary Buffer")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-visual nil
163 "Highlighting and menus in the summary buffer."
164 :link '(custom-manual "(gnus)Summary Highlighting")
166 :group 'gnus-summary)
168 (defgroup gnus-summary-various nil
169 "Various summary buffer options."
170 :link '(custom-manual "(gnus)Various Summary Stuff")
171 :group 'gnus-summary)
173 (defgroup gnus-summary-pick nil
174 "Pick mode in the summary buffer."
175 :link '(custom-manual "(gnus)Pick and Read")
177 :group 'gnus-summary)
179 (defgroup gnus-summary-tree nil
180 "Tree display of threads in the summary buffer."
181 :link '(custom-manual "(gnus)Tree Display")
183 :group 'gnus-summary)
185 ;; Belongs to gnus-uu.el
186 (defgroup gnus-extract-view nil
187 "Viewing extracted files."
188 :link '(custom-manual "(gnus)Viewing Files")
189 :group 'gnus-extract)
191 ;; Belongs to gnus-score.el
192 (defgroup gnus-score nil
193 "Score and kill file handling."
196 (defgroup gnus-score-kill nil
200 (defgroup gnus-score-adapt nil
201 "Adaptive score files."
204 (defgroup gnus-score-default nil
205 "Default values for score files."
208 (defgroup gnus-score-expire nil
209 "Expiring score rules."
212 (defgroup gnus-score-decay nil
213 "Decaying score rules."
216 (defgroup gnus-score-files nil
217 "Score and kill file names."
221 (defgroup gnus-score-various nil
222 "Various scoring and killing options."
226 (defgroup gnus-visual nil
227 "Options controlling the visual fluff."
231 (defgroup gnus-agent nil
232 "Offline support for Gnus."
235 (defgroup gnus-files nil
236 "Files used by Gnus."
239 (defgroup gnus-dribble-file nil
241 :link '(custom-manual "(gnus)Auto Save")
244 (defgroup gnus-newsrc nil
245 "Storing Gnus state."
248 (defgroup gnus-server nil
249 "Options related to newsservers and other servers used by Gnus."
252 (defgroup gnus-server-visual nil
253 "Highlighting and menus in the server buffer."
257 (defgroup gnus-message '((message custom-group))
258 "Composing replies and followups in Gnus."
261 (defgroup gnus-meta nil
262 "Meta variables controlling major portions of Gnus.
263 In general, modifying these variables does not take affect until Gnus
264 is restarted, and sometimes reloaded."
267 (defgroup gnus-various nil
268 "Other Gnus options."
269 :link '(custom-manual "(gnus)Various Various")
272 (defgroup gnus-mime nil
273 "Variables for controlling the Gnus MIME interface."
276 (defgroup gnus-exit nil
278 :link '(custom-manual "(gnus)Exiting Gnus")
281 (defgroup gnus-fun nil
282 "Frivolous Gnus extensions."
283 :link '(custom-manual "(gnus)Exiting Gnus")
286 (defconst gnus-version-number "0.3"
287 "Version number for this version of Gnus.")
289 (defconst gnus-version (format "No Gnus v%s" gnus-version-number)
290 "Version string for this version of Gnus.")
292 (defcustom gnus-inhibit-startup-message nil
293 "If non-nil, the startup message will not be displayed.
294 This variable is used before `.gnus.el' is loaded, so it should
295 be set in `.emacs' instead."
299 (defcustom gnus-play-startup-jingle nil
300 "If non-nil, play the Gnus jingle at startup."
304 (unless (fboundp 'gnus-group-remove-excess-properties)
305 (defalias 'gnus-group-remove-excess-properties 'ignore))
307 (unless (featurep 'gnus-xmas)
308 (defalias 'gnus-make-overlay 'make-overlay)
309 (defalias 'gnus-delete-overlay 'delete-overlay)
310 (defalias 'gnus-overlay-put 'overlay-put)
311 (defalias 'gnus-move-overlay 'move-overlay)
312 (defalias 'gnus-overlay-buffer 'overlay-buffer)
313 (defalias 'gnus-overlay-start 'overlay-start)
314 (defalias 'gnus-overlay-end 'overlay-end)
315 (defalias 'gnus-extent-detached-p 'ignore)
316 (defalias 'gnus-extent-start-open 'ignore)
317 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
318 (defalias 'gnus-character-to-event 'identity)
319 (defalias 'gnus-assq-delete-all 'assq-delete-all)
320 (defalias 'gnus-add-text-properties 'add-text-properties)
321 (defalias 'gnus-put-text-property 'put-text-property)
322 (defvar gnus-mode-line-image-cache t)
323 (if (fboundp 'find-image)
324 (defun gnus-mode-line-buffer-identification (line)
325 (let ((str (car-safe line))
326 (load-path (mm-image-load-path)))
327 (if (and (stringp str)
328 (string-match "^Gnus:" str))
329 (progn (add-text-properties
332 (if (eq t gnus-mode-line-image-cache)
333 (setq gnus-mode-line-image-cache
335 '((:type xpm :file "gnus-pointer.xpm"
337 (:type xbm :file "gnus-pointer.xbm"
339 gnus-mode-line-image-cache)
342 gnus-version (gnus-emacs-version)))
346 (defalias 'gnus-mode-line-buffer-identification 'identity))
347 (defalias 'gnus-characterp 'numberp)
348 (defalias 'gnus-deactivate-mark 'deactivate-mark)
349 (defalias 'gnus-window-edges 'window-edges)
350 (defalias 'gnus-key-press-event-p 'numberp)
351 ;;(defalias 'gnus-decode-rfc1522 'ignore)
354 ;; We define these group faces here to avoid the display
355 ;; update forced when creating new faces.
357 (defface gnus-group-news-1-face
360 (:foreground "PaleTurquoise" :bold t))
363 (:foreground "ForestGreen" :bold t))
366 "Level 1 newsgroup face.")
368 (defface gnus-group-news-1-empty-face
371 (:foreground "PaleTurquoise"))
374 (:foreground "ForestGreen"))
377 "Level 1 empty newsgroup face.")
379 (defface gnus-group-news-2-face
382 (:foreground "turquoise" :bold t))
385 (:foreground "CadetBlue4" :bold t))
388 "Level 2 newsgroup face.")
390 (defface gnus-group-news-2-empty-face
393 (:foreground "turquoise"))
396 (:foreground "CadetBlue4"))
399 "Level 2 empty newsgroup face.")
401 (defface gnus-group-news-3-face
410 "Level 3 newsgroup face.")
412 (defface gnus-group-news-3-empty-face
421 "Level 3 empty newsgroup face.")
423 (defface gnus-group-news-4-face
432 "Level 4 newsgroup face.")
434 (defface gnus-group-news-4-empty-face
443 "Level 4 empty newsgroup face.")
445 (defface gnus-group-news-5-face
454 "Level 5 newsgroup face.")
456 (defface gnus-group-news-5-empty-face
465 "Level 5 empty newsgroup face.")
467 (defface gnus-group-news-6-face
476 "Level 6 newsgroup face.")
478 (defface gnus-group-news-6-empty-face
487 "Level 6 empty newsgroup face.")
489 (defface gnus-group-news-low-face
492 (:foreground "DarkTurquoise" :bold t))
495 (:foreground "DarkGreen" :bold t))
498 "Low level newsgroup face.")
500 (defface gnus-group-news-low-empty-face
503 (:foreground "DarkTurquoise"))
506 (:foreground "DarkGreen"))
509 "Low level empty newsgroup face.")
511 (defface gnus-group-mail-1-face
514 (:foreground "aquamarine1" :bold t))
517 (:foreground "DeepPink3" :bold t))
520 "Level 1 mailgroup face.")
522 (defface gnus-group-mail-1-empty-face
525 (:foreground "aquamarine1"))
528 (:foreground "DeepPink3"))
530 (:italic t :bold t)))
531 "Level 1 empty mailgroup face.")
533 (defface gnus-group-mail-2-face
536 (:foreground "aquamarine2" :bold t))
539 (:foreground "HotPink3" :bold t))
542 "Level 2 mailgroup face.")
544 (defface gnus-group-mail-2-empty-face
547 (:foreground "aquamarine2"))
550 (:foreground "HotPink3"))
553 "Level 2 empty mailgroup face.")
555 (defface gnus-group-mail-3-face
558 (:foreground "aquamarine3" :bold t))
561 (:foreground "magenta4" :bold t))
564 "Level 3 mailgroup face.")
566 (defface gnus-group-mail-3-empty-face
569 (:foreground "aquamarine3"))
572 (:foreground "magenta4"))
575 "Level 3 empty mailgroup face.")
577 (defface gnus-group-mail-low-face
580 (:foreground "aquamarine4" :bold t))
583 (:foreground "DeepPink4" :bold t))
586 "Low level mailgroup face.")
588 (defface gnus-group-mail-low-empty-face
591 (:foreground "aquamarine4"))
594 (:foreground "DeepPink4"))
597 "Low level empty mailgroup face.")
599 ;; Summary mode faces.
601 (defface gnus-summary-selected-face '((t
603 "Face used for selected articles.")
605 (defface gnus-summary-cancelled-face
607 (:foreground "yellow" :background "black")))
608 "Face used for cancelled articles.")
610 (defface gnus-summary-high-ticked-face
613 (:foreground "pink" :bold t))
616 (:foreground "firebrick" :bold t))
619 "Face used for high interest ticked articles.")
621 (defface gnus-summary-low-ticked-face
624 (:foreground "pink" :italic t))
627 (:foreground "firebrick" :italic t))
630 "Face used for low interest ticked articles.")
632 (defface gnus-summary-normal-ticked-face
635 (:foreground "pink"))
638 (:foreground "firebrick"))
641 "Face used for normal interest ticked articles.")
643 (defface gnus-summary-high-ancient-face
646 (:foreground "SkyBlue" :bold t))
649 (:foreground "RoyalBlue" :bold t))
652 "Face used for high interest ancient articles.")
654 (defface gnus-summary-low-ancient-face
657 (:foreground "SkyBlue" :italic t))
660 (:foreground "RoyalBlue" :italic t))
663 "Face used for low interest ancient articles.")
665 (defface gnus-summary-normal-ancient-face
668 (:foreground "SkyBlue"))
671 (:foreground "RoyalBlue"))
674 "Face used for normal interest ancient articles.")
676 (defface gnus-summary-high-undownloaded-face
679 (:bold t :foreground "cyan4"))
680 (((class color) (background dark))
681 (:bold t :foreground "LightGray"))
682 (t (:inverse-video t :bold t)))
683 "Face used for high interest uncached articles.")
685 (defface gnus-summary-low-undownloaded-face
688 (:italic t :foreground "cyan4" :bold nil))
689 (((class color) (background dark))
690 (:italic t :foreground "LightGray" :bold nil))
691 (t (:inverse-video t :italic t)))
692 "Face used for low interest uncached articles.")
694 (defface gnus-summary-normal-undownloaded-face
697 (:foreground "cyan4" :bold nil))
698 (((class color) (background dark))
699 (:foreground "LightGray" :bold nil))
700 (t (:inverse-video t)))
701 "Face used for normal interest uncached articles.")
703 (defface gnus-summary-high-unread-face
706 "Face used for high interest unread articles.")
708 (defface gnus-summary-low-unread-face
711 "Face used for low interest unread articles.")
713 (defface gnus-summary-normal-unread-face
716 "Face used for normal interest unread articles.")
718 (defface gnus-summary-high-read-face
721 (:foreground "PaleGreen"
725 (:foreground "DarkGreen"
729 "Face used for high interest read articles.")
731 (defface gnus-summary-low-read-face
734 (:foreground "PaleGreen"
738 (:foreground "DarkGreen"
742 "Face used for low interest read articles.")
744 (defface gnus-summary-normal-read-face
747 (:foreground "PaleGreen"))
750 (:foreground "DarkGreen"))
753 "Face used for normal interest read articles.")
760 (defvar gnus-buffers nil)
762 (defun gnus-get-buffer-create (name)
763 "Do the same as `get-buffer-create', but store the created buffer."
764 (or (get-buffer name)
765 (car (push (get-buffer-create name) gnus-buffers))))
767 (defun gnus-add-buffer ()
768 "Add the current buffer to the list of Gnus buffers."
769 (push (current-buffer) gnus-buffers))
771 (defmacro gnus-kill-buffer (buffer)
772 "Kill BUFFER and remove from the list of Gnus buffers."
773 `(let ((buf ,buffer))
774 (when (gnus-buffer-exists-p buf)
775 (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
778 (defun gnus-buffers ()
779 "Return a list of live Gnus buffers."
780 (while (and gnus-buffers
781 (not (buffer-name (car gnus-buffers))))
783 (let ((buffers gnus-buffers))
785 (if (buffer-name (cadr buffers))
787 (setcdr buffers (cddr buffers)))))
792 (defvar gnus-group-buffer "*Group*")
795 (autoload 'gnus-play-jingle "gnus-audio"))
797 (defface gnus-splash-face
800 (:foreground "#888888"))
803 (:foreground "#888888"))
806 "Face for the splash screen.")
808 (defun gnus-splash ()
810 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
811 (let ((buffer-read-only nil))
813 (unless gnus-inhibit-startup-message
814 (gnus-group-startup-message)
816 (when gnus-play-startup-jingle
817 (gnus-play-jingle))))))
819 (defun gnus-indent-rigidly (start end arg)
820 "Indent rigidly using only spaces and no tabs."
823 (narrow-to-region start end)
825 (indent-rigidly start end arg)
826 ;; We translate tabs into spaces -- not everybody uses
827 ;; an 8-character tab.
828 (goto-char (point-min))
829 (while (search-forward "\t" nil t)
830 (replace-match " " t t))))))
832 (defvar gnus-simple-splash nil)
834 ;;(format "%02x%02x%02x" 114 66 20) "724214"
836 (defvar gnus-logo-color-alist
837 '((flame "#cc3300" "#ff2200")
838 (pine "#c0cc93" "#f8ffb8")
839 (moss "#a1cc93" "#d2ffb8")
840 (irish "#04cc90" "#05ff97")
841 (sky "#049acc" "#05deff")
842 (tin "#6886cc" "#82b6ff")
843 (velvet "#7c68cc" "#8c82ff")
844 (grape "#b264cc" "#cf7df")
845 (labia "#cc64c2" "#fd7dff")
846 (berry "#cc6485" "#ff7db5")
847 (dino "#724214" "#1e3f03")
848 (oort "#cccccc" "#888888")
849 (storm "#666699" "#99ccff")
850 (pdino "#9999cc" "#99ccff")
851 (purp "#9999cc" "#666699")
852 (no "#ff0000" "#ffff00")
853 (neutral "#b4b4b4" "#878787")
854 (september "#bf9900" "#ffcc00"))
855 "Color alist used for the Gnus logo.")
857 (defcustom gnus-logo-color-style 'no
858 "*Color styles used for the Gnus logo."
859 :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
860 gnus-logo-color-alist))
863 (defvar gnus-logo-colors
864 (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
865 "Colors used for the Gnus logo.")
867 (defun gnus-group-startup-message (&optional x y)
868 "Insert startup message in current buffer."
869 ;; Insert the message.
873 (fboundp 'find-image)
875 (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
877 `((:type xpm :file "gnus.xpm"
879 (("thing" . ,(car gnus-logo-colors))
880 ("shadow" . ,(cadr gnus-logo-colors))
882 ("background" . ,(face-background 'default))))
883 (:type pbm :file "gnus.pbm"
884 ;; Account for the pbm's blackground.
885 :background ,(face-foreground 'gnus-splash-face)
886 :foreground ,(face-background 'default))
887 (:type xbm :file "gnus.xbm"
888 ;; Account for the xbm's blackground.
889 :background ,(face-foreground 'gnus-splash-face)
890 :foreground ,(face-background 'default))))))
892 (let ((size (image-size image)))
893 (insert-char ?\n (max 0 (round (- (window-height)
894 (or y (cdr size)) 1) 2)))
895 (insert-char ?\ (max 0 (round (- (window-width)
896 (or x (car size))) 2)))
897 (insert-image image))
898 (setq gnus-simple-splash nil)
904 _ ___ __ ___ __ _ ___
924 (gnus-indent-rigidly (point-min) (point-max)
925 (/ (max (- (window-width) (or x 46)) 0) 2))
926 (goto-char (point-min))
928 (let* ((pheight (count-lines (point-min) (point-max)))
929 (wheight (window-height))
930 (rest (- wheight pheight)))
931 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
933 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
934 (setq gnus-simple-splash t)))
935 (goto-char (point-min))
936 (setq mode-line-buffer-identification (concat " " gnus-version))
937 (set-buffer-modified-p t))
940 (let ((command (format "%s" this-command)))
941 (when (string-match "gnus" command)
942 (if (string-match "gnus-other-frame" command)
943 (gnus-get-buffer-create gnus-group-buffer)
951 (defcustom gnus-parameters nil
952 "Alist of group parameters.
955 ((\"mail\\\\..*\" (gnus-show-threads nil)
956 (gnus-use-scoring nil)
957 (gnus-summary-line-format
958 \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
961 (\"mail\\\\.me\" (gnus-use-scoring t))
962 (\"list\\\\..*\" (total-expire . t)
963 (broken-reply-to . t)))"
965 :group 'gnus-group-various
966 :type '(repeat (cons regexp
969 (defvar gnus-group-parameters-more nil)
971 (defmacro gnus-define-group-parameter (param &rest rest)
972 "Define a group parameter PARAM.
973 REST is a plist of following:
974 :type One of `bool', `list' or nil.
975 :function The name of the function.
976 :function-document The documentation of the function.
977 :parameter-type The type for customizing the parameter.
978 :parameter-document The documentation for the parameter.
979 :variable The name of the variable.
980 :variable-document The documentation for the variable.
981 :variable-group The group for customizing the variable.
982 :variable-type The type for customizing the variable.
983 :variable-default The default value of the variable."
984 (let* ((type (plist-get rest :type))
985 (parameter-type (plist-get rest :parameter-type))
986 (parameter-document (plist-get rest :parameter-document))
987 (function (or (plist-get rest :function)
988 (intern (format "gnus-parameter-%s" param))))
989 (function-document (or (plist-get rest :function-document) ""))
990 (variable (or (plist-get rest :variable)
991 (intern (format "gnus-parameter-%s-alist" param))))
992 (variable-document (or (plist-get rest :variable-document) ""))
993 (variable-group (plist-get rest :variable-group))
994 (variable-type (or (plist-get rest :variable-type)
996 (list (regexp :tag "Group")
997 ,(car (cdr parameter-type)))))))
998 (variable-default (plist-get rest :variable-default)))
1001 `(defcustom ,variable ,variable-default
1003 :group 'gnus-group-parameter
1004 :group ',variable-group
1005 :type ,variable-type)
1006 `(setq gnus-group-parameters-more
1007 (delq (assq ',param gnus-group-parameters-more)
1008 gnus-group-parameters-more))
1009 `(add-to-list 'gnus-group-parameters-more
1012 ,parameter-document))
1014 `(defun ,function (name)
1016 (let ((params (gnus-group-find-parameter name))
1019 ((memq ',param params)
1021 ((setq val (assq ',param params))
1023 ((stringp ,variable)
1024 (string-match ,variable name))
1026 (let ((alist ,variable)
1028 (while (setq elem (pop alist))
1030 (string-match (car elem) name))
1033 (if (consp value) (car value) value))))))
1034 `(defun ,function (name)
1037 (or (gnus-group-find-parameter name ',param ,(and type t))
1038 (let ((alist ,variable)
1040 (while (setq elem (pop alist))
1042 (string-match (car elem) name))
1047 '(if (consp value) (car value) value))))))))))
1049 (defcustom gnus-home-directory "~/"
1050 "Directory variable that specifies the \"home\" directory.
1051 All other Gnus file and directory variables are initialized from this variable."
1055 (defcustom gnus-directory (or (getenv "SAVEDIR")
1056 (nnheader-concat gnus-home-directory "News/"))
1057 "*Directory variable from which all other Gnus file variables are derived.
1059 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1060 This means that other directory variables that are initialized from
1061 this variable won't be set properly if you set this variable in `.gnus.el'.
1062 Set this variable in `.emacs' instead."
1066 (defcustom gnus-default-directory nil
1067 "*Default directory for all Gnus buffers."
1069 :type '(choice (const :tag "current" nil)
1072 ;; Site dependent variables. These variables should be defined in
1075 (defvar gnus-default-nntp-server nil
1076 "Specify a default NNTP server.
1077 This variable should be defined in paths.el, and should never be set
1079 If you want to change servers, you should use `gnus-select-method'.
1080 See the documentation to that variable.")
1082 ;; Don't touch this variable.
1083 (defvar gnus-nntp-service "nntp"
1084 "NNTP service name (\"nntp\" or 119).
1085 This is an obsolete variable, which is scarcely used. If you use an
1086 nntp server for your newsgroup and want to change the port number
1087 used to 899, you would say something along these lines:
1089 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1091 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1092 "A file with only the name of the nntp server in it."
1097 (defun gnus-getenv-nntpserver ()
1098 "Find default nntp server.
1099 Check the NNTPSERVER environment variable and the
1100 `gnus-nntpserver-file' file."
1101 (or (getenv "NNTPSERVER")
1102 (and (file-readable-p gnus-nntpserver-file)
1104 (insert-file-contents gnus-nntpserver-file)
1105 (when (re-search-forward "[^ \t\n\r]+" nil t)
1106 (match-string 0))))))
1108 (defcustom gnus-select-method
1111 (list 'nntp (or (condition-case nil
1112 (gnus-getenv-nntpserver)
1114 (when (and gnus-default-nntp-server
1115 (not (string= gnus-default-nntp-server "")))
1116 gnus-default-nntp-server)
1118 (if (or (null gnus-nntp-service)
1119 (equal gnus-nntp-service "nntp"))
1121 (list gnus-nntp-service)))
1123 "Default method for selecting a newsgroup.
1124 This variable should be a list, where the first element is how the
1125 news is to be fetched, the second is the address.
1127 For instance, if you want to get your news via \"flab.flab.edu\" using
1128 NNTP, you could say:
1130 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1132 If you want to use your local spool, say:
1134 \(setq gnus-select-method (list 'nnspool (system-name)))
1136 If you use this variable, you must set `gnus-nntp-server' to nil.
1138 There is a lot more to know about select methods and virtual servers -
1139 see the manual for details."
1141 :type 'gnus-select-method)
1143 (defcustom gnus-message-archive-method "archive"
1144 "*Method used for archiving messages you've sent.
1145 This should be a mail method."
1147 :group 'gnus-message
1148 :type '(choice (const :tag "Default archive method" "archive")
1149 gnus-select-method))
1151 (defcustom gnus-message-archive-group nil
1152 "*Name of the group in which to save the messages you've written.
1153 This can either be a string; a list of strings; or an alist
1154 of regexps/functions/forms to be evaluated to return a string (or a list
1155 of strings). The functions are called with the name of the current
1156 group (or nil) as a parameter.
1158 If you want to save your mail in one group and the news articles you
1159 write in another group, you could say something like:
1161 \(setq gnus-message-archive-group
1162 '((if (message-news-p)
1166 Normally the group names returned by this variable should be
1167 unprefixed -- which implicitly means \"store on the archive server\".
1168 However, you may wish to store the message on some other server. In
1169 that case, just return a fully prefixed name of the group --
1170 \"nnml+private:mail.misc\", for instance."
1171 :group 'gnus-message
1172 :type '(choice (const :tag "none" nil)
1177 (defcustom gnus-secondary-servers nil
1178 "List of NNTP servers that the user can choose between interactively.
1179 To make Gnus query you for a server, you have to give `gnus' a
1180 non-numeric prefix - `C-u M-x gnus', in short."
1182 :type '(repeat string))
1184 (defcustom gnus-nntp-server nil
1185 "*The name of the host running the NNTP server.
1186 This variable is semi-obsolete. Use the `gnus-select-method'
1189 :type '(choice (const :tag "disable" nil)
1192 (defcustom gnus-secondary-select-methods nil
1193 "A list of secondary methods that will be used for reading news.
1194 This is a list where each element is a complete select method (see
1195 `gnus-select-method').
1197 If, for instance, you want to read your mail with the nnml back end,
1198 you could set this variable:
1200 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1202 :type '(repeat gnus-select-method))
1204 (defvar gnus-backup-default-subscribed-newsgroups
1205 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1206 "Default default new newsgroups the first time Gnus is run.
1207 Should be set in paths.el, and shouldn't be touched by the user.")
1209 (defcustom gnus-local-domain nil
1210 "Local domain name without a host name.
1211 The DOMAINNAME environment variable is used instead if it is defined.
1212 If the function `system-name' returns the full Internet name, there is
1213 no need to set this variable."
1214 :group 'gnus-message
1215 :type '(choice (const :tag "default" nil)
1218 (defvar gnus-local-organization nil
1219 "String with a description of what organization (if any) the user belongs to.
1220 Obsolete variable; use `message-user-organization' instead.")
1222 ;; Customization variables
1224 (defcustom gnus-refer-article-method nil
1225 "Preferred method for fetching an article by Message-ID.
1226 If you are reading news from the local spool (with nnspool), fetching
1227 articles by Message-ID is painfully slow. By setting this method to an
1228 nntp method, you might get acceptable results.
1230 The value of this variable must be a valid select method as discussed
1231 in the documentation of `gnus-select-method'.
1233 It can also be a list of select methods, as well as the special symbol
1234 `current', which means to use the current select method. If it is a
1235 list, Gnus will try all the methods in the list until it finds a match."
1237 :type '(choice (const :tag "default" nil)
1239 (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1241 (repeat :menu-tag "Try multiple"
1243 :value (current (nnweb "refer" (nnweb-type google)))
1244 (choice :tag "Method"
1246 (const :tag "Google"
1247 (nnweb "refer" (nnweb-type google)))
1248 gnus-select-method))))
1250 (defcustom gnus-group-faq-directory
1251 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1252 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1253 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1254 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1255 "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1256 "/ftp@rtfm.mit.edu:/pub/usenet/"
1257 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1258 "/ftp@ftp.sunet.se:/pub/usenet/"
1259 "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1260 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1261 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1262 "*Directory where the group FAQs are stored.
1263 This will most commonly be on a remote machine, and the file will be
1264 fetched by ange-ftp.
1266 This variable can also be a list of directories. In that case, the
1267 first element in the list will be used by default. The others can
1268 be used when being prompted for a site.
1270 Note that Gnus uses an aol machine as the default directory. If this
1271 feels fundamentally unclean, just think of it as a way to finally get
1272 something of value back from them.
1274 If the default site is too slow, try one of these:
1276 North America: mirrors.aol.com /pub/rtfm/usenet
1277 ftp.seas.gwu.edu /pub/rtfm
1278 rtfm.mit.edu /pub/usenet
1279 Europe: ftp.uni-paderborn.de /pub/FAQ
1280 src.doc.ic.ac.uk /usenet/news-FAQS
1281 ftp.sunet.se /pub/usenet
1282 ftp.pasteur.fr /pub/FAQ
1283 Asia: nctuccca.nctu.edu.tw /pub/Documents/rtfm/usenet-by-group/
1284 hwarang.postech.ac.kr /pub/usenet
1285 ftp.hk.super.net /mirror/faqs"
1286 :group 'gnus-group-various
1287 :type '(choice directory
1288 (repeat directory)))
1290 (defcustom gnus-group-charter-alist
1291 '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1292 ("de" . (concat "http://purl.net/charta/" name ".html"))
1293 ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1294 ("england" . (concat "http://england.news-admin.org/charters/" name))
1295 ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1296 ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1297 (gnus-replace-in-string name "europa\\." "") ".html"))
1298 ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1299 ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1300 ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1301 ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1302 ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1303 ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1304 ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1305 ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1306 (gnus-replace-in-string name "\\." "_") ".html"))
1307 ("milw" . (concat "http://usenet.mil.wi.us/"
1308 (gnus-replace-in-string name "milw\\." "") "-charter"))
1309 ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1310 ("netins" . (concat "http://www.netins.net/usenet/charter/"
1311 (gnus-replace-in-string name "\\." "-") "-charter.html")))
1312 "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1313 When FORM is evaluated `name' is bound to the name of the group."
1315 :group 'gnus-group-various
1316 :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1318 (defcustom gnus-group-fetch-control-use-browse-url nil
1319 "*Non-nil means that control messages are displayed using `browse-url'.
1320 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1323 :group 'gnus-group-various
1326 (defcustom gnus-use-cross-reference t
1327 "*Non-nil means that cross referenced articles will be marked as read.
1328 If nil, ignore cross references. If t, mark articles as read in
1329 subscribed newsgroups. If neither t nor nil, mark as read in all
1332 :type '(choice (const :tag "off" nil)
1333 (const :tag "subscribed" t)
1337 (defcustom gnus-process-mark ?#
1339 :group 'gnus-group-visual
1340 :group 'gnus-summary-marks
1343 (defcustom gnus-large-newsgroup 200
1344 "*The number of articles which indicates a large newsgroup.
1345 If the number of articles in a newsgroup is greater than this value,
1346 confirmation is required for selecting the newsgroup.
1347 If it is nil, no confirmation is required."
1348 :group 'gnus-group-select
1349 :type '(choice (const :tag "No limit" nil)
1352 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1353 "*Non-nil means that the default name of a file to save articles in is the group name.
1354 If it's nil, the directory form of the group name is used instead.
1356 If this variable is a list, and the list contains the element
1357 `not-score', long file names will not be used for score files; if it
1358 contains the element `not-save', long file names will not be used for
1359 saving; and if it contains the element `not-kill', long file names
1360 will not be used for kill files.
1362 Note that the default for this variable varies according to what system
1363 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1364 to nil while on all other systems it defaults to t."
1366 :type '(radio (sexp :format "Non-nil\n"
1367 :match (lambda (widget value)
1368 (and value (not (listp value))))
1371 (checklist (const :format "%v " not-score)
1372 (const :format "%v " not-save)
1375 (defcustom gnus-kill-files-directory gnus-directory
1376 "*Name of the directory where kill files will be stored (default \"~/News\")."
1377 :group 'gnus-score-files
1378 :group 'gnus-score-kill
1381 (defcustom gnus-save-score nil
1382 "*If non-nil, save group scoring info."
1383 :group 'gnus-score-various
1387 (defcustom gnus-use-undo t
1388 "*If non-nil, allow undoing in Gnus group mode buffers."
1392 (defcustom gnus-use-adaptive-scoring nil
1393 "*If non-nil, use some adaptive scoring scheme.
1394 If a list, then the values `word' and `line' are meaningful. The
1395 former will perform adaption on individual words in the subject
1396 header while `line' will perform adaption on several headers."
1398 :group 'gnus-score-adapt
1399 :type '(set (const word) (const line)))
1401 (defcustom gnus-use-cache 'passive
1402 "*If nil, Gnus will ignore the article cache.
1403 If `passive', it will allow entering (and reading) articles
1404 explicitly entered into the cache. If anything else, use the
1405 cache to the full extent of the law."
1408 :type '(choice (const :tag "off" nil)
1409 (const :tag "passive" passive)
1410 (const :tag "active" t)))
1412 (defcustom gnus-use-trees nil
1413 "*If non-nil, display a thread tree buffer."
1417 (defcustom gnus-keep-backlog 20
1418 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1419 If it is a number N, then Gnus will only keep the last N articles
1420 read. If it is neither nil nor a number, Gnus will keep all read
1421 articles. This is not a good idea."
1423 :type '(choice (const :tag "off" nil)
1428 (defcustom gnus-use-nocem nil
1429 "*If non-nil, Gnus will read NoCeM cancel messages."
1433 (defcustom gnus-suppress-duplicates nil
1434 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1438 (defcustom gnus-use-scoring t
1439 "*If non-nil, enable scoring."
1443 (defcustom gnus-summary-prepare-exit-hook
1444 '(gnus-summary-expire-articles)
1445 "*A hook called when preparing to exit from the summary buffer.
1446 It calls `gnus-summary-expire-articles' by default."
1447 :group 'gnus-summary-exit
1450 (defcustom gnus-novice-user t
1451 "*Non-nil means that you are a Usenet novice.
1452 If non-nil, verbose messages may be displayed and confirmations may be
1457 (defcustom gnus-expert-user nil
1458 "*Non-nil means that you will never be asked for confirmation about anything.
1459 That doesn't mean *anything* anything; particularly destructive
1460 commands will still require prompting."
1464 (defcustom gnus-interactive-catchup t
1465 "*If non-nil, require your confirmation when catching up a group."
1466 :group 'gnus-group-select
1469 (defcustom gnus-interactive-exit t
1470 "*If non-nil, require your confirmation when exiting Gnus."
1474 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1475 "*Function for extracting address components from a From header.
1476 Two pre-defined function exist: `gnus-extract-address-components',
1477 which is the default, quite fast, and too simplistic solution, and
1478 `mail-extract-address-components', which works much better, but is
1480 :group 'gnus-summary-format
1481 :type '(radio (function-item gnus-extract-address-components)
1482 (function-item mail-extract-address-components)
1483 (function :tag "Other")))
1485 (defcustom gnus-carpal nil
1486 "*If non-nil, display clickable icons."
1490 (defcustom gnus-shell-command-separator ";"
1491 "String used to separate shell commands."
1495 (defcustom gnus-valid-select-methods
1496 '(("nntp" post address prompt-address physical-address)
1497 ("nnspool" post address)
1498 ("nnvirtual" post-mail virtual prompt-address)
1499 ("nnmbox" mail respool address)
1500 ("nnml" post-mail respool address)
1501 ("nnmh" mail respool address)
1502 ("nndir" post-mail prompt-address physical-address)
1503 ("nneething" none address prompt-address physical-address)
1504 ("nndoc" none address prompt-address)
1505 ("nnbabyl" mail address respool)
1506 ("nnkiboze" post virtual)
1507 ("nnsoup" post-mail address)
1508 ("nndraft" post-mail)
1509 ("nnfolder" mail respool address)
1510 ("nngateway" post-mail address prompt-address physical-address)
1519 ("nnagent" post-mail)
1520 ("nnimap" post-mail address prompt-address physical-address)
1521 ("nnmaildir" mail respool address)
1523 "*An alist of valid select methods.
1524 The first element of each list lists should be a string with the name
1525 of the select method. The other elements may be the category of
1526 this method (i. e., `post', `mail', `none' or whatever) or other
1527 properties that this method has (like being respoolable).
1528 If you implement a new select method, all you should have to change is
1529 this variable. I think."
1531 :type '(repeat (group (string :tag "Name")
1532 (radio-button-choice (const :format "%v " post)
1533 (const :format "%v " mail)
1534 (const :format "%v " none)
1536 (checklist :inline t
1537 (const :format "%v " address)
1538 (const :format "%v " prompt-address)
1539 (const :format "%v " physical-address)
1540 (const :format "%v " virtual)
1543 (defun gnus-redefine-select-method-widget ()
1544 "Recomputes the select-method widget based on the value of
1545 `gnus-valid-select-methods'."
1546 (define-widget 'gnus-select-method 'list
1547 "Widget for entering a select method."
1549 :tag "Select Method"
1550 :args `((choice :tag "Method"
1551 ,@(mapcar (lambda (entry)
1552 (list 'const :format "%v\n"
1553 (intern (car entry))))
1554 gnus-valid-select-methods)
1555 (symbol :tag "other"))
1556 (string :tag "Address")
1557 (repeat :tag "Options"
1561 (sexp :tag "Value"))))))
1563 (gnus-redefine-select-method-widget)
1565 (defcustom gnus-updated-mode-lines '(group article summary tree)
1566 "List of buffers that should update their mode lines.
1567 The list may contain the symbols `group', `article', `tree' and
1568 `summary'. If the corresponding symbol is present, Gnus will keep
1569 that mode line updated with information that may be pertinent.
1570 If this variable is nil, screen refresh may be quicker."
1571 :group 'gnus-various
1572 :type '(set (const group)
1577 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1578 (defcustom gnus-mode-non-string-length nil
1579 "*Max length of mode-line non-string contents.
1580 If this is nil, Gnus will take space as is needed, leaving the rest
1581 of the mode line intact. Note that the default of nil is unlikely
1582 to be desirable; see the manual for further details."
1583 :group 'gnus-various
1584 :type '(choice (const nil)
1587 ;; There should be special validation for this.
1588 (define-widget 'gnus-email-address 'string
1589 "An email address.")
1591 (gnus-define-group-parameter
1594 "Return GROUP's to-address."
1596 "*Alist of group regexps and correspondent to-addresses."
1597 :variable-group gnus-group-parameter
1598 :parameter-type '(gnus-email-address :tag "To Address")
1599 :parameter-document "\
1600 This will be used when doing followups and posts.
1602 This is primarily useful in mail groups that represent closed
1603 mailing lists--mailing lists where it's expected that everybody that
1604 writes to the mailing list is subscribed to it. Since using this
1605 parameter ensures that the mail only goes to the mailing list itself,
1606 it means that members won't receive two copies of your followups.
1608 Using `to-address' will actually work whether the group is foreign or
1609 not. Let's say there's a group on the server that is called
1610 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1611 articles from a mail-to-news gateway. Posting directly to this group
1612 is therefore impossible--you have to send mail to the mailing list
1615 The gnus-group-split mail splitting mechanism will behave as if this
1616 address was listed in gnus-group-split Addresses (see below).")
1618 (gnus-define-group-parameter
1621 "Return GROUP's to-list."
1623 "*Alist of group regexps and correspondent to-lists."
1624 :variable-group gnus-group-parameter
1625 :parameter-type '(gnus-email-address :tag "To List")
1626 :parameter-document "\
1627 This address will be used when doing a `a' in the group.
1629 It is totally ignored when doing a followup--except that if it is
1630 present in a news group, you'll get mail group semantics when doing
1633 The gnus-group-split mail splitting mechanism will behave as if this
1634 address was listed in gnus-group-split Addresses (see below).")
1636 (gnus-define-group-parameter
1640 "Return GROUP's subscription status."
1642 "*Groups which are automatically considered subscribed."
1643 :variable-group gnus-group-parameter
1644 :parameter-type '(const :tag "Subscribed" t)
1645 :parameter-document "\
1646 Gnus assumed that you are subscribed to the To/List address.
1648 When constructing a list of subscribed groups using
1649 `gnus-find-subscribed-addresses', Gnus includes the To address given
1650 above, or the list address (if the To address has not been set).")
1652 (gnus-define-group-parameter
1655 :function gnus-group-auto-expirable-p
1657 "Check whether GROUP is auto-expirable or not."
1658 :variable gnus-auto-expirable-newsgroups
1659 :variable-default nil
1661 "*Groups in which to automatically mark read articles as expirable.
1662 If non-nil, this should be a regexp that should match all groups in
1663 which to perform auto-expiry. This only makes sense for mail groups."
1664 :variable-group nnmail-expire
1665 :variable-type '(choice (const nil)
1667 :parameter-type '(const :tag "Automatic Expire" t)
1669 "All articles that are read will be marked as expirable.")
1671 (gnus-define-group-parameter
1674 :function gnus-group-total-expirable-p
1676 "Check whether GROUP is total-expirable or not."
1677 :variable gnus-total-expirable-newsgroups
1678 :variable-default nil
1680 "*Groups in which to perform expiry of all read articles.
1681 Use with extreme caution. All groups that match this regexp will be
1682 expiring - which means that all read articles will be deleted after
1683 \(say) one week. (This only goes for mail groups and the like, of
1685 :variable-group nnmail-expire
1686 :variable-type '(choice (const nil)
1688 :parameter-type '(const :tag "Total Expire" t)
1690 "All read articles will be put through the expiry process
1692 This happens even if they are not marked as expirable.
1695 (gnus-define-group-parameter
1698 "Return the default charset of GROUP."
1699 :variable gnus-group-charset-alist
1701 '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1702 ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1703 ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1704 ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1705 ("\\(^\\|:\\)relcom\\>" koi8-r)
1706 ("\\(^\\|:\\)fido7\\>" koi8-r)
1707 ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1708 ("\\(^\\|:\\)israel\\>" iso-8859-1)
1709 ("\\(^\\|:\\)han\\>" euc-kr)
1710 ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1711 ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1712 ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1714 "Alist of regexps (to match group names) and default charsets to be used when reading."
1715 :variable-group gnus-charset
1716 :variable-type '(repeat (list (regexp :tag "Group")
1717 (symbol :tag "Charset")))
1718 :parameter-type '(symbol :tag "Charset")
1719 :parameter-document "\
1720 The default charset to use in the group.")
1722 (gnus-define-group-parameter
1726 "Return a posting method for GROUP."
1727 :variable gnus-post-method-alist
1729 "Alist of regexps (to match group names) and method to be used when
1730 posting an article."
1731 :variable-group gnus-group-foreign
1733 '(choice :tag "Posting Method"
1734 (const :tag "Use native server" native)
1735 (const :tag "Use current server" current)
1736 (list :convert-widget
1738 (list 'sexp :tag "Methods"
1739 :value gnus-select-method))))
1741 "Posting method for this group.")
1743 (gnus-define-group-parameter
1744 large-newsgroup-initial
1747 "Return GROUP's initial input of the number of articles."
1749 "*Alist of group regexps and its initial input of the number of articles."
1750 :variable-group gnus-group-parameter
1751 :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1752 (const :tag "All" nil)
1754 :parameter-document "\
1756 This number will be prompted as the initial value of the number of
1757 articles to list when the group is a large newsgroup (see
1758 `gnus-large-newsgroup'). If it is nil, the default value is the
1759 total number of articles in the group.")
1761 ;; The Gnus registry's ignored groups
1762 (gnus-define-group-parameter
1766 "Whether this group should be ignored by the registry."
1767 :variable gnus-registry-ignored-groups
1768 :variable-default nil
1770 "*Groups in which the registry should be turned off."
1771 :variable-group gnus-registry
1772 :variable-type '(repeat
1774 (regexp :tag "Group Name Regular Expression")
1775 (boolean :tag "Ignored")))
1777 :parameter-type '(boolean :tag "Group Ignored by the Registry")
1779 "Whether the Gnus Registry should ignore this group.")
1781 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1782 (defcustom gnus-install-group-spam-parameters t
1783 "*Disable the group parameters for spam detection.
1784 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1789 (when gnus-install-group-spam-parameters
1790 (defvar gnus-group-spam-classification-spam t
1791 "Spam group classification (requires spam.el).
1792 This group contains spam messages. On summary entry, unread messages
1793 will be marked as spam. On summary exit, the specified spam
1794 processors will be invoked on spam-marked messages, then those
1795 messages will be expired, so the spam processor will only see a
1796 spam-marked message once.")
1798 (defvar gnus-group-spam-classification-ham 'ask
1799 "The ham value for the spam group parameter (requires spam.el).
1800 On summary exit, the specified ham processors will be invoked on
1801 ham-marked messages. Exercise caution, since the ham processor will
1802 see the same message more than once because there is no ham message
1805 (gnus-define-group-parameter
1809 "The spam type (spam, ham, or neither) of the group."
1810 :variable gnus-spam-newsgroup-contents
1811 :variable-default nil
1813 "*Group classification (spam, ham, or neither). Only
1814 meaningful when spam.el is loaded. If non-nil, this should be a
1815 list of group name regexps associated with a classification for
1816 each one. In spam groups, new articles are marked as spam on
1817 summary entry. There is other behavior associated with ham and
1818 no classification when spam.el is loaded - see the manual."
1819 :variable-group spam
1820 :variable-type '(repeat
1821 (list :tag "Group contents spam/ham classification"
1822 (regexp :tag "Group")
1824 (variable-item gnus-group-spam-classification-spam)
1825 (variable-item gnus-group-spam-classification-ham)
1826 (const :tag "Unclassified" nil))))
1828 :parameter-type '(list :tag "Group contents spam/ham classification"
1829 (choice :tag "Group contents classification for spam sorting"
1830 (variable-item gnus-group-spam-classification-spam)
1831 (variable-item gnus-group-spam-classification-ham)
1832 (const :tag "Unclassified" nil)))
1834 "The spam classification (spam, ham, or neither) of this group.
1835 When a spam group is entered, all unread articles are marked as
1836 spam. There is other behavior associated with ham and no
1837 classification when spam.el is loaded - see the manual.")
1839 (gnus-define-group-parameter
1843 "The address to get spam resent (through spam-report-resend)."
1844 :variable gnus-spam-resend-to
1845 :variable-default nil
1847 "The address to get spam resent (through spam-report-resend)."
1848 :variable-group spam
1849 :variable-type '(repeat
1850 (list :tag "Group address for resending spam"
1851 (regexp :tag "Group")
1852 (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1853 :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1855 "The address to get spam resent (through spam-report-resend).")
1857 (gnus-define-group-parameter
1861 "The address to get ham resent (through spam-report-resend)."
1862 :variable gnus-ham-resend-to
1863 :variable-default nil
1865 "The address to get ham resent (through spam-report-resend)."
1866 :variable-group spam
1867 :variable-type '(repeat
1868 (list :tag "Group address for resending ham"
1869 (regexp :tag "Group")
1870 (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1871 :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1873 "The address to get ham resent (through spam-report-resend).")
1875 (defvar gnus-group-spam-exit-processor-ifile "ifile"
1876 "OBSOLETE: The ifile summary exit spam processor.")
1878 (defvar gnus-group-spam-exit-processor-stat "stat"
1879 "OBSOLETE: The spam-stat summary exit spam processor.")
1881 (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1882 "OBSOLETE: The Bogofilter summary exit spam processor.")
1884 (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1885 "OBSOLETE: The Blacklist summary exit spam processor.")
1887 (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1888 "OBSOLETE: The Gmane reporting summary exit spam processor.
1889 Only applicable to NNTP groups with articles from Gmane. See spam-report.el")
1891 (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1892 "OBSOLETE: The spamoracle summary exit spam processor.")
1894 (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1895 "OBSOLETE: The ifile summary exit ham processor.
1896 Only applicable to non-spam (unclassified and ham) groups.")
1898 (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1899 "OBSOLETE: The Bogofilter summary exit ham processor.
1900 Only applicable to non-spam (unclassified and ham) groups.")
1902 (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1903 "OBSOLETE: The spam-stat summary exit ham processor.
1904 Only applicable to non-spam (unclassified and ham) groups.")
1906 (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1907 "OBSOLETE: The whitelist summary exit ham processor.
1908 Only applicable to non-spam (unclassified and ham) groups.")
1910 (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1911 "OBSOLETE: The BBDB summary exit ham processor.
1912 Only applicable to non-spam (unclassified and ham) groups.")
1914 (defvar gnus-group-ham-exit-processor-copy "copy"
1915 "OBSOLETE: The ham copy exit ham processor.
1916 Only applicable to non-spam (unclassified and ham) groups.")
1918 (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1919 "OBSOLETE: The spamoracle summary exit ham processor.
1920 Only applicable to non-spam (unclassified and ham) groups.")
1922 (gnus-define-group-parameter
1927 :tag "Spam Summary Exit Processor"
1929 (list :tag "Spam Summary Exit Processor Choices"
1931 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1932 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1933 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1934 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1935 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1936 (const :tag "Spam: ifile" (spam spam-use-ifile))
1937 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1938 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1939 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1940 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1941 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1942 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1943 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1944 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1945 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1946 (const :tag "Ham: ifile" (ham spam-use-ifile))
1947 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1948 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1949 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
1950 (const :tag "Ham: CRM114" (ham spam-use-crm114))
1951 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
1952 (variable-item gnus-group-spam-exit-processor-ifile)
1953 (variable-item gnus-group-spam-exit-processor-stat)
1954 (variable-item gnus-group-spam-exit-processor-bogofilter)
1955 (variable-item gnus-group-spam-exit-processor-blacklist)
1956 (variable-item gnus-group-spam-exit-processor-spamoracle)
1957 (variable-item gnus-group-spam-exit-processor-report-gmane)
1958 (variable-item gnus-group-ham-exit-processor-bogofilter)
1959 (variable-item gnus-group-ham-exit-processor-ifile)
1960 (variable-item gnus-group-ham-exit-processor-stat)
1961 (variable-item gnus-group-ham-exit-processor-whitelist)
1962 (variable-item gnus-group-ham-exit-processor-BBDB)
1963 (variable-item gnus-group-ham-exit-processor-spamoracle)
1964 (variable-item gnus-group-ham-exit-processor-copy))))
1966 "Which spam or ham processors will be applied when the summary is exited."
1967 :variable gnus-spam-process-newsgroups
1968 :variable-default nil
1970 "*Groups in which to automatically process spam or ham articles with
1971 a backend on summary exit. If non-nil, this should be a list of group
1972 name regexps that should match all groups in which to do automatic
1973 spam processing, associated with the appropriate processor."
1974 :variable-group spam
1976 '(repeat :tag "Spam/Ham Processors"
1977 (list :tag "Spam Summary Exit Processor Choices"
1978 (regexp :tag "Group Regexp")
1980 :tag "Spam/Ham Summary Exit Processor"
1981 (const :tag "Spam: Bogofilter" (spam spam-use-bogofilter))
1982 (const :tag "Spam: Blacklist" (spam spam-use-blacklist))
1983 (const :tag "Spam: Bsfilter" (spam spam-use-bsfilter))
1984 (const :tag "Spam: Gmane Report" (spam spam-use-gmane))
1985 (const :tag "Spam: Resend Message"(spam spam-use-resend))
1986 (const :tag "Spam: ifile" (spam spam-use-ifile))
1987 (const :tag "Spam: Spam-stat" (spam spam-use-stat))
1988 (const :tag "Spam: Spam Oracle" (spam spam-use-spamoracle))
1989 (const :tag "Spam: SpamAssassin" (spam spam-use-spamassassin))
1990 (const :tag "Spam: CRM114" (spam spam-use-crm114))
1991 (const :tag "Ham: BBDB" (ham spam-use-BBDB))
1992 (const :tag "Ham: Bogofilter" (ham spam-use-bogofilter))
1993 (const :tag "Ham: Bsfilter" (ham spam-use-bsfilter))
1994 (const :tag "Ham: Copy" (ham spam-use-ham-copy))
1995 (const :tag "Ham: Resend Message" (ham spam-use-resend))
1996 (const :tag "Ham: ifile" (ham spam-use-ifile))
1997 (const :tag "Ham: Spam-stat" (ham spam-use-stat))
1998 (const :tag "Ham: Spam Oracle" (ham spam-use-spamoracle))
1999 (const :tag "Ham: SpamAssassin" (ham spam-use-spamassassin))
2000 (const :tag "Ham: CRM114" (ham spam-use-crm114))
2001 (const :tag "Ham: Whitelist" (ham spam-use-whitelist))
2002 (variable-item gnus-group-spam-exit-processor-ifile)
2003 (variable-item gnus-group-spam-exit-processor-stat)
2004 (variable-item gnus-group-spam-exit-processor-bogofilter)
2005 (variable-item gnus-group-spam-exit-processor-blacklist)
2006 (variable-item gnus-group-spam-exit-processor-spamoracle)
2007 (variable-item gnus-group-spam-exit-processor-report-gmane)
2008 (variable-item gnus-group-ham-exit-processor-bogofilter)
2009 (variable-item gnus-group-ham-exit-processor-ifile)
2010 (variable-item gnus-group-ham-exit-processor-stat)
2011 (variable-item gnus-group-ham-exit-processor-whitelist)
2012 (variable-item gnus-group-ham-exit-processor-BBDB)
2013 (variable-item gnus-group-ham-exit-processor-spamoracle)
2014 (variable-item gnus-group-ham-exit-processor-copy))))
2017 "Which spam or ham processors will be applied when the summary is exited.")
2019 (gnus-define-group-parameter
2023 '(boolean :tag "Spam autodetection")
2025 "Should spam be autodetected (with spam-split) in this group?"
2026 :variable gnus-spam-autodetect
2027 :variable-default nil
2029 "*Groups in which spam should be autodetected when they are entered.
2030 Only unseen articles will be examined, unless
2031 spam-autodetect-recheck-messages is set."
2032 :variable-group spam
2035 :tag "Autodetection setting"
2037 (regexp :tag "Group Regexp")
2040 "Spam autodetection.
2041 Only unseen articles will be examined, unless
2042 spam-autodetect-recheck-messages is set.")
2044 (gnus-define-group-parameter
2045 spam-autodetect-methods
2048 '(choice :tag "Spam autodetection-specific methods"
2051 (set :tag "Use specific methods"
2052 (variable-item spam-use-blacklist)
2053 (variable-item spam-use-gmane-xref)
2054 (variable-item spam-use-regex-headers)
2055 (variable-item spam-use-regex-body)
2056 (variable-item spam-use-whitelist)
2057 (variable-item spam-use-BBDB)
2058 (variable-item spam-use-ifile)
2059 (variable-item spam-use-spamoracle)
2060 (variable-item spam-use-crm114)
2061 (variable-item spam-use-spamassassin)
2062 (variable-item spam-use-spamassassin-headers)
2063 (variable-item spam-use-bsfilter)
2064 (variable-item spam-use-bsfilter-headers)
2065 (variable-item spam-use-stat)
2066 (variable-item spam-use-blackholes)
2067 (variable-item spam-use-hashcash)
2068 (variable-item spam-use-bogofilter-headers)
2069 (variable-item spam-use-bogofilter)))
2071 "Methods to be used for autodetection in each group"
2072 :variable gnus-spam-autodetect-methods
2073 :variable-default nil
2075 "*Methods for autodetecting spam per group.
2076 Requires the spam-autodetect parameter. Only unseen articles
2077 will be examined, unless spam-autodetect-recheck-messages is
2079 :variable-group spam
2082 :tag "Autodetection methods"
2084 (regexp :tag "Group Regexp")
2088 (set :tag "Use specific methods"
2089 (variable-item spam-use-blacklist)
2090 (variable-item spam-use-gmane-xref)
2091 (variable-item spam-use-regex-headers)
2092 (variable-item spam-use-regex-body)
2093 (variable-item spam-use-whitelist)
2094 (variable-item spam-use-BBDB)
2095 (variable-item spam-use-ifile)
2096 (variable-item spam-use-spamoracle)
2097 (variable-item spam-use-crm114)
2098 (variable-item spam-use-stat)
2099 (variable-item spam-use-blackholes)
2100 (variable-item spam-use-hashcash)
2101 (variable-item spam-use-spamassassin)
2102 (variable-item spam-use-spamassassin-headers)
2103 (variable-item spam-use-bsfilter)
2104 (variable-item spam-use-bsfilter-headers)
2105 (variable-item spam-use-bogofilter-headers)
2106 (variable-item spam-use-bogofilter)))))
2108 "Spam autodetection methods.
2109 Requires the spam-autodetect parameter. Only unseen articles
2110 will be examined, unless spam-autodetect-recheck-messages is
2113 (gnus-define-group-parameter
2114 spam-process-destination
2117 '(choice :tag "Destination for spam-processed articles at summary exit"
2118 (string :tag "Move to a group")
2119 (repeat :tag "Move to multiple groups"
2120 (string :tag "Destination group"))
2121 (const :tag "Expire" nil))
2123 "Where spam-processed articles will go at summary exit."
2124 :variable gnus-spam-process-destinations
2125 :variable-default nil
2127 "*Groups in which to explicitly send spam-processed articles to
2128 another group, or expire them (the default). If non-nil, this should
2129 be a list of group name regexps that should match all groups in which
2130 to do spam-processed article moving, associated with the destination
2131 group or nil for explicit expiration. This only makes sense for
2133 :variable-group spam
2136 :tag "Spam-processed articles destination"
2138 (regexp :tag "Group Regexp")
2140 :tag "Destination for spam-processed articles at summary exit"
2141 (string :tag "Move to a group")
2142 (repeat :tag "Move to multiple groups"
2143 (string :tag "Destination group"))
2144 (const :tag "Expire" nil))))
2146 "Where spam-processed articles will go at summary exit.")
2148 (gnus-define-group-parameter
2149 ham-process-destination
2153 :tag "Destination for ham articles at summary exit from a spam group"
2154 (string :tag "Move to a group")
2155 (repeat :tag "Move to multiple groups"
2156 (string :tag "Destination group"))
2157 (const :tag "Respool" respool)
2158 (const :tag "Do nothing" nil))
2160 "Where ham articles will go at summary exit from a spam group."
2161 :variable gnus-ham-process-destinations
2162 :variable-default nil
2164 "*Groups in which to explicitly send ham articles to
2165 another group, or do nothing (the default). If non-nil, this should
2166 be a list of group name regexps that should match all groups in which
2167 to do ham article moving, associated with the destination
2168 group or nil for explicit ignoring. This only makes sense for
2169 mail groups, and only works in spam groups."
2170 :variable-group spam
2173 :tag "Ham articles destination"
2175 (regexp :tag "Group Regexp")
2177 :tag "Destination for ham articles at summary exit from spam group"
2178 (string :tag "Move to a group")
2179 (repeat :tag "Move to multiple groups"
2180 (string :tag "Destination group"))
2181 (const :tag "Respool" respool)
2182 (const :tag "Expire" nil))))
2184 "Where ham articles will go at summary exit from a spam group.")
2186 (gnus-define-group-parameter
2189 :parameter-type '(list :tag "Ham mark choices"
2191 (variable-item gnus-del-mark)
2192 (variable-item gnus-read-mark)
2193 (variable-item gnus-ticked-mark)
2194 (variable-item gnus-killed-mark)
2195 (variable-item gnus-kill-file-mark)
2196 (variable-item gnus-low-score-mark)))
2199 "Marks considered ham (positively not spam). Such articles will be
2200 processed as ham (non-spam) on group exit. When nil, the global
2201 spam-ham-marks variable takes precedence."
2202 :variable-default '((".*" ((gnus-del-mark
2206 gnus-low-score-mark))))
2207 :variable-group spam
2209 "*Groups in which to explicitly set the ham marks to some value.")
2211 (gnus-define-group-parameter
2214 :parameter-type '(list :tag "Spam mark choices"
2216 (variable-item gnus-spam-mark)
2217 (variable-item gnus-killed-mark)
2218 (variable-item gnus-kill-file-mark)
2219 (variable-item gnus-low-score-mark)))
2222 "Marks considered spam.
2223 Such articles will be processed as spam on group exit. When nil, the global
2224 spam-spam-marks variable takes precedence."
2225 :variable-default '((".*" ((gnus-spam-mark))))
2226 :variable-group spam
2228 "*Groups in which to explicitly set the spam marks to some value."))
2230 (defcustom gnus-group-uncollapsed-levels 1
2231 "Number of group name elements to leave alone when making a short group name."
2232 :group 'gnus-group-visual
2235 (defcustom gnus-group-use-permanent-levels nil
2236 "*If non-nil, once you set a level, Gnus will use this level."
2237 :group 'gnus-group-levels
2242 (defcustom gnus-load-hook nil
2243 "A hook run while Gnus is loaded."
2247 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2248 "A hook called to apply kill files to a group.
2249 This hook is intended to apply a kill file to the selected newsgroup.
2250 The function `gnus-apply-kill-file' is called by default.
2252 Since a general kill file is too heavy to use only for a few
2253 newsgroups, I recommend you to use a lighter hook function. For
2254 example, if you'd like to apply a kill file to articles which contains
2255 a string `rmgroup' in subject in newsgroup `control', you can use the
2258 (setq gnus-apply-kill-hook
2261 (cond ((string-match \"control\" gnus-newsgroup-name)
2262 (gnus-kill \"Subject\" \"rmgroup\")
2263 (gnus-expunge \"X\"))))))"
2264 :group 'gnus-score-kill
2265 :options '(gnus-apply-kill-file)
2268 (defcustom gnus-group-change-level-function nil
2269 "Function run when a group level is changed.
2270 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2271 :group 'gnus-group-levels
2276 (defcustom gnus-visual
2277 '(summary-highlight group-highlight article-highlight
2279 summary-menu group-menu article-menu
2280 tree-highlight menu highlight
2281 browse-menu server-menu
2282 page-marker tree-menu binary-menu pick-menu)
2283 "*Enable visual features.
2284 If `visual' is disabled, there will be no menus and few faces. Most of
2285 the visual customization options below will be ignored. Gnus will use
2286 less space and be faster as a result.
2288 This variable can also be a list of visual elements to switch on. For
2289 instance, to switch off all visual things except menus, you can say:
2291 (setq gnus-visual '(menu))
2293 Valid elements include `summary-highlight', `group-highlight',
2294 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2295 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2296 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2299 :type '(set (const summary-highlight)
2300 (const group-highlight)
2301 (const article-highlight)
2303 (const summary-menu)
2305 (const article-menu)
2306 (const tree-highlight)
2316 ;; Byte-compiler warning.
2317 (defvar gnus-visual)
2318 ;; Find out whether the gnus-visual TYPE is wanted.
2319 (defun gnus-visual-p (&optional type class)
2320 (and gnus-visual ; Has to be non-nil, at least.
2321 (if (not type) ; We don't care about type.
2323 (if (listp gnus-visual) ; It's a list, so we check it.
2324 (or (memq type gnus-visual)
2325 (memq class gnus-visual))
2328 (defcustom gnus-mouse-face
2330 (if (gnus-visual-p 'mouse-face 'highlight)
2331 (if (boundp 'gnus-mouse-face)
2332 (or gnus-mouse-face 'highlight)
2336 "*Face used for group or summary buffer mouse highlighting.
2337 The line beneath the mouse pointer will be highlighted with this
2342 (defcustom gnus-article-save-directory gnus-directory
2343 "*Name of the directory articles will be saved in (default \"~/News\")."
2344 :group 'gnus-article-saving
2347 (defvar gnus-plugged t
2348 "Whether Gnus is plugged or not.")
2350 (defcustom gnus-agent-cache t
2351 "Controls use of the agent cache while plugged.
2352 When set, Gnus will prefer using the locally stored content rather
2353 than re-fetching it from the server. You also need to enable
2354 `gnus-agent' for this to have any affect."
2359 (defcustom gnus-default-charset 'undecided
2360 "Default charset assumed to be used when viewing non-ASCII characters.
2361 This variable is overridden on a group-to-group basis by the
2362 `gnus-group-charset-alist' variable and is only used on groups not
2363 covered by that variable."
2365 :group 'gnus-charset)
2367 ;; Fixme: Doc reference to agent.
2368 (defcustom gnus-agent t
2369 "Whether we want to use the Gnus agent or not.
2371 You may customize gnus-agent to disable its use. However, some
2372 back ends have started to use the agent as a client-side cache.
2373 Disabling the agent may result in noticeable loss of performance."
2378 (defcustom gnus-other-frame-function 'gnus
2379 "Function called by the command `gnus-other-frame'."
2381 :type '(choice (function-item gnus)
2382 (function-item gnus-no-server)
2383 (function-item gnus-slave)
2384 (function-item gnus-slave-no-server)))
2386 (defcustom gnus-other-frame-parameters nil
2387 "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2388 This should be an alist for Emacs, or a plist for XEmacs."
2390 :type (if (featurep 'xemacs)
2391 '(repeat (list :inline t :format "%v"
2392 (symbol :tag "Property")
2393 (sexp :tag "Value")))
2394 '(repeat (cons :format "%v"
2395 (symbol :tag "Parameter")
2396 (sexp :tag "Value")))))
2398 (defcustom gnus-user-agent '(emacs gnus type)
2399 "Which information should be exposed in the User-Agent header.
2401 Can be a list of symbols or a string. Valid symbols are `gnus'
2402 \(show Gnus version\) and `emacs' \(show Emacs version\). In
2403 addition to the Emacs version, you can add `codename' \(show
2404 \(S\)XEmacs codename\) or either `config' \(show system
2405 configuration\) or `type' \(show system type\). If you set it to
2406 a string, be sure to use a valid format, see RFC 2616."
2409 :group 'gnus-message
2410 :type '(choice (list (set :inline t
2411 (const gnus :tag "Gnus version")
2412 (const emacs :tag "Emacs version")
2413 (choice :tag "system"
2414 (const type :tag "system type")
2415 (const config :tag "system configuration"))
2416 (const codename :tag "Emacs codename")))
2419 ;; Convert old (< 2005-01-10) symbol type values:
2420 (when (symbolp gnus-user-agent)
2421 (setq gnus-user-agent
2422 (cond ((eq gnus-user-agent 'emacs-gnus-config)
2423 '(emacs gnus config))
2424 ((eq gnus-user-agent 'emacs-gnus-type)
2426 ((eq gnus-user-agent 'emacs-gnus)
2428 ((eq gnus-user-agent 'gnus)
2430 (t gnus-user-agent)))
2431 (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2433 (if (get 'gnus-user-agent 'saved-value)
2434 (customize-save-variable 'gnus-user-agent gnus-user-agent)
2435 (gnus-message 1 "Edit your init file to make this change permanent.")
2439 ;;; Internal variables
2441 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2442 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2443 (defvar gnus-agent-method-p-cache nil
2444 ; Reset each time gnus-agent-covered-methods is changed else
2445 ; gnus-agent-method-p may mis-report a methods status.
2447 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2448 (defvar gnus-draft-meta-information-header "X-Draft-From")
2449 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2450 (defvar gnus-original-article-buffer " *Original Article*")
2451 (defvar gnus-newsgroup-name nil)
2452 (defvar gnus-ephemeral-servers nil)
2453 (defvar gnus-server-method-cache nil)
2455 (defvar gnus-agent-fetching nil
2456 "Whether Gnus agent is in fetching mode.")
2458 (defvar gnus-agent-covered-methods nil
2459 "A list of servers, NOT methods, showing which servers are covered by the agent.")
2461 (defvar gnus-command-method nil
2462 "Dynamically bound variable that says what the current back end is.")
2464 (defvar gnus-current-select-method nil
2465 "The current method for selecting a newsgroup.")
2467 (defvar gnus-tree-buffer "*Tree*"
2468 "Buffer where Gnus thread trees are displayed.")
2471 (defvar gnus-use-generic-from nil)
2473 ;; Variable holding the user answers to all method prompts.
2474 (defvar gnus-method-history nil)
2476 ;; Variable holding the user answers to all mail method prompts.
2477 (defvar gnus-mail-method-history nil)
2479 ;; Variable holding the user answers to all group prompts.
2480 (defvar gnus-group-history nil)
2482 (defvar gnus-server-alist nil
2483 "List of available servers.")
2485 (defcustom gnus-cache-directory
2486 (nnheader-concat gnus-directory "cache/")
2487 "*The directory where cached articles will be stored."
2491 (defvar gnus-predefined-server-alist
2494 (nnspool-spool-directory ,gnus-cache-directory)
2495 (nnspool-nov-directory ,gnus-cache-directory)
2496 (nnspool-active-file
2497 ,(nnheader-concat gnus-cache-directory "active"))))
2498 "List of predefined (convenience) servers.")
2500 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2502 (defconst gnus-article-mark-lists
2503 '((marked . tick) (replied . reply)
2504 (expirable . expire) (killed . killed)
2505 (bookmarks . bookmark) (dormant . dormant)
2506 (scored . score) (saved . save)
2507 (cached . cache) (downloadable . download)
2508 (unsendable . unsend) (forwarded . forward)
2509 (recent . recent) (seen . seen)))
2511 (defconst gnus-article-special-mark-lists
2517 ;; Propagate flags to server, with the following exceptions:
2518 ;; `seen' is private to each gnus installation
2519 ;; `cache' is a internal gnus flag for each gnus installation
2520 ;; `download' is a agent flag private to each gnus installation
2521 ;; `unsend' are for nndraft groups only
2522 ;; `score' is not a proper mark
2523 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2524 (defconst gnus-article-unpropagated-mark-lists
2525 '(seen cache download unsend score bookmark)
2526 "Marks that shouldn't be propagated to back ends.
2527 Typical marks are those that make no sense in a standalone back end,
2528 such as a mark that says whether an article is stored in the cache
2529 \(which doesn't make sense in a standalone back end).")
2531 (defvar gnus-headers-retrieved-by nil)
2532 (defvar gnus-article-reply nil)
2533 (defvar gnus-override-method nil)
2534 (defvar gnus-opened-servers nil)
2536 (defvar gnus-current-kill-article nil)
2538 (defvar gnus-have-read-active-file nil)
2540 (defconst gnus-maintainer
2541 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2542 "The mail address of the Gnus maintainers.")
2544 (defvar gnus-info-nodes
2545 '((gnus-group-mode "(gnus)Group Buffer")
2546 (gnus-summary-mode "(gnus)Summary Buffer")
2547 (gnus-article-mode "(gnus)Article Buffer")
2548 (gnus-server-mode "(gnus)Server Buffer")
2549 (gnus-browse-mode "(gnus)Browse Foreign Server")
2550 (gnus-tree-mode "(gnus)Tree Display"))
2551 "Alist of major modes and related Info nodes.")
2553 (defvar gnus-group-buffer "*Group*")
2554 (defvar gnus-summary-buffer "*Summary*")
2555 (defvar gnus-article-buffer "*Article*")
2556 (defvar gnus-server-buffer "*Server*")
2558 (defvar gnus-slave nil
2559 "Whether this Gnus is a slave or not.")
2561 (defvar gnus-batch-mode nil
2562 "Whether this Gnus is running in batch mode or not.")
2564 (defvar gnus-variable-list
2565 '(gnus-newsrc-options gnus-newsrc-options-n
2566 gnus-newsrc-last-checked-date
2567 gnus-newsrc-alist gnus-server-alist
2568 gnus-killed-list gnus-zombie-list
2569 gnus-topic-topology gnus-topic-alist
2571 "Gnus variables saved in the quick startup file.")
2573 (defvar gnus-newsrc-alist nil
2574 "Assoc list of read articles.
2575 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2577 (defvar gnus-registry-alist nil
2578 "Assoc list of registry data.
2579 gnus-registry.el will populate this if it's loaded.")
2581 (defvar gnus-newsrc-hashtb nil
2582 "Hashtable of `gnus-newsrc-alist'.")
2584 (defvar gnus-killed-list nil
2585 "List of killed newsgroups.")
2587 (defvar gnus-killed-hashtb nil
2588 "Hash table equivalent of `gnus-killed-list'.")
2590 (defvar gnus-zombie-list nil
2591 "List of almost dead newsgroups.")
2593 (defvar gnus-description-hashtb nil
2594 "Descriptions of newsgroups.")
2596 (defvar gnus-list-of-killed-groups nil
2597 "List of newsgroups that have recently been killed by the user.")
2599 (defvar gnus-active-hashtb nil
2600 "Hashtable of active articles.")
2602 (defvar gnus-moderated-hashtb nil
2603 "Hashtable of moderated newsgroups.")
2605 ;; Save window configuration.
2606 (defvar gnus-prev-winconf nil)
2608 (defvar gnus-reffed-article-number nil)
2610 ;;; Let the byte-compiler know that we know about this variable.
2611 (defvar rmail-default-rmail-file)
2613 (defvar gnus-dead-summary nil)
2615 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2616 "Regexp matching invalid groups.")
2618 (defvar gnus-other-frame-object nil
2619 "A frame object which will be created by `gnus-other-frame'.")
2621 ;;; End of variables.
2623 ;; Define some autoload functions Gnus might use.
2626 ;; This little mapcar goes through the list below and marks the
2627 ;; symbols in question as autoloaded functions.
2630 (let ((interactive (nth 1 (memq ':interactive package))))
2634 (when (consp function)
2635 (setq keymap (car (memq 'keymap function)))
2636 (setq function (car function)))
2637 (unless (fboundp function)
2638 (autoload function (car package) nil interactive keymap))))
2639 (if (eq (nth 1 package) ':interactive)
2642 '(("info" :interactive t Info-goto-node)
2644 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2645 ("ps-print" ps-print-preprint)
2646 ("message" :interactive t
2647 message-send-and-exit message-yank-original)
2648 ("babel" babel-as-string)
2649 ("nnmail" nnmail-split-fancy nnmail-article-group)
2650 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2651 ("rmailout" rmail-output rmail-output-to-rmail-file)
2652 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2653 rmail-show-message rmail-summary-exists
2654 rmail-select-summary rmail-update-summary)
2655 ("gnus-audio" :interactive t gnus-audio-play)
2656 ("gnus-xmas" gnus-xmas-splash)
2657 ("gnus-soup" :interactive t
2658 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2659 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2660 ("nnsoup" nnsoup-pack-replies)
2661 ("score-mode" :interactive t gnus-score-mode)
2662 ("gnus-mh" gnus-summary-save-article-folder
2663 gnus-Folder-save-name gnus-folder-save-name)
2664 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2665 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2666 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2667 gnus-demon-add-disconnection gnus-demon-add-handler
2668 gnus-demon-remove-handler)
2669 ("gnus-demon" :interactive t
2670 gnus-demon-init gnus-demon-cancel)
2671 ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2672 gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2673 gnus-face-from-file)
2674 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2675 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2676 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2677 gnus-nocem-unwanted-article-p)
2678 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2679 gnus-server-server-name)
2680 ("gnus-srvr" gnus-browse-foreign-server)
2681 ("gnus-cite" :interactive t
2682 gnus-article-highlight-citation gnus-article-hide-citation-maybe
2683 gnus-article-hide-citation gnus-article-fill-cited-article
2684 gnus-article-hide-citation-in-followups)
2685 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2686 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2687 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2688 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2689 gnus-cache-possibly-remove-articles gnus-cache-request-article
2690 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2691 gnus-cache-enter-remove-article gnus-cached-article-p
2692 gnus-cache-open gnus-cache-close gnus-cache-update-article
2693 gnus-cache-articles-in-group)
2694 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2695 gnus-cache-remove-article gnus-summary-insert-cached-articles)
2696 ("gnus-score" :interactive t
2697 gnus-summary-increase-score gnus-summary-set-score
2698 gnus-summary-raise-thread gnus-summary-raise-same-subject
2699 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2700 gnus-summary-lower-thread gnus-summary-lower-same-subject
2701 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2702 gnus-summary-current-score gnus-score-delta-default
2703 gnus-score-flush-cache gnus-score-close
2704 gnus-possibly-score-headers gnus-score-followup-article
2705 gnus-score-followup-thread)
2707 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2708 gnus-current-score-file-nondirectory gnus-score-adaptive
2709 gnus-score-find-trace gnus-score-file-name)
2710 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2711 ("gnus-topic" :interactive t gnus-topic-mode)
2712 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2713 gnus-subscribe-topics)
2714 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2715 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2716 ("gnus-uu" :interactive t
2717 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2718 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2719 gnus-uu-mark-by-regexp gnus-uu-mark-all
2720 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2721 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2722 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2723 gnus-uu-decode-binhex gnus-uu-decode-uu-view
2724 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2725 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2726 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2727 gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2728 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2729 ("gnus-msg" (gnus-summary-send-map keymap)
2730 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2731 ("gnus-msg" :interactive t
2732 gnus-group-post-news gnus-group-mail gnus-group-news
2733 gnus-summary-post-news gnus-summary-news-other-window
2734 gnus-summary-followup gnus-summary-followup-with-original
2735 gnus-summary-cancel-article gnus-summary-supersede-article
2736 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2737 gnus-summary-mail-forward gnus-summary-mail-other-window
2738 gnus-summary-resend-message gnus-summary-resend-bounced-mail
2739 gnus-summary-wide-reply gnus-summary-followup-to-mail
2740 gnus-summary-followup-to-mail-with-original gnus-bug
2741 gnus-summary-wide-reply-with-original
2742 gnus-summary-post-forward gnus-summary-wide-reply-with-original
2743 gnus-summary-post-forward)
2744 ("gnus-picon" :interactive t gnus-treat-from-picon)
2745 ("smiley" :interactive t smiley-region)
2746 ("gnus-win" gnus-configure-windows gnus-add-configuration)
2747 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2748 gnus-list-of-unread-articles gnus-list-of-read-articles
2749 gnus-offer-save-summaries gnus-make-thread-indent-array
2750 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2751 gnus-summary-skip-intangible gnus-summary-article-number
2752 gnus-data-header gnus-data-find)
2753 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2754 gnus-group-list-groups gnus-group-first-unread-group
2755 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2756 gnus-group-setup-buffer gnus-group-get-new-news
2757 gnus-group-make-help-group gnus-group-update-group
2758 gnus-group-iterate gnus-group-group-name)
2759 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2760 gnus-backlog-remove-article)
2761 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2762 gnus-article-prepare gnus-article-set-window-start
2763 gnus-article-next-page gnus-article-prev-page
2764 gnus-request-article-this-buffer gnus-article-mode
2765 gnus-article-setup-buffer gnus-narrow-to-page
2766 gnus-article-delete-invisible-text gnus-treat-article)
2767 ("gnus-art" :interactive t
2768 gnus-article-hide-headers gnus-article-hide-boring-headers
2769 gnus-article-treat-overstrike
2770 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2771 gnus-article-display-x-face gnus-article-de-quoted-unreadable
2772 gnus-article-de-base64-unreadable
2773 gnus-article-decode-HZ
2774 gnus-article-wash-html
2775 gnus-article-unsplit-urls
2776 gnus-article-hide-pem gnus-article-hide-signature
2777 gnus-article-strip-leading-blank-lines gnus-article-date-local
2778 gnus-article-date-original gnus-article-date-lapsed
2779 ;; gnus-article-show-all-headers
2780 gnus-article-edit-mode gnus-article-edit-article
2781 gnus-article-edit-done gnus-article-decode-encoded-words
2782 gnus-start-date-timer gnus-stop-date-timer
2783 gnus-mime-view-all-parts)
2784 ("gnus-int" gnus-request-type)
2785 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2786 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2787 gnus-check-reasonable-setup)
2788 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2789 gnus-dup-enter-articles)
2790 ("gnus-range" gnus-copy-sequence)
2791 ("gnus-eform" gnus-edit-form)
2792 ("gnus-move" :interactive t
2793 gnus-group-move-group-to-server gnus-change-server)
2794 ("gnus-logic" gnus-score-advanced)
2795 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2796 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2797 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2798 gnus-async-halt-prefetch)
2799 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2800 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2801 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2802 gnus-summary-set-agent-mark gnus-agent-save-group-info
2803 gnus-agent-request-article gnus-agent-retrieve-headers)
2804 ("gnus-agent" :interactive t
2805 gnus-unplugged gnus-agentize gnus-agent-batch)
2806 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2807 gnus-summary-save-article-vm)
2808 ("compface" uncompface)
2809 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2810 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2811 ("gnus-mlspl" :interactive t gnus-group-split-setup
2812 gnus-group-split-update)
2813 ("gnus-delay" gnus-delay-initialize))))
2815 ;;; gnus-sum.el thingies
2818 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2819 "*The format specification of the lines in the summary buffer.
2821 It works along the same lines as a normal formatting string,
2822 with some simple extensions.
2824 %N Article number, left padded with spaces (string)
2826 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2827 %n Name of the poster (string)
2828 %a Extracted name of the poster (string)
2829 %A Extracted address of the poster (string)
2830 %F Contents of the From: header (string)
2831 %f Contents of the From: or To: headers (string)
2832 %x Contents of the Xref: header (string)
2833 %D Date of the article (string)
2834 %d Date of the article (string) in DD-MMM format
2835 %o Date of the article (string) in YYYYMMDD`T'HHMMSS format
2836 %M Message-id of the article (string)
2837 %r References of the article (string)
2838 %c Number of characters in the article (integer)
2839 %k Pretty-printed version of the above (string)
2840 For example, \"1.2k\" or \"0.4M\".
2841 %L Number of lines in the article (integer)
2842 %I Indentation based on thread level (a string of spaces)
2843 %B A complex trn-style thread tree (string)
2844 The variables `gnus-sum-thread-*' can be used for customization.
2845 %T A string with two possible values: 80 spaces if the article
2846 is on thread level two or larger and 0 spaces on level one
2847 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2848 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2849 %[ Opening bracket (character, \"[\" or \"<\")
2850 %] Closing bracket (character, \"]\" or \">\")
2851 %> Spaces of length thread-level (string)
2852 %< Spaces of length (- 20 thread-level) (string)
2853 %i Article score (number)
2854 %z Article zcore (character)
2855 %t Number of articles under the current thread (number).
2856 %e Whether the thread is empty or not (character).
2857 %V Total thread score (number).
2858 %P The line number (number).
2859 %O Download mark (character).
2860 %* If present, indicates desired cursor position
2861 (instead of after first colon).
2862 %u User defined specifier. The next character in the format string should
2863 be a letter. Gnus will call the function gnus-user-format-function-X,
2864 where X is the letter following %u. The function will be passed the
2865 current header as argument. The function should return a string, which
2866 will be inserted into the summary just like information from any other
2869 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2870 with care. For reasons of efficiency, Gnus will compute what column
2871 these characters will end up in, and \"hard-code\" that. This means that
2872 it is invalid to have these specs after a variable-length spec. Well,
2873 you might not be arrested, but your summary buffer will look strange,
2874 which is bad enough.
2876 The smart choice is to have these specs as far to the left as
2879 This restriction may disappear in later versions of Gnus.
2881 General format specifiers can also be used.
2882 See Info node `(gnus)Formatting Variables'."
2883 :link '(custom-manual "(gnus)Formatting Variables")
2885 :group 'gnus-summary-format)
2888 ;;; Skeleton keymaps
2891 (defun gnus-suppress-keymap (keymap)
2892 (suppress-keymap keymap)
2893 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2895 (define-key keymap (pop keys) 'undefined))))
2897 (defvar gnus-article-mode-map
2898 (let ((keymap (make-sparse-keymap)))
2899 (gnus-suppress-keymap keymap)
2901 (defvar gnus-summary-mode-map
2902 (let ((keymap (make-keymap)))
2903 (gnus-suppress-keymap keymap)
2905 (defvar gnus-group-mode-map
2906 (let ((keymap (make-keymap)))
2907 (gnus-suppress-keymap keymap)
2912 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2913 ;; If you want the cursor to go somewhere else, set these two
2914 ;; functions in some startup hook to whatever you want.
2915 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2916 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2918 ;;; Various macros and substs.
2920 (defun gnus-header-from (header)
2921 (mail-header-from header))
2923 (defmacro gnus-gethash (string hashtable)
2924 "Get hash value of STRING in HASHTABLE."
2925 `(symbol-value (intern-soft ,string ,hashtable)))
2927 (defmacro gnus-gethash-safe (string hashtable)
2928 "Get hash value of STRING in HASHTABLE.
2929 Return nil if not defined."
2930 `(let ((sym (intern-soft ,string ,hashtable)))
2931 (and (boundp sym) (symbol-value sym))))
2933 (defmacro gnus-sethash (string value hashtable)
2934 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2935 `(set (intern ,string ,hashtable) ,value))
2936 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2938 (defmacro gnus-group-unread (group)
2939 "Get the currently computed number of unread articles in GROUP."
2940 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2942 (defmacro gnus-group-entry (group)
2943 "Get the newsrc entry for GROUP."
2944 `(gnus-gethash ,group gnus-newsrc-hashtb))
2946 (defmacro gnus-active (group)
2947 "Get active info on GROUP."
2948 `(gnus-gethash ,group gnus-active-hashtb))
2950 (defmacro gnus-set-active (group active)
2951 "Set GROUP's active info."
2952 `(gnus-sethash ,group ,active gnus-active-hashtb))
2954 ;; Info access macros.
2956 (defmacro gnus-info-group (info)
2958 (defmacro gnus-info-rank (info)
2960 (defmacro gnus-info-read (info)
2962 (defmacro gnus-info-marks (info)
2964 (defmacro gnus-info-method (info)
2966 (defmacro gnus-info-params (info)
2969 (defmacro gnus-info-level (info)
2970 `(let ((rank (gnus-info-rank ,info)))
2974 (defmacro gnus-info-score (info)
2975 `(let ((rank (gnus-info-rank ,info)))
2976 (or (and (consp rank) (cdr rank)) 0)))
2978 (defmacro gnus-info-set-group (info group)
2979 `(setcar ,info ,group))
2980 (defmacro gnus-info-set-rank (info rank)
2981 `(setcar (nthcdr 1 ,info) ,rank))
2982 (defmacro gnus-info-set-read (info read)
2983 `(setcar (nthcdr 2 ,info) ,read))
2984 (defmacro gnus-info-set-marks (info marks &optional extend)
2986 `(gnus-info-set-entry ,info ,marks 3)
2987 `(setcar (nthcdr 3 ,info) ,marks)))
2988 (defmacro gnus-info-set-method (info method &optional extend)
2990 `(gnus-info-set-entry ,info ,method 4)
2991 `(setcar (nthcdr 4 ,info) ,method)))
2992 (defmacro gnus-info-set-params (info params &optional extend)
2994 `(gnus-info-set-entry ,info ,params 5)
2995 `(setcar (nthcdr 5 ,info) ,params)))
2997 (defun gnus-info-set-entry (info entry number)
2998 ;; Extend the info until we have enough elements.
2999 (while (<= (length info) number)
3000 (nconc info (list nil)))
3002 (setcar (nthcdr number info) entry))
3004 (defmacro gnus-info-set-level (info level)
3005 `(let ((rank (cdr ,info)))
3006 (if (consp (car rank))
3007 (setcar (car rank) ,level)
3008 (setcar rank ,level))))
3009 (defmacro gnus-info-set-score (info score)
3010 `(let ((rank (cdr ,info)))
3011 (if (consp (car rank))
3012 (setcdr (car rank) ,score)
3013 (setcar rank (cons (car rank) ,score)))))
3015 (defmacro gnus-get-info (group)
3016 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3018 ;;; Load the compatibility functions.
3027 (defvar gnus-shutdown-alist nil)
3029 (defun gnus-add-shutdown (function &rest symbols)
3030 "Run FUNCTION whenever one of SYMBOLS is shut down."
3031 (push (cons function symbols) gnus-shutdown-alist))
3033 (defun gnus-shutdown (symbol)
3034 "Shut down everything that waits for SYMBOL."
3035 (dolist (entry gnus-shutdown-alist)
3036 (when (memq symbol (cdr entry))
3037 (funcall (car entry)))))
3041 ;;; Gnus Utility Functions
3044 (defun gnus-find-subscribed-addresses ()
3045 "Return a regexp matching the addresses of all subscribed mail groups.
3046 It consists of the `to-address' or `to-list' parameter of all groups
3047 with a `subscribed' parameter."
3048 (let (group address addresses)
3049 (dolist (entry (cdr gnus-newsrc-alist))
3050 (setq group (car entry))
3051 (when (gnus-parameter-subscribed group)
3052 (setq address (mail-strip-quoted-names
3053 (or (gnus-group-fast-parameter group 'to-address)
3054 (gnus-group-fast-parameter group 'to-list))))
3056 (add-to-list 'addresses address))))
3058 (list (mapconcat 'regexp-quote addresses "\\|")))))
3060 (defmacro gnus-string-or (&rest strings)
3061 "Return the first element of STRINGS that is a non-blank string.
3062 STRINGS will be evaluated in normal `or' order."
3063 `(gnus-string-or-1 ',strings))
3065 (defun gnus-string-or-1 (strings)
3068 (setq string (eval (pop strings)))
3069 (if (string-match "^[ \t]*$" string)
3071 (setq strings nil)))
3074 (defun gnus-version (&optional arg)
3075 "Version number of this version of Gnus.
3076 If ARG, insert string at point."
3079 (insert (message gnus-version))
3080 (message gnus-version)))
3082 (defun gnus-continuum-version (&optional version)
3083 "Return VERSION as a floating point number."
3086 (setq version gnus-version))
3087 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3088 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3089 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3090 (number (match-string 2 version))
3092 (unless (string-match
3093 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3094 (error "Invalid version string: %s" version))
3095 (setq major (string-to-number (match-string 1 number))
3096 minor (string-to-number (match-string 2 number))
3097 least (if (match-beginning 3)
3098 (string-to-number (match-string 3 number))
3102 (format "%s00%02d%02d"
3103 (if (member alpha '("(ding)" "d"))
3107 (- (mm-char-int (aref (downcase alpha) 0))
3111 (format "%d.%02d%02d" major minor least))))))
3113 (defun gnus-info-find-node (&optional nodename)
3114 "Find Info documentation of Gnus."
3116 ;; Enlarge info window if needed.
3117 (let (gnus-info-buffer)
3118 (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3119 (setq gnus-info-buffer (current-buffer))
3120 (gnus-configure-windows 'info)))
3123 ;;; gnus-interactive
3126 (defvar gnus-current-prefix-symbol nil
3127 "Current prefix symbol.")
3129 (defvar gnus-current-prefix-symbols nil
3130 "List of current prefix symbols.")
3132 (defun gnus-interactive (string &optional params)
3133 "Return a list that can be fed to `interactive'.
3134 See `interactive' for full documentation.
3136 Adds the following specs:
3138 y -- The current symbolic prefix.
3139 Y -- A list of the current symbolic prefix(es).
3140 A -- Article number.
3141 H -- Article header.
3145 (while (< i (length string))
3146 (string-match ".\\([^\n]*\\)\n?" string i)
3147 (setq c (aref string i))
3149 (setq prompt (match-string 1 string)))
3150 (setq i (match-end 0))
3151 ;; We basically emulate just about everything that
3152 ;; `interactive' does, but add the specs listed above.
3156 (completing-read prompt obarray 'fboundp t))
3158 (read-buffer prompt (current-buffer) t))
3160 (read-buffer prompt (other-buffer (current-buffer))))
3164 (completing-read prompt obarray 'commandp t))
3168 (read-file-name prompt nil default-directory 'lambda))
3170 (read-file-name prompt nil nil 'lambda))
3172 (read-file-name prompt))
3174 (read-key-sequence prompt))
3176 (error "Not implemented spec"))
3178 (error "Not implemented spec"))
3182 (error "Not implemented spec"))
3184 (string-to-number (read-from-minibuffer prompt)))
3186 (prefix-numeric-value current-prefix-arg))
3192 (read-string prompt))
3194 (intern (read-string prompt)))
3196 (read-variable prompt))
3198 (read-minibuffer prompt))
3200 (eval-minibuffer prompt))
3201 ;; And here the new specs come.
3203 gnus-current-prefix-symbol)
3205 gnus-current-prefix-symbols)
3207 (gnus-group-group-name))
3209 (gnus-summary-skip-intangible)
3210 (or (get-text-property (point) 'gnus-number)
3211 (gnus-summary-last-subject)))
3213 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3215 (error "Non-implemented spec")))
3219 (push (if (< (point) (mark)) (point) (mark)) out)
3220 (push (if (> (point) (mark)) (point) (mark)) out))))
3221 (setq out (delq 'gnus-prefix-nil out))
3224 (defun gnus-symbolic-argument (&optional arg)
3225 "Read a symbolic argument and a command, and then execute command."
3227 (let* ((in-command (this-command-keys))
3228 (command in-command)
3229 gnus-current-prefix-symbols
3230 gnus-current-prefix-symbol
3232 (while (equal in-command command)
3233 (message "%s-" (key-description (this-command-keys)))
3234 (push (intern (char-to-string (read-char))) syms)
3235 (setq command (read-key-sequence nil t)))
3236 (setq gnus-current-prefix-symbols (nreverse syms)
3237 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3238 (call-interactively (key-binding command t))))
3240 ;;; More various functions.
3242 (defsubst gnus-check-backend-function (func group)
3243 "Check whether GROUP supports function FUNC.
3244 GROUP can either be a string (a group name) or a select method."
3246 (let ((method (if (stringp group)
3247 (car (gnus-find-method-for-group group))
3249 (unless (featurep method)
3251 (fboundp (intern (format "%s-%s" method func))))))
3253 (defun gnus-group-read-only-p (&optional group)
3254 "Check whether GROUP supports editing or not.
3255 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
3256 that that variable is buffer-local to the summary buffers."
3257 (let ((group (or group gnus-newsgroup-name)))
3258 (not (gnus-check-backend-function 'request-replace-article group))))
3260 (defun gnus-virtual-group-p (group)
3261 "Say whether GROUP is virtual or not."
3262 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3263 gnus-valid-select-methods)))
3265 (defun gnus-news-group-p (group &optional article)
3266 "Return non-nil if GROUP (and ARTICLE) come from a news server."
3267 (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3268 t) ;is news of course.
3269 ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3270 nil) ;must be mail then.
3271 ((vectorp article) ;Has header info.
3272 (eq (gnus-request-type group (mail-header-id article)) 'news))
3273 ((null article) ;Hasn't header info
3274 (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3275 ((< article 0) ;Virtual message
3276 nil) ;we don't know, guess mail.
3277 (t ;Has positive number
3278 (eq (gnus-request-type group article) 'news)))) ;use it.
3280 ;; Returns a list of writable groups.
3281 (defun gnus-writable-groups ()
3282 (let ((alist gnus-newsrc-alist)
3284 (while (setq group (car (pop alist)))
3285 (unless (gnus-group-read-only-p group)
3286 (push group groups)))
3289 ;; Check whether to use long file names.
3290 (defun gnus-use-long-file-name (symbol)
3291 ;; The variable has to be set...
3292 (and gnus-use-long-file-name
3293 ;; If it isn't a list, then we return t.
3294 (or (not (listp gnus-use-long-file-name))
3295 ;; If it is a list, and the list contains `symbol', we
3297 (not (memq symbol gnus-use-long-file-name)))))
3299 ;; Generate a unique new group name.
3300 (defun gnus-generate-new-group-name (leaf)
3303 (while (gnus-group-entry name)
3304 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3307 (defun gnus-ephemeral-group-p (group)
3308 "Say whether GROUP is ephemeral or not."
3309 (gnus-group-get-parameter group 'quit-config t))
3311 (defun gnus-group-quit-config (group)
3312 "Return the quit-config of GROUP."
3313 (gnus-group-get-parameter group 'quit-config t))
3315 (defun gnus-kill-ephemeral-group (group)
3316 "Remove ephemeral GROUP from relevant structures."
3317 (gnus-sethash group nil gnus-newsrc-hashtb))
3319 (defun gnus-simplify-mode-line ()
3320 "Make mode lines a bit simpler."
3321 (setq mode-line-modified (cdr gnus-mode-line-modified))
3322 (when (listp mode-line-format)
3323 (make-local-variable 'mode-line-format)
3324 (setq mode-line-format (copy-sequence mode-line-format))
3325 (when (equal (nth 3 mode-line-format) " ")
3326 (setcar (nthcdr 3 mode-line-format) " "))))
3328 ;;; Servers and groups.
3330 (defsubst gnus-server-add-address (method)
3331 (let ((method-name (symbol-name (car method))))
3332 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3333 (not (assq (intern (concat method-name "-address")) method))
3334 (memq 'physical-address (assq (car method)
3335 gnus-valid-select-methods)))
3336 (append method (list (list (intern (concat method-name "-address"))
3340 (defsubst gnus-method-to-server (method)
3342 (setq method (or method gnus-select-method))
3344 ;; Perhaps it is already in the cache.
3345 (mapc (lambda (name-method)
3346 (if (equal (cdr name-method) method)
3347 (throw 'server-name (car name-method))))
3348 gnus-server-method-cache)
3351 (lambda (server-alist)
3352 (mapc (lambda (name-method)
3353 (when (gnus-methods-equal-p (cdr name-method) method)
3354 (unless (member name-method gnus-server-method-cache)
3355 (push name-method gnus-server-method-cache))
3356 (throw 'server-name (car name-method))))
3358 (let ((alists (list gnus-server-alist
3359 gnus-predefined-server-alist)))
3360 (if gnus-select-method
3361 (push (list (cons "native" gnus-select-method)) alists))
3364 (let* ((name (if (member (cadr method) '(nil ""))
3365 (format "%s" (car method))
3366 (format "%s:%s" (car method) (cadr method))))
3367 (name-method (cons name method)))
3368 (unless (member name-method gnus-server-method-cache)
3369 (push name-method gnus-server-method-cache))
3372 (defsubst gnus-server-to-method (server)
3373 "Map virtual server names to select methods."
3374 (or (and server (listp server) server)
3375 (cdr (assoc server gnus-server-method-cache))
3378 ;; Perhaps this is the native server?
3379 (and (equal server "native") gnus-select-method)
3380 ;; It should be in the server alist.
3381 (cdr (assoc server gnus-server-alist))
3382 ;; It could be in the predefined server alist.
3383 (cdr (assoc server gnus-predefined-server-alist))
3384 ;; If not, we look through all the opened server
3385 ;; to see whether we can find it there.
3386 (let ((opened gnus-opened-servers))
3388 (not (equal server (format "%s:%s" (caaar opened)
3392 ;; It could be a named method, search all servers
3393 (let ((servers gnus-secondary-select-methods))
3395 (not (equal server (format "%s:%s" (caar servers)
3399 ;; This could be some sort of foreign server that I
3400 ;; simply haven't opened (yet). Do a brute-force scan
3401 ;; of the entire gnus-newsrc-alist for the server name
3402 ;; of every method. As a side-effect, loads the
3403 ;; gnus-server-method-cache so this only happens once,
3408 (let ((info-method (gnus-info-method info)))
3409 (unless (stringp info-method)
3410 (let ((info-server (gnus-method-to-server info-method)))
3411 (when (equal server info-server)
3412 (setq match info-method))))))
3413 (cdr gnus-newsrc-alist))
3416 (push (cons server result) gnus-server-method-cache))
3419 (defsubst gnus-server-get-method (group method)
3420 ;; Input either a server name, and extended server name, or a
3421 ;; select method, and return a select method.
3422 (cond ((stringp method)
3423 (gnus-server-to-method method))
3424 ((equal method gnus-select-method)
3426 ((and (stringp (car method))
3428 (gnus-server-extend-method group method))
3431 (equal (cadr method) ""))
3434 (gnus-server-add-address method))))
3436 (defmacro gnus-method-equal (ss1 ss2)
3437 "Say whether two servers are equal."
3441 (and (= (length s1) (length s2))
3443 (while (and s1 (member (car s1) s2))
3447 (defun gnus-methods-equal-p (m1 m2)
3448 (let ((m1 (or m1 gnus-select-method))
3449 (m2 (or m2 gnus-select-method)))
3451 (and (eq (car m1) (car m2))
3452 (or (not (memq 'address (assoc (symbol-name (car m1))
3453 gnus-valid-select-methods)))
3454 (equal (nth 1 m1) (nth 1 m2)))))))
3456 (defun gnus-server-equal (m1 m2)
3457 "Say whether two methods are equal."
3458 (let ((m1 (cond ((null m1) gnus-select-method)
3459 ((stringp m1) (gnus-server-to-method m1))
3461 (m2 (cond ((null m2) gnus-select-method)
3462 ((stringp m2) (gnus-server-to-method m2))
3464 (gnus-method-equal m1 m2)))
3466 (defun gnus-servers-using-backend (backend)
3467 "Return a list of known servers using BACKEND."
3468 (let ((opened gnus-opened-servers)
3471 (when (eq backend (caaar opened))
3472 (push (caar opened) out))
3476 (defun gnus-archive-server-wanted-p ()
3477 "Say whether the user wants to use the archive server."
3479 ((or (not gnus-message-archive-method)
3480 (not gnus-message-archive-group))
3482 ((and gnus-message-archive-method gnus-message-archive-group)
3485 (let ((active (cadr (assq 'nnfolder-active-file
3486 gnus-message-archive-method))))
3488 (file-exists-p active))))))
3490 (defsubst gnus-method-to-server-name (method)
3492 (format "%s" (car method))
3494 (or (assoc (format "%s" (car method))
3495 (gnus-methods-using 'address))
3496 (gnus-server-equal method gnus-message-archive-method))
3498 (not (string= (nth 1 method) "")))
3499 (concat "+" (nth 1 method)))))
3501 (defsubst gnus-method-to-full-server-name (method)
3502 (format "%s+%s" (car method) (nth 1 method)))
3504 (defun gnus-group-prefixed-name (group method &optional full)
3505 "Return the whole name from GROUP and METHOD.
3506 Call with full set to get the fully qualified group name (even if the
3508 (when (stringp method)
3509 (setq method (gnus-server-to-method method)))
3510 (if (or (not method)
3511 (and (not full) (gnus-server-equal method "native"))
3512 ;;;!!! This might not be right. We'll see...
3513 ;(string-match ":" group)
3516 (concat (gnus-method-to-server-name method) ":" group)))
3518 (defun gnus-group-guess-prefixed-name (group)
3519 "Guess the whole name from GROUP and METHOD."
3520 (gnus-group-prefixed-name group (gnus-find-method-for-group
3523 (defun gnus-group-full-name (group method)
3524 "Return the full name from GROUP and METHOD, even if the method is native."
3525 (gnus-group-prefixed-name group method t))
3527 (defun gnus-group-guess-full-name (group)
3528 "Guess the full name from GROUP, even if the method is native."
3529 (if (gnus-group-prefixed-p group)
3531 (gnus-group-full-name group (gnus-find-method-for-group group))))
3533 (defun gnus-group-guess-full-name-from-command-method (group)
3534 "Guess the full name from GROUP, even if the method is native."
3535 (if (gnus-group-prefixed-p group)
3537 (gnus-group-full-name group gnus-command-method)))
3539 (defun gnus-group-real-prefix (group)
3540 "Return the prefix of the current group name."
3542 (if (string-match "^[^:]+:" group)
3543 (substring group 0 (match-end 0))
3547 (defun gnus-group-short-name (group)
3548 "Return the short group name."
3549 (let ((prefix (gnus-group-real-prefix group)))
3550 (if (< 0 (length prefix))
3551 (substring group (length prefix) nil)
3554 (defun gnus-group-prefixed-p (group)
3555 "Return the prefix of the current group name."
3556 (< 0 (length (gnus-group-real-prefix group))))
3558 (defun gnus-summary-buffer-name (group)
3559 "Return the summary buffer name of GROUP."
3560 (concat "*Summary " (gnus-group-decoded-name group) "*"))
3562 (defun gnus-group-method (group)
3563 "Return the server or method used for selecting GROUP.
3564 You should probably use `gnus-find-method-for-group' instead."
3565 (let ((prefix (gnus-group-real-prefix group)))
3566 (if (equal prefix "")
3568 (let ((servers gnus-opened-servers)
3570 backend possible found)
3571 (if (string-match "^[^\\+]+\\+" prefix)
3572 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3573 server (substring prefix (match-end 0) (1- (length prefix))))
3574 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3576 (when (eq (caaar servers) backend)
3577 (setq possible (caar servers))
3578 (when (equal (cadaar servers) server)
3579 (setq found (caar servers))))
3581 (or (car (rassoc found gnus-server-alist))
3583 (car (rassoc possible gnus-server-alist))
3585 (list backend server))))))
3587 (defsubst gnus-native-method-p (method)
3588 "Return whether METHOD is the native select method."
3589 (gnus-method-equal method gnus-select-method))
3591 (defsubst gnus-secondary-method-p (method)
3592 "Return whether METHOD is a secondary select method."
3593 (let ((methods gnus-secondary-select-methods)
3594 (gmethod (inline (gnus-server-get-method nil method))))
3596 (not (gnus-method-equal
3597 (inline (gnus-server-get-method nil (car methods)))
3599 (setq methods (cdr methods)))
3602 (defun gnus-method-simplify (method)
3603 "Return the shortest uniquely identifying string or method for METHOD."
3604 (cond ((stringp method)
3606 ((gnus-native-method-p method)
3608 ((gnus-secondary-method-p method)
3609 (format "%s:%s" (nth 0 method) (nth 1 method)))
3613 (defun gnus-groups-from-server (server)
3614 "Return a list of all groups that are fetched from SERVER."
3615 (let ((alist (cdr gnus-newsrc-alist))
3617 (while (setq info (pop alist))
3618 (when (gnus-server-equal (gnus-info-method info) server)
3619 (push (gnus-info-group info) groups)))
3620 (sort groups 'string<)))
3622 (defun gnus-group-foreign-p (group)
3623 "Say whether a group is foreign or not."
3624 (and (not (gnus-group-native-p group))
3625 (not (gnus-group-secondary-p group))))
3627 (defun gnus-group-native-p (group)
3628 "Say whether the group is native or not."
3629 (not (string-match ":" group)))
3631 (defun gnus-group-secondary-p (group)
3632 "Say whether the group is secondary or not."
3633 (gnus-secondary-method-p (gnus-find-method-for-group group)))
3635 (defun gnus-parameters-get-parameter (group)
3636 "Return the group parameters for GROUP from `gnus-parameters'."
3638 (dolist (elem gnus-parameters)
3639 (when (string-match (car elem) group)
3641 (nconc (gnus-expand-group-parameters
3642 (car elem) (cdr elem) group)
3646 (defun gnus-expand-group-parameter (match value group)
3647 "Use MATCH to expand VALUE in GROUP."
3650 (goto-char (point-min))
3651 (while (re-search-forward match nil t)
3652 (replace-match value))
3655 (defun gnus-expand-group-parameters (match parameters group)
3656 "Go through PARAMETERS and expand them according to the match data."
3658 (dolist (elem parameters)
3659 (if (and (stringp (cdr elem))
3660 (string-match "\\\\[0-9&]" (cdr elem)))
3661 (push (cons (car elem)
3662 (gnus-expand-group-parameter match (cdr elem) group))
3667 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3668 "For GROUP, return the value of SYMBOL.
3670 You should call this in the `gnus-group-buffer' buffer.
3671 The function `gnus-group-find-parameter' will do that for you."
3672 ;; The speed trick: No cons'ing and quit early.
3673 (let* ((params (funcall gnus-group-get-parameter-function group))
3674 ;; Start easy, check the "real" group parameters.
3676 (gnus-group-parameter-value params symbol allow-list t)))
3678 ;; Found results; return them.
3679 (car simple-results)
3680 ;; We didn't found it there, try `gnus-parameters'.
3683 (tail gnus-parameters))
3684 ;; A good old-fashioned non-cl loop.
3686 (setq head (car tail)
3688 ;; The car is regexp matching for matching the group name.
3689 (when (string-match (car head) group)
3690 ;; The cdr is the parameters.
3691 (setq result (gnus-group-parameter-value (cdr head)
3694 ;; Expand if necessary.
3695 (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3696 (setq result (gnus-expand-group-parameter (car head)
3698 ;; Exit the loop early.
3703 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3704 "Return the group parameters for GROUP.
3705 If SYMBOL, return the value of that symbol in the group parameters.
3707 If you call this function inside a loop, consider using the faster
3708 `gnus-group-fast-parameter' instead."
3710 (set-buffer gnus-group-buffer)
3712 (gnus-group-fast-parameter group symbol allow-list)
3715 (funcall gnus-group-get-parameter-function group))
3716 (gnus-parameters-get-parameter group)))))
3718 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3719 "Return the group parameters for GROUP.
3720 If SYMBOL, return the value of that symbol in the group parameters.
3721 Most functions should use `gnus-group-find-parameter', which
3722 also examines the topic parameters."
3723 (let ((params (gnus-info-params (gnus-get-info group))))
3725 (gnus-group-parameter-value params symbol allow-list)
3728 (defun gnus-group-parameter-value (params symbol &optional
3729 allow-list present-p)
3730 "Return the value of SYMBOL in group PARAMS."
3731 ;; We only wish to return group parameters (dotted lists) and
3732 ;; not local variables, which may have the same names.
3733 ;; But first we handle single elements...
3734 (or (car (memq symbol params))
3738 (while (setq elem (pop params))
3739 (when (and (consp elem)
3740 (eq (car elem) symbol)
3743 (throw 'found (if present-p (list (cdr elem))
3746 (defun gnus-group-add-parameter (group param)
3747 "Add parameter PARAM to GROUP."
3748 (let ((info (gnus-get-info group)))
3750 (gnus-group-remove-parameter group (if (consp param) (car param) param))
3751 ;; Cons the new param to the old one and update.
3752 (gnus-group-set-info (cons param (gnus-info-params info))
3755 (defun gnus-group-set-parameter (group name value)
3756 "Set parameter NAME to VALUE in GROUP."
3757 (let ((info (gnus-get-info group)))
3759 (gnus-group-remove-parameter group name)
3760 (let ((old-params (gnus-info-params info))
3761 (new-params (list (cons name value))))
3763 (when (or (not (listp (car old-params)))
3764 (not (eq (caar old-params) name)))
3765 (setq new-params (append new-params (list (car old-params)))))
3766 (setq old-params (cdr old-params)))
3767 (gnus-group-set-info new-params group 'params)))))
3769 (defun gnus-group-remove-parameter (group name)
3770 "Remove parameter NAME from GROUP."
3771 (let ((info (gnus-get-info group)))
3773 (let ((params (gnus-info-params info)))
3775 (setq params (delq name params))
3776 (while (assq name params)
3777 (gnus-pull name params))
3778 (gnus-info-set-params info params))))))
3780 (defun gnus-group-add-score (group &optional score)
3781 "Add SCORE to the GROUP score.
3782 If SCORE is nil, add 1 to the score of GROUP."
3783 (let ((info (gnus-get-info group)))
3785 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3787 (defun gnus-short-group-name (group &optional levels)
3788 "Collapse GROUP name LEVELS.
3789 Select methods are stripped and any remote host name is stripped down to
3790 just the host name."
3796 gnus-group-uncollapsed-levels
3798 (while (string-match "\\." group skip)
3799 (setq skip (match-end 0)
3802 ;; Separate foreign select method from group name and collapse.
3803 ;; If method contains a server, collapse to non-domain server name,
3804 ;; otherwise collapse to select method.
3805 (let* ((colon (string-match ":" group))
3806 (server (and colon (substring group 0 colon)))
3807 (plus (and server (string-match "+" server))))
3810 (setq foreign (substring server (+ 1 plus)
3811 (string-match "\\." server))
3812 group (substring group (+ 1 colon)))
3813 (setq foreign server
3814 group (substring group (+ 1 colon))))
3815 (setq foreign (concat foreign ":")))
3816 ;; Collapse group name leaving LEVELS uncollapsed elements
3817 (let* ((slist (split-string group "/"))
3818 (slen (length slist))
3819 (dlist (split-string group "\\."))
3820 (dlen (length dlist))
3832 (setq levels (- glen levels))
3834 (push (if (>= (decf levels) 0)
3835 (if (zerop (length g))
3840 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3842 (defun gnus-narrow-to-body ()
3843 "Narrow to the body of an article."
3846 (goto-char (point-min))
3847 (or (search-forward "\n\n" nil t)
3853 ;;; Kill file handling.
3856 (defun gnus-apply-kill-file ()
3857 "Apply a kill file to the current newsgroup.
3858 Returns the number of articles marked as read."
3859 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3860 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3861 (gnus-apply-kill-file-internal)
3864 (defun gnus-kill-save-kill-buffer ()
3865 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3866 (when (get-file-buffer file)
3868 (set-buffer (get-file-buffer file))
3869 (when (buffer-modified-p)
3871 (kill-buffer (current-buffer))))))
3873 (defcustom gnus-kill-file-name "KILL"
3874 "Suffix of the kill files."
3875 :group 'gnus-score-kill
3876 :group 'gnus-score-files
3879 (defun gnus-newsgroup-kill-file (newsgroup)
3880 "Return the name of a kill file name for NEWSGROUP.
3881 If NEWSGROUP is nil, return the global kill file name instead."
3883 ;; The global KILL file is placed at top of the directory.
3884 ((or (null newsgroup)
3885 (string-equal newsgroup ""))
3886 (expand-file-name gnus-kill-file-name
3887 gnus-kill-files-directory))
3888 ;; Append ".KILL" to newsgroup name.
3889 ((gnus-use-long-file-name 'not-kill)
3890 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3891 "." gnus-kill-file-name)
3892 gnus-kill-files-directory))
3893 ;; Place "KILL" under the hierarchical directory.
3895 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3896 "/" gnus-kill-file-name)
3897 gnus-kill-files-directory))))
3901 (defun gnus-member-of-valid (symbol group)
3902 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3904 (symbol-name (car (gnus-find-method-for-group group)))
3905 gnus-valid-select-methods)))
3907 (defun gnus-method-option-p (method option)
3908 "Return non-nil if select METHOD has OPTION as a parameter."
3909 (when (stringp method)
3910 (setq method (gnus-server-to-method method)))
3911 (memq option (assoc (format "%s" (car method))
3912 gnus-valid-select-methods)))
3914 (defun gnus-similar-server-opened (method)
3915 (let ((opened gnus-opened-servers))
3916 (while (and method opened)
3917 (when (and (equal (cadr method) (cadaar opened))
3918 (equal (car method) (caaar opened))
3919 (not (equal method (caar opened))))
3924 (defun gnus-server-extend-method (group method)
3925 ;; This function "extends" a virtual server. If the server is
3926 ;; "hello", and the select method is ("hello" (my-var "something"))
3927 ;; in the group "alt.alt", this will result in a new virtual server
3928 ;; called "hello+alt.alt".
3929 (if (or (not (inline (gnus-similar-server-opened method)))
3930 (not (cddr method)))
3932 `(,(car method) ,(concat (cadr method) "+" group)
3933 (,(intern (format "%s-address" (car method))) ,(cadr method))
3936 (defun gnus-server-status (method)
3937 "Return the status of METHOD."
3938 (nth 1 (assoc method gnus-opened-servers)))
3940 (defun gnus-group-name-to-method (group)
3941 "Guess a select method based on GROUP."
3942 (if (string-match ":" group)
3943 (let ((server (substring group 0 (match-beginning 0))))
3944 (if (string-match "\\+" server)
3945 (list (intern (substring server 0 (match-beginning 0)))
3946 (substring server (match-end 0)))
3947 (list (intern server) "")))
3948 gnus-select-method))
3950 (defun gnus-server-string (server)
3951 "Return a readable string that describes SERVER."
3952 (let* ((server (gnus-server-to-method server))
3953 (address (nth 1 server)))
3955 (not (zerop (length address))))
3956 (format "%s using %s" address (car server))
3957 (format "%s" (car server)))))
3959 (defun gnus-find-method-for-group (group &optional info)
3960 "Find the select method that GROUP uses."
3961 (or gnus-override-method
3964 (and (not (gnus-group-entry group)) ;; a new group
3965 (gnus-group-name-to-method group))
3966 (let ((info (or info (gnus-get-info group)))
3969 (not (setq method (gnus-info-method info)))
3970 (equal method "native"))
3973 (cond ((stringp method)
3974 (inline (gnus-server-to-method method)))
3975 ((stringp (cadr method))
3976 (inline (gnus-server-extend-method group method)))
3979 (cond ((equal (cadr method) "")
3981 ((null (cadr method))
3982 (list (car method) ""))
3984 (gnus-server-add-address method)))))))
3986 (defun gnus-methods-using (feature)
3987 "Find all methods that have FEATURE."
3988 (let ((valids gnus-valid-select-methods)
3991 (when (memq feature (car valids))
3992 (push (car valids) outs))
3993 (setq valids (cdr valids)))
3997 (autoload 'message-y-or-n-p "message" nil nil 'macro))
3999 (defun gnus-read-group (prompt &optional default)
4000 "Prompt the user for a group name.
4001 Disallow invalid group names."
4006 gnus-invalid-group-regexp
4007 (setq group (read-string (concat prefix prompt)
4008 (cons (or default "") 0)
4009 'gnus-group-history)))
4010 (let ((match (match-string 0 group)))
4011 ;; Might be okay (e.g. for nnimap), so ask the user:
4012 (unless (and (not (string-match "^$\\|:" match))
4014 "Proceed and create group anyway? " t
4015 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4017 Usually, it's dangerous to create a group with this name, because it's not
4018 supported by all back ends and servers. On IMAP servers it should work,
4019 though. If you are really sure, you can proceed anyway and create the group.
4021 You may customize the variable `gnus-invalid-group-regexp', which currently is
4022 set to \"" gnus-invalid-group-regexp
4023 "\", if you want to get rid of this query permanently."))
4024 (setq prefix (format "Invalid group name: \"%s\". " group)
4028 (defun gnus-read-method (prompt)
4029 "Prompt the user for a method.
4030 Allow completion over sensible values."
4031 (let* ((open-servers
4032 (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4033 gnus-opened-servers))
4036 (dolist (method gnus-valid-select-methods)
4037 (if (or (memq 'prompt-address method)
4038 (not (assoc (format "%s:" (car method)) open-servers)))
4039 (push method methods)))
4042 (append valid-methods
4044 gnus-predefined-server-alist
4049 nil t nil 'gnus-method-history)))
4052 (setq method gnus-select-method))
4053 ((assoc method gnus-valid-select-methods)
4054 (let ((address (if (memq 'prompt-address
4055 (assoc method gnus-valid-select-methods))
4056 (read-string "Address: ")
4058 (or (cadr (assoc (format "%s:%s" method address) open-servers))
4059 (list (intern method) address))))
4060 ((assoc method servers)
4063 (list (intern method) "")))))
4067 (defun gnus-agent-method-p (method)
4068 "Say whether METHOD is covered by the agent."
4069 (or (eq (car gnus-agent-method-p-cache) method)
4070 (setq gnus-agent-method-p-cache
4072 (member (if (stringp method)
4074 (gnus-method-to-server method)) gnus-agent-covered-methods))))
4075 (cdr gnus-agent-method-p-cache))
4077 (defun gnus-online (method)
4080 (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4081 (gnus-agent-method-p method))))
4083 ;;; User-level commands.
4086 (defun gnus-slave-no-server (&optional arg)
4087 "Read network news as a slave, without connecting to the local server."
4089 (gnus-no-server arg t))
4092 (defun gnus-no-server (&optional arg slave)
4094 If ARG is a positive number, Gnus will use that as the startup
4095 level. If ARG is nil, Gnus will be started at level 2. If ARG is
4096 non-nil and not a positive number, Gnus will prompt the user for the
4097 name of an NNTP server to use.
4098 As opposed to `gnus', this command will not connect to the local
4101 (gnus-no-server-1 arg slave))
4104 (defun gnus-slave (&optional arg)
4105 "Read news as a slave."
4107 (gnus arg nil 'slave))
4110 (defun gnus-other-frame (&optional arg display)
4111 "Pop up a frame to read news.
4112 This will call one of the Gnus commands which is specified by the user
4113 option `gnus-other-frame-function' (default `gnus') with the argument
4114 ARG if Gnus is not running, otherwise just pop up a Gnus frame. The
4115 optional second argument DISPLAY should be a standard display string
4116 such as \"unix:0\" to specify where to pop up a frame. If DISPLAY is
4117 omitted or the function `make-frame-on-display' is not available, the
4118 current display is used."
4120 (if (fboundp 'make-frame-on-display)
4122 (setq display (gnus-frame-or-window-display-name (selected-frame))))
4124 (let ((alive (gnus-alive-p)))
4129 (when (and (or (not display)
4131 (gnus-frame-or-window-display-name
4133 (with-current-buffer (window-buffer window)
4134 (string-match "\\`gnus-"
4135 (symbol-name major-mode))))
4136 (gnus-select-frame-set-input-focus
4137 (setq gnus-other-frame-object (window-frame window)))
4138 (select-window window)
4141 (gnus-select-frame-set-input-focus
4142 (setq gnus-other-frame-object
4144 (make-frame-on-display display gnus-other-frame-parameters)
4145 (make-frame gnus-other-frame-parameters))))
4147 (switch-to-buffer gnus-group-buffer)
4148 (funcall gnus-other-frame-function arg)
4149 (add-hook 'gnus-exit-gnus-hook
4151 (when (and (frame-live-p gnus-other-frame-object)
4153 (delete-frame gnus-other-frame-object))
4154 (setq gnus-other-frame-object nil)))))))
4156 ;;(setq thing ? ; this is a comment
4160 (defun gnus (&optional arg dont-connect slave)
4162 If ARG is non-nil and a positive number, Gnus will use that as the
4163 startup level. If ARG is non-nil and not a positive number, Gnus will
4164 prompt the user for the name of an NNTP server to use."
4166 (unless (byte-code-function-p (symbol-function 'gnus))
4167 (message "You should byte-compile Gnus")
4169 (gnus-1 arg dont-connect slave))
4171 ;; Allow redefinition of Gnus functions.
4177 ;;; arch-tag: acebeeab-f331-4f8f-a7ea-89c58c84f636
4178 ;;; gnus.el ends here