1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;; 1997, 1998, 2000, 2001 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news, mail
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
30 (eval '(run-hooks 'gnus-load-hook))
32 (eval-when-compile (require 'cl))
36 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
40 (defgroup gnus-charset nil
41 "Group character set issues."
42 :link '(custom-manual "(gnus)Charsets")
46 (defgroup gnus-cache nil
50 (defgroup gnus-start nil
51 "Starting your favorite newsreader."
54 (defgroup gnus-start-server nil
55 "Server options at startup."
58 ;; These belong to gnus-group.el.
59 (defgroup gnus-group nil
61 :link '(custom-manual "(gnus)The Group Buffer")
64 (defgroup gnus-group-foreign nil
66 :link '(custom-manual "(gnus)Foreign Groups")
69 (defgroup gnus-group-new nil
70 "Automatic subscription of new groups."
73 (defgroup gnus-group-levels nil
75 :link '(custom-manual "(gnus)Group Levels")
78 (defgroup gnus-group-select nil
80 :link '(custom-manual "(gnus)Selecting a Group")
83 (defgroup gnus-group-listing nil
84 "Showing slices of the group list."
85 :link '(custom-manual "(gnus)Listing Groups")
88 (defgroup gnus-group-visual nil
89 "Sorting the group buffer."
90 :link '(custom-manual "(gnus)Group Buffer Format")
94 (defgroup gnus-group-various nil
95 "Various group options."
96 :link '(custom-manual "(gnus)Scanning New Messages")
99 ;; These belong to gnus-sum.el.
100 (defgroup gnus-summary nil
102 :link '(custom-manual "(gnus)The Summary Buffer")
105 (defgroup gnus-summary-exit nil
106 "Leaving summary buffers."
107 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
108 :group 'gnus-summary)
110 (defgroup gnus-summary-marks nil
111 "Marks used in summary buffers."
112 :link '(custom-manual "(gnus)Marking Articles")
113 :group 'gnus-summary)
115 (defgroup gnus-thread nil
116 "Ordering articles according to replies."
117 :link '(custom-manual "(gnus)Threading")
118 :group 'gnus-summary)
120 (defgroup gnus-summary-format nil
121 "Formatting of the summary buffer."
122 :link '(custom-manual "(gnus)Summary Buffer Format")
123 :group 'gnus-summary)
125 (defgroup gnus-summary-choose nil
127 :link '(custom-manual "(gnus)Choosing Articles")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-maneuvering nil
131 "Summary movement commands."
132 :link '(custom-manual "(gnus)Summary Maneuvering")
133 :group 'gnus-summary)
135 (defgroup gnus-summary-mail nil
136 "Mail group commands."
137 :link '(custom-manual "(gnus)Mail Group Commands")
138 :group 'gnus-summary)
140 (defgroup gnus-summary-sort nil
141 "Sorting the summary buffer."
142 :link '(custom-manual "(gnus)Sorting")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-visual nil
146 "Highlighting and menus in the summary buffer."
147 :link '(custom-manual "(gnus)Summary Highlighting")
149 :group 'gnus-summary)
151 (defgroup gnus-summary-various nil
152 "Various summary buffer options."
153 :link '(custom-manual "(gnus)Various Summary Stuff")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-pick nil
157 "Pick mode in the summary buffer."
158 :link '(custom-manual "(gnus)Pick and Read")
160 :group 'gnus-summary)
162 (defgroup gnus-summary-tree nil
163 "Tree display of threads in the summary buffer."
164 :link '(custom-manual "(gnus)Tree Display")
166 :group 'gnus-summary)
168 ;; Belongs to gnus-uu.el
169 (defgroup gnus-extract-view nil
170 "Viewing extracted files."
171 :link '(custom-manual "(gnus)Viewing Files")
172 :group 'gnus-extract)
174 ;; Belongs to gnus-score.el
175 (defgroup gnus-score nil
176 "Score and kill file handling."
179 (defgroup gnus-score-kill nil
183 (defgroup gnus-score-adapt nil
184 "Adaptive score files."
187 (defgroup gnus-score-default nil
188 "Default values for score files."
191 (defgroup gnus-score-expire nil
192 "Expiring score rules."
195 (defgroup gnus-score-decay nil
196 "Decaying score rules."
199 (defgroup gnus-score-files nil
200 "Score and kill file names."
204 (defgroup gnus-score-various nil
205 "Various scoring and killing options."
209 (defgroup gnus-visual nil
210 "Options controling the visual fluff."
214 (defgroup gnus-agent nil
215 "Offline support for Gnus."
218 (defgroup gnus-files nil
219 "Files used by Gnus."
222 (defgroup gnus-dribble-file nil
224 :link '(custom-manual "(gnus)Auto Save")
227 (defgroup gnus-newsrc nil
228 "Storing Gnus state."
231 (defgroup gnus-server nil
232 "Options related to newsservers and other servers used by Gnus."
235 (defgroup gnus-message '((message custom-group))
236 "Composing replies and followups in Gnus."
239 (defgroup gnus-meta nil
240 "Meta variables controling major portions of Gnus.
241 In general, modifying these variables does not take affect until Gnus
242 is restarted, and sometimes reloaded."
245 (defgroup gnus-various nil
246 "Other Gnus options."
247 :link '(custom-manual "(gnus)Various Various")
250 (defgroup gnus-mime nil
251 "Variables for controlling the Gnus MIME interface."
254 (defgroup gnus-exit nil
256 :link '(custom-manual "(gnus)Exiting Gnus")
259 (defconst gnus-version-number "0.01"
260 "Version number for this version of Gnus.")
262 (defconst gnus-version (format "Oort Gnus v%s" gnus-version-number)
263 "Version string for this version of Gnus.")
265 (defcustom gnus-inhibit-startup-message nil
266 "If non-nil, the startup message will not be displayed.
267 This variable is used before `.gnus.el' is loaded, so it should
268 be set in `.emacs' instead."
272 (defcustom gnus-play-startup-jingle nil
273 "If non-nil, play the Gnus jingle at startup."
277 (unless (fboundp 'gnus-group-remove-excess-properties)
278 (defalias 'gnus-group-remove-excess-properties 'ignore))
280 (unless (fboundp 'gnus-set-text-properties)
281 (defalias 'gnus-set-text-properties 'set-text-properties))
283 (unless (featurep 'gnus-xmas)
284 (defalias 'gnus-make-overlay 'make-overlay)
285 (defalias 'gnus-delete-overlay 'delete-overlay)
286 (defalias 'gnus-overlay-put 'overlay-put)
287 (defalias 'gnus-move-overlay 'move-overlay)
288 (defalias 'gnus-overlay-buffer 'overlay-buffer)
289 (defalias 'gnus-overlay-start 'overlay-start)
290 (defalias 'gnus-overlay-end 'overlay-end)
291 (defalias 'gnus-extent-detached-p 'ignore)
292 (defalias 'gnus-extent-start-open 'ignore)
293 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
294 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
295 (defalias 'gnus-character-to-event 'identity)
296 (defalias 'gnus-add-text-properties 'add-text-properties)
297 (defalias 'gnus-put-text-property 'put-text-property)
298 (defvar gnus-mode-line-image-cache t)
299 (if (fboundp 'find-image)
300 (defun gnus-mode-line-buffer-identification (line)
301 (let ((str (car-safe line)))
302 (if (and (stringp str)
303 (string-match "^Gnus:" str))
304 (progn (add-text-properties
307 (if (eq t gnus-mode-line-image-cache)
308 (setq gnus-mode-line-image-cache
310 '((:type xpm :file "gnus-pointer.xpm"
312 (:type xbm :file "gnus-pointer.xbm"
314 gnus-mode-line-image-cache)
315 'help-echo "This is Gnus")
319 (defalias 'gnus-mode-line-buffer-identification 'identity))
320 (defalias 'gnus-characterp 'numberp)
321 (defalias 'gnus-deactivate-mark 'deactivate-mark)
322 (defalias 'gnus-window-edges 'window-edges)
323 (defalias 'gnus-key-press-event-p 'numberp)
324 ;;(defalias 'gnus-decode-rfc1522 'ignore)
327 ;; We define these group faces here to avoid the display
328 ;; update forced when creating new faces.
330 (defface gnus-group-news-1-face
333 (:foreground "PaleTurquoise" :bold t))
336 (:foreground "ForestGreen" :bold t))
339 "Level 1 newsgroup face.")
341 (defface gnus-group-news-1-empty-face
344 (:foreground "PaleTurquoise"))
347 (:foreground "ForestGreen"))
350 "Level 1 empty newsgroup face.")
352 (defface gnus-group-news-2-face
355 (:foreground "turquoise" :bold t))
358 (:foreground "CadetBlue4" :bold t))
361 "Level 2 newsgroup face.")
363 (defface gnus-group-news-2-empty-face
366 (:foreground "turquoise"))
369 (:foreground "CadetBlue4"))
372 "Level 2 empty newsgroup face.")
374 (defface gnus-group-news-3-face
383 "Level 3 newsgroup face.")
385 (defface gnus-group-news-3-empty-face
394 "Level 3 empty newsgroup face.")
396 (defface gnus-group-news-4-face
405 "Level 4 newsgroup face.")
407 (defface gnus-group-news-4-empty-face
416 "Level 4 empty newsgroup face.")
418 (defface gnus-group-news-5-face
427 "Level 5 newsgroup face.")
429 (defface gnus-group-news-5-empty-face
438 "Level 5 empty newsgroup face.")
440 (defface gnus-group-news-6-face
449 "Level 6 newsgroup face.")
451 (defface gnus-group-news-6-empty-face
460 "Level 6 empty newsgroup face.")
462 (defface gnus-group-news-low-face
465 (:foreground "DarkTurquoise" :bold t))
468 (:foreground "DarkGreen" :bold t))
471 "Low level newsgroup face.")
473 (defface gnus-group-news-low-empty-face
476 (:foreground "DarkTurquoise"))
479 (:foreground "DarkGreen"))
482 "Low level empty newsgroup face.")
484 (defface gnus-group-mail-1-face
487 (:foreground "aquamarine1" :bold t))
490 (:foreground "DeepPink3" :bold t))
493 "Level 1 mailgroup face.")
495 (defface gnus-group-mail-1-empty-face
498 (:foreground "aquamarine1"))
501 (:foreground "DeepPink3"))
503 (:italic t :bold t)))
504 "Level 1 empty mailgroup face.")
506 (defface gnus-group-mail-2-face
509 (:foreground "aquamarine2" :bold t))
512 (:foreground "HotPink3" :bold t))
515 "Level 2 mailgroup face.")
517 (defface gnus-group-mail-2-empty-face
520 (:foreground "aquamarine2"))
523 (:foreground "HotPink3"))
526 "Level 2 empty mailgroup face.")
528 (defface gnus-group-mail-3-face
531 (:foreground "aquamarine3" :bold t))
534 (:foreground "magenta4" :bold t))
537 "Level 3 mailgroup face.")
539 (defface gnus-group-mail-3-empty-face
542 (:foreground "aquamarine3"))
545 (:foreground "magenta4"))
548 "Level 3 empty mailgroup face.")
550 (defface gnus-group-mail-low-face
553 (:foreground "aquamarine4" :bold t))
556 (:foreground "DeepPink4" :bold t))
559 "Low level mailgroup face.")
561 (defface gnus-group-mail-low-empty-face
564 (:foreground "aquamarine4"))
567 (:foreground "DeepPink4"))
570 "Low level empty mailgroup face.")
572 ;; Summary mode faces.
574 (defface gnus-summary-selected-face '((t
576 "Face used for selected articles.")
578 (defface gnus-summary-cancelled-face
580 (:foreground "yellow" :background "black")))
581 "Face used for cancelled articles.")
583 (defface gnus-summary-high-ticked-face
586 (:foreground "pink" :bold t))
589 (:foreground "firebrick" :bold t))
592 "Face used for high interest ticked articles.")
594 (defface gnus-summary-low-ticked-face
597 (:foreground "pink" :italic t))
600 (:foreground "firebrick" :italic t))
603 "Face used for low interest ticked articles.")
605 (defface gnus-summary-normal-ticked-face
608 (:foreground "pink"))
611 (:foreground "firebrick"))
614 "Face used for normal interest ticked articles.")
616 (defface gnus-summary-high-ancient-face
619 (:foreground "SkyBlue" :bold t))
622 (:foreground "RoyalBlue" :bold t))
625 "Face used for high interest ancient articles.")
627 (defface gnus-summary-low-ancient-face
630 (:foreground "SkyBlue" :italic t))
633 (:foreground "RoyalBlue" :italic t))
636 "Face used for low interest ancient articles.")
638 (defface gnus-summary-normal-ancient-face
641 (:foreground "SkyBlue"))
644 (:foreground "RoyalBlue"))
647 "Face used for normal interest ancient articles.")
649 (defface gnus-summary-high-unread-face
652 "Face used for high interest unread articles.")
654 (defface gnus-summary-low-unread-face
657 "Face used for low interest unread articles.")
659 (defface gnus-summary-normal-unread-face
662 "Face used for normal interest unread articles.")
664 (defface gnus-summary-high-read-face
667 (:foreground "PaleGreen"
671 (:foreground "DarkGreen"
675 "Face used for high interest read articles.")
677 (defface gnus-summary-low-read-face
680 (:foreground "PaleGreen"
684 (:foreground "DarkGreen"
688 "Face used for low interest read articles.")
690 (defface gnus-summary-normal-read-face
693 (:foreground "PaleGreen"))
696 (:foreground "DarkGreen"))
699 "Face used for normal interest read articles.")
706 (defvar gnus-buffers nil)
708 (defun gnus-get-buffer-create (name)
709 "Do the same as `get-buffer-create', but store the created buffer."
710 (or (get-buffer name)
711 (car (push (get-buffer-create name) gnus-buffers))))
713 (defun gnus-add-buffer ()
714 "Add the current buffer to the list of Gnus buffers."
715 (push (current-buffer) gnus-buffers))
717 (defun gnus-buffers ()
718 "Return a list of live Gnus buffers."
719 (while (and gnus-buffers
720 (not (buffer-name (car gnus-buffers))))
722 (let ((buffers gnus-buffers))
724 (if (buffer-name (cadr buffers))
726 (setcdr buffers (cddr buffers)))))
731 (defvar gnus-group-buffer "*Group*")
734 (autoload 'gnus-play-jingle "gnus-audio"))
736 (defface gnus-splash-face
739 (:foreground "Brown"))
742 (:foreground "Brown"))
745 "Face of the splash screen.")
747 (defun gnus-splash ()
749 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
750 (let ((buffer-read-only nil))
752 (unless gnus-inhibit-startup-message
753 (gnus-group-startup-message)
755 (when gnus-play-startup-jingle
756 (gnus-play-jingle))))))
758 (defun gnus-indent-rigidly (start end arg)
759 "Indent rigidly using only spaces and no tabs."
762 (narrow-to-region start end)
764 (indent-rigidly start end arg)
765 ;; We translate tabs into spaces -- not everybody uses
766 ;; an 8-character tab.
767 (goto-char (point-min))
768 (while (search-forward "\t" nil t)
769 (replace-match " " t t))))))
771 (defvar gnus-simple-splash nil)
773 (defun gnus-group-startup-message (&optional x y)
774 "Insert startup message in current buffer."
775 ;; Insert the message.
779 (fboundp 'find-image)
781 (let ((image (find-image
782 `((:type xpm :file "gnus.xpm")
783 (:type pbm :file "gnus.pbm"
784 ;; Account for the pbm's blackground.
785 :background ,(face-foreground 'gnus-splash-face)
786 :foreground ,(face-background 'default))
787 (:type xbm :file "gnus.xbm"
788 ;; Account for the xbm's blackground.
789 :background ,(face-foreground 'gnus-splash-face)
790 :foreground ,(face-background 'default))))))
792 (let ((size (image-size image)))
793 (insert-char ?\n (max 0 (round (- (window-height)
794 (or y (cdr size)) 1) 2)))
795 (insert-char ?\ (max 0 (round (- (window-width)
796 (or x (car size))) 2)))
797 (insert-image image))
798 (setq gnus-simple-splash nil)
804 _ ___ __ ___ __ _ ___
824 (gnus-indent-rigidly (point-min) (point-max)
825 (/ (max (- (window-width) (or x 46)) 0) 2))
826 (goto-char (point-min))
828 (let* ((pheight (count-lines (point-min) (point-max)))
829 (wheight (window-height))
830 (rest (- wheight pheight)))
831 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
833 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
834 (setq gnus-simple-splash t)))
835 (goto-char (point-min))
836 (setq mode-line-buffer-identification (concat " " gnus-version))
837 (set-buffer-modified-p t))
840 (let ((command (format "%s" this-command)))
841 (if (and (string-match "gnus" command)
842 (not (string-match "gnus-other-frame" command)))
844 (gnus-get-buffer-create gnus-group-buffer))))
851 (defvar gnus-parameters nil
852 "Alist of group parameters.
855 ((\"mail\\\\..*\" (gnus-show-threads nil)
856 (gnus-use-scoring nil)
857 (gnus-summary-line-format
858 \"%U%R%z%I%(%[%d:%ub%-20,20f%]%) %s\\n\")
861 (\"mail\\\\.me\" (gnus-use-scoring t))
862 (\"list\\\\..*\" (total-expire . t)
863 (broken-reply-to . t)))")
865 (defvar gnus-group-parameters-more nil)
867 (defmacro gnus-define-group-parameter (param &rest rest)
868 "Define a group parameter PARAM.
869 REST is a plist of following:
870 :type One of `bool', `list' or `nil'.
871 :function The name of the function.
872 :function-document The document of the function.
873 :parameter-type The type for customizing the parameter.
874 :parameter-document The document for the parameter.
875 :variable The name of the variable.
876 :variable-document The document for the variable.
877 :variable-group The group for customizing the variable.
878 :variable-type The type for customizing the variable.
879 :variable-default The default value of the variable."
880 (let* ((type (plist-get rest :type))
881 (parameter-type (plist-get rest :parameter-type))
882 (parameter-document (plist-get rest :parameter-document))
883 (function (or (plist-get rest :function)
884 (intern (format "gnus-parameter-%s" param))))
885 (function-document (or (plist-get rest :function-document) ""))
886 (variable (or (plist-get rest :variable)
887 (intern (format "gnus-parameter-%s-alist" param))))
888 (variable-document (or (plist-get rest :variable-document) ""))
889 (variable-group (plist-get rest :variable-group))
890 (variable-type (or (plist-get rest :variable-type)
891 `(quote (repeat (list (regexp :tag "Group")
893 (variable-default (plist-get rest :variable-default)))
896 `(defcustom ,variable ,variable-default
898 :group 'gnus-group-parameter
899 :group ',variable-group
900 :type ,variable-type)
901 `(setq gnus-group-parameters-more
902 (delq (assq ',param gnus-group-parameters-more)
903 gnus-group-parameters-more))
904 `(add-to-list 'gnus-group-parameters-more
907 ,parameter-document))
909 `(defun ,function (name)
911 (let ((params (gnus-group-find-parameter name))
914 ((memq ',param params)
916 ((setq val (assq ',param params))
919 (string-match ,variable name))
921 (let ((alist ,variable)
923 (while (setq elem (pop alist))
925 (string-match (car elem) name))
928 (if (consp value) (car value) value))))))
929 `(defun ,function (name)
932 (or (gnus-group-find-parameter name ',param ,(and type t))
933 (let ((alist ,variable)
935 (while (setq elem (pop alist))
937 (string-match (car elem) name))
942 '(if (consp value) (car value) value))))))))))
944 (defcustom gnus-home-directory "~/"
945 "Directory variable that specifies the \"home\" directory.
946 All other Gnus path variables are initialized from this variable."
950 (defcustom gnus-directory (or (getenv "SAVEDIR")
951 (nnheader-concat gnus-home-directory "News/"))
952 "*Directory variable from which all other Gnus file variables are derived.
954 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
955 This means that other directory variables that are initialized from
956 this variable won't be set properly if you set this variable in `.gnus.el'.
957 Set this variable in `.emacs' instead."
961 (defcustom gnus-default-directory nil
962 "*Default directory for all Gnus buffers."
964 :type '(choice (const :tag "current" nil)
967 ;; Site dependent variables. These variables should be defined in
970 (defvar gnus-default-nntp-server nil
971 "Specify a default NNTP server.
972 This variable should be defined in paths.el, and should never be set
974 If you want to change servers, you should use `gnus-select-method'.
975 See the documentation to that variable.")
977 ;; Don't touch this variable.
978 (defvar gnus-nntp-service "nntp"
979 "NNTP service name (\"nntp\" or 119).
980 This is an obsolete variable, which is scarcely used. If you use an
981 nntp server for your newsgroup and want to change the port number
982 used to 899, you would say something along these lines:
984 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
986 (defcustom gnus-nntpserver-file "/etc/nntpserver"
987 "A file with only the name of the nntp server in it."
992 ;; This function is used to check both the environment variable
993 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
994 ;; an nntp server name default.
995 (defun gnus-getenv-nntpserver ()
996 (or (getenv "NNTPSERVER")
997 (and (file-readable-p gnus-nntpserver-file)
999 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1000 (insert-file-contents gnus-nntpserver-file)
1001 (let ((name (buffer-string)))
1003 (if (string-match "\\'[ \t\n]*$" name)
1006 (kill-buffer (current-buffer))))))))
1008 (defcustom gnus-select-method
1011 (list 'nntp (or (condition-case nil
1012 (gnus-getenv-nntpserver)
1014 (when (and gnus-default-nntp-server
1015 (not (string= gnus-default-nntp-server "")))
1016 gnus-default-nntp-server)
1018 (if (or (null gnus-nntp-service)
1019 (equal gnus-nntp-service "nntp"))
1021 (list gnus-nntp-service)))
1023 "Default method for selecting a newsgroup.
1024 This variable should be a list, where the first element is how the
1025 news is to be fetched, the second is the address.
1027 For instance, if you want to get your news via NNTP from
1028 \"flab.flab.edu\", you could say:
1030 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1032 If you want to use your local spool, say:
1034 \(setq gnus-select-method (list 'nnspool (system-name)))
1036 If you use this variable, you must set `gnus-nntp-server' to nil.
1038 There is a lot more to know about select methods and virtual servers -
1039 see the manual for details."
1041 :type 'gnus-select-method)
1043 (defcustom gnus-message-archive-method
1045 ;; Don't require it at top level to avoid circularity.
1049 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
1050 (nnfolder-active-file
1051 ,(nnheader-concat message-directory "archive/active"))
1052 (nnfolder-get-new-mail nil)
1053 (nnfolder-inhibit-expiry t)))
1054 "*Method used for archiving messages you've sent.
1055 This should be a mail method.
1057 It's probably not very effective to change this variable once you've
1058 run Gnus once. After doing that, you must edit this server from the
1061 :group 'gnus-message
1062 :type 'gnus-select-method)
1064 (defcustom gnus-message-archive-group nil
1065 "*Name of the group in which to save the messages you've written.
1066 This can either be a string; a list of strings; or an alist
1067 of regexps/functions/forms to be evaluated to return a string (or a list
1068 of strings). The functions are called with the name of the current
1069 group (or nil) as a parameter.
1071 If you want to save your mail in one group and the news articles you
1072 write in another group, you could say something like:
1074 \(setq gnus-message-archive-group
1075 '((if (message-news-p)
1079 Normally the group names returned by this variable should be
1080 unprefixed -- which implicitly means \"store on the archive server\".
1081 However, you may wish to store the message on some other server. In
1082 that case, just return a fully prefixed name of the group --
1083 \"nnml+private:mail.misc\", for instance."
1084 :group 'gnus-message
1085 :type '(choice (const :tag "none" nil)
1090 (defcustom gnus-secondary-servers nil
1091 "List of NNTP servers that the user can choose between interactively.
1092 To make Gnus query you for a server, you have to give `gnus' a
1093 non-numeric prefix - `C-u M-x gnus', in short."
1095 :type '(repeat string))
1097 (defcustom gnus-nntp-server nil
1098 "*The name of the host running the NNTP server.
1099 This variable is semi-obsolete. Use the `gnus-select-method'
1102 :type '(choice (const :tag "disable" nil)
1105 (defcustom gnus-secondary-select-methods nil
1106 "A list of secondary methods that will be used for reading news.
1107 This is a list where each element is a complete select method (see
1108 `gnus-select-method').
1110 If, for instance, you want to read your mail with the nnml backend,
1111 you could set this variable:
1113 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1115 :type '(repeat gnus-select-method))
1117 (defvar gnus-backup-default-subscribed-newsgroups
1118 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1119 "Default default new newsgroups the first time Gnus is run.
1120 Should be set in paths.el, and shouldn't be touched by the user.")
1122 (defcustom gnus-local-domain nil
1123 "Local domain name without a host name.
1124 The DOMAINNAME environment variable is used instead if it is defined.
1125 If the `system-name' function returns the full Internet name, there is
1126 no need to set this variable."
1127 :group 'gnus-message
1128 :type '(choice (const :tag "default" nil)
1131 (defvar gnus-local-organization nil
1132 "String with a description of what organization (if any) the user belongs to.
1133 Obsolete variable; use `message-user-organization' instead.")
1135 ;; Customization variables
1137 (defcustom gnus-refer-article-method nil
1138 "Preferred method for fetching an article by Message-ID.
1139 If you are reading news from the local spool (with nnspool), fetching
1140 articles by Message-ID is painfully slow. By setting this method to an
1141 nntp method, you might get acceptable results.
1143 The value of this variable must be a valid select method as discussed
1144 in the documentation of `gnus-select-method'.
1146 It can also be a list of select methods, as well as the special symbol
1147 `current', which means to use the current select method. If it is a
1148 list, Gnus will try all the methods in the list until it finds a match."
1150 :type '(choice (const :tag "default" nil)
1151 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1153 (repeat :menu-tag "Try multiple"
1155 :value (current (nnweb "refer" (nnweb-type dejanews)))
1156 (choice :tag "Method"
1158 (const :tag "DejaNews"
1159 (nnweb "refer" (nnweb-type dejanews)))
1160 gnus-select-method))))
1162 (defcustom gnus-group-faq-directory
1163 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1164 "/ftp@sunsite.auc.dk:/pub/usenet/"
1165 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1166 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1167 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1168 "/ftp@rtfm.mit.edu:/pub/usenet/"
1169 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1170 "/ftp@ftp.sunet.se:/pub/usenet/"
1171 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1172 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1173 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1174 "*Directory where the group FAQs are stored.
1175 This will most commonly be on a remote machine, and the file will be
1176 fetched by ange-ftp.
1178 This variable can also be a list of directories. In that case, the
1179 first element in the list will be used by default. The others can
1180 be used when being prompted for a site.
1182 Note that Gnus uses an aol machine as the default directory. If this
1183 feels fundamentally unclean, just think of it as a way to finally get
1184 something of value back from them.
1186 If the default site is too slow, try one of these:
1188 North America: mirrors.aol.com /pub/rtfm/usenet
1189 ftp.seas.gwu.edu /pub/rtfm
1190 rtfm.mit.edu /pub/usenet
1191 Europe: ftp.uni-paderborn.de /pub/FAQ
1192 src.doc.ic.ac.uk /usenet/news-FAQS
1193 ftp.sunet.se /pub/usenet
1194 sunsite.auc.dk /pub/usenet
1195 Asia: nctuccca.edu.tw /USENET/FAQ
1196 hwarang.postech.ac.kr /pub/usenet
1197 ftp.hk.super.net /mirror/faqs"
1198 :group 'gnus-group-various
1199 :type '(choice directory
1200 (repeat directory)))
1202 (defcustom gnus-use-cross-reference t
1203 "*Non-nil means that cross referenced articles will be marked as read.
1204 If nil, ignore cross references. If t, mark articles as read in
1205 subscribed newsgroups. If neither t nor nil, mark as read in all
1208 :type '(choice (const :tag "off" nil)
1209 (const :tag "subscribed" t)
1213 (defcustom gnus-process-mark ?#
1215 :group 'gnus-group-visual
1216 :group 'gnus-summary-marks
1219 (defcustom gnus-large-newsgroup 200
1220 "*The number of articles which indicates a large newsgroup.
1221 If the number of articles in a newsgroup is greater than this value,
1222 confirmation is required for selecting the newsgroup."
1223 :group 'gnus-group-select
1226 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1227 "*Non-nil means that the default name of a file to save articles in is the group name.
1228 If it's nil, the directory form of the group name is used instead.
1230 If this variable is a list, and the list contains the element
1231 `not-score', long file names will not be used for score files; if it
1232 contains the element `not-save', long file names will not be used for
1233 saving; and if it contains the element `not-kill', long file names
1234 will not be used for kill files.
1236 Note that the default for this variable varies according to what system
1237 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1238 to nil while on all other systems it defaults to t."
1242 (defcustom gnus-kill-files-directory gnus-directory
1243 "*Name of the directory where kill files will be stored (default \"~/News\")."
1244 :group 'gnus-score-files
1245 :group 'gnus-score-kill
1248 (defcustom gnus-save-score nil
1249 "*If non-nil, save group scoring info."
1250 :group 'gnus-score-various
1254 (defcustom gnus-use-undo t
1255 "*If non-nil, allow undoing in Gnus group mode buffers."
1259 (defcustom gnus-use-adaptive-scoring nil
1260 "*If non-nil, use some adaptive scoring scheme.
1261 If a list, then the values `word' and `line' are meaningful. The
1262 former will perform adaption on individual words in the subject
1263 header while `line' will perform adaption on several headers."
1265 :group 'gnus-score-adapt
1266 :type '(set (const word) (const line)))
1268 (defcustom gnus-use-cache 'passive
1269 "*If nil, Gnus will ignore the article cache.
1270 If `passive', it will allow entering (and reading) articles
1271 explicitly entered into the cache. If anything else, use the
1272 cache to the full extent of the law."
1275 :type '(choice (const :tag "off" nil)
1276 (const :tag "passive" passive)
1277 (const :tag "active" t)))
1279 (defcustom gnus-use-trees nil
1280 "*If non-nil, display a thread tree buffer."
1284 (defcustom gnus-use-grouplens nil
1285 "*If non-nil, use GroupLens ratings."
1289 (defcustom gnus-keep-backlog nil
1290 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1291 If it is a number N, then Gnus will only keep the last N articles
1292 read. If it is neither nil nor a number, Gnus will keep all read
1293 articles. This is not a good idea."
1295 :type '(choice (const :tag "off" nil)
1300 (defcustom gnus-use-nocem nil
1301 "*If non-nil, Gnus will read NoCeM cancel messages."
1305 (defcustom gnus-suppress-duplicates nil
1306 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1310 (defcustom gnus-use-scoring t
1311 "*If non-nil, enable scoring."
1315 (defcustom gnus-use-picons nil
1316 "*If non-nil, display picons in a frame of their own."
1320 (defcustom gnus-summary-prepare-exit-hook
1321 '(gnus-summary-expire-articles)
1322 "*A hook called when preparing to exit from the summary buffer.
1323 It calls `gnus-summary-expire-articles' by default."
1324 :group 'gnus-summary-exit
1327 (defcustom gnus-novice-user t
1328 "*Non-nil means that you are a usenet novice.
1329 If non-nil, verbose messages may be displayed and confirmations may be
1334 (defcustom gnus-expert-user nil
1335 "*Non-nil means that you will never be asked for confirmation about anything.
1336 That doesn't mean *anything* anything; particularly destructive
1337 commands will still require prompting."
1341 (defcustom gnus-interactive-catchup t
1342 "*If non-nil, require your confirmation when catching up a group."
1343 :group 'gnus-group-select
1346 (defcustom gnus-interactive-exit t
1347 "*If non-nil, require your confirmation when exiting Gnus."
1351 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1352 "*Function for extracting address components from a From header.
1353 Two pre-defined function exist: `gnus-extract-address-components',
1354 which is the default, quite fast, and too simplistic solution, and
1355 `mail-extract-address-components', which works much better, but is
1357 :group 'gnus-summary-format
1358 :type '(radio (function-item gnus-extract-address-components)
1359 (function-item mail-extract-address-components)
1360 (function :tag "Other")))
1362 (defcustom gnus-carpal nil
1363 "*If non-nil, display clickable icons."
1367 (defcustom gnus-shell-command-separator ";"
1368 "String used to separate to shell commands."
1372 (defcustom gnus-valid-select-methods
1373 '(("nntp" post address prompt-address physical-address)
1374 ("nnspool" post address)
1375 ("nnvirtual" post-mail virtual prompt-address)
1376 ("nnmbox" mail respool address)
1377 ("nnml" mail respool address)
1378 ("nnmh" mail respool address)
1379 ("nndir" post-mail prompt-address physical-address)
1380 ("nneething" none address prompt-address physical-address)
1381 ("nndoc" none address prompt-address)
1382 ("nnbabyl" mail address respool)
1383 ("nnkiboze" post virtual)
1384 ("nnsoup" post-mail address)
1385 ("nndraft" post-mail)
1386 ("nnfolder" mail respool address)
1387 ("nngateway" post-mail address prompt-address physical-address)
1394 ("nnagent" post-mail)
1395 ("nnimap" post-mail address prompt-address physical-address))
1396 "*An alist of valid select methods.
1397 The first element of each list lists should be a string with the name
1398 of the select method. The other elements may be the category of
1399 this method (i. e., `post', `mail', `none' or whatever) or other
1400 properties that this method has (like being respoolable).
1401 If you implement a new select method, all you should have to change is
1402 this variable. I think."
1404 :type '(repeat (group (string :tag "Name")
1405 (radio-button-choice (const :format "%v " post)
1406 (const :format "%v " mail)
1407 (const :format "%v " none)
1409 (checklist :inline t
1410 (const :format "%v " address)
1411 (const :format "%v " prompt-address)
1412 (const :format "%v " physical-address)
1413 (const :format "%v " virtual)
1416 (defun gnus-redefine-select-method-widget ()
1417 "Recomputes the select-method widget based on the value of
1418 `gnus-valid-select-methods'."
1419 (define-widget 'gnus-select-method 'list
1420 "Widget for entering a select method."
1422 :tag "Select Method"
1423 :args `((choice :tag "Method"
1424 ,@(mapcar (lambda (entry)
1425 (list 'const :format "%v\n"
1426 (intern (car entry))))
1427 gnus-valid-select-methods)
1428 (symbol :tag "other"))
1429 (string :tag "Address")
1430 (repeat :tag "Options"
1434 (sexp :tag "Value"))))))
1436 (gnus-redefine-select-method-widget)
1438 (defcustom gnus-updated-mode-lines '(group article summary tree)
1439 "List of buffers that should update their mode lines.
1440 The list may contain the symbols `group', `article', `tree' and
1441 `summary'. If the corresponding symbol is present, Gnus will keep
1442 that mode line updated with information that may be pertinent.
1443 If this variable is nil, screen refresh may be quicker."
1444 :group 'gnus-various
1445 :type '(set (const group)
1450 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1451 (defcustom gnus-mode-non-string-length nil
1452 "*Max length of mode-line non-string contents.
1453 If this is nil, Gnus will take space as is needed, leaving the rest
1454 of the modeline intact. Note that the default of nil is unlikely
1455 to be desirable; see the manual for further details."
1456 :group 'gnus-various
1457 :type '(choice (const nil)
1460 (gnus-define-group-parameter
1463 "Return GROUP's to-address."
1465 "*Alist of group regexps and correspondent to-addresses."
1466 :parameter-type '(gnus-email-address :tag "To Address")
1467 :parameter-document "\
1468 This will be used when doing followups and posts.
1470 This is primarily useful in mail groups that represent closed
1471 mailing lists--mailing lists where it's expected that everybody that
1472 writes to the mailing list is subscribed to it. Since using this
1473 parameter ensures that the mail only goes to the mailing list itself,
1474 it means that members won't receive two copies of your followups.
1476 Using `to-address' will actually work whether the group is foreign or
1477 not. Let's say there's a group on the server that is called
1478 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1479 articles from a mail-to-news gateway. Posting directly to this group
1480 is therefore impossible--you have to send mail to the mailing list
1483 The gnus-group-split mail splitting mechanism will behave as if this
1484 address was listed in gnus-group-split Addresses (see below).")
1486 (gnus-define-group-parameter
1489 "Return GROUP's to-list."
1491 "*Alist of group regexps and correspondent to-lists."
1492 :parameter-type '(gnus-email-address :tag "To List")
1493 :parameter-document "\
1494 This address will be used when doing a `a' in the group.
1496 It is totally ignored when doing a followup--except that if it is
1497 present in a news group, you'll get mail group semantics when doing
1500 The gnus-group-split mail splitting mechanism will behave as if this
1501 address was listed in gnus-group-split Addresses (see below).")
1503 (gnus-define-group-parameter
1506 :function gnus-group-auto-expirable-p
1508 "Check whether GROUP is auto-expirable or not."
1509 :variable gnus-auto-expirable-newsgroups
1510 :variable-default nil
1512 "*Groups in which to automatically mark read articles as expirable.
1513 If non-nil, this should be a regexp that should match all groups in
1514 which to perform auto-expiry. This only makes sense for mail groups."
1515 :variable-group nnmail-expire
1516 :variable-type '(choice (const nil)
1518 :parameter-type '(const :tag "Automatic Expire" t)
1520 "All articles that are read will be marked as expirable.")
1522 (gnus-define-group-parameter
1525 :function gnus-group-total-expirable-p
1527 "Check whether GROUP is total-expirable or not."
1528 :variable gnus-total-expirable-newsgroups
1529 :variable-default nil
1531 "*Groups in which to perform expiry of all read articles.
1532 Use with extreme caution. All groups that match this regexp will be
1533 expiring - which means that all read articles will be deleted after
1534 \(say) one week. (This only goes for mail groups and the like, of
1536 :variable-group nnmail-expire
1537 :variable-type '(choice (const nil)
1539 :parameter-type '(const :tag "Total Expire" t)
1541 "All read articles will be put through the expiry process
1543 This happens even if they are not marked as expirable.
1546 (defcustom gnus-group-uncollapsed-levels 1
1547 "Number of group name elements to leave alone when making a short group name."
1548 :group 'gnus-group-visual
1551 (defcustom gnus-group-use-permanent-levels nil
1552 "*If non-nil, once you set a level, Gnus will use this level."
1553 :group 'gnus-group-levels
1558 (defcustom gnus-load-hook nil
1559 "A hook run while Gnus is loaded."
1563 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1564 "A hook called to apply kill files to a group.
1565 This hook is intended to apply a kill file to the selected newsgroup.
1566 The function `gnus-apply-kill-file' is called by default.
1568 Since a general kill file is too heavy to use only for a few
1569 newsgroups, I recommend you to use a lighter hook function. For
1570 example, if you'd like to apply a kill file to articles which contains
1571 a string `rmgroup' in subject in newsgroup `control', you can use the
1574 (setq gnus-apply-kill-hook
1577 (cond ((string-match \"control\" gnus-newsgroup-name)
1578 (gnus-kill \"Subject\" \"rmgroup\")
1579 (gnus-expunge \"X\"))))))"
1580 :group 'gnus-score-kill
1581 :options '(gnus-apply-kill-file)
1584 (defcustom gnus-group-change-level-function nil
1585 "Function run when a group level is changed.
1586 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1587 :group 'gnus-group-levels
1592 (defcustom gnus-visual
1593 '(summary-highlight group-highlight article-highlight
1595 summary-menu group-menu article-menu
1596 tree-highlight menu highlight
1597 browse-menu server-menu
1598 page-marker tree-menu binary-menu pick-menu
1600 "*Enable visual features.
1601 If `visual' is disabled, there will be no menus and few faces. Most of
1602 the visual customization options below will be ignored. Gnus will use
1603 less space and be faster as a result.
1605 This variable can also be a list of visual elements to switch on. For
1606 instance, to switch off all visual things except menus, you can say:
1608 (setq gnus-visual '(menu))
1610 Valid elements include `summary-highlight', `group-highlight',
1611 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1612 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1613 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1614 and `grouplens-menu'."
1617 :type '(set (const summary-highlight)
1618 (const group-highlight)
1619 (const article-highlight)
1621 (const summary-menu)
1623 (const article-menu)
1624 (const tree-highlight)
1633 (const grouplens-menu)))
1635 (defcustom gnus-mouse-face
1637 (if (gnus-visual-p 'mouse-face 'highlight)
1638 (if (boundp 'gnus-mouse-face)
1639 (or gnus-mouse-face 'highlight)
1643 "*Face used for group or summary buffer mouse highlighting.
1644 The line beneath the mouse pointer will be highlighted with this
1649 (defcustom gnus-article-save-directory gnus-directory
1650 "*Name of the directory articles will be saved in (default \"~/News\")."
1651 :group 'gnus-article-saving
1654 (defvar gnus-plugged t
1655 "Whether Gnus is plugged or not.")
1657 (defcustom gnus-default-charset 'iso-8859-1
1658 "Default charset assumed to be used when viewing non-ASCII characters.
1659 This variable is overridden on a group-to-group basis by the
1660 gnus-group-charset-alist variable and is only used on groups not
1661 covered by that variable."
1663 :group 'gnus-charset)
1666 ;;; Internal variables
1668 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1669 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1670 (defvar gnus-draft-meta-information-header "X-Draft-From")
1671 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1672 (defvar gnus-original-article-buffer " *Original Article*")
1673 (defvar gnus-newsgroup-name nil)
1674 (defvar gnus-ephemeral-servers nil)
1676 (defvar gnus-agent nil
1677 "Whether we want to use the Gnus agent or not.")
1679 (defvar gnus-agent-fetching nil
1680 "Whether Gnus agent is in fetching mode.")
1682 (defvar gnus-command-method nil
1683 "Dynamically bound variable that says what the current backend is.")
1685 (defvar gnus-current-select-method nil
1686 "The current method for selecting a newsgroup.")
1688 (defvar gnus-tree-buffer "*Tree*"
1689 "Buffer where Gnus thread trees are displayed.")
1692 (defvar gnus-use-generic-from nil)
1694 ;; Variable holding the user answers to all method prompts.
1695 (defvar gnus-method-history nil)
1697 ;; Variable holding the user answers to all mail method prompts.
1698 (defvar gnus-mail-method-history nil)
1700 ;; Variable holding the user answers to all group prompts.
1701 (defvar gnus-group-history nil)
1703 (defvar gnus-server-alist nil
1704 "List of available servers.")
1706 (defcustom gnus-cache-directory
1707 (nnheader-concat gnus-directory "cache/")
1708 "*The directory where cached articles will be stored."
1712 (defvar gnus-predefined-server-alist
1715 (nnspool-spool-directory ,gnus-cache-directory)
1716 (nnspool-nov-directory ,gnus-cache-directory)
1717 (nnspool-active-file
1718 ,(nnheader-concat gnus-cache-directory "active"))))
1719 "List of predefined (convenience) servers.")
1721 (defvar gnus-topic-indentation "");; Obsolete variable.
1723 (defconst gnus-article-mark-lists
1724 '((marked . tick) (replied . reply)
1725 (expirable . expire) (killed . killed)
1726 (bookmarks . bookmark) (dormant . dormant)
1727 (scored . score) (saved . save)
1728 (cached . cache) (downloadable . download)
1729 (unsendable . unsend)))
1731 (defvar gnus-headers-retrieved-by nil)
1732 (defvar gnus-article-reply nil)
1733 (defvar gnus-override-method nil)
1734 (defvar gnus-article-check-size nil)
1735 (defvar gnus-opened-servers nil)
1737 (defvar gnus-current-kill-article nil)
1739 (defvar gnus-have-read-active-file nil)
1741 (defconst gnus-maintainer
1742 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1743 "The mail address of the Gnus maintainers.")
1745 (defvar gnus-info-nodes
1746 '((gnus-group-mode "(gnus)The Group Buffer")
1747 (gnus-summary-mode "(gnus)The Summary Buffer")
1748 (gnus-article-mode "(gnus)The Article Buffer")
1749 (gnus-server-mode "(gnus)The Server Buffer")
1750 (gnus-browse-mode "(gnus)Browse Foreign Server")
1751 (gnus-tree-mode "(gnus)Tree Display"))
1752 "Alist of major modes and related Info nodes.")
1754 (defvar gnus-group-buffer "*Group*")
1755 (defvar gnus-summary-buffer "*Summary*")
1756 (defvar gnus-article-buffer "*Article*")
1757 (defvar gnus-server-buffer "*Server*")
1759 (defvar gnus-slave nil
1760 "Whether this Gnus is a slave or not.")
1762 (defvar gnus-batch-mode nil
1763 "Whether this Gnus is running in batch mode or not.")
1765 (defvar gnus-variable-list
1766 '(gnus-newsrc-options gnus-newsrc-options-n
1767 gnus-newsrc-last-checked-date
1768 gnus-newsrc-alist gnus-server-alist
1769 gnus-killed-list gnus-zombie-list
1770 gnus-topic-topology gnus-topic-alist
1772 "Gnus variables saved in the quick startup file.")
1774 (defvar gnus-newsrc-alist nil
1775 "Assoc list of read articles.
1776 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1778 (defvar gnus-newsrc-hashtb nil
1779 "Hashtable of gnus-newsrc-alist.")
1781 (defvar gnus-killed-list nil
1782 "List of killed newsgroups.")
1784 (defvar gnus-killed-hashtb nil
1785 "Hash table equivalent of gnus-killed-list.")
1787 (defvar gnus-zombie-list nil
1788 "List of almost dead newsgroups.")
1790 (defvar gnus-description-hashtb nil
1791 "Descriptions of newsgroups.")
1793 (defvar gnus-list-of-killed-groups nil
1794 "List of newsgroups that have recently been killed by the user.")
1796 (defvar gnus-active-hashtb nil
1797 "Hashtable of active articles.")
1799 (defvar gnus-moderated-hashtb nil
1800 "Hashtable of moderated newsgroups.")
1802 ;; Save window configuration.
1803 (defvar gnus-prev-winconf nil)
1805 (defvar gnus-reffed-article-number nil)
1807 ;;; Let the byte-compiler know that we know about this variable.
1808 (defvar rmail-default-rmail-file)
1810 (defvar gnus-dead-summary nil)
1812 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1813 "Regexp matching invalid groups.")
1815 ;;; End of variables.
1817 ;; Define some autoload functions Gnus might use.
1820 ;; This little mapcar goes through the list below and marks the
1821 ;; symbols in question as autoloaded functions.
1824 (let ((interactive (nth 1 (memq ':interactive package))))
1828 (when (consp function)
1829 (setq keymap (car (memq 'keymap function)))
1830 (setq function (car function)))
1831 (unless (fboundp function)
1832 (autoload function (car package) nil interactive keymap))))
1833 (if (eq (nth 1 package) ':interactive)
1836 '(("info" :interactive t Info-goto-node)
1838 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1839 ("ps-print" ps-print-preprint)
1840 ("message" :interactive t
1841 message-send-and-exit message-yank-original)
1842 ("babel" babel-as-string)
1843 ("nnmail" nnmail-split-fancy nnmail-article-group)
1844 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1845 ("rmailout" rmail-output rmail-output-to-rmail-file)
1846 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1847 rmail-show-message rmail-summary-exists
1848 rmail-select-summary rmail-update-summary)
1849 ("gnus-audio" :interactive t gnus-audio-play)
1850 ("gnus-xmas" gnus-xmas-splash)
1851 ("gnus-soup" :interactive t
1852 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1853 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1854 ("nnsoup" nnsoup-pack-replies)
1855 ("score-mode" :interactive t gnus-score-mode)
1856 ("gnus-mh" gnus-summary-save-article-folder
1857 gnus-Folder-save-name gnus-folder-save-name)
1858 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1859 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1860 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1861 gnus-demon-add-disconnection gnus-demon-add-handler
1862 gnus-demon-remove-handler)
1863 ("gnus-demon" :interactive t
1864 gnus-demon-init gnus-demon-cancel)
1865 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1866 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1867 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1868 gnus-nocem-unwanted-article-p)
1869 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1870 gnus-server-server-name)
1871 ("gnus-srvr" gnus-browse-foreign-server)
1872 ("gnus-cite" :interactive t
1873 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1874 gnus-article-hide-citation gnus-article-fill-cited-article
1875 gnus-article-hide-citation-in-followups)
1876 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1877 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1878 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1879 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1880 gnus-cache-possibly-remove-articles gnus-cache-request-article
1881 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1882 gnus-cache-enter-remove-article gnus-cached-article-p
1883 gnus-cache-open gnus-cache-close gnus-cache-update-article
1884 gnus-cache-articles-in-group)
1885 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1886 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1887 ("gnus-score" :interactive t
1888 gnus-summary-increase-score gnus-summary-set-score
1889 gnus-summary-raise-thread gnus-summary-raise-same-subject
1890 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1891 gnus-summary-lower-thread gnus-summary-lower-same-subject
1892 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1893 gnus-summary-current-score gnus-score-delta-default
1894 gnus-score-flush-cache gnus-score-close
1895 gnus-possibly-score-headers gnus-score-followup-article
1896 gnus-score-followup-thread)
1898 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1899 gnus-current-score-file-nondirectory gnus-score-adaptive
1900 gnus-score-find-trace gnus-score-file-name)
1901 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1902 ("gnus-topic" :interactive t gnus-topic-mode)
1903 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1904 gnus-subscribe-topics)
1905 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1906 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1907 ("gnus-uu" :interactive t
1908 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1909 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1910 gnus-uu-mark-by-regexp gnus-uu-mark-all
1911 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1912 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1913 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1914 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1915 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1916 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1917 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1918 gnus-uu-mark-over gnus-uu-post-news)
1919 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1920 ("gnus-msg" (gnus-summary-send-map keymap)
1921 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1922 ("gnus-msg" :interactive t
1923 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1924 gnus-summary-followup gnus-summary-followup-with-original
1925 gnus-summary-cancel-article gnus-summary-supersede-article
1926 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1927 gnus-summary-mail-forward gnus-summary-mail-other-window
1928 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1929 gnus-summary-wide-reply gnus-summary-followup-to-mail
1930 gnus-summary-followup-to-mail-with-original gnus-bug
1931 gnus-summary-wide-reply-with-original
1932 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1933 gnus-summary-post-forward)
1934 ("gnus-picon" :interactive t gnus-article-display-picons
1935 gnus-group-display-picons gnus-picons-article-display-x-face
1936 gnus-picons-display-x-face)
1937 ("gnus-picon" gnus-picons-buffer-name)
1938 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1939 gnus-grouplens-mode)
1940 ("smiley" :interactive t gnus-smiley-display)
1941 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1942 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1943 gnus-list-of-unread-articles gnus-list-of-read-articles
1944 gnus-offer-save-summaries gnus-make-thread-indent-array
1945 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1946 gnus-summary-skip-intangible gnus-summary-article-number
1947 gnus-data-header gnus-data-find)
1948 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1949 gnus-group-list-groups gnus-group-first-unread-group
1950 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1951 gnus-group-setup-buffer gnus-group-get-new-news
1952 gnus-group-make-help-group gnus-group-update-group
1953 gnus-group-iterate gnus-group-group-name)
1954 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1955 gnus-backlog-remove-article)
1956 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1957 gnus-article-prepare gnus-article-set-window-start
1958 gnus-article-next-page gnus-article-prev-page
1959 gnus-request-article-this-buffer gnus-article-mode
1960 gnus-article-setup-buffer gnus-narrow-to-page
1961 gnus-article-delete-invisible-text gnus-treat-article)
1962 ("gnus-art" :interactive t
1963 gnus-article-hide-headers gnus-article-hide-boring-headers
1964 gnus-article-treat-overstrike
1965 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1966 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1967 gnus-article-de-base64-unreadable
1968 gnus-article-decode-HZ
1969 gnus-article-wash-html
1970 gnus-article-hide-pgp
1971 gnus-article-hide-pem gnus-article-hide-signature
1972 gnus-article-strip-leading-blank-lines gnus-article-date-local
1973 gnus-article-date-original gnus-article-date-lapsed
1974 gnus-article-show-all-headers
1975 gnus-article-edit-mode gnus-article-edit-article
1976 gnus-article-edit-done gnus-article-decode-encoded-words
1977 gnus-start-date-timer gnus-stop-date-timer
1978 gnus-mime-view-all-parts)
1979 ("gnus-int" gnus-request-type)
1980 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1981 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1982 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1983 gnus-dup-enter-articles)
1984 ("gnus-range" gnus-copy-sequence)
1985 ("gnus-eform" gnus-edit-form)
1986 ("gnus-move" :interactive t
1987 gnus-group-move-group-to-server gnus-change-server)
1988 ("gnus-logic" gnus-score-advanced)
1989 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1990 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1991 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1992 gnus-async-halt-prefetch)
1993 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1994 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1995 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1996 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1997 ("gnus-agent" :interactive t
1998 gnus-unplugged gnus-agentize gnus-agent-batch)
1999 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2000 gnus-summary-save-article-vm)
2001 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
2002 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2003 ("gnus-mlspl" :interactive t gnus-group-split-setup
2004 gnus-group-split-update))))
2006 ;;; gnus-sum.el thingies
2009 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
2010 "*The format specification of the lines in the summary buffer.
2012 It works along the same lines as a normal formatting string,
2013 with some simple extensions.
2015 %N Article number, left padded with spaces (string)
2017 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2018 %n Name of the poster (string)
2019 %a Extracted name of the poster (string)
2020 %A Extracted address of the poster (string)
2021 %F Contents of the From: header (string)
2022 %f Contents of the From: or To: headers (string)
2023 %x Contents of the Xref: header (string)
2024 %D Date of the article (string)
2025 %d Date of the article (string) in DD-MMM format
2026 %M Message-id of the article (string)
2027 %r References of the article (string)
2028 %c Number of characters in the article (integer)
2029 %L Number of lines in the article (integer)
2030 %I Indentation based on thread level (a string of spaces)
2031 %T A string with two possible values: 80 spaces if the article
2032 is on thread level two or larger and 0 spaces on level one
2033 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2034 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2035 %[ Opening bracket (character, \"[\" or \"<\")
2036 %] Closing bracket (character, \"]\" or \">\")
2037 %> Spaces of length thread-level (string)
2038 %< Spaces of length (- 20 thread-level) (string)
2039 %i Article score (number)
2040 %z Article zcore (character)
2041 %t Number of articles under the current thread (number).
2042 %e Whether the thread is empty or not (character).
2043 %l GroupLens score (string).
2044 %V Total thread score (number).
2045 %P The line number (number).
2046 %O Download mark (character).
2047 %u User defined specifier. The next character in the format string should
2048 be a letter. Gnus will call the function gnus-user-format-function-X,
2049 where X is the letter following %u. The function will be passed the
2050 current header as argument. The function should return a string, which
2051 will be inserted into the summary just like information from any other
2054 Text between %( and %) will be highlighted with `gnus-mouse-face'
2055 when the mouse point is placed inside the area. There can only be one
2058 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2059 with care. For reasons of efficiency, Gnus will compute what column
2060 these characters will end up in, and \"hard-code\" that. This means that
2061 it is invalid to have these specs after a variable-length spec. Well,
2062 you might not be arrested, but your summary buffer will look strange,
2063 which is bad enough.
2065 The smart choice is to have these specs as for to the left as
2068 This restriction may disappear in later versions of Gnus."
2070 :group 'gnus-summary-format)
2073 ;;; Skeleton keymaps
2076 (defun gnus-suppress-keymap (keymap)
2077 (suppress-keymap keymap)
2078 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2080 (define-key keymap (pop keys) 'undefined))))
2082 (defvar gnus-article-mode-map
2083 (let ((keymap (make-sparse-keymap)))
2084 (gnus-suppress-keymap keymap)
2086 (defvar gnus-summary-mode-map
2087 (let ((keymap (make-keymap)))
2088 (gnus-suppress-keymap keymap)
2090 (defvar gnus-group-mode-map
2091 (let ((keymap (make-keymap)))
2092 (gnus-suppress-keymap keymap)
2097 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2098 ;; If you want the cursor to go somewhere else, set these two
2099 ;; functions in some startup hook to whatever you want.
2100 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2101 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2103 ;;; Various macros and substs.
2105 (defun gnus-header-from (header)
2106 (mail-header-from header))
2108 (defmacro gnus-gethash (string hashtable)
2109 "Get hash value of STRING in HASHTABLE."
2110 `(symbol-value (intern-soft ,string ,hashtable)))
2112 (defmacro gnus-sethash (string value hashtable)
2113 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2114 `(set (intern ,string ,hashtable) ,value))
2115 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2117 (defmacro gnus-group-unread (group)
2118 "Get the currently computed number of unread articles in GROUP."
2119 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2121 (defmacro gnus-group-entry (group)
2122 "Get the newsrc entry for GROUP."
2123 `(gnus-gethash ,group gnus-newsrc-hashtb))
2125 (defmacro gnus-active (group)
2126 "Get active info on GROUP."
2127 `(gnus-gethash ,group gnus-active-hashtb))
2129 (defmacro gnus-set-active (group active)
2130 "Set GROUP's active info."
2131 `(gnus-sethash ,group ,active gnus-active-hashtb))
2133 ;; Info access macros.
2135 (defmacro gnus-info-group (info)
2137 (defmacro gnus-info-rank (info)
2139 (defmacro gnus-info-read (info)
2141 (defmacro gnus-info-marks (info)
2143 (defmacro gnus-info-method (info)
2145 (defmacro gnus-info-params (info)
2148 (defmacro gnus-info-level (info)
2149 `(let ((rank (gnus-info-rank ,info)))
2153 (defmacro gnus-info-score (info)
2154 `(let ((rank (gnus-info-rank ,info)))
2155 (or (and (consp rank) (cdr rank)) 0)))
2157 (defmacro gnus-info-set-group (info group)
2158 `(setcar ,info ,group))
2159 (defmacro gnus-info-set-rank (info rank)
2160 `(setcar (nthcdr 1 ,info) ,rank))
2161 (defmacro gnus-info-set-read (info read)
2162 `(setcar (nthcdr 2 ,info) ,read))
2163 (defmacro gnus-info-set-marks (info marks &optional extend)
2165 `(gnus-info-set-entry ,info ,marks 3)
2166 `(setcar (nthcdr 3 ,info) ,marks)))
2167 (defmacro gnus-info-set-method (info method &optional extend)
2169 `(gnus-info-set-entry ,info ,method 4)
2170 `(setcar (nthcdr 4 ,info) ,method)))
2171 (defmacro gnus-info-set-params (info params &optional extend)
2173 `(gnus-info-set-entry ,info ,params 5)
2174 `(setcar (nthcdr 5 ,info) ,params)))
2176 (defun gnus-info-set-entry (info entry number)
2177 ;; Extend the info until we have enough elements.
2178 (while (<= (length info) number)
2179 (nconc info (list nil)))
2181 (setcar (nthcdr number info) entry))
2183 (defmacro gnus-info-set-level (info level)
2184 `(let ((rank (cdr ,info)))
2185 (if (consp (car rank))
2186 (setcar (car rank) ,level)
2187 (setcar rank ,level))))
2188 (defmacro gnus-info-set-score (info score)
2189 `(let ((rank (cdr ,info)))
2190 (if (consp (car rank))
2191 (setcdr (car rank) ,score)
2192 (setcar rank (cons (car rank) ,score)))))
2194 (defmacro gnus-get-info (group)
2195 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2197 ;; Byte-compiler warning.
2198 (defvar gnus-visual)
2199 ;; Find out whether the gnus-visual TYPE is wanted.
2200 (defun gnus-visual-p (&optional type class)
2201 (and gnus-visual ; Has to be non-nil, at least.
2202 (if (not type) ; We don't care about type.
2204 (if (listp gnus-visual) ; It's a list, so we check it.
2205 (or (memq type gnus-visual)
2206 (memq class gnus-visual))
2209 ;;; Load the compatability functions.
2218 (defvar gnus-shutdown-alist nil)
2220 (defun gnus-add-shutdown (function &rest symbols)
2221 "Run FUNCTION whenever one of SYMBOLS is shut down."
2222 (push (cons function symbols) gnus-shutdown-alist))
2224 (defun gnus-shutdown (symbol)
2225 "Shut down everything that waits for SYMBOL."
2226 (let ((alist gnus-shutdown-alist)
2228 (while (setq entry (pop alist))
2229 (when (memq symbol (cdr entry))
2230 (funcall (car entry))))))
2234 ;;; Gnus Utility Functions
2238 (defmacro gnus-string-or (&rest strings)
2239 "Return the first element of STRINGS that is a non-blank string.
2240 STRINGS will be evaluated in normal `or' order."
2241 `(gnus-string-or-1 ',strings))
2243 (defun gnus-string-or-1 (strings)
2246 (setq string (eval (pop strings)))
2247 (if (string-match "^[ \t]*$" string)
2249 (setq strings nil)))
2252 (defun gnus-version (&optional arg)
2253 "Version number of this version of Gnus.
2254 If ARG, insert string at point."
2257 (insert (message gnus-version))
2258 (message gnus-version)))
2260 (defun gnus-continuum-version (version)
2261 "Return VERSION as a floating point number."
2262 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2263 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2264 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2265 (number (match-string 2 version))
2267 (unless (string-match
2268 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2269 (error "Invalid version string: %s" version))
2270 (setq major (string-to-number (match-string 1 number))
2271 minor (string-to-number (match-string 2 number))
2272 least (if (match-beginning 3)
2273 (string-to-number (match-string 3 number))
2277 (format "%s00%02d%02d"
2278 (if (member alpha '("(ding)" "d"))
2282 (- (mm-char-int (aref (downcase alpha) 0))
2286 (format "%d.%02d%02d" major minor least))))))
2288 (defun gnus-info-find-node ()
2289 "Find Info documentation of Gnus."
2291 ;; Enlarge info window if needed.
2292 (let (gnus-info-buffer)
2293 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2294 (setq gnus-info-buffer (current-buffer))
2295 (gnus-configure-windows 'info)))
2298 ;;; gnus-interactive
2301 (defvar gnus-current-prefix-symbol nil
2302 "Current prefix symbol.")
2304 (defvar gnus-current-prefix-symbols nil
2305 "List of current prefix symbols.")
2307 (defun gnus-interactive (string &optional params)
2308 "Return a list that can be fed to `interactive'.
2309 See `interactive' for full documentation.
2311 Adds the following specs:
2313 y -- The current symbolic prefix.
2314 Y -- A list of the current symbolic prefix(es).
2315 A -- Article number.
2316 H -- Article header.
2320 (while (< i (length string))
2321 (string-match ".\\([^\n]*\\)\n?" string i)
2322 (setq c (aref string i))
2324 (setq prompt (match-string 1 string)))
2325 (setq i (match-end 0))
2326 ;; We basically emulate just about everything that
2327 ;; `interactive' does, but add the specs listed above.
2331 (completing-read prompt obarray 'fboundp t))
2333 (read-buffer prompt (current-buffer) t))
2335 (read-buffer prompt (other-buffer (current-buffer))))
2339 (completing-read prompt obarray 'commandp t))
2343 (read-file-name prompt nil default-directory 'lambda))
2345 (read-file-name prompt nil nil 'lambda))
2347 (read-file-name prompt))
2349 (read-key-sequence prompt))
2351 (error "Not implemented spec"))
2353 (error "Not implemented spec"))
2357 (error "Not implemented spec"))
2359 (string-to-number (read-from-minibuffer prompt)))
2361 (prefix-numeric-value current-prefix-arg))
2367 (read-string prompt))
2369 (intern (read-string prompt)))
2371 (read-variable prompt))
2373 (read-minibuffer prompt))
2375 (eval-minibuffer prompt))
2376 ;; And here the new specs come.
2378 gnus-current-prefix-symbol)
2380 gnus-current-prefix-symbols)
2382 (gnus-group-group-name))
2384 (gnus-summary-skip-intangible)
2385 (or (get-text-property (point) 'gnus-number)
2386 (gnus-summary-last-subject)))
2388 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2390 (error "Non-implemented spec")))
2394 (push (if (< (point) (mark) (point) (mark))) out)
2395 (push (if (> (point) (mark) (point) (mark))) out))))
2396 (setq out (delq 'gnus-prefix-nil out))
2399 (defun gnus-symbolic-argument (&optional arg)
2400 "Read a symbolic argument and a command, and then execute command."
2402 (let* ((in-command (this-command-keys))
2403 (command in-command)
2404 gnus-current-prefix-symbols
2405 gnus-current-prefix-symbol
2407 (while (equal in-command command)
2408 (message "%s-" (key-description (this-command-keys)))
2409 (push (intern (char-to-string (read-char))) syms)
2410 (setq command (read-key-sequence nil t)))
2411 (setq gnus-current-prefix-symbols (nreverse syms)
2412 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2413 (call-interactively (key-binding command t))))
2415 ;;; More various functions.
2417 (defsubst gnus-check-backend-function (func group)
2418 "Check whether GROUP supports function FUNC.
2419 GROUP can either be a string (a group name) or a select method."
2421 (let ((method (if (stringp group)
2422 (car (gnus-find-method-for-group group))
2424 (unless (featurep method)
2426 (fboundp (intern (format "%s-%s" method func))))))
2428 (defun gnus-group-read-only-p (&optional group)
2429 "Check whether GROUP supports editing or not.
2430 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2431 that that variable is buffer-local to the summary buffers."
2432 (let ((group (or group gnus-newsgroup-name)))
2433 (not (gnus-check-backend-function 'request-replace-article group))))
2435 (defun gnus-virtual-group-p (group)
2436 "Say whether GROUP is virtual or not."
2437 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2438 gnus-valid-select-methods)))
2440 (defun gnus-news-group-p (group &optional article)
2441 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2442 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2443 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2444 (if (or (null article)
2445 (not (< article 0)))
2446 (eq (gnus-request-type group article) 'news)
2447 (if (not (vectorp article))
2449 ;; It's a real article.
2450 (eq (gnus-request-type group (mail-header-id article))
2453 ;; Returns a list of writable groups.
2454 (defun gnus-writable-groups ()
2455 (let ((alist gnus-newsrc-alist)
2457 (while (setq group (car (pop alist)))
2458 (unless (gnus-group-read-only-p group)
2459 (push group groups)))
2462 ;; Check whether to use long file names.
2463 (defun gnus-use-long-file-name (symbol)
2464 ;; The variable has to be set...
2465 (and gnus-use-long-file-name
2466 ;; If it isn't a list, then we return t.
2467 (or (not (listp gnus-use-long-file-name))
2468 ;; If it is a list, and the list contains `symbol', we
2470 (not (memq symbol gnus-use-long-file-name)))))
2472 ;; Generate a unique new group name.
2473 (defun gnus-generate-new-group-name (leaf)
2476 (while (gnus-gethash name gnus-newsrc-hashtb)
2477 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2480 (defun gnus-ephemeral-group-p (group)
2481 "Say whether GROUP is ephemeral or not."
2482 (gnus-group-get-parameter group 'quit-config t))
2484 (defun gnus-group-quit-config (group)
2485 "Return the quit-config of GROUP."
2486 (gnus-group-get-parameter group 'quit-config t))
2488 (defun gnus-kill-ephemeral-group (group)
2489 "Remove ephemeral GROUP from relevant structures."
2490 (gnus-sethash group nil gnus-newsrc-hashtb))
2492 (defun gnus-simplify-mode-line ()
2493 "Make mode lines a bit simpler."
2494 (setq mode-line-modified (cdr gnus-mode-line-modified))
2495 (when (listp mode-line-format)
2496 (make-local-variable 'mode-line-format)
2497 (setq mode-line-format (copy-sequence mode-line-format))
2498 (when (equal (nth 3 mode-line-format) " ")
2499 (setcar (nthcdr 3 mode-line-format) " "))))
2501 ;;; Servers and groups.
2503 (defsubst gnus-server-add-address (method)
2504 (let ((method-name (symbol-name (car method))))
2505 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2506 (not (assq (intern (concat method-name "-address")) method))
2507 (memq 'physical-address (assq (car method)
2508 gnus-valid-select-methods)))
2509 (append method (list (list (intern (concat method-name "-address"))
2513 (defsubst gnus-server-get-method (group method)
2514 ;; Input either a server name, and extended server name, or a
2515 ;; select method, and return a select method.
2516 (cond ((stringp method)
2517 (gnus-server-to-method method))
2518 ((equal method gnus-select-method)
2520 ((and (stringp (car method))
2522 (gnus-server-extend-method group method))
2525 (equal (cadr method) ""))
2528 (gnus-server-add-address method))))
2530 (defun gnus-server-to-method (server)
2531 "Map virtual server names to select methods."
2533 ;; Is this a method, perhaps?
2534 (and server (listp server) server)
2535 ;; Perhaps this is the native server?
2536 (and (equal server "native") gnus-select-method)
2537 ;; It should be in the server alist.
2538 (cdr (assoc server gnus-server-alist))
2539 ;; It could be in the predefined server alist.
2540 (cdr (assoc server gnus-predefined-server-alist))
2541 ;; If not, we look through all the opened server
2542 ;; to see whether we can find it there.
2543 (let ((opened gnus-opened-servers))
2545 (not (equal server (format "%s:%s" (caaar opened)
2549 ;; It could be a named method, search all servers
2550 (let ((servers gnus-secondary-select-methods))
2552 (not (equal server (format "%s:%s" (caar servers)
2557 (defmacro gnus-method-equal (ss1 ss2)
2558 "Say whether two servers are equal."
2562 (and (= (length s1) (length s2))
2564 (while (and s1 (member (car s1) s2))
2568 (defun gnus-methods-equal-p (m1 m2)
2569 (let ((m1 (or m1 gnus-select-method))
2570 (m2 (or m2 gnus-select-method)))
2572 (and (eq (car m1) (car m2))
2573 (or (not (memq 'address (assoc (symbol-name (car m1))
2574 gnus-valid-select-methods)))
2575 (equal (nth 1 m1) (nth 1 m2)))))))
2577 (defun gnus-server-equal (m1 m2)
2578 "Say whether two methods are equal."
2579 (let ((m1 (cond ((null m1) gnus-select-method)
2580 ((stringp m1) (gnus-server-to-method m1))
2582 (m2 (cond ((null m2) gnus-select-method)
2583 ((stringp m2) (gnus-server-to-method m2))
2585 (gnus-method-equal m1 m2)))
2587 (defun gnus-servers-using-backend (backend)
2588 "Return a list of known servers using BACKEND."
2589 (let ((opened gnus-opened-servers)
2592 (when (eq backend (caaar opened))
2593 (push (caar opened) out))
2597 (defun gnus-archive-server-wanted-p ()
2598 "Say whether the user wants to use the archive server."
2600 ((or (not gnus-message-archive-method)
2601 (not gnus-message-archive-group))
2603 ((and gnus-message-archive-method gnus-message-archive-group)
2606 (let ((active (cadr (assq 'nnfolder-active-file
2607 gnus-message-archive-method))))
2609 (file-exists-p active))))))
2611 (defsubst gnus-method-to-server-name (method)
2613 (format "%s" (car method))
2615 (or (assoc (format "%s" (car method))
2616 (gnus-methods-using 'address))
2617 (gnus-server-equal method gnus-message-archive-method))
2619 (not (string= (nth 1 method) "")))
2620 (concat "+" (nth 1 method)))))
2622 (defun gnus-group-prefixed-name (group method)
2623 "Return the whole name from GROUP and METHOD."
2624 (and (stringp method) (setq method (gnus-server-to-method method)))
2625 (if (or (not method)
2626 (gnus-server-equal method "native"))
2628 (concat (gnus-method-to-server-name method) ":" group)))
2630 (defun gnus-group-real-prefix (group)
2631 "Return the prefix of the current group name."
2632 (if (string-match "^[^:]+:" group)
2633 (substring group 0 (match-end 0))
2636 (defun gnus-group-method (group)
2637 "Return the server or method used for selecting GROUP.
2638 You should probably use `gnus-find-method-for-group' instead."
2639 (let ((prefix (gnus-group-real-prefix group)))
2640 (if (equal prefix "")
2642 (let ((servers gnus-opened-servers)
2644 backend possible found)
2645 (if (string-match "^[^\\+]+\\+" prefix)
2646 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2647 server (substring prefix (match-end 0) (1- (length prefix))))
2648 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2650 (when (eq (caaar servers) backend)
2651 (setq possible (caar servers))
2652 (when (equal (cadaar servers) server)
2653 (setq found (caar servers))))
2655 (or (car (rassoc found gnus-server-alist))
2657 (car (rassoc possible gnus-server-alist))
2659 (list backend server))))))
2661 (defsubst gnus-native-method-p (method)
2662 "Return whether METHOD is the native select method."
2663 (gnus-method-equal method gnus-select-method))
2665 (defsubst gnus-secondary-method-p (method)
2666 "Return whether METHOD is a secondary select method."
2667 (let ((methods gnus-secondary-select-methods)
2668 (gmethod (gnus-server-get-method nil method)))
2670 (not (gnus-method-equal
2671 (gnus-server-get-method nil (car methods))
2673 (setq methods (cdr methods)))
2676 (defun gnus-method-simplify (method)
2677 "Return the shortest uniquely identifying string or method for METHOD."
2678 (cond ((stringp method)
2680 ((gnus-native-method-p method)
2682 ((gnus-secondary-method-p method)
2683 (format "%s:%s" (nth 0 method) (nth 1 method)))
2687 (defun gnus-groups-from-server (server)
2688 "Return a list of all groups that are fetched from SERVER."
2689 (let ((alist (cdr gnus-newsrc-alist))
2691 (while (setq info (pop alist))
2692 (when (gnus-server-equal (gnus-info-method info) server)
2693 (push (gnus-info-group info) groups)))
2694 (sort groups 'string<)))
2696 (defun gnus-group-foreign-p (group)
2697 "Say whether a group is foreign or not."
2698 (and (not (gnus-group-native-p group))
2699 (not (gnus-group-secondary-p group))))
2701 (defun gnus-group-native-p (group)
2702 "Say whether the group is native or not."
2703 (not (string-match ":" group)))
2705 (defun gnus-group-secondary-p (group)
2706 "Say whether the group is secondary or not."
2707 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2709 (defun gnus-parameters-get-parameter (group)
2710 "Return the group parameters for GROUP from `gnus-parameters'."
2711 (let ((alist gnus-parameters)
2714 (when (string-match (caar alist) group)
2716 (nconc (copy-sequence (cdar alist))
2721 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2722 "Return the group parameters for GROUP.
2723 If SYMBOL, return the value of that symbol in the group parameters."
2725 (set-buffer gnus-group-buffer)
2729 (funcall gnus-group-get-parameter-function group))
2730 (gnus-parameters-get-parameter group))))
2732 (gnus-group-parameter-value parameters symbol allow-list)
2735 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2736 "Return the group parameters for GROUP.
2737 If SYMBOL, return the value of that symbol in the group parameters.
2738 Most functions should use `gnus-group-find-parameter', which
2739 also examines the topic parameters."
2740 (let ((params (gnus-info-params (gnus-get-info group))))
2742 (gnus-group-parameter-value params symbol allow-list)
2745 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2746 "Return the value of SYMBOL in group PARAMS."
2747 ;; We only wish to return group parameters (dotted lists) and
2748 ;; not local variables, which may have the same names.
2749 ;; But first we handle single elements...
2750 (or (car (memq symbol params))
2754 (while (setq elem (pop params))
2755 (when (and (consp elem)
2756 (eq (car elem) symbol)
2759 (throw 'found (cdr elem))))))))
2761 (defun gnus-group-add-parameter (group param)
2762 "Add parameter PARAM to GROUP."
2763 (let ((info (gnus-get-info group)))
2765 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2766 ;; Cons the new param to the old one and update.
2767 (gnus-group-set-info (cons param (gnus-info-params info))
2770 (defun gnus-group-set-parameter (group name value)
2771 "Set parameter NAME to VALUE in GROUP."
2772 (let ((info (gnus-get-info group)))
2774 (gnus-group-remove-parameter group name)
2775 (let ((old-params (gnus-info-params info))
2776 (new-params (list (cons name value))))
2778 (when (or (not (listp (car old-params)))
2779 (not (eq (caar old-params) name)))
2780 (setq new-params (append new-params (list (car old-params)))))
2781 (setq old-params (cdr old-params)))
2782 (gnus-group-set-info new-params group 'params)))))
2784 (defun gnus-group-remove-parameter (group name)
2785 "Remove parameter NAME from GROUP."
2786 (let ((info (gnus-get-info group)))
2788 (let ((params (gnus-info-params info)))
2790 (setq params (delq name params))
2791 (while (assq name params)
2792 (gnus-pull name params))
2793 (gnus-info-set-params info params))))))
2795 (defun gnus-group-add-score (group &optional score)
2796 "Add SCORE to the GROUP score.
2797 If SCORE is nil, add 1 to the score of GROUP."
2798 (let ((info (gnus-get-info group)))
2800 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2802 (defun gnus-short-group-name (group &optional levels)
2803 "Collapse GROUP name LEVELS.
2804 Select methods are stripped and any remote host name is stripped down to
2805 just the host name."
2811 gnus-group-uncollapsed-levels
2813 (while (string-match "\\." group skip)
2814 (setq skip (match-end 0)
2817 ;; Separate foreign select method from group name and collapse.
2818 ;; If method contains a server, collapse to non-domain server name,
2819 ;; otherwise collapse to select method.
2820 (let* ((colon (string-match ":" group))
2821 (server (and colon (substring group 0 colon)))
2822 (plus (and server (string-match "+" server))))
2825 (setq foreign (substring server (+ 1 plus)
2826 (string-match "\\." server))
2827 group (substring group (+ 1 colon)))
2828 (setq foreign server
2829 group (substring group (+ 1 colon))))
2830 (setq foreign (concat foreign ":")))
2831 ;; Collapse group name leaving LEVELS uncollapsed elements
2832 (let* ((slist (split-string group "/"))
2833 (slen (length slist))
2834 (dlist (split-string group "\\."))
2835 (dlen (length dlist))
2847 (setq levels (- glen levels))
2849 (push (if (>= (decf levels) 0)
2850 (if (zerop (length g))
2855 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2857 (defun gnus-narrow-to-body ()
2858 "Narrow to the body of an article."
2861 (goto-char (point-min))
2862 (or (search-forward "\n\n" nil t)
2868 ;;; Kill file handling.
2871 (defun gnus-apply-kill-file ()
2872 "Apply a kill file to the current newsgroup.
2873 Returns the number of articles marked as read."
2874 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2875 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2876 (gnus-apply-kill-file-internal)
2879 (defun gnus-kill-save-kill-buffer ()
2880 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2881 (when (get-file-buffer file)
2883 (set-buffer (get-file-buffer file))
2884 (when (buffer-modified-p)
2886 (kill-buffer (current-buffer))))))
2888 (defcustom gnus-kill-file-name "KILL"
2889 "Suffix of the kill files."
2890 :group 'gnus-score-kill
2891 :group 'gnus-score-files
2894 (defun gnus-newsgroup-kill-file (newsgroup)
2895 "Return the name of a kill file name for NEWSGROUP.
2896 If NEWSGROUP is nil, return the global kill file name instead."
2898 ;; The global KILL file is placed at top of the directory.
2899 ((or (null newsgroup)
2900 (string-equal newsgroup ""))
2901 (expand-file-name gnus-kill-file-name
2902 gnus-kill-files-directory))
2903 ;; Append ".KILL" to newsgroup name.
2904 ((gnus-use-long-file-name 'not-kill)
2905 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2906 "." gnus-kill-file-name)
2907 gnus-kill-files-directory))
2908 ;; Place "KILL" under the hierarchical directory.
2910 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2911 "/" gnus-kill-file-name)
2912 gnus-kill-files-directory))))
2916 (defun gnus-member-of-valid (symbol group)
2917 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2919 (symbol-name (car (gnus-find-method-for-group group)))
2920 gnus-valid-select-methods)))
2922 (defun gnus-method-option-p (method option)
2923 "Return non-nil if select METHOD has OPTION as a parameter."
2924 (when (stringp method)
2925 (setq method (gnus-server-to-method method)))
2926 (memq option (assoc (format "%s" (car method))
2927 gnus-valid-select-methods)))
2929 (defun gnus-similar-server-opened (method)
2930 (let ((opened gnus-opened-servers))
2931 (while (and method opened)
2932 (when (and (equal (cadr method) (cadaar opened))
2933 (equal (car method) (caaar opened))
2934 (not (equal method (caar opened))))
2939 (defun gnus-server-extend-method (group method)
2940 ;; This function "extends" a virtual server. If the server is
2941 ;; "hello", and the select method is ("hello" (my-var "something"))
2942 ;; in the group "alt.alt", this will result in a new virtual server
2943 ;; called "hello+alt.alt".
2944 (if (or (not (inline (gnus-similar-server-opened method)))
2945 (not (cddr method)))
2947 `(,(car method) ,(concat (cadr method) "+" group)
2948 (,(intern (format "%s-address" (car method))) ,(cadr method))
2951 (defun gnus-server-status (method)
2952 "Return the status of METHOD."
2953 (nth 1 (assoc method gnus-opened-servers)))
2955 (defun gnus-group-name-to-method (group)
2956 "Guess a select method based on GROUP."
2957 (if (string-match ":" group)
2958 (let ((server (substring group 0 (match-beginning 0))))
2959 (if (string-match "\\+" server)
2960 (list (intern (substring server 0 (match-beginning 0)))
2961 (substring server (match-end 0)))
2962 (list (intern server) "")))
2963 gnus-select-method))
2965 (defun gnus-find-method-for-group (group &optional info)
2966 "Find the select method that GROUP uses."
2967 (or gnus-override-method
2970 (and (not (gnus-group-entry group));; a new group
2971 (gnus-group-name-to-method group))
2972 (let ((info (or info (gnus-get-info group)))
2975 (not (setq method (gnus-info-method info)))
2976 (equal method "native"))
2979 (cond ((stringp method)
2980 (inline (gnus-server-to-method method)))
2981 ((stringp (cadr method))
2982 (inline (gnus-server-extend-method group method)))
2985 (cond ((equal (cadr method) "")
2987 ((null (cadr method))
2988 (list (car method) ""))
2990 (gnus-server-add-address method)))))))
2992 (defun gnus-methods-using (feature)
2993 "Find all methods that have FEATURE."
2994 (let ((valids gnus-valid-select-methods)
2997 (when (memq feature (car valids))
2998 (push (car valids) outs))
2999 (setq valids (cdr valids)))
3002 (defun gnus-read-group (prompt &optional default)
3003 "Prompt the user for a group name.
3004 Disallow invalid group names."
3009 gnus-invalid-group-regexp
3010 (setq group (read-string (concat prefix prompt)
3011 (cons (or default "") 0)
3012 'gnus-group-history)))
3013 (setq prefix (format "Invalid group name: \"%s\". " group)
3017 (defun gnus-read-method (prompt)
3018 "Prompt the user for a method.
3019 Allow completion over sensible values."
3021 (append gnus-valid-select-methods
3022 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
3024 gnus-opened-servers)
3025 gnus-predefined-server-alist
3030 nil t nil 'gnus-method-history)))
3033 (setq method gnus-select-method))
3034 ((assoc method gnus-valid-select-methods)
3035 (let ((address (if (memq 'prompt-address
3036 (assoc method gnus-valid-select-methods))
3037 (read-string "Address: ")
3039 (or (let ((opened gnus-opened-servers))
3041 (not (equal (format "%s:%s" method address)
3042 (format "%s:%s" (caaar opened)
3046 (list (intern method) address))))
3047 ((assoc method servers)
3050 (list (intern method) "")))))
3052 ;;; User-level commands.
3055 (defun gnus-slave-no-server (&optional arg)
3056 "Read network news as a slave, without connecting to local server."
3058 (gnus-no-server arg t))
3061 (defun gnus-no-server (&optional arg slave)
3063 If ARG is a positive number, Gnus will use that as the
3064 startup level. If ARG is nil, Gnus will be started at level 2.
3065 If ARG is non-nil and not a positive number, Gnus will
3066 prompt the user for the name of an NNTP server to use.
3067 As opposed to `gnus', this command will not connect to the local server."
3069 (gnus-no-server-1 arg slave))
3072 (defun gnus-slave (&optional arg)
3073 "Read news as a slave."
3075 (gnus arg nil 'slave))
3078 (defun gnus-other-frame (&optional arg)
3079 "Pop up a frame to read news."
3081 (let ((window (get-buffer-window gnus-group-buffer)))
3083 (select-frame (window-frame window)))
3085 (select-frame (make-frame)))))
3088 ;;(setq thing ? ; this is a comment
3092 (defun gnus (&optional arg dont-connect slave)
3094 If ARG is non-nil and a positive number, Gnus will use that as the
3095 startup level. If ARG is non-nil and not a positive number, Gnus will
3096 prompt the user for the name of an NNTP server to use."
3098 (gnus-1 arg dont-connect slave))
3100 ;; Allow redefinition of Gnus functions.
3106 ;;; gnus.el ends here
projects / gnus / blob