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-group-parameters-more nil)
853 (defmacro gnus-define-group-parameter (param &rest rest)
854 "Define a group parameter PARAM.
855 REST is a plist of following:
856 :type One of `bool', `list' or `nil'.
857 :function The name of the function.
858 :function-document The document of the function.
859 :parameter-type The type for customizing the parameter.
860 :parameter-document The document for the parameter.
861 :variable The name of the variable.
862 :variable-document The document for the variable.
863 :variable-group The group for customizing the variable.
864 :variable-type The type for customizing the variable.
865 :variable-default The default value of the variable."
866 (let* ((type (plist-get rest :type))
867 (parameter-type (plist-get rest :parameter-type))
868 (parameter-document (plist-get rest :parameter-document))
869 (function (or (plist-get rest :function)
870 (intern (format "gnus-parameter-%s" param))))
871 (function-document (or (plist-get rest :function-document) ""))
872 (variable (or (plist-get rest :variable)
873 (intern (format "gnus-parameter-%s-alist" param))))
874 (variable-document (or (plist-get rest :variable-document) ""))
875 (variable-group (plist-get rest :variable-group))
876 (variable-type (or (plist-get rest :variable-type)
877 `(quote (repeat (list (regexp :tag "Group")
879 (variable-default (plist-get rest :variable-default)))
882 `(defcustom ,variable ,variable-default
884 :group 'gnus-group-parameter
885 :group ',variable-group
886 :type ,variable-type)
887 `(setq gnus-group-parameters-more
888 (delq (assq ',param gnus-group-parameters-more)
889 gnus-group-parameters-more))
890 `(add-to-list 'gnus-group-parameters-more
893 ,parameter-document))
895 `(defun ,function (name)
897 (let ((params (gnus-group-find-parameter name))
900 ((memq ',param params)
902 ((setq val (assq ',param params))
905 (string-match ,variable name))
907 (let ((alist ,variable)
909 (while (setq elem (pop alist))
911 (string-match (car elem) name))
914 (if (consp value) (car value) value))))))
915 `(defun ,function (name)
918 (or (gnus-group-find-parameter name ',param ,(and type t))
919 (let ((alist ,variable)
921 (while (setq elem (pop alist))
923 (string-match (car elem) name))
928 '(if (consp value) (car value) value))))))))))
930 (defcustom gnus-home-directory "~/"
931 "Directory variable that specifies the \"home\" directory.
932 All other Gnus path variables are initialized from this variable."
936 (defcustom gnus-directory (or (getenv "SAVEDIR")
937 (nnheader-concat gnus-home-directory "News/"))
938 "*Directory variable from which all other Gnus file variables are derived.
940 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
941 This means that other directory variables that are initialized from
942 this variable won't be set properly if you set this variable in `.gnus.el'.
943 Set this variable in `.emacs' instead."
947 (defcustom gnus-default-directory nil
948 "*Default directory for all Gnus buffers."
950 :type '(choice (const :tag "current" nil)
953 ;; Site dependent variables. These variables should be defined in
956 (defvar gnus-default-nntp-server nil
957 "Specify a default NNTP server.
958 This variable should be defined in paths.el, and should never be set
960 If you want to change servers, you should use `gnus-select-method'.
961 See the documentation to that variable.")
963 ;; Don't touch this variable.
964 (defvar gnus-nntp-service "nntp"
965 "NNTP service name (\"nntp\" or 119).
966 This is an obsolete variable, which is scarcely used. If you use an
967 nntp server for your newsgroup and want to change the port number
968 used to 899, you would say something along these lines:
970 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
972 (defcustom gnus-nntpserver-file "/etc/nntpserver"
973 "A file with only the name of the nntp server in it."
978 ;; This function is used to check both the environment variable
979 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
980 ;; an nntp server name default.
981 (defun gnus-getenv-nntpserver ()
982 (or (getenv "NNTPSERVER")
983 (and (file-readable-p gnus-nntpserver-file)
985 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
986 (insert-file-contents gnus-nntpserver-file)
987 (let ((name (buffer-string)))
989 (if (string-match "\\'[ \t\n]*$" name)
992 (kill-buffer (current-buffer))))))))
994 (defcustom gnus-select-method
997 (list 'nntp (or (condition-case nil
998 (gnus-getenv-nntpserver)
1000 (when (and gnus-default-nntp-server
1001 (not (string= gnus-default-nntp-server "")))
1002 gnus-default-nntp-server)
1004 (if (or (null gnus-nntp-service)
1005 (equal gnus-nntp-service "nntp"))
1007 (list gnus-nntp-service)))
1009 "Default method for selecting a newsgroup.
1010 This variable should be a list, where the first element is how the
1011 news is to be fetched, the second is the address.
1013 For instance, if you want to get your news via NNTP from
1014 \"flab.flab.edu\", you could say:
1016 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1018 If you want to use your local spool, say:
1020 \(setq gnus-select-method (list 'nnspool (system-name)))
1022 If you use this variable, you must set `gnus-nntp-server' to nil.
1024 There is a lot more to know about select methods and virtual servers -
1025 see the manual for details."
1027 :type 'gnus-select-method)
1029 (defcustom gnus-message-archive-method
1031 ;; Don't require it at top level to avoid circularity.
1035 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
1036 (nnfolder-active-file
1037 ,(nnheader-concat message-directory "archive/active"))
1038 (nnfolder-get-new-mail nil)
1039 (nnfolder-inhibit-expiry t)))
1040 "*Method used for archiving messages you've sent.
1041 This should be a mail method.
1043 It's probably not very effective to change this variable once you've
1044 run Gnus once. After doing that, you must edit this server from the
1047 :group 'gnus-message
1048 :type 'gnus-select-method)
1050 (defcustom gnus-message-archive-group nil
1051 "*Name of the group in which to save the messages you've written.
1052 This can either be a string; a list of strings; or an alist
1053 of regexps/functions/forms to be evaluated to return a string (or a list
1054 of strings). The functions are called with the name of the current
1055 group (or nil) as a parameter.
1057 If you want to save your mail in one group and the news articles you
1058 write in another group, you could say something like:
1060 \(setq gnus-message-archive-group
1061 '((if (message-news-p)
1065 Normally the group names returned by this variable should be
1066 unprefixed -- which implicitly means \"store on the archive server\".
1067 However, you may wish to store the message on some other server. In
1068 that case, just return a fully prefixed name of the group --
1069 \"nnml+private:mail.misc\", for instance."
1070 :group 'gnus-message
1071 :type '(choice (const :tag "none" nil)
1076 (defcustom gnus-secondary-servers nil
1077 "List of NNTP servers that the user can choose between interactively.
1078 To make Gnus query you for a server, you have to give `gnus' a
1079 non-numeric prefix - `C-u M-x gnus', in short."
1081 :type '(repeat string))
1083 (defcustom gnus-nntp-server nil
1084 "*The name of the host running the NNTP server.
1085 This variable is semi-obsolete. Use the `gnus-select-method'
1088 :type '(choice (const :tag "disable" nil)
1091 (defcustom gnus-secondary-select-methods nil
1092 "A list of secondary methods that will be used for reading news.
1093 This is a list where each element is a complete select method (see
1094 `gnus-select-method').
1096 If, for instance, you want to read your mail with the nnml backend,
1097 you could set this variable:
1099 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1101 :type '(repeat gnus-select-method))
1103 (defvar gnus-backup-default-subscribed-newsgroups
1104 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1105 "Default default new newsgroups the first time Gnus is run.
1106 Should be set in paths.el, and shouldn't be touched by the user.")
1108 (defcustom gnus-local-domain nil
1109 "Local domain name without a host name.
1110 The DOMAINNAME environment variable is used instead if it is defined.
1111 If the `system-name' function returns the full Internet name, there is
1112 no need to set this variable."
1113 :group 'gnus-message
1114 :type '(choice (const :tag "default" nil)
1117 (defvar gnus-local-organization nil
1118 "String with a description of what organization (if any) the user belongs to.
1119 Obsolete variable; use `message-user-organization' instead.")
1121 ;; Customization variables
1123 (defcustom gnus-refer-article-method nil
1124 "Preferred method for fetching an article by Message-ID.
1125 If you are reading news from the local spool (with nnspool), fetching
1126 articles by Message-ID is painfully slow. By setting this method to an
1127 nntp method, you might get acceptable results.
1129 The value of this variable must be a valid select method as discussed
1130 in the documentation of `gnus-select-method'.
1132 It can also be a list of select methods, as well as the special symbol
1133 `current', which means to use the current select method. If it is a
1134 list, Gnus will try all the methods in the list until it finds a match."
1136 :type '(choice (const :tag "default" nil)
1137 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1139 (repeat :menu-tag "Try multiple"
1141 :value (current (nnweb "refer" (nnweb-type dejanews)))
1142 (choice :tag "Method"
1144 (const :tag "DejaNews"
1145 (nnweb "refer" (nnweb-type dejanews)))
1146 gnus-select-method))))
1148 (defcustom gnus-group-faq-directory
1149 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1150 "/ftp@sunsite.auc.dk:/pub/usenet/"
1151 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1152 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1153 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1154 "/ftp@rtfm.mit.edu:/pub/usenet/"
1155 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1156 "/ftp@ftp.sunet.se:/pub/usenet/"
1157 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1158 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1159 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1160 "*Directory where the group FAQs are stored.
1161 This will most commonly be on a remote machine, and the file will be
1162 fetched by ange-ftp.
1164 This variable can also be a list of directories. In that case, the
1165 first element in the list will be used by default. The others can
1166 be used when being prompted for a site.
1168 Note that Gnus uses an aol machine as the default directory. If this
1169 feels fundamentally unclean, just think of it as a way to finally get
1170 something of value back from them.
1172 If the default site is too slow, try one of these:
1174 North America: mirrors.aol.com /pub/rtfm/usenet
1175 ftp.seas.gwu.edu /pub/rtfm
1176 rtfm.mit.edu /pub/usenet
1177 Europe: ftp.uni-paderborn.de /pub/FAQ
1178 src.doc.ic.ac.uk /usenet/news-FAQS
1179 ftp.sunet.se /pub/usenet
1180 sunsite.auc.dk /pub/usenet
1181 Asia: nctuccca.edu.tw /USENET/FAQ
1182 hwarang.postech.ac.kr /pub/usenet
1183 ftp.hk.super.net /mirror/faqs"
1184 :group 'gnus-group-various
1185 :type '(choice directory
1186 (repeat directory)))
1188 (defcustom gnus-use-cross-reference t
1189 "*Non-nil means that cross referenced articles will be marked as read.
1190 If nil, ignore cross references. If t, mark articles as read in
1191 subscribed newsgroups. If neither t nor nil, mark as read in all
1194 :type '(choice (const :tag "off" nil)
1195 (const :tag "subscribed" t)
1199 (defcustom gnus-process-mark ?#
1201 :group 'gnus-group-visual
1202 :group 'gnus-summary-marks
1205 (defcustom gnus-large-newsgroup 200
1206 "*The number of articles which indicates a large newsgroup.
1207 If the number of articles in a newsgroup is greater than this value,
1208 confirmation is required for selecting the newsgroup."
1209 :group 'gnus-group-select
1212 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1213 "*Non-nil means that the default name of a file to save articles in is the group name.
1214 If it's nil, the directory form of the group name is used instead.
1216 If this variable is a list, and the list contains the element
1217 `not-score', long file names will not be used for score files; if it
1218 contains the element `not-save', long file names will not be used for
1219 saving; and if it contains the element `not-kill', long file names
1220 will not be used for kill files.
1222 Note that the default for this variable varies according to what system
1223 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1224 to nil while on all other systems it defaults to t."
1228 (defcustom gnus-kill-files-directory gnus-directory
1229 "*Name of the directory where kill files will be stored (default \"~/News\")."
1230 :group 'gnus-score-files
1231 :group 'gnus-score-kill
1234 (defcustom gnus-save-score nil
1235 "*If non-nil, save group scoring info."
1236 :group 'gnus-score-various
1240 (defcustom gnus-use-undo t
1241 "*If non-nil, allow undoing in Gnus group mode buffers."
1245 (defcustom gnus-use-adaptive-scoring nil
1246 "*If non-nil, use some adaptive scoring scheme.
1247 If a list, then the values `word' and `line' are meaningful. The
1248 former will perform adaption on individual words in the subject
1249 header while `line' will perform adaption on several headers."
1251 :group 'gnus-score-adapt
1252 :type '(set (const word) (const line)))
1254 (defcustom gnus-use-cache 'passive
1255 "*If nil, Gnus will ignore the article cache.
1256 If `passive', it will allow entering (and reading) articles
1257 explicitly entered into the cache. If anything else, use the
1258 cache to the full extent of the law."
1261 :type '(choice (const :tag "off" nil)
1262 (const :tag "passive" passive)
1263 (const :tag "active" t)))
1265 (defcustom gnus-use-trees nil
1266 "*If non-nil, display a thread tree buffer."
1270 (defcustom gnus-use-grouplens nil
1271 "*If non-nil, use GroupLens ratings."
1275 (defcustom gnus-keep-backlog nil
1276 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1277 If it is a number N, then Gnus will only keep the last N articles
1278 read. If it is neither nil nor a number, Gnus will keep all read
1279 articles. This is not a good idea."
1281 :type '(choice (const :tag "off" nil)
1286 (defcustom gnus-use-nocem nil
1287 "*If non-nil, Gnus will read NoCeM cancel messages."
1291 (defcustom gnus-suppress-duplicates nil
1292 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1296 (defcustom gnus-use-scoring t
1297 "*If non-nil, enable scoring."
1301 (defcustom gnus-use-picons nil
1302 "*If non-nil, display picons in a frame of their own."
1306 (defcustom gnus-summary-prepare-exit-hook
1307 '(gnus-summary-expire-articles)
1308 "*A hook called when preparing to exit from the summary buffer.
1309 It calls `gnus-summary-expire-articles' by default."
1310 :group 'gnus-summary-exit
1313 (defcustom gnus-novice-user t
1314 "*Non-nil means that you are a usenet novice.
1315 If non-nil, verbose messages may be displayed and confirmations may be
1320 (defcustom gnus-expert-user nil
1321 "*Non-nil means that you will never be asked for confirmation about anything.
1322 That doesn't mean *anything* anything; particularly destructive
1323 commands will still require prompting."
1327 (defcustom gnus-interactive-catchup t
1328 "*If non-nil, require your confirmation when catching up a group."
1329 :group 'gnus-group-select
1332 (defcustom gnus-interactive-exit t
1333 "*If non-nil, require your confirmation when exiting Gnus."
1337 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1338 "*Function for extracting address components from a From header.
1339 Two pre-defined function exist: `gnus-extract-address-components',
1340 which is the default, quite fast, and too simplistic solution, and
1341 `mail-extract-address-components', which works much better, but is
1343 :group 'gnus-summary-format
1344 :type '(radio (function-item gnus-extract-address-components)
1345 (function-item mail-extract-address-components)
1346 (function :tag "Other")))
1348 (defcustom gnus-carpal nil
1349 "*If non-nil, display clickable icons."
1353 (defcustom gnus-shell-command-separator ";"
1354 "String used to separate to shell commands."
1358 (defcustom gnus-valid-select-methods
1359 '(("nntp" post address prompt-address physical-address)
1360 ("nnspool" post address)
1361 ("nnvirtual" post-mail virtual prompt-address)
1362 ("nnmbox" mail respool address)
1363 ("nnml" mail respool address)
1364 ("nnmh" mail respool address)
1365 ("nndir" post-mail prompt-address physical-address)
1366 ("nneething" none address prompt-address physical-address)
1367 ("nndoc" none address prompt-address)
1368 ("nnbabyl" mail address respool)
1369 ("nnkiboze" post virtual)
1370 ("nnsoup" post-mail address)
1371 ("nndraft" post-mail)
1372 ("nnfolder" mail respool address)
1373 ("nngateway" post-mail address prompt-address physical-address)
1380 ("nnagent" post-mail)
1381 ("nnimap" post-mail address prompt-address physical-address))
1382 "*An alist of valid select methods.
1383 The first element of each list lists should be a string with the name
1384 of the select method. The other elements may be the category of
1385 this method (i. e., `post', `mail', `none' or whatever) or other
1386 properties that this method has (like being respoolable).
1387 If you implement a new select method, all you should have to change is
1388 this variable. I think."
1390 :type '(repeat (group (string :tag "Name")
1391 (radio-button-choice (const :format "%v " post)
1392 (const :format "%v " mail)
1393 (const :format "%v " none)
1395 (checklist :inline t
1396 (const :format "%v " address)
1397 (const :format "%v " prompt-address)
1398 (const :format "%v " physical-address)
1399 (const :format "%v " virtual)
1402 (defun gnus-redefine-select-method-widget ()
1403 "Recomputes the select-method widget based on the value of
1404 `gnus-valid-select-methods'."
1405 (define-widget 'gnus-select-method 'list
1406 "Widget for entering a select method."
1408 :tag "Select Method"
1409 :args `((choice :tag "Method"
1410 ,@(mapcar (lambda (entry)
1411 (list 'const :format "%v\n"
1412 (intern (car entry))))
1413 gnus-valid-select-methods)
1414 (symbol :tag "other"))
1415 (string :tag "Address")
1416 (repeat :tag "Options"
1420 (sexp :tag "Value"))))))
1422 (gnus-redefine-select-method-widget)
1424 (defcustom gnus-updated-mode-lines '(group article summary tree)
1425 "List of buffers that should update their mode lines.
1426 The list may contain the symbols `group', `article', `tree' and
1427 `summary'. If the corresponding symbol is present, Gnus will keep
1428 that mode line updated with information that may be pertinent.
1429 If this variable is nil, screen refresh may be quicker."
1430 :group 'gnus-various
1431 :type '(set (const group)
1436 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1437 (defcustom gnus-mode-non-string-length nil
1438 "*Max length of mode-line non-string contents.
1439 If this is nil, Gnus will take space as is needed, leaving the rest
1440 of the modeline intact. Note that the default of nil is unlikely
1441 to be desirable; see the manual for further details."
1442 :group 'gnus-various
1443 :type '(choice (const nil)
1446 (gnus-define-group-parameter
1449 "Return GROUP's to-address."
1451 "*Alist of group regexps and correspondent to-addresses."
1452 :parameter-type '(gnus-email-address :tag "To Address")
1453 :parameter-document "\
1454 This will be used when doing followups and posts.
1456 This is primarily useful in mail groups that represent closed
1457 mailing lists--mailing lists where it's expected that everybody that
1458 writes to the mailing list is subscribed to it. Since using this
1459 parameter ensures that the mail only goes to the mailing list itself,
1460 it means that members won't receive two copies of your followups.
1462 Using `to-address' will actually work whether the group is foreign or
1463 not. Let's say there's a group on the server that is called
1464 `fa.4ad-l'. This is a real newsgroup, but the server has gotten the
1465 articles from a mail-to-news gateway. Posting directly to this group
1466 is therefore impossible--you have to send mail to the mailing list
1469 The gnus-group-split mail splitting mechanism will behave as if this
1470 address was listed in gnus-group-split Addresses (see below).")
1472 (gnus-define-group-parameter
1475 "Return GROUP's to-list."
1477 "*Alist of group regexps and correspondent to-lists."
1478 :parameter-type '(gnus-email-address :tag "To List")
1479 :parameter-document "\
1480 This address will be used when doing a `a' in the group.
1482 It is totally ignored when doing a followup--except that if it is
1483 present in a news group, you'll get mail group semantics when doing
1486 The gnus-group-split mail splitting mechanism will behave as if this
1487 address was listed in gnus-group-split Addresses (see below).")
1489 (gnus-define-group-parameter
1492 :function gnus-group-auto-expirable-p
1494 "Check whether GROUP is auto-expirable or not."
1495 :variable gnus-auto-expirable-newsgroups
1496 :variable-default nil
1498 "*Groups in which to automatically mark read articles as expirable.
1499 If non-nil, this should be a regexp that should match all groups in
1500 which to perform auto-expiry. This only makes sense for mail groups."
1501 :variable-group nnmail-expire
1502 :variable-type '(choice (const nil)
1504 :parameter-type '(const :tag "Automatic Expire" t)
1506 "All articles that are read will be marked as expirable.")
1508 (gnus-define-group-parameter
1511 :function gnus-group-total-expirable-p
1513 "Check whether GROUP is total-expirable or not."
1514 :variable gnus-total-expirable-newsgroups
1515 :variable-default nil
1517 "*Groups in which to perform expiry of all read articles.
1518 Use with extreme caution. All groups that match this regexp will be
1519 expiring - which means that all read articles will be deleted after
1520 \(say) one week. (This only goes for mail groups and the like, of
1522 :variable-group nnmail-expire
1523 :variable-type '(choice (const nil)
1525 :parameter-type '(const :tag "Total Expire" t)
1527 "All read articles will be put through the expiry process
1529 This happens even if they are not marked as expirable.
1532 (defcustom gnus-group-uncollapsed-levels 1
1533 "Number of group name elements to leave alone when making a short group name."
1534 :group 'gnus-group-visual
1537 (defcustom gnus-group-use-permanent-levels nil
1538 "*If non-nil, once you set a level, Gnus will use this level."
1539 :group 'gnus-group-levels
1544 (defcustom gnus-load-hook nil
1545 "A hook run while Gnus is loaded."
1549 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1550 "A hook called to apply kill files to a group.
1551 This hook is intended to apply a kill file to the selected newsgroup.
1552 The function `gnus-apply-kill-file' is called by default.
1554 Since a general kill file is too heavy to use only for a few
1555 newsgroups, I recommend you to use a lighter hook function. For
1556 example, if you'd like to apply a kill file to articles which contains
1557 a string `rmgroup' in subject in newsgroup `control', you can use the
1560 (setq gnus-apply-kill-hook
1563 (cond ((string-match \"control\" gnus-newsgroup-name)
1564 (gnus-kill \"Subject\" \"rmgroup\")
1565 (gnus-expunge \"X\"))))))"
1566 :group 'gnus-score-kill
1567 :options '(gnus-apply-kill-file)
1570 (defcustom gnus-group-change-level-function nil
1571 "Function run when a group level is changed.
1572 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1573 :group 'gnus-group-levels
1578 (defcustom gnus-visual
1579 '(summary-highlight group-highlight article-highlight
1581 summary-menu group-menu article-menu
1582 tree-highlight menu highlight
1583 browse-menu server-menu
1584 page-marker tree-menu binary-menu pick-menu
1586 "*Enable visual features.
1587 If `visual' is disabled, there will be no menus and few faces. Most of
1588 the visual customization options below will be ignored. Gnus will use
1589 less space and be faster as a result.
1591 This variable can also be a list of visual elements to switch on. For
1592 instance, to switch off all visual things except menus, you can say:
1594 (setq gnus-visual '(menu))
1596 Valid elements include `summary-highlight', `group-highlight',
1597 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1598 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1599 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1600 and `grouplens-menu'."
1603 :type '(set (const summary-highlight)
1604 (const group-highlight)
1605 (const article-highlight)
1607 (const summary-menu)
1609 (const article-menu)
1610 (const tree-highlight)
1619 (const grouplens-menu)))
1621 (defcustom gnus-mouse-face
1623 (if (gnus-visual-p 'mouse-face 'highlight)
1624 (if (boundp 'gnus-mouse-face)
1625 (or gnus-mouse-face 'highlight)
1629 "*Face used for group or summary buffer mouse highlighting.
1630 The line beneath the mouse pointer will be highlighted with this
1635 (defcustom gnus-article-save-directory gnus-directory
1636 "*Name of the directory articles will be saved in (default \"~/News\")."
1637 :group 'gnus-article-saving
1640 (defvar gnus-plugged t
1641 "Whether Gnus is plugged or not.")
1643 (defcustom gnus-default-charset 'iso-8859-1
1644 "Default charset assumed to be used when viewing non-ASCII characters.
1645 This variable is overridden on a group-to-group basis by the
1646 gnus-group-charset-alist variable and is only used on groups not
1647 covered by that variable."
1649 :group 'gnus-charset)
1652 ;;; Internal variables
1654 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1655 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1656 (defvar gnus-draft-meta-information-header "X-Draft-From")
1657 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1658 (defvar gnus-original-article-buffer " *Original Article*")
1659 (defvar gnus-newsgroup-name nil)
1660 (defvar gnus-ephemeral-servers nil)
1662 (defvar gnus-agent nil
1663 "Whether we want to use the Gnus agent or not.")
1665 (defvar gnus-agent-fetching nil
1666 "Whether Gnus agent is in fetching mode.")
1668 (defvar gnus-command-method nil
1669 "Dynamically bound variable that says what the current backend is.")
1671 (defvar gnus-current-select-method nil
1672 "The current method for selecting a newsgroup.")
1674 (defvar gnus-tree-buffer "*Tree*"
1675 "Buffer where Gnus thread trees are displayed.")
1678 (defvar gnus-use-generic-from nil)
1680 ;; Variable holding the user answers to all method prompts.
1681 (defvar gnus-method-history nil)
1683 ;; Variable holding the user answers to all mail method prompts.
1684 (defvar gnus-mail-method-history nil)
1686 ;; Variable holding the user answers to all group prompts.
1687 (defvar gnus-group-history nil)
1689 (defvar gnus-server-alist nil
1690 "List of available servers.")
1692 (defcustom gnus-cache-directory
1693 (nnheader-concat gnus-directory "cache/")
1694 "*The directory where cached articles will be stored."
1698 (defvar gnus-predefined-server-alist
1701 (nnspool-spool-directory ,gnus-cache-directory)
1702 (nnspool-nov-directory ,gnus-cache-directory)
1703 (nnspool-active-file
1704 ,(nnheader-concat gnus-cache-directory "active"))))
1705 "List of predefined (convenience) servers.")
1707 (defvar gnus-topic-indentation "");; Obsolete variable.
1709 (defconst gnus-article-mark-lists
1710 '((marked . tick) (replied . reply)
1711 (expirable . expire) (killed . killed)
1712 (bookmarks . bookmark) (dormant . dormant)
1713 (scored . score) (saved . save)
1714 (cached . cache) (downloadable . download)
1715 (unsendable . unsend)))
1717 (defvar gnus-headers-retrieved-by nil)
1718 (defvar gnus-article-reply nil)
1719 (defvar gnus-override-method nil)
1720 (defvar gnus-article-check-size nil)
1721 (defvar gnus-opened-servers nil)
1723 (defvar gnus-current-kill-article nil)
1725 (defvar gnus-have-read-active-file nil)
1727 (defconst gnus-maintainer
1728 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1729 "The mail address of the Gnus maintainers.")
1731 (defvar gnus-info-nodes
1732 '((gnus-group-mode "(gnus)The Group Buffer")
1733 (gnus-summary-mode "(gnus)The Summary Buffer")
1734 (gnus-article-mode "(gnus)The Article Buffer")
1735 (gnus-server-mode "(gnus)The Server Buffer")
1736 (gnus-browse-mode "(gnus)Browse Foreign Server")
1737 (gnus-tree-mode "(gnus)Tree Display"))
1738 "Alist of major modes and related Info nodes.")
1740 (defvar gnus-group-buffer "*Group*")
1741 (defvar gnus-summary-buffer "*Summary*")
1742 (defvar gnus-article-buffer "*Article*")
1743 (defvar gnus-server-buffer "*Server*")
1745 (defvar gnus-slave nil
1746 "Whether this Gnus is a slave or not.")
1748 (defvar gnus-batch-mode nil
1749 "Whether this Gnus is running in batch mode or not.")
1751 (defvar gnus-variable-list
1752 '(gnus-newsrc-options gnus-newsrc-options-n
1753 gnus-newsrc-last-checked-date
1754 gnus-newsrc-alist gnus-server-alist
1755 gnus-killed-list gnus-zombie-list
1756 gnus-topic-topology gnus-topic-alist
1758 "Gnus variables saved in the quick startup file.")
1760 (defvar gnus-newsrc-alist nil
1761 "Assoc list of read articles.
1762 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1764 (defvar gnus-newsrc-hashtb nil
1765 "Hashtable of gnus-newsrc-alist.")
1767 (defvar gnus-killed-list nil
1768 "List of killed newsgroups.")
1770 (defvar gnus-killed-hashtb nil
1771 "Hash table equivalent of gnus-killed-list.")
1773 (defvar gnus-zombie-list nil
1774 "List of almost dead newsgroups.")
1776 (defvar gnus-description-hashtb nil
1777 "Descriptions of newsgroups.")
1779 (defvar gnus-list-of-killed-groups nil
1780 "List of newsgroups that have recently been killed by the user.")
1782 (defvar gnus-active-hashtb nil
1783 "Hashtable of active articles.")
1785 (defvar gnus-moderated-hashtb nil
1786 "Hashtable of moderated newsgroups.")
1788 ;; Save window configuration.
1789 (defvar gnus-prev-winconf nil)
1791 (defvar gnus-reffed-article-number nil)
1793 ;;; Let the byte-compiler know that we know about this variable.
1794 (defvar rmail-default-rmail-file)
1796 (defvar gnus-dead-summary nil)
1798 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1799 "Regexp matching invalid groups.")
1801 ;;; End of variables.
1803 ;; Define some autoload functions Gnus might use.
1806 ;; This little mapcar goes through the list below and marks the
1807 ;; symbols in question as autoloaded functions.
1810 (let ((interactive (nth 1 (memq ':interactive package))))
1814 (when (consp function)
1815 (setq keymap (car (memq 'keymap function)))
1816 (setq function (car function)))
1817 (unless (fboundp function)
1818 (autoload function (car package) nil interactive keymap))))
1819 (if (eq (nth 1 package) ':interactive)
1822 '(("info" :interactive t Info-goto-node)
1824 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1825 ("ps-print" ps-print-preprint)
1826 ("message" :interactive t
1827 message-send-and-exit message-yank-original)
1828 ("babel" babel-as-string)
1829 ("nnmail" nnmail-split-fancy nnmail-article-group)
1830 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1831 ("rmailout" rmail-output rmail-output-to-rmail-file)
1832 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1833 rmail-show-message rmail-summary-exists
1834 rmail-select-summary rmail-update-summary)
1835 ("gnus-audio" :interactive t gnus-audio-play)
1836 ("gnus-xmas" gnus-xmas-splash)
1837 ("gnus-soup" :interactive t
1838 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1839 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1840 ("nnsoup" nnsoup-pack-replies)
1841 ("score-mode" :interactive t gnus-score-mode)
1842 ("gnus-mh" gnus-summary-save-article-folder
1843 gnus-Folder-save-name gnus-folder-save-name)
1844 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1845 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1846 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1847 gnus-demon-add-disconnection gnus-demon-add-handler
1848 gnus-demon-remove-handler)
1849 ("gnus-demon" :interactive t
1850 gnus-demon-init gnus-demon-cancel)
1851 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1852 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1853 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1854 gnus-nocem-unwanted-article-p)
1855 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1856 gnus-server-server-name)
1857 ("gnus-srvr" gnus-browse-foreign-server)
1858 ("gnus-cite" :interactive t
1859 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1860 gnus-article-hide-citation gnus-article-fill-cited-article
1861 gnus-article-hide-citation-in-followups)
1862 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1863 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1864 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1865 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1866 gnus-cache-possibly-remove-articles gnus-cache-request-article
1867 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1868 gnus-cache-enter-remove-article gnus-cached-article-p
1869 gnus-cache-open gnus-cache-close gnus-cache-update-article
1870 gnus-cache-articles-in-group)
1871 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1872 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1873 ("gnus-score" :interactive t
1874 gnus-summary-increase-score gnus-summary-set-score
1875 gnus-summary-raise-thread gnus-summary-raise-same-subject
1876 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1877 gnus-summary-lower-thread gnus-summary-lower-same-subject
1878 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1879 gnus-summary-current-score gnus-score-delta-default
1880 gnus-score-flush-cache gnus-score-close
1881 gnus-possibly-score-headers gnus-score-followup-article
1882 gnus-score-followup-thread)
1884 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1885 gnus-current-score-file-nondirectory gnus-score-adaptive
1886 gnus-score-find-trace gnus-score-file-name)
1887 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1888 ("gnus-topic" :interactive t gnus-topic-mode)
1889 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1890 gnus-subscribe-topics)
1891 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1892 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1893 ("gnus-uu" :interactive t
1894 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1895 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1896 gnus-uu-mark-by-regexp gnus-uu-mark-all
1897 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1898 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1899 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1900 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1901 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1902 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1903 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1904 gnus-uu-mark-over gnus-uu-post-news)
1905 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1906 ("gnus-msg" (gnus-summary-send-map keymap)
1907 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1908 ("gnus-msg" :interactive t
1909 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1910 gnus-summary-followup gnus-summary-followup-with-original
1911 gnus-summary-cancel-article gnus-summary-supersede-article
1912 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1913 gnus-summary-mail-forward gnus-summary-mail-other-window
1914 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1915 gnus-summary-wide-reply gnus-summary-followup-to-mail
1916 gnus-summary-followup-to-mail-with-original gnus-bug
1917 gnus-summary-wide-reply-with-original
1918 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1919 gnus-summary-post-forward)
1920 ("gnus-picon" :interactive t gnus-article-display-picons
1921 gnus-group-display-picons gnus-picons-article-display-x-face
1922 gnus-picons-display-x-face)
1923 ("gnus-picon" gnus-picons-buffer-name)
1924 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1925 gnus-grouplens-mode)
1926 ("smiley" :interactive t gnus-smiley-display)
1927 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1928 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1929 gnus-list-of-unread-articles gnus-list-of-read-articles
1930 gnus-offer-save-summaries gnus-make-thread-indent-array
1931 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1932 gnus-summary-skip-intangible gnus-summary-article-number
1933 gnus-data-header gnus-data-find)
1934 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1935 gnus-group-list-groups gnus-group-first-unread-group
1936 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1937 gnus-group-setup-buffer gnus-group-get-new-news
1938 gnus-group-make-help-group gnus-group-update-group
1939 gnus-group-iterate gnus-group-group-name)
1940 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1941 gnus-backlog-remove-article)
1942 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1943 gnus-article-prepare gnus-article-set-window-start
1944 gnus-article-next-page gnus-article-prev-page
1945 gnus-request-article-this-buffer gnus-article-mode
1946 gnus-article-setup-buffer gnus-narrow-to-page
1947 gnus-article-delete-invisible-text gnus-treat-article)
1948 ("gnus-art" :interactive t
1949 gnus-article-hide-headers gnus-article-hide-boring-headers
1950 gnus-article-treat-overstrike
1951 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1952 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1953 gnus-article-de-base64-unreadable
1954 gnus-article-decode-HZ
1955 gnus-article-wash-html
1956 gnus-article-hide-pgp
1957 gnus-article-hide-pem gnus-article-hide-signature
1958 gnus-article-strip-leading-blank-lines gnus-article-date-local
1959 gnus-article-date-original gnus-article-date-lapsed
1960 gnus-article-show-all-headers
1961 gnus-article-edit-mode gnus-article-edit-article
1962 gnus-article-edit-done gnus-article-decode-encoded-words
1963 gnus-start-date-timer gnus-stop-date-timer
1964 gnus-mime-view-all-parts)
1965 ("gnus-int" gnus-request-type)
1966 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1967 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1968 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1969 gnus-dup-enter-articles)
1970 ("gnus-range" gnus-copy-sequence)
1971 ("gnus-eform" gnus-edit-form)
1972 ("gnus-move" :interactive t
1973 gnus-group-move-group-to-server gnus-change-server)
1974 ("gnus-logic" gnus-score-advanced)
1975 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1976 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1977 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1978 gnus-async-halt-prefetch)
1979 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1980 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1981 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1982 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1983 ("gnus-agent" :interactive t
1984 gnus-unplugged gnus-agentize gnus-agent-batch)
1985 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1986 gnus-summary-save-article-vm)
1987 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1988 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1989 ("gnus-mlspl" :interactive t gnus-group-split-setup
1990 gnus-group-split-update))))
1992 ;;; gnus-sum.el thingies
1995 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1996 "*The format specification of the lines in the summary buffer.
1998 It works along the same lines as a normal formatting string,
1999 with some simple extensions.
2001 %N Article number, left padded with spaces (string)
2003 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2004 %n Name of the poster (string)
2005 %a Extracted name of the poster (string)
2006 %A Extracted address of the poster (string)
2007 %F Contents of the From: header (string)
2008 %f Contents of the From: or To: headers (string)
2009 %x Contents of the Xref: header (string)
2010 %D Date of the article (string)
2011 %d Date of the article (string) in DD-MMM format
2012 %M Message-id of the article (string)
2013 %r References of the article (string)
2014 %c Number of characters in the article (integer)
2015 %L Number of lines in the article (integer)
2016 %I Indentation based on thread level (a string of spaces)
2017 %T A string with two possible values: 80 spaces if the article
2018 is on thread level two or larger and 0 spaces on level one
2019 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2020 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2021 %[ Opening bracket (character, \"[\" or \"<\")
2022 %] Closing bracket (character, \"]\" or \">\")
2023 %> Spaces of length thread-level (string)
2024 %< Spaces of length (- 20 thread-level) (string)
2025 %i Article score (number)
2026 %z Article zcore (character)
2027 %t Number of articles under the current thread (number).
2028 %e Whether the thread is empty or not (character).
2029 %l GroupLens score (string).
2030 %V Total thread score (number).
2031 %P The line number (number).
2032 %O Download mark (character).
2033 %u User defined specifier. The next character in the format string should
2034 be a letter. Gnus will call the function gnus-user-format-function-X,
2035 where X is the letter following %u. The function will be passed the
2036 current header as argument. The function should return a string, which
2037 will be inserted into the summary just like information from any other
2040 Text between %( and %) will be highlighted with `gnus-mouse-face'
2041 when the mouse point is placed inside the area. There can only be one
2044 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2045 with care. For reasons of efficiency, Gnus will compute what column
2046 these characters will end up in, and \"hard-code\" that. This means that
2047 it is invalid to have these specs after a variable-length spec. Well,
2048 you might not be arrested, but your summary buffer will look strange,
2049 which is bad enough.
2051 The smart choice is to have these specs as for to the left as
2054 This restriction may disappear in later versions of Gnus."
2056 :group 'gnus-summary-format)
2059 ;;; Skeleton keymaps
2062 (defun gnus-suppress-keymap (keymap)
2063 (suppress-keymap keymap)
2064 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2066 (define-key keymap (pop keys) 'undefined))))
2068 (defvar gnus-article-mode-map
2069 (let ((keymap (make-sparse-keymap)))
2070 (gnus-suppress-keymap keymap)
2072 (defvar gnus-summary-mode-map
2073 (let ((keymap (make-keymap)))
2074 (gnus-suppress-keymap keymap)
2076 (defvar gnus-group-mode-map
2077 (let ((keymap (make-keymap)))
2078 (gnus-suppress-keymap keymap)
2083 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2084 ;; If you want the cursor to go somewhere else, set these two
2085 ;; functions in some startup hook to whatever you want.
2086 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2087 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2089 ;;; Various macros and substs.
2091 (defun gnus-header-from (header)
2092 (mail-header-from header))
2094 (defmacro gnus-gethash (string hashtable)
2095 "Get hash value of STRING in HASHTABLE."
2096 `(symbol-value (intern-soft ,string ,hashtable)))
2098 (defmacro gnus-sethash (string value hashtable)
2099 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2100 `(set (intern ,string ,hashtable) ,value))
2101 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2103 (defmacro gnus-group-unread (group)
2104 "Get the currently computed number of unread articles in GROUP."
2105 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2107 (defmacro gnus-group-entry (group)
2108 "Get the newsrc entry for GROUP."
2109 `(gnus-gethash ,group gnus-newsrc-hashtb))
2111 (defmacro gnus-active (group)
2112 "Get active info on GROUP."
2113 `(gnus-gethash ,group gnus-active-hashtb))
2115 (defmacro gnus-set-active (group active)
2116 "Set GROUP's active info."
2117 `(gnus-sethash ,group ,active gnus-active-hashtb))
2119 ;; Info access macros.
2121 (defmacro gnus-info-group (info)
2123 (defmacro gnus-info-rank (info)
2125 (defmacro gnus-info-read (info)
2127 (defmacro gnus-info-marks (info)
2129 (defmacro gnus-info-method (info)
2131 (defmacro gnus-info-params (info)
2134 (defmacro gnus-info-level (info)
2135 `(let ((rank (gnus-info-rank ,info)))
2139 (defmacro gnus-info-score (info)
2140 `(let ((rank (gnus-info-rank ,info)))
2141 (or (and (consp rank) (cdr rank)) 0)))
2143 (defmacro gnus-info-set-group (info group)
2144 `(setcar ,info ,group))
2145 (defmacro gnus-info-set-rank (info rank)
2146 `(setcar (nthcdr 1 ,info) ,rank))
2147 (defmacro gnus-info-set-read (info read)
2148 `(setcar (nthcdr 2 ,info) ,read))
2149 (defmacro gnus-info-set-marks (info marks &optional extend)
2151 `(gnus-info-set-entry ,info ,marks 3)
2152 `(setcar (nthcdr 3 ,info) ,marks)))
2153 (defmacro gnus-info-set-method (info method &optional extend)
2155 `(gnus-info-set-entry ,info ,method 4)
2156 `(setcar (nthcdr 4 ,info) ,method)))
2157 (defmacro gnus-info-set-params (info params &optional extend)
2159 `(gnus-info-set-entry ,info ,params 5)
2160 `(setcar (nthcdr 5 ,info) ,params)))
2162 (defun gnus-info-set-entry (info entry number)
2163 ;; Extend the info until we have enough elements.
2164 (while (<= (length info) number)
2165 (nconc info (list nil)))
2167 (setcar (nthcdr number info) entry))
2169 (defmacro gnus-info-set-level (info level)
2170 `(let ((rank (cdr ,info)))
2171 (if (consp (car rank))
2172 (setcar (car rank) ,level)
2173 (setcar rank ,level))))
2174 (defmacro gnus-info-set-score (info score)
2175 `(let ((rank (cdr ,info)))
2176 (if (consp (car rank))
2177 (setcdr (car rank) ,score)
2178 (setcar rank (cons (car rank) ,score)))))
2180 (defmacro gnus-get-info (group)
2181 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2183 ;; Byte-compiler warning.
2184 (defvar gnus-visual)
2185 ;; Find out whether the gnus-visual TYPE is wanted.
2186 (defun gnus-visual-p (&optional type class)
2187 (and gnus-visual ; Has to be non-nil, at least.
2188 (if (not type) ; We don't care about type.
2190 (if (listp gnus-visual) ; It's a list, so we check it.
2191 (or (memq type gnus-visual)
2192 (memq class gnus-visual))
2195 ;;; Load the compatability functions.
2204 (defvar gnus-shutdown-alist nil)
2206 (defun gnus-add-shutdown (function &rest symbols)
2207 "Run FUNCTION whenever one of SYMBOLS is shut down."
2208 (push (cons function symbols) gnus-shutdown-alist))
2210 (defun gnus-shutdown (symbol)
2211 "Shut down everything that waits for SYMBOL."
2212 (let ((alist gnus-shutdown-alist)
2214 (while (setq entry (pop alist))
2215 (when (memq symbol (cdr entry))
2216 (funcall (car entry))))))
2220 ;;; Gnus Utility Functions
2224 (defmacro gnus-string-or (&rest strings)
2225 "Return the first element of STRINGS that is a non-blank string.
2226 STRINGS will be evaluated in normal `or' order."
2227 `(gnus-string-or-1 ',strings))
2229 (defun gnus-string-or-1 (strings)
2232 (setq string (eval (pop strings)))
2233 (if (string-match "^[ \t]*$" string)
2235 (setq strings nil)))
2238 (defun gnus-version (&optional arg)
2239 "Version number of this version of Gnus.
2240 If ARG, insert string at point."
2243 (insert (message gnus-version))
2244 (message gnus-version)))
2246 (defun gnus-continuum-version (version)
2247 "Return VERSION as a floating point number."
2248 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2249 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2250 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2251 (number (match-string 2 version))
2253 (unless (string-match
2254 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2255 (error "Invalid version string: %s" version))
2256 (setq major (string-to-number (match-string 1 number))
2257 minor (string-to-number (match-string 2 number))
2258 least (if (match-beginning 3)
2259 (string-to-number (match-string 3 number))
2263 (format "%s00%02d%02d"
2264 (if (member alpha '("(ding)" "d"))
2268 (- (mm-char-int (aref (downcase alpha) 0))
2272 (format "%d.%02d%02d" major minor least))))))
2274 (defun gnus-info-find-node ()
2275 "Find Info documentation of Gnus."
2277 ;; Enlarge info window if needed.
2278 (let (gnus-info-buffer)
2279 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2280 (setq gnus-info-buffer (current-buffer))
2281 (gnus-configure-windows 'info)))
2284 ;;; gnus-interactive
2287 (defvar gnus-current-prefix-symbol nil
2288 "Current prefix symbol.")
2290 (defvar gnus-current-prefix-symbols nil
2291 "List of current prefix symbols.")
2293 (defun gnus-interactive (string &optional params)
2294 "Return a list that can be fed to `interactive'.
2295 See `interactive' for full documentation.
2297 Adds the following specs:
2299 y -- The current symbolic prefix.
2300 Y -- A list of the current symbolic prefix(es).
2301 A -- Article number.
2302 H -- Article header.
2306 (while (< i (length string))
2307 (string-match ".\\([^\n]*\\)\n?" string i)
2308 (setq c (aref string i))
2310 (setq prompt (match-string 1 string)))
2311 (setq i (match-end 0))
2312 ;; We basically emulate just about everything that
2313 ;; `interactive' does, but add the specs listed above.
2317 (completing-read prompt obarray 'fboundp t))
2319 (read-buffer prompt (current-buffer) t))
2321 (read-buffer prompt (other-buffer (current-buffer))))
2325 (completing-read prompt obarray 'commandp t))
2329 (read-file-name prompt nil default-directory 'lambda))
2331 (read-file-name prompt nil nil 'lambda))
2333 (read-file-name prompt))
2335 (read-key-sequence prompt))
2337 (error "Not implemented spec"))
2339 (error "Not implemented spec"))
2343 (error "Not implemented spec"))
2345 (string-to-number (read-from-minibuffer prompt)))
2347 (prefix-numeric-value current-prefix-arg))
2353 (read-string prompt))
2355 (intern (read-string prompt)))
2357 (read-variable prompt))
2359 (read-minibuffer prompt))
2361 (eval-minibuffer prompt))
2362 ;; And here the new specs come.
2364 gnus-current-prefix-symbol)
2366 gnus-current-prefix-symbols)
2368 (gnus-group-group-name))
2370 (gnus-summary-skip-intangible)
2371 (or (get-text-property (point) 'gnus-number)
2372 (gnus-summary-last-subject)))
2374 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2376 (error "Non-implemented spec")))
2380 (push (if (< (point) (mark) (point) (mark))) out)
2381 (push (if (> (point) (mark) (point) (mark))) out))))
2382 (setq out (delq 'gnus-prefix-nil out))
2385 (defun gnus-symbolic-argument (&optional arg)
2386 "Read a symbolic argument and a command, and then execute command."
2388 (let* ((in-command (this-command-keys))
2389 (command in-command)
2390 gnus-current-prefix-symbols
2391 gnus-current-prefix-symbol
2393 (while (equal in-command command)
2394 (message "%s-" (key-description (this-command-keys)))
2395 (push (intern (char-to-string (read-char))) syms)
2396 (setq command (read-key-sequence nil t)))
2397 (setq gnus-current-prefix-symbols (nreverse syms)
2398 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2399 (call-interactively (key-binding command t))))
2401 ;;; More various functions.
2403 (defsubst gnus-check-backend-function (func group)
2404 "Check whether GROUP supports function FUNC.
2405 GROUP can either be a string (a group name) or a select method."
2407 (let ((method (if (stringp group)
2408 (car (gnus-find-method-for-group group))
2410 (unless (featurep method)
2412 (fboundp (intern (format "%s-%s" method func))))))
2414 (defun gnus-group-read-only-p (&optional group)
2415 "Check whether GROUP supports editing or not.
2416 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2417 that that variable is buffer-local to the summary buffers."
2418 (let ((group (or group gnus-newsgroup-name)))
2419 (not (gnus-check-backend-function 'request-replace-article group))))
2421 (defun gnus-virtual-group-p (group)
2422 "Say whether GROUP is virtual or not."
2423 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2424 gnus-valid-select-methods)))
2426 (defun gnus-news-group-p (group &optional article)
2427 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2428 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2429 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2430 (if (or (null article)
2431 (not (< article 0)))
2432 (eq (gnus-request-type group article) 'news)
2433 (if (not (vectorp article))
2435 ;; It's a real article.
2436 (eq (gnus-request-type group (mail-header-id article))
2439 ;; Returns a list of writable groups.
2440 (defun gnus-writable-groups ()
2441 (let ((alist gnus-newsrc-alist)
2443 (while (setq group (car (pop alist)))
2444 (unless (gnus-group-read-only-p group)
2445 (push group groups)))
2448 ;; Check whether to use long file names.
2449 (defun gnus-use-long-file-name (symbol)
2450 ;; The variable has to be set...
2451 (and gnus-use-long-file-name
2452 ;; If it isn't a list, then we return t.
2453 (or (not (listp gnus-use-long-file-name))
2454 ;; If it is a list, and the list contains `symbol', we
2456 (not (memq symbol gnus-use-long-file-name)))))
2458 ;; Generate a unique new group name.
2459 (defun gnus-generate-new-group-name (leaf)
2462 (while (gnus-gethash name gnus-newsrc-hashtb)
2463 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2466 (defun gnus-ephemeral-group-p (group)
2467 "Say whether GROUP is ephemeral or not."
2468 (gnus-group-get-parameter group 'quit-config t))
2470 (defun gnus-group-quit-config (group)
2471 "Return the quit-config of GROUP."
2472 (gnus-group-get-parameter group 'quit-config t))
2474 (defun gnus-kill-ephemeral-group (group)
2475 "Remove ephemeral GROUP from relevant structures."
2476 (gnus-sethash group nil gnus-newsrc-hashtb))
2478 (defun gnus-simplify-mode-line ()
2479 "Make mode lines a bit simpler."
2480 (setq mode-line-modified (cdr gnus-mode-line-modified))
2481 (when (listp mode-line-format)
2482 (make-local-variable 'mode-line-format)
2483 (setq mode-line-format (copy-sequence mode-line-format))
2484 (when (equal (nth 3 mode-line-format) " ")
2485 (setcar (nthcdr 3 mode-line-format) " "))))
2487 ;;; Servers and groups.
2489 (defsubst gnus-server-add-address (method)
2490 (let ((method-name (symbol-name (car method))))
2491 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2492 (not (assq (intern (concat method-name "-address")) method))
2493 (memq 'physical-address (assq (car method)
2494 gnus-valid-select-methods)))
2495 (append method (list (list (intern (concat method-name "-address"))
2499 (defsubst gnus-server-get-method (group method)
2500 ;; Input either a server name, and extended server name, or a
2501 ;; select method, and return a select method.
2502 (cond ((stringp method)
2503 (gnus-server-to-method method))
2504 ((equal method gnus-select-method)
2506 ((and (stringp (car method))
2508 (gnus-server-extend-method group method))
2511 (equal (cadr method) ""))
2514 (gnus-server-add-address method))))
2516 (defun gnus-server-to-method (server)
2517 "Map virtual server names to select methods."
2519 ;; Is this a method, perhaps?
2520 (and server (listp server) server)
2521 ;; Perhaps this is the native server?
2522 (and (equal server "native") gnus-select-method)
2523 ;; It should be in the server alist.
2524 (cdr (assoc server gnus-server-alist))
2525 ;; It could be in the predefined server alist.
2526 (cdr (assoc server gnus-predefined-server-alist))
2527 ;; If not, we look through all the opened server
2528 ;; to see whether we can find it there.
2529 (let ((opened gnus-opened-servers))
2531 (not (equal server (format "%s:%s" (caaar opened)
2535 ;; It could be a named method, search all servers
2536 (let ((servers gnus-secondary-select-methods))
2538 (not (equal server (format "%s:%s" (caar servers)
2543 (defmacro gnus-method-equal (ss1 ss2)
2544 "Say whether two servers are equal."
2548 (and (= (length s1) (length s2))
2550 (while (and s1 (member (car s1) s2))
2554 (defun gnus-methods-equal-p (m1 m2)
2555 (let ((m1 (or m1 gnus-select-method))
2556 (m2 (or m2 gnus-select-method)))
2558 (and (eq (car m1) (car m2))
2559 (or (not (memq 'address (assoc (symbol-name (car m1))
2560 gnus-valid-select-methods)))
2561 (equal (nth 1 m1) (nth 1 m2)))))))
2563 (defun gnus-server-equal (m1 m2)
2564 "Say whether two methods are equal."
2565 (let ((m1 (cond ((null m1) gnus-select-method)
2566 ((stringp m1) (gnus-server-to-method m1))
2568 (m2 (cond ((null m2) gnus-select-method)
2569 ((stringp m2) (gnus-server-to-method m2))
2571 (gnus-method-equal m1 m2)))
2573 (defun gnus-servers-using-backend (backend)
2574 "Return a list of known servers using BACKEND."
2575 (let ((opened gnus-opened-servers)
2578 (when (eq backend (caaar opened))
2579 (push (caar opened) out))
2583 (defun gnus-archive-server-wanted-p ()
2584 "Say whether the user wants to use the archive server."
2586 ((or (not gnus-message-archive-method)
2587 (not gnus-message-archive-group))
2589 ((and gnus-message-archive-method gnus-message-archive-group)
2592 (let ((active (cadr (assq 'nnfolder-active-file
2593 gnus-message-archive-method))))
2595 (file-exists-p active))))))
2597 (defsubst gnus-method-to-server-name (method)
2599 (format "%s" (car method))
2601 (or (assoc (format "%s" (car method))
2602 (gnus-methods-using 'address))
2603 (gnus-server-equal method gnus-message-archive-method))
2605 (not (string= (nth 1 method) "")))
2606 (concat "+" (nth 1 method)))))
2608 (defun gnus-group-prefixed-name (group method)
2609 "Return the whole name from GROUP and METHOD."
2610 (and (stringp method) (setq method (gnus-server-to-method method)))
2611 (if (or (not method)
2612 (gnus-server-equal method "native"))
2614 (concat (gnus-method-to-server-name method) ":" group)))
2616 (defun gnus-group-real-prefix (group)
2617 "Return the prefix of the current group name."
2618 (if (string-match "^[^:]+:" group)
2619 (substring group 0 (match-end 0))
2622 (defun gnus-group-method (group)
2623 "Return the server or method used for selecting GROUP.
2624 You should probably use `gnus-find-method-for-group' instead."
2625 (let ((prefix (gnus-group-real-prefix group)))
2626 (if (equal prefix "")
2628 (let ((servers gnus-opened-servers)
2630 backend possible found)
2631 (if (string-match "^[^\\+]+\\+" prefix)
2632 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2633 server (substring prefix (match-end 0) (1- (length prefix))))
2634 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2636 (when (eq (caaar servers) backend)
2637 (setq possible (caar servers))
2638 (when (equal (cadaar servers) server)
2639 (setq found (caar servers))))
2641 (or (car (rassoc found gnus-server-alist))
2643 (car (rassoc possible gnus-server-alist))
2645 (list backend server))))))
2647 (defsubst gnus-native-method-p (method)
2648 "Return whether METHOD is the native select method."
2649 (gnus-method-equal method gnus-select-method))
2651 (defsubst gnus-secondary-method-p (method)
2652 "Return whether METHOD is a secondary select method."
2653 (let ((methods gnus-secondary-select-methods)
2654 (gmethod (gnus-server-get-method nil method)))
2656 (not (gnus-method-equal
2657 (gnus-server-get-method nil (car methods))
2659 (setq methods (cdr methods)))
2662 (defun gnus-method-simplify (method)
2663 "Return the shortest uniquely identifying string or method for METHOD."
2664 (cond ((stringp method)
2666 ((gnus-native-method-p method)
2668 ((gnus-secondary-method-p method)
2669 (format "%s:%s" (nth 0 method) (nth 1 method)))
2673 (defun gnus-groups-from-server (server)
2674 "Return a list of all groups that are fetched from SERVER."
2675 (let ((alist (cdr gnus-newsrc-alist))
2677 (while (setq info (pop alist))
2678 (when (gnus-server-equal (gnus-info-method info) server)
2679 (push (gnus-info-group info) groups)))
2680 (sort groups 'string<)))
2682 (defun gnus-group-foreign-p (group)
2683 "Say whether a group is foreign or not."
2684 (and (not (gnus-group-native-p group))
2685 (not (gnus-group-secondary-p group))))
2687 (defun gnus-group-native-p (group)
2688 "Say whether the group is native or not."
2689 (not (string-match ":" group)))
2691 (defun gnus-group-secondary-p (group)
2692 "Say whether the group is secondary or not."
2693 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2695 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2696 "Return the group parameters for GROUP.
2697 If SYMBOL, return the value of that symbol in the group parameters."
2699 (set-buffer gnus-group-buffer)
2700 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2702 (gnus-group-parameter-value parameters symbol allow-list)
2705 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2706 "Return the group parameters for GROUP.
2707 If SYMBOL, return the value of that symbol in the group parameters.
2708 Most functions should use `gnus-group-find-parameter', which
2709 also examines the topic parameters."
2710 (let ((params (gnus-info-params (gnus-get-info group))))
2712 (gnus-group-parameter-value params symbol allow-list)
2715 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2716 "Return the value of SYMBOL in group PARAMS."
2717 ;; We only wish to return group parameters (dotted lists) and
2718 ;; not local variables, which may have the same names.
2719 ;; But first we handle single elements...
2720 (or (car (memq symbol params))
2724 (while (setq elem (pop params))
2725 (when (and (consp elem)
2726 (eq (car elem) symbol)
2729 (throw 'found (cdr elem))))))))
2731 (defun gnus-group-add-parameter (group param)
2732 "Add parameter PARAM to GROUP."
2733 (let ((info (gnus-get-info group)))
2735 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2736 ;; Cons the new param to the old one and update.
2737 (gnus-group-set-info (cons param (gnus-info-params info))
2740 (defun gnus-group-set-parameter (group name value)
2741 "Set parameter NAME to VALUE in GROUP."
2742 (let ((info (gnus-get-info group)))
2744 (gnus-group-remove-parameter group name)
2745 (let ((old-params (gnus-info-params info))
2746 (new-params (list (cons name value))))
2748 (when (or (not (listp (car old-params)))
2749 (not (eq (caar old-params) name)))
2750 (setq new-params (append new-params (list (car old-params)))))
2751 (setq old-params (cdr old-params)))
2752 (gnus-group-set-info new-params group 'params)))))
2754 (defun gnus-group-remove-parameter (group name)
2755 "Remove parameter NAME from GROUP."
2756 (let ((info (gnus-get-info group)))
2758 (let ((params (gnus-info-params info)))
2760 (setq params (delq name params))
2761 (while (assq name params)
2762 (gnus-pull name params))
2763 (gnus-info-set-params info params))))))
2765 (defun gnus-group-add-score (group &optional score)
2766 "Add SCORE to the GROUP score.
2767 If SCORE is nil, add 1 to the score of GROUP."
2768 (let ((info (gnus-get-info group)))
2770 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2772 (defun gnus-short-group-name (group &optional levels)
2773 "Collapse GROUP name LEVELS.
2774 Select methods are stripped and any remote host name is stripped down to
2775 just the host name."
2781 gnus-group-uncollapsed-levels
2783 (while (string-match "\\." group skip)
2784 (setq skip (match-end 0)
2787 ;; Separate foreign select method from group name and collapse.
2788 ;; If method contains a server, collapse to non-domain server name,
2789 ;; otherwise collapse to select method.
2790 (let* ((colon (string-match ":" group))
2791 (server (and colon (substring group 0 colon)))
2792 (plus (and server (string-match "+" server))))
2795 (setq foreign (substring server (+ 1 plus)
2796 (string-match "\\." server))
2797 group (substring group (+ 1 colon)))
2798 (setq foreign server
2799 group (substring group (+ 1 colon))))
2800 (setq foreign (concat foreign ":")))
2801 ;; Collapse group name leaving LEVELS uncollapsed elements
2802 (let* ((slist (split-string group "/"))
2803 (slen (length slist))
2804 (dlist (split-string group "\\."))
2805 (dlen (length dlist))
2817 (setq levels (- glen levels))
2819 (push (if (>= (decf levels) 0)
2820 (if (zerop (length g))
2825 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2827 (defun gnus-narrow-to-body ()
2828 "Narrow to the body of an article."
2831 (goto-char (point-min))
2832 (or (search-forward "\n\n" nil t)
2838 ;;; Kill file handling.
2841 (defun gnus-apply-kill-file ()
2842 "Apply a kill file to the current newsgroup.
2843 Returns the number of articles marked as read."
2844 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2845 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2846 (gnus-apply-kill-file-internal)
2849 (defun gnus-kill-save-kill-buffer ()
2850 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2851 (when (get-file-buffer file)
2853 (set-buffer (get-file-buffer file))
2854 (when (buffer-modified-p)
2856 (kill-buffer (current-buffer))))))
2858 (defcustom gnus-kill-file-name "KILL"
2859 "Suffix of the kill files."
2860 :group 'gnus-score-kill
2861 :group 'gnus-score-files
2864 (defun gnus-newsgroup-kill-file (newsgroup)
2865 "Return the name of a kill file name for NEWSGROUP.
2866 If NEWSGROUP is nil, return the global kill file name instead."
2868 ;; The global KILL file is placed at top of the directory.
2869 ((or (null newsgroup)
2870 (string-equal newsgroup ""))
2871 (expand-file-name gnus-kill-file-name
2872 gnus-kill-files-directory))
2873 ;; Append ".KILL" to newsgroup name.
2874 ((gnus-use-long-file-name 'not-kill)
2875 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2876 "." gnus-kill-file-name)
2877 gnus-kill-files-directory))
2878 ;; Place "KILL" under the hierarchical directory.
2880 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2881 "/" gnus-kill-file-name)
2882 gnus-kill-files-directory))))
2886 (defun gnus-member-of-valid (symbol group)
2887 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2889 (symbol-name (car (gnus-find-method-for-group group)))
2890 gnus-valid-select-methods)))
2892 (defun gnus-method-option-p (method option)
2893 "Return non-nil if select METHOD has OPTION as a parameter."
2894 (when (stringp method)
2895 (setq method (gnus-server-to-method method)))
2896 (memq option (assoc (format "%s" (car method))
2897 gnus-valid-select-methods)))
2899 (defun gnus-similar-server-opened (method)
2900 (let ((opened gnus-opened-servers))
2901 (while (and method opened)
2902 (when (and (equal (cadr method) (cadaar opened))
2903 (equal (car method) (caaar opened))
2904 (not (equal method (caar opened))))
2909 (defun gnus-server-extend-method (group method)
2910 ;; This function "extends" a virtual server. If the server is
2911 ;; "hello", and the select method is ("hello" (my-var "something"))
2912 ;; in the group "alt.alt", this will result in a new virtual server
2913 ;; called "hello+alt.alt".
2914 (if (or (not (inline (gnus-similar-server-opened method)))
2915 (not (cddr method)))
2917 `(,(car method) ,(concat (cadr method) "+" group)
2918 (,(intern (format "%s-address" (car method))) ,(cadr method))
2921 (defun gnus-server-status (method)
2922 "Return the status of METHOD."
2923 (nth 1 (assoc method gnus-opened-servers)))
2925 (defun gnus-group-name-to-method (group)
2926 "Guess a select method based on GROUP."
2927 (if (string-match ":" group)
2928 (let ((server (substring group 0 (match-beginning 0))))
2929 (if (string-match "\\+" server)
2930 (list (intern (substring server 0 (match-beginning 0)))
2931 (substring server (match-end 0)))
2932 (list (intern server) "")))
2933 gnus-select-method))
2935 (defun gnus-find-method-for-group (group &optional info)
2936 "Find the select method that GROUP uses."
2937 (or gnus-override-method
2940 (and (not (gnus-group-entry group));; a new group
2941 (gnus-group-name-to-method group))
2942 (let ((info (or info (gnus-get-info group)))
2945 (not (setq method (gnus-info-method info)))
2946 (equal method "native"))
2949 (cond ((stringp method)
2950 (inline (gnus-server-to-method method)))
2951 ((stringp (cadr method))
2952 (inline (gnus-server-extend-method group method)))
2955 (cond ((equal (cadr method) "")
2957 ((null (cadr method))
2958 (list (car method) ""))
2960 (gnus-server-add-address method)))))))
2962 (defun gnus-methods-using (feature)
2963 "Find all methods that have FEATURE."
2964 (let ((valids gnus-valid-select-methods)
2967 (when (memq feature (car valids))
2968 (push (car valids) outs))
2969 (setq valids (cdr valids)))
2972 (defun gnus-read-group (prompt &optional default)
2973 "Prompt the user for a group name.
2974 Disallow invalid group names."
2979 gnus-invalid-group-regexp
2980 (setq group (read-string (concat prefix prompt)
2981 (cons (or default "") 0)
2982 'gnus-group-history)))
2983 (setq prefix (format "Invalid group name: \"%s\". " group)
2987 (defun gnus-read-method (prompt)
2988 "Prompt the user for a method.
2989 Allow completion over sensible values."
2991 (append gnus-valid-select-methods
2992 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2994 gnus-opened-servers)
2995 gnus-predefined-server-alist
3000 nil t nil 'gnus-method-history)))
3003 (setq method gnus-select-method))
3004 ((assoc method gnus-valid-select-methods)
3005 (let ((address (if (memq 'prompt-address
3006 (assoc method gnus-valid-select-methods))
3007 (read-string "Address: ")
3009 (or (let ((opened gnus-opened-servers))
3011 (not (equal (format "%s:%s" method address)
3012 (format "%s:%s" (caaar opened)
3016 (list (intern method) address))))
3017 ((assoc method servers)
3020 (list (intern method) "")))))
3022 ;;; User-level commands.
3025 (defun gnus-slave-no-server (&optional arg)
3026 "Read network news as a slave, without connecting to local server."
3028 (gnus-no-server arg t))
3031 (defun gnus-no-server (&optional arg slave)
3033 If ARG is a positive number, Gnus will use that as the
3034 startup level. If ARG is nil, Gnus will be started at level 2.
3035 If ARG is non-nil and not a positive number, Gnus will
3036 prompt the user for the name of an NNTP server to use.
3037 As opposed to `gnus', this command will not connect to the local server."
3039 (gnus-no-server-1 arg slave))
3042 (defun gnus-slave (&optional arg)
3043 "Read news as a slave."
3045 (gnus arg nil 'slave))
3048 (defun gnus-other-frame (&optional arg)
3049 "Pop up a frame to read news."
3051 (let ((window (get-buffer-window gnus-group-buffer)))
3053 (select-frame (window-frame window)))
3055 (select-frame (make-frame)))))
3058 ;;(setq thing ? ; this is a comment
3062 (defun gnus (&optional arg dont-connect slave)
3064 If ARG is non-nil and a positive number, Gnus will use that as the
3065 startup level. 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."
3068 (gnus-1 arg dont-connect slave))
3070 ;; Allow redefinition of Gnus functions.
3076 ;;; gnus.el ends here