1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
3 ;; 1997, 1998, 2000 Free Software Foundation, Inc.
5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
6 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
8 ;; Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
9 ;; Keywords: news, mail
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
32 (eval '(run-hooks 'gnus-load-hook))
34 (eval-when-compile (require 'cl))
35 (eval-when-compile (require 'static))
40 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
44 (defgroup gnus-charset nil
45 "Group character set issues."
46 :link '(custom-manual "(gnus)Charsets")
50 (defgroup gnus-cache nil
54 (defgroup gnus-start nil
55 "Starting your favorite newsreader."
58 (defgroup gnus-start-server nil
59 "Server options at startup."
62 ;; These belong to gnus-group.el.
63 (defgroup gnus-group nil
65 :link '(custom-manual "(gnus)The Group Buffer")
68 (defgroup gnus-group-foreign nil
70 :link '(custom-manual "(gnus)Foreign Groups")
73 (defgroup gnus-group-new nil
74 "Automatic subscription of new groups."
77 (defgroup gnus-group-levels nil
79 :link '(custom-manual "(gnus)Group Levels")
82 (defgroup gnus-group-select nil
84 :link '(custom-manual "(gnus)Selecting a Group")
87 (defgroup gnus-group-listing nil
88 "Showing slices of the group list."
89 :link '(custom-manual "(gnus)Listing Groups")
92 (defgroup gnus-group-visual nil
93 "Sorting the group buffer."
94 :link '(custom-manual "(gnus)Group Buffer Format")
98 (defgroup gnus-group-various nil
99 "Various group options."
100 :link '(custom-manual "(gnus)Scanning New Messages")
103 ;; These belong to gnus-sum.el.
104 (defgroup gnus-summary nil
106 :link '(custom-manual "(gnus)The Summary Buffer")
109 (defgroup gnus-summary-exit nil
110 "Leaving summary buffers."
111 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
112 :group 'gnus-summary)
114 (defgroup gnus-summary-marks nil
115 "Marks used in summary buffers."
116 :link '(custom-manual "(gnus)Marking Articles")
117 :group 'gnus-summary)
119 (defgroup gnus-thread nil
120 "Ordering articles according to replies."
121 :link '(custom-manual "(gnus)Threading")
122 :group 'gnus-summary)
124 (defgroup gnus-summary-format nil
125 "Formatting of the summary buffer."
126 :link '(custom-manual "(gnus)Summary Buffer Format")
127 :group 'gnus-summary)
129 (defgroup gnus-summary-choose nil
131 :link '(custom-manual "(gnus)Choosing Articles")
132 :group 'gnus-summary)
134 (defgroup gnus-summary-maneuvering nil
135 "Summary movement commands."
136 :link '(custom-manual "(gnus)Summary Maneuvering")
137 :group 'gnus-summary)
139 (defgroup gnus-summary-mail nil
140 "Mail group commands."
141 :link '(custom-manual "(gnus)Mail Group Commands")
142 :group 'gnus-summary)
144 (defgroup gnus-summary-sort nil
145 "Sorting the summary buffer."
146 :link '(custom-manual "(gnus)Sorting")
147 :group 'gnus-summary)
149 (defgroup gnus-summary-visual nil
150 "Highlighting and menus in the summary buffer."
151 :link '(custom-manual "(gnus)Summary Highlighting")
153 :group 'gnus-summary)
155 (defgroup gnus-summary-various nil
156 "Various summary buffer options."
157 :link '(custom-manual "(gnus)Various Summary Stuff")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-pick nil
161 "Pick mode in the summary buffer."
162 :link '(custom-manual "(gnus)Pick and Read")
164 :group 'gnus-summary)
166 (defgroup gnus-summary-tree nil
167 "Tree display of threads in the summary buffer."
168 :link '(custom-manual "(gnus)Tree Display")
170 :group 'gnus-summary)
172 ;; Belongs to gnus-uu.el
173 (defgroup gnus-extract-view nil
174 "Viewing extracted files."
175 :link '(custom-manual "(gnus)Viewing Files")
176 :group 'gnus-extract)
178 ;; Belongs to gnus-score.el
179 (defgroup gnus-score nil
180 "Score and kill file handling."
183 (defgroup gnus-score-kill nil
187 (defgroup gnus-score-adapt nil
188 "Adaptive score files."
191 (defgroup gnus-score-default nil
192 "Default values for score files."
195 (defgroup gnus-score-expire nil
196 "Expiring score rules."
199 (defgroup gnus-score-decay nil
200 "Decaying score rules."
203 (defgroup gnus-score-files nil
204 "Score and kill file names."
208 (defgroup gnus-score-various nil
209 "Various scoring and killing options."
213 (defgroup gnus-visual nil
214 "Options controling the visual fluff."
218 (defgroup gnus-agent nil
219 "Offline support for Gnus."
222 (defgroup gnus-files nil
223 "Files used by Gnus."
226 (defgroup gnus-dribble-file nil
228 :link '(custom-manual "(gnus)Auto Save")
231 (defgroup gnus-newsrc nil
232 "Storing Gnus state."
235 (defgroup gnus-server nil
236 "Options related to newsservers and other servers used by Gnus."
239 (defgroup gnus-message '((message custom-group))
240 "Composing replies and followups in Gnus."
243 (defgroup gnus-meta nil
244 "Meta variables controling major portions of Gnus.
245 In general, modifying these variables does not take affect until Gnus
246 is restarted, and sometimes reloaded."
249 (defgroup gnus-various nil
250 "Other Gnus options."
251 :link '(custom-manual "(gnus)Various Various")
254 (defgroup gnus-mime nil
255 "Variables for controlling the Gnus MIME interface."
258 (defgroup gnus-exit nil
260 :link '(custom-manual "(gnus)Exiting Gnus")
263 (defcustom gnus-inhibit-startup-message nil
264 "If non-nil, the startup message will not be displayed.
265 This variable is used before `.gnus.el' is loaded, so it should
266 be set in `.emacs' instead."
270 (defcustom gnus-play-startup-jingle nil
271 "If non-nil, play the Gnus jingle at startup."
275 (unless (fboundp 'gnus-group-remove-excess-properties)
276 (defalias 'gnus-group-remove-excess-properties 'ignore))
278 (unless (fboundp 'gnus-set-text-properties)
279 (defalias 'gnus-set-text-properties 'set-text-properties))
281 (unless (featurep 'gnus-xmas)
282 (defalias 'gnus-make-overlay 'make-overlay)
283 (defalias 'gnus-delete-overlay 'delete-overlay)
284 (defalias 'gnus-overlay-put 'overlay-put)
285 (defalias 'gnus-move-overlay 'move-overlay)
286 (defalias 'gnus-overlay-buffer 'overlay-buffer)
287 (defalias 'gnus-overlay-start 'overlay-start)
288 (defalias 'gnus-overlay-end 'overlay-end)
289 (defalias 'gnus-extent-detached-p 'ignore)
290 (defalias 'gnus-extent-start-open 'ignore)
291 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
292 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
293 (defalias 'gnus-character-to-event 'identity)
294 (defalias 'gnus-add-text-properties 'add-text-properties)
295 (defalias 'gnus-put-text-property 'put-text-property)
296 (defvar gnus-mode-line-image-cache t)
297 (if (fboundp 'find-image)
298 (defun gnus-mode-line-buffer-identification (line)
299 (let ((str (car-safe line)))
300 (if (and (stringp str)
301 (string-match "^Gnus:" str))
302 (progn (add-text-properties
305 (if (eq t gnus-mode-line-image-cache)
306 (setq gnus-mode-line-image-cache
308 '((:type xpm :file "gnus-pointer.xpm"
310 (:type xbm :file "gnus-pointer.xbm"
312 gnus-mode-line-image-cache)
313 'help-echo "This is Gnus")
317 (defalias 'gnus-mode-line-buffer-identification 'identity))
318 (defalias 'gnus-characterp 'numberp)
319 (defalias 'gnus-deactivate-mark 'deactivate-mark)
320 (defalias 'gnus-window-edges 'window-edges)
321 (defalias 'gnus-key-press-event-p 'numberp)
322 ;;(defalias 'gnus-decode-rfc1522 'ignore)
325 ;; We define these group faces here to avoid the display
326 ;; update forced when creating new faces.
328 (defface gnus-group-news-1-face
331 (:foreground "PaleTurquoise" :bold t))
334 (:foreground "ForestGreen" :bold t))
337 "Level 1 newsgroup face.")
339 (defface gnus-group-news-1-empty-face
342 (:foreground "PaleTurquoise"))
345 (:foreground "ForestGreen"))
348 "Level 1 empty newsgroup face.")
350 (defface gnus-group-news-2-face
353 (:foreground "turquoise" :bold t))
356 (:foreground "CadetBlue4" :bold t))
359 "Level 2 newsgroup face.")
361 (defface gnus-group-news-2-empty-face
364 (:foreground "turquoise"))
367 (:foreground "CadetBlue4"))
370 "Level 2 empty newsgroup face.")
372 (defface gnus-group-news-3-face
381 "Level 3 newsgroup face.")
383 (defface gnus-group-news-3-empty-face
392 "Level 3 empty newsgroup face.")
394 (defface gnus-group-news-4-face
403 "Level 4 newsgroup face.")
405 (defface gnus-group-news-4-empty-face
414 "Level 4 empty newsgroup face.")
416 (defface gnus-group-news-5-face
425 "Level 5 newsgroup face.")
427 (defface gnus-group-news-5-empty-face
436 "Level 5 empty newsgroup face.")
438 (defface gnus-group-news-6-face
447 "Level 6 newsgroup face.")
449 (defface gnus-group-news-6-empty-face
458 "Level 6 empty newsgroup face.")
460 (defface gnus-group-news-low-face
463 (:foreground "DarkTurquoise" :bold t))
466 (:foreground "DarkGreen" :bold t))
469 "Low level newsgroup face.")
471 (defface gnus-group-news-low-empty-face
474 (:foreground "DarkTurquoise"))
477 (:foreground "DarkGreen"))
480 "Low level empty newsgroup face.")
482 (defface gnus-group-mail-1-face
485 (:foreground "aquamarine1" :bold t))
488 (:foreground "DeepPink3" :bold t))
491 "Level 1 mailgroup face.")
493 (defface gnus-group-mail-1-empty-face
496 (:foreground "aquamarine1"))
499 (:foreground "DeepPink3"))
501 (:italic t :bold t)))
502 "Level 1 empty mailgroup face.")
504 (defface gnus-group-mail-2-face
507 (:foreground "aquamarine2" :bold t))
510 (:foreground "HotPink3" :bold t))
513 "Level 2 mailgroup face.")
515 (defface gnus-group-mail-2-empty-face
518 (:foreground "aquamarine2"))
521 (:foreground "HotPink3"))
524 "Level 2 empty mailgroup face.")
526 (defface gnus-group-mail-3-face
529 (:foreground "aquamarine3" :bold t))
532 (:foreground "magenta4" :bold t))
535 "Level 3 mailgroup face.")
537 (defface gnus-group-mail-3-empty-face
540 (:foreground "aquamarine3"))
543 (:foreground "magenta4"))
546 "Level 3 empty mailgroup face.")
548 (defface gnus-group-mail-low-face
551 (:foreground "aquamarine4" :bold t))
554 (:foreground "DeepPink4" :bold t))
557 "Low level mailgroup face.")
559 (defface gnus-group-mail-low-empty-face
562 (:foreground "aquamarine4"))
565 (:foreground "DeepPink4"))
568 "Low level empty mailgroup face.")
570 ;; Summary mode faces.
572 (defface gnus-summary-selected-face '((t
574 "Face used for selected articles.")
576 (defface gnus-summary-cancelled-face
578 (:foreground "yellow" :background "black")))
579 "Face used for cancelled articles.")
581 (defface gnus-summary-high-ticked-face
584 (:foreground "pink" :bold t))
587 (:foreground "firebrick" :bold t))
590 "Face used for high interest ticked articles.")
592 (defface gnus-summary-low-ticked-face
595 (:foreground "pink" :italic t))
598 (:foreground "firebrick" :italic t))
601 "Face used for low interest ticked articles.")
603 (defface gnus-summary-normal-ticked-face
606 (:foreground "pink"))
609 (:foreground "firebrick"))
612 "Face used for normal interest ticked articles.")
614 (defface gnus-summary-high-ancient-face
617 (:foreground "SkyBlue" :bold t))
620 (:foreground "RoyalBlue" :bold t))
623 "Face used for high interest ancient articles.")
625 (defface gnus-summary-low-ancient-face
628 (:foreground "SkyBlue" :italic t))
631 (:foreground "RoyalBlue" :italic t))
634 "Face used for low interest ancient articles.")
636 (defface gnus-summary-normal-ancient-face
639 (:foreground "SkyBlue"))
642 (:foreground "RoyalBlue"))
645 "Face used for normal interest ancient articles.")
647 (defface gnus-summary-high-unread-face
650 "Face used for high interest unread articles.")
652 (defface gnus-summary-low-unread-face
655 "Face used for low interest unread articles.")
657 (defface gnus-summary-normal-unread-face
660 "Face used for normal interest unread articles.")
662 (defface gnus-summary-incorporated-face
665 "Face used for incorporated articles.")
667 (defface gnus-summary-high-read-face
670 (:foreground "PaleGreen"
674 (:foreground "DarkGreen"
678 "Face used for high interest read articles.")
680 (defface gnus-summary-low-read-face
683 (:foreground "PaleGreen"
687 (:foreground "DarkGreen"
691 "Face used for low interest read articles.")
693 (defface gnus-summary-normal-read-face
696 (:foreground "PaleGreen"))
699 (:foreground "DarkGreen"))
702 "Face used for normal interest read articles.")
709 (defvar gnus-buffers nil)
711 (defun gnus-get-buffer-create (name)
712 "Do the same as `get-buffer-create', but store the created buffer."
713 (or (get-buffer name)
714 (car (push (get-buffer-create name) gnus-buffers))))
716 (defun gnus-add-buffer ()
717 "Add the current buffer to the list of Gnus buffers."
718 (push (current-buffer) gnus-buffers))
720 (defun gnus-buffers ()
721 "Return a list of live Gnus buffers."
722 (while (and gnus-buffers
723 (not (buffer-name (car gnus-buffers))))
725 (let ((buffers gnus-buffers))
727 (if (buffer-name (cadr buffers))
729 (setcdr buffers (cddr buffers)))))
734 (defvar gnus-group-buffer "*Group*")
737 (autoload 'gnus-play-jingle "gnus-audio"))
739 (defface gnus-splash-face
742 (:foreground "Brown"))
745 (:foreground "Brown"))
748 "Face of the splash screen.")
750 (defun gnus-splash ()
752 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
753 (let ((buffer-read-only nil))
755 (unless gnus-inhibit-startup-message
756 (gnus-group-startup-message)
758 (when gnus-play-startup-jingle
759 (gnus-play-jingle))))))
761 (defun gnus-indent-rigidly (start end arg)
762 "Indent rigidly using only spaces and no tabs."
765 (narrow-to-region start end)
767 (indent-rigidly start end arg)
768 ;; We translate tabs into spaces -- not everybody uses
769 ;; an 8-character tab.
770 (goto-char (point-min))
771 (while (search-forward "\t" nil t)
772 (replace-match " " t t))))))
774 (defvar gnus-simple-splash nil)
776 (defun gnus-group-startup-message (&optional x y)
777 "Insert startup message in current buffer."
778 ;; Insert the message.
781 ((and (fboundp 'find-image)
783 (let* ((bg (face-background 'default))
784 (fg (face-foreground 'gnus-splash-face))
786 `((:type xpm :file "gnus.xpm"
787 :color-symbols (("thing" . "#724214")
788 ("shadow" . "#1e3f03")
789 ("background" . ,bg)))
790 (:type pbm :file "gnus.pbm"
791 ;; Account for the pbm's blackground.
792 :background ,bg :foreground ,fg)
793 (:type xbm :file "gnus.xbm"
794 ;; Account for the xbm's blackground.
795 :background ,bg :foreground ,fg)))))
799 (concat gnus-product-name " " gnus-version-number
800 (if (zerop (string-to-number gnus-revision-number))
802 (concat " (r" gnus-revision-number ")"))
803 " based on " gnus-original-product-name " v"
804 gnus-original-version-number)
805 'face `(variable-pitch :background ,bg :foreground ,fg)))
806 (let ((fill-column (window-width)))
807 (center-region (point-min) (point)))
808 (let ((size (image-size image)))
809 (insert-char ?\n (max 1 (round (- (window-height)
810 (or y (cdr size))) 2)))
812 (propertize " " 'display
814 ,(max 0 (round (- (window-width)
815 (or x (car size))) 2)))))
816 (insert-image image))
817 (setq gnus-simple-splash nil)
822 _ ___ __ ___ __ _ ___
841 (goto-char (point-min))
842 (insert gnus-product-name " " gnus-version-number
843 (if (zerop (string-to-number gnus-revision-number))
845 (concat " (r" gnus-revision-number ")"))
846 " based on " gnus-original-product-name " v"
847 gnus-original-version-number)
848 (insert-char ?\ (prog1
849 (max 0 (/ (- (window-width) (point)) 2))
850 (goto-char (point-min))))
853 (gnus-indent-rigidly (point) (point-max)
854 (/ (max (- (window-width) (or x 46)) 0) 2))
855 (goto-char (point-min))
857 (let* ((pheight (count-lines (point-min) (point-max)))
858 (wheight (window-height))
859 (rest (- wheight pheight)))
860 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
862 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
863 (setq gnus-simple-splash t)))
864 (goto-char (point-min))
865 (setq mode-line-buffer-identification (concat " " gnus-version))
866 (set-buffer-modified-p t))
869 (let ((command (format "%s" this-command)))
870 (if (and (string-match "gnus" command)
871 (not (string-match "gnus-other-frame" command)))
873 (gnus-get-buffer-create gnus-group-buffer))))
880 (defvar gnus-group-parameters-more nil)
883 :symbol-for-testing-whether-colon-keyword-is-available-or-not
886 (dolist (keyword '(:parameter-type
887 :parameter-document :function :function-document
888 :variable :variable-document :variable-group
889 :variable-type :variable-default))
890 (set keyword keyword))))
892 (defmacro gnus-define-group-parameter (param &rest rest)
893 "Define a group parameter PARAM.
894 REST is a plist of following:
895 :type One of `bool', `list' or `nil'.
896 :function The name of the function.
897 :function-document The document of the function.
898 :parameter-type The type for customizing the parameter.
899 :parameter-document The document for the parameter.
900 :variable The name of the variable.
901 :variable-document The document for the variable.
902 :variable-group The group for customizing the variable.
903 :variable-type The type for customizing the variable.
904 :variable-default The default value of the variable."
905 (let* ((type (plist-get rest :type))
906 (parameter-type (plist-get rest :parameter-type))
907 (parameter-document (plist-get rest :parameter-document))
908 (function (or (plist-get rest :function)
909 (intern (format "gnus-parameter-%s" param))))
910 (function-document (or (plist-get rest :function-document) ""))
911 (variable (or (plist-get rest :variable)
912 (intern (format "gnus-parameter-%s-alist" param))))
913 (variable-document (or (plist-get rest :variable-document) ""))
914 (variable-group (plist-get rest :variable-group))
915 (variable-type (or (plist-get rest :variable-type)
916 `(quote (repeat (list (regexp :tag "Group")
918 (variable-default (plist-get rest :variable-default)))
921 `(defcustom ,variable ,variable-default
923 :group 'gnus-group-parameter
924 :group ',variable-group
925 :type ,variable-type)
926 `(setq gnus-group-parameters-more
927 (delq (assq ',param gnus-group-parameters-more)
928 gnus-group-parameters-more))
929 `(add-to-list 'gnus-group-parameters-more
932 ,parameter-document))
934 `(defun ,function (group)
936 (let ((params (gnus-group-find-parameter group))
939 ((memq ',param params)
941 ((setq val (assq ',param params))
944 (string-match ,variable group)))))
945 `(defun ,function (name)
948 (or (gnus-group-find-parameter name ',param)
949 (let ((alist ,variable)
951 (while (setq elem (pop alist))
953 (string-match (car elem) name))
958 '(if (consp value) (car value) value))))))))))
960 (defcustom gnus-home-directory "~/"
961 "Directory variable that specifies the \"home\" directory.
962 All other Gnus path variables are initialized from this variable."
966 (defcustom gnus-directory (or (getenv "SAVEDIR")
967 (nnheader-concat gnus-home-directory "News/"))
968 "*Directory variable from which all other Gnus file variables are derived.
970 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
971 This means that other directory variables that are initialized from
972 this variable won't be set properly if you set this variable in `.gnus.el'.
973 Set this variable in `.emacs' instead."
977 (defcustom gnus-default-directory nil
978 "*Default directory for all Gnus buffers."
980 :type '(choice (const :tag "current" nil)
983 ;; Site dependent variables. These variables should be defined in
986 (defvar gnus-default-nntp-server nil
987 "Specify a default NNTP server.
988 This variable should be defined in paths.el, and should never be set
990 If you want to change servers, you should use `gnus-select-method'.
991 See the documentation to that variable.")
993 ;; Don't touch this variable.
994 (defvar gnus-nntp-service "nntp"
995 "NNTP service name (\"nntp\" or 119).
996 This is an obsolete variable, which is scarcely used. If you use an
997 nntp server for your newsgroup and want to change the port number
998 used to 899, you would say something along these lines:
1000 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1002 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1003 "A file with only the name of the nntp server in it."
1008 ;; This function is used to check both the environment variable
1009 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
1010 ;; an nntp server name default.
1011 (defun gnus-getenv-nntpserver ()
1012 (or (getenv "NNTPSERVER")
1013 (and (file-readable-p gnus-nntpserver-file)
1015 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
1016 (insert-file-contents gnus-nntpserver-file)
1017 (let ((name (buffer-string)))
1019 (if (string-match "\\'[ \t\n]*$" name)
1022 (kill-buffer (current-buffer))))))))
1024 (defcustom gnus-select-method
1027 (list 'nntp (or (condition-case nil
1028 (gnus-getenv-nntpserver)
1030 (when (and gnus-default-nntp-server
1031 (not (string= gnus-default-nntp-server "")))
1032 gnus-default-nntp-server)
1034 (if (or (null gnus-nntp-service)
1035 (equal gnus-nntp-service "nntp"))
1037 (list gnus-nntp-service)))
1039 "Default method for selecting a newsgroup.
1040 This variable should be a list, where the first element is how the
1041 news is to be fetched, the second is the address.
1043 For instance, if you want to get your news via NNTP from
1044 \"flab.flab.edu\", you could say:
1046 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1048 If you want to use your local spool, say:
1050 \(setq gnus-select-method (list 'nnspool (system-name)))
1052 If you use this variable, you must set `gnus-nntp-server' to nil.
1054 There is a lot more to know about select methods and virtual servers -
1055 see the manual for details."
1057 :type 'gnus-select-method)
1059 (defcustom gnus-message-archive-method
1061 ;; Don't require it at top level to avoid circularity.
1065 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
1066 (nnfolder-active-file
1067 ,(nnheader-concat message-directory "archive/active"))
1068 (nnfolder-get-new-mail nil)
1069 (nnfolder-inhibit-expiry t)))
1070 "*Method used for archiving messages you've sent.
1071 This should be a mail method.
1073 It's probably not very effective to change this variable once you've
1074 run Gnus once. After doing that, you must edit this server from the
1077 :group 'gnus-message
1078 :type 'gnus-select-method)
1080 (defcustom gnus-message-archive-group nil
1081 "*Name of the group in which to save the messages you've written.
1082 This can either be a string; a list of strings; or an alist
1083 of regexps/functions/forms to be evaluated to return a string (or a list
1084 of strings). The functions are called with the name of the current
1085 group (or nil) as a parameter.
1087 If you want to save your mail in one group and the news articles you
1088 write in another group, you could say something like:
1090 \(setq gnus-message-archive-group
1091 '((if (message-news-p)
1095 Normally the group names returned by this variable should be
1096 unprefixed -- which implicitly means \"store on the archive server\".
1097 However, you may wish to store the message on some other server. In
1098 that case, just return a fully prefixed name of the group --
1099 \"nnml+private:mail.misc\", for instance."
1100 :group 'gnus-message
1101 :type '(choice (const :tag "none" nil)
1106 (defcustom gnus-secondary-servers nil
1107 "List of NNTP servers that the user can choose between interactively.
1108 To make Gnus query you for a server, you have to give `gnus' a
1109 non-numeric prefix - `C-u M-x gnus', in short."
1111 :type '(repeat string))
1113 (defcustom gnus-nntp-server nil
1114 "*The name of the host running the NNTP server.
1115 This variable is semi-obsolete. Use the `gnus-select-method'
1118 :type '(choice (const :tag "disable" nil)
1121 (defcustom gnus-secondary-select-methods nil
1122 "A list of secondary methods that will be used for reading news.
1123 This is a list where each element is a complete select method (see
1124 `gnus-select-method').
1126 If, for instance, you want to read your mail with the nnml backend,
1127 you could set this variable:
1129 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1131 :type '(repeat gnus-select-method))
1133 (defvar gnus-backup-default-subscribed-newsgroups
1134 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1135 "Default default new newsgroups the first time Gnus is run.
1136 Should be set in paths.el, and shouldn't be touched by the user.")
1138 (defcustom gnus-local-domain nil
1139 "Local domain name without a host name.
1140 The DOMAINNAME environment variable is used instead if it is defined.
1141 If the `system-name' function returns the full Internet name, there is
1142 no need to set this variable."
1143 :group 'gnus-message
1144 :type '(choice (const :tag "default" nil)
1147 (defvar gnus-local-organization nil
1148 "String with a description of what organization (if any) the user belongs to.
1149 Obsolete variable; use `message-user-organization' instead.")
1151 ;; Customization variables
1153 (defcustom gnus-refer-article-method nil
1154 "Preferred method for fetching an article by Message-ID.
1155 If you are reading news from the local spool (with nnspool), fetching
1156 articles by Message-ID is painfully slow. By setting this method to an
1157 nntp method, you might get acceptable results.
1159 The value of this variable must be a valid select method as discussed
1160 in the documentation of `gnus-select-method'.
1162 It can also be a list of select methods, as well as the special symbol
1163 `current', which means to use the current select method. If it is a
1164 list, Gnus will try all the methods in the list until it finds a match."
1166 :type '(choice (const :tag "default" nil)
1167 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1169 (repeat :menu-tag "Try multiple"
1171 :value (current (nnweb "refer" (nnweb-type dejanews)))
1172 (choice :tag "Method"
1174 (const :tag "DejaNews"
1175 (nnweb "refer" (nnweb-type dejanews)))
1176 gnus-select-method))))
1178 (defcustom gnus-group-faq-directory
1179 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1180 "/ftp@sunsite.auc.dk:/pub/usenet/"
1181 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1182 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1183 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1184 "/ftp@rtfm.mit.edu:/pub/usenet/"
1185 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1186 "/ftp@ftp.sunet.se:/pub/usenet/"
1187 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1188 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1189 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1190 "*Directory where the group FAQs are stored.
1191 This will most commonly be on a remote machine, and the file will be
1192 fetched by ange-ftp.
1194 This variable can also be a list of directories. In that case, the
1195 first element in the list will be used by default. The others can
1196 be used when being prompted for a site.
1198 Note that Gnus uses an aol machine as the default directory. If this
1199 feels fundamentally unclean, just think of it as a way to finally get
1200 something of value back from them.
1202 If the default site is too slow, try one of these:
1204 North America: mirrors.aol.com /pub/rtfm/usenet
1205 ftp.seas.gwu.edu /pub/rtfm
1206 rtfm.mit.edu /pub/usenet
1207 Europe: ftp.uni-paderborn.de /pub/FAQ
1208 src.doc.ic.ac.uk /usenet/news-FAQS
1209 ftp.sunet.se /pub/usenet
1210 sunsite.auc.dk /pub/usenet
1211 Asia: nctuccca.edu.tw /USENET/FAQ
1212 hwarang.postech.ac.kr /pub/usenet
1213 ftp.hk.super.net /mirror/faqs"
1214 :group 'gnus-group-various
1215 :type '(choice directory
1216 (repeat directory)))
1218 (defcustom gnus-use-cross-reference t
1219 "*Non-nil means that cross referenced articles will be marked as read.
1220 If nil, ignore cross references. If t, mark articles as read in
1221 subscribed newsgroups. If neither t nor nil, mark as read in all
1224 :type '(choice (const :tag "off" nil)
1225 (const :tag "subscribed" t)
1229 (defcustom gnus-process-mark ?#
1231 :group 'gnus-group-visual
1232 :group 'gnus-summary-marks
1235 (defcustom gnus-large-newsgroup 200
1236 "*The number of articles which indicates a large newsgroup.
1237 If the number of articles in a newsgroup is greater than this value,
1238 confirmation is required for selecting the newsgroup."
1239 :group 'gnus-group-select
1242 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1243 "*Non-nil means that the default name of a file to save articles in is the group name.
1244 If it's nil, the directory form of the group name is used instead.
1246 If this variable is a list, and the list contains the element
1247 `not-score', long file names will not be used for score files; if it
1248 contains the element `not-save', long file names will not be used for
1249 saving; and if it contains the element `not-kill', long file names
1250 will not be used for kill files.
1252 Note that the default for this variable varies according to what system
1253 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1254 to nil while on all other systems it defaults to t."
1258 (defcustom gnus-kill-files-directory gnus-directory
1259 "*Name of the directory where kill files will be stored (default \"~/News\")."
1260 :group 'gnus-score-files
1261 :group 'gnus-score-kill
1264 (defcustom gnus-save-score nil
1265 "*If non-nil, save group scoring info."
1266 :group 'gnus-score-various
1270 (defcustom gnus-use-undo t
1271 "*If non-nil, allow undoing in Gnus group mode buffers."
1275 (defcustom gnus-use-adaptive-scoring nil
1276 "*If non-nil, use some adaptive scoring scheme.
1277 If a list, then the values `word' and `line' are meaningful. The
1278 former will perform adaption on individual words in the subject
1279 header while `line' will perform adaption on several headers."
1281 :group 'gnus-score-adapt
1282 :type '(set (const word) (const line)))
1284 (defcustom gnus-use-cache 'passive
1285 "*If nil, Gnus will ignore the article cache.
1286 If `passive', it will allow entering (and reading) articles
1287 explicitly entered into the cache. If anything else, use the
1288 cache to the full extent of the law."
1291 :type '(choice (const :tag "off" nil)
1292 (const :tag "passive" passive)
1293 (const :tag "active" t)))
1295 (defcustom gnus-use-trees nil
1296 "*If non-nil, display a thread tree buffer."
1300 (defcustom gnus-use-grouplens nil
1301 "*If non-nil, use GroupLens ratings."
1305 (defcustom gnus-keep-backlog nil
1306 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1307 If it is a number N, then Gnus will only keep the last N articles
1308 read. If it is neither nil nor a number, Gnus will keep all read
1309 articles. This is not a good idea."
1311 :type '(choice (const :tag "off" nil)
1316 (defcustom gnus-use-nocem nil
1317 "*If non-nil, Gnus will read NoCeM cancel messages."
1321 (defcustom gnus-suppress-duplicates nil
1322 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1326 (defcustom gnus-use-scoring t
1327 "*If non-nil, enable scoring."
1331 (defcustom gnus-use-picons nil
1332 "*If non-nil, display picons in a frame of their own."
1336 (defcustom gnus-summary-prepare-exit-hook
1337 '(gnus-summary-expire-articles)
1338 "*A hook called when preparing to exit from the summary buffer.
1339 It calls `gnus-summary-expire-articles' by default."
1340 :group 'gnus-summary-exit
1343 (defcustom gnus-novice-user t
1344 "*Non-nil means that you are a usenet novice.
1345 If non-nil, verbose messages may be displayed and confirmations may be
1350 (defcustom gnus-expert-user nil
1351 "*Non-nil means that you will never be asked for confirmation about anything.
1352 That doesn't mean *anything* anything; particularly destructive
1353 commands will still require prompting."
1357 (defcustom gnus-interactive-catchup t
1358 "*If non-nil, require your confirmation when catching up a group."
1359 :group 'gnus-group-select
1362 (defcustom gnus-interactive-exit t
1363 "*If non-nil, require your confirmation when exiting Gnus."
1367 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1368 "*Function for extracting address components from a From header.
1369 Two pre-defined function exist: `gnus-extract-address-components',
1370 which is the default, quite fast, and too simplistic solution, and
1371 `mail-extract-address-components', which works much better, but is
1373 :group 'gnus-summary-format
1374 :type '(radio (function-item gnus-extract-address-components)
1375 (function-item mail-extract-address-components)
1376 (function-item std11-extract-address-components)
1377 (function :tag "Other")))
1379 (defcustom gnus-carpal nil
1380 "*If non-nil, display clickable icons."
1384 (defcustom gnus-shell-command-separator ";"
1385 "String used to separate to shell commands."
1389 (defcustom gnus-valid-select-methods
1390 '(("nntp" post address prompt-address physical-address)
1391 ("nnspool" post address)
1392 ("nnvirtual" post-mail virtual prompt-address)
1393 ("nnmbox" mail respool address)
1394 ("nnml" mail respool address)
1395 ("nnmh" mail respool address)
1396 ("nndir" post-mail prompt-address physical-address)
1397 ("nneething" none address prompt-address physical-address)
1398 ("nndoc" none address prompt-address)
1399 ("nnbabyl" mail address respool)
1400 ("nnkiboze" post virtual)
1401 ("nnsoup" post-mail address)
1402 ("nndraft" post-mail)
1403 ("nnfolder" mail respool address)
1404 ("nngateway" post-mail address prompt-address physical-address)
1411 ("nnagent" post-mail)
1412 ("nnimap" post-mail address prompt-address physical-address))
1413 "*An alist of valid select methods.
1414 The first element of each list lists should be a string with the name
1415 of the select method. The other elements may be the category of
1416 this method (i. e., `post', `mail', `none' or whatever) or other
1417 properties that this method has (like being respoolable).
1418 If you implement a new select method, all you should have to change is
1419 this variable. I think."
1421 :type '(repeat (group (string :tag "Name")
1422 (radio-button-choice (const :format "%v " post)
1423 (const :format "%v " mail)
1424 (const :format "%v " none)
1426 (checklist :inline t
1427 (const :format "%v " address)
1428 (const :format "%v " prompt-address)
1429 (const :format "%v " physical-address)
1430 (const :format "%v " virtual)
1433 (defun gnus-redefine-select-method-widget ()
1434 "Recomputes the select-method widget based on the value of
1435 `gnus-valid-select-methods'."
1436 (define-widget 'gnus-select-method 'list
1437 "Widget for entering a select method."
1439 :tag "Select Method"
1440 :args `((choice :tag "Method"
1441 ,@(mapcar (lambda (entry)
1442 (list 'const :format "%v\n"
1443 (intern (car entry))))
1444 gnus-valid-select-methods)
1445 (symbol :tag "other"))
1446 (string :tag "Address")
1447 (repeat :tag "Options"
1451 (sexp :tag "Value"))))))
1453 (gnus-redefine-select-method-widget)
1455 (defcustom gnus-updated-mode-lines '(group article summary tree)
1456 "List of buffers that should update their mode lines.
1457 The list may contain the symbols `group', `article', `tree' and
1458 `summary'. If the corresponding symbol is present, Gnus will keep
1459 that mode line updated with information that may be pertinent.
1460 If this variable is nil, screen refresh may be quicker."
1461 :group 'gnus-various
1462 :type '(set (const group)
1467 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1468 (defcustom gnus-mode-non-string-length nil
1469 "*Max length of mode-line non-string contents.
1470 If this is nil, Gnus will take space as is needed, leaving the rest
1471 of the modeline intact. Note that the default of nil is unlikely
1472 to be desirable; see the manual for further details."
1473 :group 'gnus-various
1474 :type '(choice (const nil)
1477 (gnus-define-group-parameter
1480 :function gnus-group-auto-expirable-p
1482 "Check whether GROUP is auto-expirable or not."
1483 :variable gnus-auto-expirable-newsgroups
1484 :variable-default nil
1486 "*Groups in which to automatically mark read articles as expirable.
1487 If non-nil, this should be a regexp that should match all groups in
1488 which to perform auto-expiry. This only makes sense for mail groups."
1489 :variable-group nnmail-expire
1490 :variable-type '(choice (const nil)
1492 :parameter-type '(const :tag "Automatic Expire" t)
1494 "All articles that are read will be marked as expirable.")
1496 (gnus-define-group-parameter
1499 :function gnus-group-total-expirable-p
1501 "Check whether GROUP is total-expirable or not."
1502 :variable gnus-total-expirable-newsgroups
1503 :variable-default nil
1505 "*Groups in which to perform expiry of all read articles.
1506 Use with extreme caution. All groups that match this regexp will be
1507 expiring - which means that all read articles will be deleted after
1508 \(say) one week. (This only goes for mail groups and the like, of
1510 :variable-group nnmail-expire
1511 :variable-type '(choice (const nil)
1513 :parameter-type '(const :tag "Total Expire" t)
1515 "All read articles will be put through the expiry process
1517 This happens even if they are not marked as expirable.
1520 (defcustom gnus-group-uncollapsed-levels 1
1521 "Number of group name elements to leave alone when making a short group name."
1522 :group 'gnus-group-visual
1525 (defcustom gnus-group-use-permanent-levels nil
1526 "*If non-nil, once you set a level, Gnus will use this level."
1527 :group 'gnus-group-levels
1532 (defcustom gnus-load-hook nil
1533 "A hook run while Gnus is loaded."
1537 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1538 "A hook called to apply kill files to a group.
1539 This hook is intended to apply a kill file to the selected newsgroup.
1540 The function `gnus-apply-kill-file' is called by default.
1542 Since a general kill file is too heavy to use only for a few
1543 newsgroups, I recommend you to use a lighter hook function. For
1544 example, if you'd like to apply a kill file to articles which contains
1545 a string `rmgroup' in subject in newsgroup `control', you can use the
1548 (setq gnus-apply-kill-hook
1551 (cond ((string-match \"control\" gnus-newsgroup-name)
1552 (gnus-kill \"Subject\" \"rmgroup\")
1553 (gnus-expunge \"X\"))))))"
1554 :group 'gnus-score-kill
1555 :options '(gnus-apply-kill-file)
1558 (defcustom gnus-group-change-level-function nil
1559 "Function run when a group level is changed.
1560 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1561 :group 'gnus-group-levels
1566 (defcustom gnus-visual
1567 '(summary-highlight group-highlight article-highlight
1569 summary-menu group-menu article-menu
1570 tree-highlight menu highlight
1571 browse-menu server-menu
1572 page-marker tree-menu binary-menu pick-menu
1574 "*Enable visual features.
1575 If `visual' is disabled, there will be no menus and few faces. Most of
1576 the visual customization options below will be ignored. Gnus will use
1577 less space and be faster as a result.
1579 This variable can also be a list of visual elements to switch on. For
1580 instance, to switch off all visual things except menus, you can say:
1582 (setq gnus-visual '(menu))
1584 Valid elements include `summary-highlight', `group-highlight',
1585 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1586 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1587 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1588 and `grouplens-menu'."
1591 :type '(set (const summary-highlight)
1592 (const group-highlight)
1593 (const article-highlight)
1595 (const summary-menu)
1597 (const article-menu)
1598 (const tree-highlight)
1607 (const grouplens-menu)))
1609 (defcustom gnus-mouse-face
1611 (if (gnus-visual-p 'mouse-face 'highlight)
1612 (if (boundp 'gnus-mouse-face)
1613 (or gnus-mouse-face 'highlight)
1617 "*Face used for group or summary buffer mouse highlighting.
1618 The line beneath the mouse pointer will be highlighted with this
1623 (defcustom gnus-article-save-directory gnus-directory
1624 "*Name of the directory articles will be saved in (default \"~/News\")."
1625 :group 'gnus-article-saving
1628 (defvar gnus-plugged t
1629 "Whether Gnus is plugged or not.")
1631 (defcustom gnus-default-charset 'iso-8859-1
1632 "Default charset assumed to be used when viewing non-ASCII characters.
1633 This variable is overridden on a group-to-group basis by the
1634 gnus-group-charset-alist variable and is only used on groups not
1635 covered by that variable."
1637 :group 'gnus-charset)
1639 (defcustom gnus-default-posting-charset nil
1640 "Default charset assumed to be used when posting non-ASCII characters.
1641 This variable is overridden on a group-to-group basis by the
1642 gnus-group-posting-charset-alist variable and is only used on groups not
1643 covered by that variable.
1644 If nil, no default charset is assumed when posting."
1646 :group 'gnus-charset)
1649 ;;; Internal variables
1651 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1652 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1653 (defvar gnus-draft-meta-information-header "X-Draft-From")
1654 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1655 (defvar gnus-original-article-buffer " *Original Article*")
1656 (defvar gnus-newsgroup-name nil)
1657 (defvar gnus-ephemeral-servers nil)
1659 (defvar gnus-agent nil
1660 "Whether we want to use the Gnus agent or not.")
1662 (defvar gnus-agent-fetching nil
1663 "Whether Gnus agent is in fetching mode.")
1665 (defvar gnus-command-method nil
1666 "Dynamically bound variable that says what the current backend is.")
1668 (defvar gnus-current-select-method nil
1669 "The current method for selecting a newsgroup.")
1671 (defvar gnus-tree-buffer "*Tree*"
1672 "Buffer where Gnus thread trees are displayed.")
1675 (defvar gnus-use-generic-from nil)
1677 ;; Variable holding the user answers to all method prompts.
1678 (defvar gnus-method-history nil)
1680 ;; Variable holding the user answers to all mail method prompts.
1681 (defvar gnus-mail-method-history nil)
1683 ;; Variable holding the user answers to all group prompts.
1684 (defvar gnus-group-history nil)
1686 (defvar gnus-server-alist nil
1687 "List of available servers.")
1689 (defcustom gnus-cache-directory
1690 (nnheader-concat gnus-directory "cache/")
1691 "*The directory where cached articles will be stored."
1695 (defvar gnus-predefined-server-alist
1698 (nnspool-spool-directory ,gnus-cache-directory)
1699 (nnspool-nov-directory ,gnus-cache-directory)
1700 (nnspool-active-file
1701 ,(nnheader-concat gnus-cache-directory "active"))))
1702 "List of predefined (convenience) servers.")
1704 (defvar gnus-topic-indentation "");; Obsolete variable.
1706 (defconst gnus-article-mark-lists
1707 '((marked . tick) (replied . reply)
1708 (expirable . expire) (killed . killed)
1709 (bookmarks . bookmark) (dormant . dormant)
1710 (scored . score) (saved . save)
1711 (cached . cache) (downloadable . download)
1712 (unsendable . unsend)))
1714 (defvar gnus-headers-retrieved-by nil)
1715 (defvar gnus-article-reply nil)
1716 (defvar gnus-override-method nil)
1717 (defvar gnus-article-check-size nil)
1718 (defvar gnus-opened-servers nil)
1720 (defvar gnus-current-kill-article nil)
1722 (defvar gnus-have-read-active-file nil)
1724 (defconst gnus-maintainer
1725 "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
1726 "The mail address of the T-gnus maintainers.")
1728 (defcustom gnus-info-filename nil
1729 "*Controls language of gnus Info.
1730 If nil and current-language-environment is Japanese, go to gnus-ja.
1731 Otherwise go to corresponding Info.
1732 This variable can be nil, gnus or gnus-ja."
1734 :type '(choice (const nil)
1735 (const :tag "English" gnus)
1736 (const :tag "Japanese" gnus-ja)))
1738 (defvar gnus-info-nodes
1739 '((gnus-group-mode "The Group Buffer")
1740 (gnus-summary-mode "The Summary Buffer")
1741 (gnus-article-mode "The Article Buffer")
1742 (gnus-server-mode "The Server Buffer")
1743 (gnus-browse-mode "Browse Foreign Server")
1744 (gnus-tree-mode "Tree Display"))
1745 "Alist of major modes and related Info nodes.")
1747 (defvar gnus-group-buffer "*Group*")
1748 (defvar gnus-summary-buffer "*Summary*")
1749 (defvar gnus-article-buffer "*Article*")
1750 (defvar gnus-server-buffer "*Server*")
1752 (defvar gnus-slave nil
1753 "Whether this Gnus is a slave or not.")
1755 (defvar gnus-batch-mode nil
1756 "Whether this Gnus is running in batch mode or not.")
1758 (defvar gnus-variable-list
1759 '(gnus-newsrc-options gnus-newsrc-options-n
1760 gnus-newsrc-last-checked-date
1761 gnus-newsrc-alist gnus-server-alist
1762 gnus-killed-list gnus-zombie-list
1763 gnus-topic-topology gnus-topic-alist)
1764 "Gnus variables saved in the quick startup file.")
1766 (defvar gnus-product-variable-file-list
1767 (let ((version (product-version (product-find 'gnus-vers)))
1768 (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1769 `(("strict-cache" ((product-version ,version) (emacs-version))
1771 gnus-format-specs-compiled)
1772 ("cache" ((product-version ,version) (emacs-version))
1774 gnus-format-specs)))
1775 "Gnus variables are saved in the produce depend quick startup files.")
1777 (defcustom gnus-compile-user-specs t
1778 "If non-nil, the user-defined format specs will be byte-compiled
1780 It has an effect on the values of `gnus-*-line-format-spec'."
1784 (defvar gnus-newsrc-alist nil
1785 "Assoc list of read articles.
1786 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1788 (defvar gnus-newsrc-hashtb nil
1789 "Hashtable of gnus-newsrc-alist.")
1791 (defvar gnus-killed-list nil
1792 "List of killed newsgroups.")
1794 (defvar gnus-killed-hashtb nil
1795 "Hash table equivalent of gnus-killed-list.")
1797 (defvar gnus-zombie-list nil
1798 "List of almost dead newsgroups.")
1800 (defvar gnus-description-hashtb nil
1801 "Descriptions of newsgroups.")
1803 (defvar gnus-list-of-killed-groups nil
1804 "List of newsgroups that have recently been killed by the user.")
1806 (defvar gnus-active-hashtb nil
1807 "Hashtable of active articles.")
1809 (defvar gnus-moderated-hashtb nil
1810 "Hashtable of moderated newsgroups.")
1812 ;; Save window configuration.
1813 (defvar gnus-prev-winconf nil)
1815 (defvar gnus-reffed-article-number nil)
1817 ;;; Let the byte-compiler know that we know about this variable.
1818 (defvar rmail-default-rmail-file)
1820 (defvar gnus-dead-summary nil)
1822 (defvar gnus-article-display-hook nil
1823 "Controls how the article buffer will look. This is an obsolete variable;
1824 use the article treating faculties instead. Is is described in Info node
1825 `Customizing Articles'.")
1827 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1828 "Regexp matching invalid groups.")
1830 ;;; End of variables.
1832 ;; Define some autoload functions Gnus might use.
1835 ;; This little mapcar goes through the list below and marks the
1836 ;; symbols in question as autoloaded functions.
1839 (let ((interactive (nth 1 (memq ':interactive package))))
1843 (when (consp function)
1844 (setq keymap (car (memq 'keymap function)))
1845 (setq function (car function)))
1846 (unless (fboundp function)
1847 (autoload function (car package) nil interactive keymap))))
1848 (if (eq (nth 1 package) ':interactive)
1851 '(("info" :interactive t Info-goto-node)
1853 ("ps-print" ps-print-preprint)
1854 ("message" :interactive t
1855 message-send-and-exit message-yank-original)
1856 ("babel" babel-as-string)
1857 ("nnmail" nnmail-split-fancy nnmail-article-group)
1858 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1859 ("rmailout" rmail-output rmail-output-to-rmail-file)
1860 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1861 rmail-show-message rmail-summary-exists
1862 rmail-select-summary rmail-update-summary)
1863 ("gnus-audio" :interactive t gnus-audio-play)
1864 ("gnus-xmas" gnus-xmas-splash)
1865 ("gnus-soup" :interactive t
1866 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1867 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1868 ("nnsoup" nnsoup-pack-replies)
1869 ("score-mode" :interactive t gnus-score-mode)
1870 ("gnus-mh" gnus-summary-save-article-folder
1871 gnus-Folder-save-name gnus-folder-save-name)
1872 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1873 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1874 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1875 gnus-demon-add-disconnection gnus-demon-add-handler
1876 gnus-demon-remove-handler)
1877 ("gnus-demon" :interactive t
1878 gnus-demon-init gnus-demon-cancel)
1879 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1880 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1881 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1882 gnus-nocem-unwanted-article-p)
1883 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1884 gnus-server-server-name)
1885 ("gnus-srvr" gnus-browse-foreign-server)
1886 ("gnus-cite" :interactive t
1887 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1888 gnus-article-hide-citation gnus-article-fill-cited-article
1889 gnus-article-hide-citation-in-followups)
1890 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1891 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1892 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1893 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1894 gnus-cache-possibly-remove-articles gnus-cache-request-article
1895 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1896 gnus-cache-enter-remove-article gnus-cached-article-p
1897 gnus-cache-open gnus-cache-close gnus-cache-update-article
1898 gnus-cache-articles-in-group)
1899 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1900 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1901 ("gnus-score" :interactive t
1902 gnus-summary-increase-score gnus-summary-set-score
1903 gnus-summary-raise-thread gnus-summary-raise-same-subject
1904 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1905 gnus-summary-lower-thread gnus-summary-lower-same-subject
1906 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1907 gnus-summary-current-score gnus-score-delta-default
1908 gnus-score-flush-cache gnus-score-close
1909 gnus-possibly-score-headers gnus-score-followup-article
1910 gnus-score-followup-thread)
1912 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1913 gnus-current-score-file-nondirectory gnus-score-adaptive
1914 gnus-score-find-trace gnus-score-file-name)
1915 ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
1916 gnus-score-customize)
1917 ("gnus-topic" :interactive t gnus-topic-mode)
1918 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1919 gnus-subscribe-topics)
1920 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1921 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1922 ("gnus-uu" :interactive t
1923 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1924 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1925 gnus-uu-mark-by-regexp gnus-uu-mark-all
1926 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1927 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1928 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1929 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1930 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1931 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1932 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1933 gnus-uu-mark-over gnus-uu-post-news)
1934 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1935 gnus-uu-unmark-thread)
1936 ("gnus-msg" (gnus-summary-send-map keymap)
1937 gnus-article-mail gnus-copy-article-buffer gnus-following-method)
1938 ("gnus-msg" :interactive t
1939 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1940 gnus-summary-followup gnus-summary-followup-with-original
1941 gnus-summary-cancel-article gnus-summary-supersede-article
1942 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1943 gnus-summary-mail-forward gnus-summary-mail-other-window
1944 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1945 gnus-summary-wide-reply gnus-summary-followup-to-mail
1946 gnus-summary-followup-to-mail-with-original gnus-bug
1947 gnus-summary-wide-reply-with-original
1948 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1949 gnus-summary-post-forward)
1950 ("gnus-picon" :interactive t gnus-article-display-picons
1951 gnus-group-display-picons)
1952 ("gnus-picon" gnus-picons-buffer-name)
1953 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1954 gnus-grouplens-mode)
1955 ("smiley" :interactive t gnus-smiley-display)
1956 ("smiley" smiley-toggle-buffer)
1957 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1958 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1959 gnus-list-of-unread-articles gnus-list-of-read-articles
1960 gnus-offer-save-summaries gnus-make-thread-indent-array
1961 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1962 gnus-summary-skip-intangible gnus-summary-article-number
1963 gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
1964 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1965 gnus-group-list-groups gnus-group-first-unread-group
1966 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1967 gnus-group-setup-buffer gnus-group-get-new-news
1968 gnus-group-make-help-group gnus-group-update-group
1969 gnus-group-iterate gnus-group-group-name)
1970 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1971 gnus-backlog-remove-article)
1972 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1973 gnus-article-prepare gnus-article-set-window-start
1974 gnus-article-next-page gnus-article-prev-page
1975 gnus-request-article-this-buffer gnus-article-mode
1976 gnus-article-setup-buffer gnus-narrow-to-page
1977 gnus-article-delete-invisible-text gnus-treat-article)
1978 ("gnus-art" :interactive t
1979 gnus-article-hide-headers gnus-article-hide-boring-headers
1980 gnus-article-treat-overstrike
1981 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1982 gnus-article-display-x-face
1983 gnus-article-decode-HZ
1984 gnus-article-wash-html
1985 gnus-article-hide-pgp
1986 gnus-article-hide-pem gnus-article-hide-signature
1987 gnus-article-strip-leading-blank-lines gnus-article-date-local
1988 gnus-article-date-original gnus-article-date-lapsed
1989 gnus-article-show-all-headers gnus-article-show-all
1990 gnus-article-edit-mode gnus-article-edit-article
1991 gnus-article-edit-done article-decode-encoded-words
1992 gnus-start-date-timer gnus-stop-date-timer
1993 gnus-article-toggle-headers)
1994 ("gnus-int" gnus-request-type)
1995 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1996 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1997 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1998 gnus-dup-enter-articles)
1999 ("gnus-range" gnus-copy-sequence)
2000 ("gnus-eform" gnus-edit-form)
2001 ("gnus-move" :interactive t
2002 gnus-group-move-group-to-server gnus-change-server)
2003 ("gnus-logic" gnus-score-advanced)
2004 ("gnus-undo" gnus-undo-mode gnus-undo-register)
2005 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2006 gnus-async-prefetch-article gnus-async-prefetch-remove-group
2007 gnus-async-halt-prefetch)
2010 ("gnus-offline" :interactive t
2011 gnus-offline-toggle-plugged
2012 gnus-offline-set-unplugged-state
2013 gnus-offline-toggle-auto-hangup
2014 gnus-offline-toggle-on/off-send-mail
2015 gnus-offline-toggle-articles-to-fetch
2016 gnus-offline-set-interval-time
2017 gnus-offline-agent-expire)
2018 ("miee" :interactive t gnspool-get-news
2019 mail-spool-send news-spool-post)
2020 ("international/mw32misc" define-process-argument-editing
2021 general-process-argument-editing-function)
2022 ("gnus-agent" gnus-open-agent gnus-agent-get-function
2023 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2024 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2025 gnus-summary-set-agent-mark gnus-agent-save-group-info)
2026 ("gnus-agent" :interactive t
2027 gnus-unplugged gnus-agentize gnus-agent-batch)
2028 ("gnus-vm" :interactive t gnus-summary-save-in-vm
2029 gnus-summary-save-article-vm)
2030 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
2031 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2032 ("gnus-mlspl" :interactive t gnus-group-split-setup
2033 gnus-group-split-update))))
2036 (unless (featurep 'xemacs)
2037 (autoload 'gnus-smiley-display "gnus-bitmap" nil t)
2038 (autoload 'smiley-toggle-buffer "gnus-bitmap")
2039 (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")
2040 (when (>= emacs-major-version 21)
2041 (autoload 'x-face-decode-message-header "x-face-e21"))))
2043 ;;; gnus-sum.el thingies
2046 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
2047 "*The format specification of the lines in the summary buffer.
2049 It works along the same lines as a normal formatting string,
2050 with some simple extensions.
2052 %N Article number, left padded with spaces (string)
2054 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
2055 %n Name of the poster (string)
2056 %a Extracted name of the poster (string)
2057 %A Extracted address of the poster (string)
2058 %F Contents of the From: header (string)
2059 %f Contents of the From: or To: headers (string)
2060 %x Contents of the Xref: header (string)
2061 %D Date of the article (string)
2062 %d Date of the article (string) in DD-MMM format
2063 %M Message-id of the article (string)
2064 %r References of the article (string)
2065 %c Number of characters in the article (integer)
2066 %L Number of lines in the article (integer)
2067 %I Indentation based on thread level (a string of spaces)
2068 %T A string with two possible values: 80 spaces if the article
2069 is on thread level two or larger and 0 spaces on level one
2070 %R \"A\" if this article has been replied to, \" \" otherwise (character)
2071 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2072 %[ Opening bracket (character, \"[\" or \"<\")
2073 %] Closing bracket (character, \"]\" or \">\")
2074 %> Spaces of length thread-level (string)
2075 %< Spaces of length (- 20 thread-level) (string)
2076 %i Article score (number)
2077 %z Article zcore (character)
2078 %t Number of articles under the current thread (number).
2079 %e Whether the thread is empty or not (character).
2080 %l GroupLens score (string).
2081 %V Total thread score (number).
2082 %P The line number (number).
2083 %O Download mark (character).
2084 %u User defined specifier. The next character in the format string should
2085 be a letter. Gnus will call the function gnus-user-format-function-X,
2086 where X is the letter following %u. The function will be passed the
2087 current header as argument. The function should return a string, which
2088 will be inserted into the summary just like information from any other
2091 Text between %( and %) will be highlighted with `gnus-mouse-face'
2092 when the mouse point is placed inside the area. There can only be one
2095 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2096 with care. For reasons of efficiency, Gnus will compute what column
2097 these characters will end up in, and \"hard-code\" that. This means that
2098 it is invalid to have these specs after a variable-length spec. Well,
2099 you might not be arrested, but your summary buffer will look strange,
2100 which is bad enough.
2102 The smart choice is to have these specs as for to the left as
2105 This restriction may disappear in later versions of Gnus."
2107 :group 'gnus-summary-format)
2110 ;;; Skeleton keymaps
2113 (defun gnus-suppress-keymap (keymap)
2114 (suppress-keymap keymap)
2115 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2117 (define-key keymap (pop keys) 'undefined))))
2119 (defvar gnus-article-mode-map
2120 (let ((keymap (make-sparse-keymap)))
2121 (gnus-suppress-keymap keymap)
2123 (defvar gnus-summary-mode-map
2124 (let ((keymap (make-keymap)))
2125 (gnus-suppress-keymap keymap)
2127 (defvar gnus-group-mode-map
2128 (let ((keymap (make-keymap)))
2129 (gnus-suppress-keymap keymap)
2134 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2135 ;; If you want the cursor to go somewhere else, set these two
2136 ;; functions in some startup hook to whatever you want.
2137 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2138 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2140 ;;; Various macros and substs.
2142 (defun gnus-header-from (header)
2143 (mail-header-from header))
2145 (defmacro gnus-gethash (string hashtable)
2146 "Get hash value of STRING in HASHTABLE."
2147 `(symbol-value (intern-soft ,string ,hashtable)))
2149 (defmacro gnus-sethash (string value hashtable)
2150 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2151 `(set (intern ,string ,hashtable) ,value))
2152 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2154 (defmacro gnus-group-unread (group)
2155 "Get the currently computed number of unread articles in GROUP."
2156 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2158 (defmacro gnus-group-entry (group)
2159 "Get the newsrc entry for GROUP."
2160 `(gnus-gethash ,group gnus-newsrc-hashtb))
2162 (defmacro gnus-active (group)
2163 "Get active info on GROUP."
2164 `(gnus-gethash ,group gnus-active-hashtb))
2166 (defmacro gnus-set-active (group active)
2167 "Set GROUP's active info."
2168 `(gnus-sethash ,group ,active gnus-active-hashtb))
2170 ;; Info access macros.
2172 (defmacro gnus-info-group (info)
2174 (defmacro gnus-info-rank (info)
2176 (defmacro gnus-info-read (info)
2178 (defmacro gnus-info-marks (info)
2180 (defmacro gnus-info-method (info)
2182 (defmacro gnus-info-params (info)
2185 (defmacro gnus-info-level (info)
2186 `(let ((rank (gnus-info-rank ,info)))
2190 (defmacro gnus-info-score (info)
2191 `(let ((rank (gnus-info-rank ,info)))
2192 (or (and (consp rank) (cdr rank)) 0)))
2194 (defmacro gnus-info-set-group (info group)
2195 `(setcar ,info ,group))
2196 (defmacro gnus-info-set-rank (info rank)
2197 `(setcar (nthcdr 1 ,info) ,rank))
2198 (defmacro gnus-info-set-read (info read)
2199 `(setcar (nthcdr 2 ,info) ,read))
2200 (defmacro gnus-info-set-marks (info marks &optional extend)
2202 `(gnus-info-set-entry ,info ,marks 3)
2203 `(setcar (nthcdr 3 ,info) ,marks)))
2204 (defmacro gnus-info-set-method (info method &optional extend)
2206 `(gnus-info-set-entry ,info ,method 4)
2207 `(setcar (nthcdr 4 ,info) ,method)))
2208 (defmacro gnus-info-set-params (info params &optional extend)
2210 `(gnus-info-set-entry ,info ,params 5)
2211 `(setcar (nthcdr 5 ,info) ,params)))
2213 (defun gnus-info-set-entry (info entry number)
2214 ;; Extend the info until we have enough elements.
2215 (while (<= (length info) number)
2216 (nconc info (list nil)))
2218 (setcar (nthcdr number info) entry))
2220 (defmacro gnus-info-set-level (info level)
2221 `(let ((rank (cdr ,info)))
2222 (if (consp (car rank))
2223 (setcar (car rank) ,level)
2224 (setcar rank ,level))))
2225 (defmacro gnus-info-set-score (info score)
2226 `(let ((rank (cdr ,info)))
2227 (if (consp (car rank))
2228 (setcdr (car rank) ,score)
2229 (setcar rank (cons (car rank) ,score)))))
2231 (defmacro gnus-get-info (group)
2232 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2234 ;; Byte-compiler warning.
2235 (defvar gnus-visual)
2236 ;; Find out whether the gnus-visual TYPE is wanted.
2237 (defun gnus-visual-p (&optional type class)
2238 (and gnus-visual ; Has to be non-nil, at least.
2239 (if (not type) ; We don't care about type.
2241 (if (listp gnus-visual) ; It's a list, so we check it.
2242 (or (memq type gnus-visual)
2243 (memq class gnus-visual))
2246 ;;; Load the compatability functions.
2255 (defvar gnus-shutdown-alist nil)
2257 (defun gnus-add-shutdown (function &rest symbols)
2258 "Run FUNCTION whenever one of SYMBOLS is shut down."
2259 (push (cons function symbols) gnus-shutdown-alist))
2261 (defun gnus-shutdown (symbol)
2262 "Shut down everything that waits for SYMBOL."
2263 (let ((alist gnus-shutdown-alist)
2265 (while (setq entry (pop alist))
2266 (when (memq symbol (cdr entry))
2267 (funcall (car entry))))))
2271 ;;; Gnus Utility Functions
2275 (defmacro gnus-string-or (&rest strings)
2276 "Return the first element of STRINGS that is a non-blank string.
2277 STRINGS will be evaluated in normal `or' order."
2278 `(gnus-string-or-1 ',strings))
2280 (defun gnus-string-or-1 (strings)
2283 (setq string (eval (pop strings)))
2284 (if (string-match "^[ \t]*$" string)
2286 (setq strings nil)))
2289 (defun gnus-info-find-node ()
2290 "Find Info documentation of Gnus."
2292 ;; Enlarge info window if needed.
2293 (let (gnus-info-buffer)
2296 (or gnus-info-filename
2297 (get-language-info current-language-environment 'gnus-info)
2299 (cadr (assq major-mode gnus-info-nodes))))
2300 (setq gnus-info-buffer (current-buffer))
2301 (gnus-configure-windows 'info)))
2304 ;;; gnus-interactive
2307 (defvar gnus-current-prefix-symbol nil
2308 "Current prefix symbol.")
2310 (defvar gnus-current-prefix-symbols nil
2311 "List of current prefix symbols.")
2313 (defun gnus-interactive (string &optional params)
2314 "Return a list that can be fed to `interactive'.
2315 See `interactive' for full documentation.
2317 Adds the following specs:
2319 y -- The current symbolic prefix.
2320 Y -- A list of the current symbolic prefix(es).
2321 A -- Article number.
2322 H -- Article header.
2326 (while (< i (length string))
2327 (string-match ".\\([^\n]*\\)\n?" string i)
2328 (setq c (aref string i))
2330 (setq prompt (match-string 1 string)))
2331 (setq i (match-end 0))
2332 ;; We basically emulate just about everything that
2333 ;; `interactive' does, but add the specs listed above.
2337 (completing-read prompt obarray 'fboundp t))
2339 (read-buffer prompt (current-buffer) t))
2341 (read-buffer prompt (other-buffer (current-buffer))))
2345 (completing-read prompt obarray 'commandp t))
2349 (read-file-name prompt nil default-directory 'lambda))
2351 (read-file-name prompt nil nil 'lambda))
2353 (read-file-name prompt))
2355 (read-key-sequence prompt))
2357 (error "Not implemented spec"))
2359 (error "Not implemented spec"))
2363 (error "Not implemented spec"))
2365 (string-to-number (read-from-minibuffer prompt)))
2367 (prefix-numeric-value current-prefix-arg))
2373 (read-string prompt))
2375 (intern (read-string prompt)))
2377 (read-variable prompt))
2379 (read-minibuffer prompt))
2381 (eval-minibuffer prompt))
2382 ;; And here the new specs come.
2384 gnus-current-prefix-symbol)
2386 gnus-current-prefix-symbols)
2388 (gnus-group-group-name))
2390 (gnus-summary-skip-intangible)
2391 (or (get-text-property (point) 'gnus-number)
2392 (gnus-summary-last-subject)))
2394 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2396 (error "Non-implemented spec")))
2400 (push (if (< (point) (mark) (point) (mark))) out)
2401 (push (if (> (point) (mark) (point) (mark))) out))))
2402 (setq out (delq 'gnus-prefix-nil out))
2405 (defun gnus-symbolic-argument (&optional arg)
2406 "Read a symbolic argument and a command, and then execute command."
2408 (let* ((in-command (this-command-keys))
2409 (command in-command)
2410 gnus-current-prefix-symbols
2411 gnus-current-prefix-symbol
2413 (while (equal in-command command)
2414 (message "%s-" (key-description (this-command-keys)))
2415 (push (intern (char-to-string (read-char))) syms)
2416 (setq command (read-key-sequence nil t)))
2417 (setq gnus-current-prefix-symbols (nreverse syms)
2418 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2419 (call-interactively (key-binding command t))))
2421 ;;; More various functions.
2423 (defsubst gnus-check-backend-function (func group)
2424 "Check whether GROUP supports function FUNC.
2425 GROUP can either be a string (a group name) or a select method."
2427 (let ((method (if (stringp group)
2428 (car (gnus-find-method-for-group group))
2430 (unless (featurep method)
2432 (fboundp (intern (format "%s-%s" method func))))))
2434 (defun gnus-group-read-only-p (&optional group)
2435 "Check whether GROUP supports editing or not.
2436 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2437 that that variable is buffer-local to the summary buffers."
2438 (let ((group (or group gnus-newsgroup-name)))
2439 (not (gnus-check-backend-function 'request-replace-article group))))
2441 (defun gnus-virtual-group-p (group)
2442 "Say whether GROUP is virtual or not."
2443 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2444 gnus-valid-select-methods)))
2446 (defun gnus-news-group-p (group &optional article)
2447 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2448 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2449 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2450 (if (or (null article)
2451 (not (< article 0)))
2452 (eq (gnus-request-type group article) 'news)
2453 (if (not (vectorp article))
2455 ;; It's a real article.
2456 (eq (gnus-request-type group (mail-header-id article))
2459 ;; Returns a list of writable groups.
2460 (defun gnus-writable-groups ()
2461 (let ((alist gnus-newsrc-alist)
2463 (while (setq group (car (pop alist)))
2464 (unless (gnus-group-read-only-p group)
2465 (push group groups)))
2468 ;; Check whether to use long file names.
2469 (defun gnus-use-long-file-name (symbol)
2470 ;; The variable has to be set...
2471 (and gnus-use-long-file-name
2472 ;; If it isn't a list, then we return t.
2473 (or (not (listp gnus-use-long-file-name))
2474 ;; If it is a list, and the list contains `symbol', we
2476 (not (memq symbol gnus-use-long-file-name)))))
2478 ;; Generate a unique new group name.
2479 (defun gnus-generate-new-group-name (leaf)
2482 (while (gnus-gethash name gnus-newsrc-hashtb)
2483 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2486 (defun gnus-ephemeral-group-p (group)
2487 "Say whether GROUP is ephemeral or not."
2488 (gnus-group-get-parameter group 'quit-config t))
2490 (defun gnus-group-quit-config (group)
2491 "Return the quit-config of GROUP."
2492 (gnus-group-get-parameter group 'quit-config t))
2494 (defun gnus-kill-ephemeral-group (group)
2495 "Remove ephemeral GROUP from relevant structures."
2496 (gnus-sethash group nil gnus-newsrc-hashtb))
2498 (defun gnus-simplify-mode-line ()
2499 "Make mode lines a bit simpler."
2500 (setq mode-line-modified (cdr gnus-mode-line-modified))
2501 (when (listp mode-line-format)
2502 (make-local-variable 'mode-line-format)
2503 (setq mode-line-format (copy-sequence mode-line-format))
2504 (when (equal (nth 3 mode-line-format) " ")
2505 (setcar (nthcdr 3 mode-line-format) " "))))
2507 ;;; Servers and groups.
2509 (defsubst gnus-server-add-address (method)
2510 (let ((method-name (symbol-name (car method))))
2511 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2512 (not (assq (intern (concat method-name "-address")) method))
2513 (memq 'physical-address (assq (car method)
2514 gnus-valid-select-methods)))
2515 (append method (list (list (intern (concat method-name "-address"))
2519 (defsubst gnus-server-get-method (group method)
2520 ;; Input either a server name, and extended server name, or a
2521 ;; select method, and return a select method.
2522 (cond ((stringp method)
2523 (gnus-server-to-method method))
2524 ((equal method gnus-select-method)
2526 ((and (stringp (car method))
2528 (gnus-server-extend-method group method))
2531 (equal (cadr method) ""))
2534 (gnus-server-add-address method))))
2536 (defun gnus-server-to-method (server)
2537 "Map virtual server names to select methods."
2539 ;; Is this a method, perhaps?
2540 (and server (listp server) server)
2541 ;; Perhaps this is the native server?
2542 (and (equal server "native") gnus-select-method)
2543 ;; It should be in the server alist.
2544 (cdr (assoc server gnus-server-alist))
2545 ;; It could be in the predefined server alist.
2546 (cdr (assoc server gnus-predefined-server-alist))
2547 ;; If not, we look through all the opened server
2548 ;; to see whether we can find it there.
2549 (let ((opened gnus-opened-servers))
2551 (not (equal server (format "%s:%s" (caaar opened)
2555 ;; It could be a named method, search all servers
2556 (let ((servers gnus-secondary-select-methods))
2558 (not (equal server (format "%s:%s" (caar servers)
2563 (defmacro gnus-method-equal (ss1 ss2)
2564 "Say whether two servers are equal."
2568 (and (= (length s1) (length s2))
2570 (while (and s1 (member (car s1) s2))
2574 (defun gnus-methods-equal-p (m1 m2)
2575 (let ((m1 (or m1 gnus-select-method))
2576 (m2 (or m2 gnus-select-method)))
2578 (and (eq (car m1) (car m2))
2579 (or (not (memq 'address (assoc (symbol-name (car m1))
2580 gnus-valid-select-methods)))
2581 (equal (nth 1 m1) (nth 1 m2)))))))
2583 (defun gnus-server-equal (m1 m2)
2584 "Say whether two methods are equal."
2585 (let ((m1 (cond ((null m1) gnus-select-method)
2586 ((stringp m1) (gnus-server-to-method m1))
2588 (m2 (cond ((null m2) gnus-select-method)
2589 ((stringp m2) (gnus-server-to-method m2))
2591 (gnus-method-equal m1 m2)))
2593 (defun gnus-servers-using-backend (backend)
2594 "Return a list of known servers using BACKEND."
2595 (let ((opened gnus-opened-servers)
2598 (when (eq backend (caaar opened))
2599 (push (caar opened) out))
2603 (defun gnus-archive-server-wanted-p ()
2604 "Say whether the user wants to use the archive server."
2606 ((or (not gnus-message-archive-method)
2607 (not gnus-message-archive-group))
2609 ((and gnus-message-archive-method gnus-message-archive-group)
2612 (let ((active (cadr (assq 'nnfolder-active-file
2613 gnus-message-archive-method))))
2615 (file-exists-p active))))))
2617 (defsubst gnus-method-to-server-name (method)
2619 (format "%s" (car method))
2621 (or (assoc (format "%s" (car method))
2622 (gnus-methods-using 'address))
2623 (gnus-server-equal method gnus-message-archive-method))
2625 (not (string= (nth 1 method) "")))
2626 (concat "+" (nth 1 method)))))
2628 (defun gnus-group-prefixed-name (group method)
2629 "Return the whole name from GROUP and METHOD."
2630 (and (stringp method) (setq method (gnus-server-to-method method)))
2631 (if (or (not method)
2632 (gnus-server-equal method "native"))
2634 (concat (gnus-method-to-server-name method) ":" group)))
2636 (defun gnus-group-real-prefix (group)
2637 "Return the prefix of the current group name."
2638 (if (string-match "^[^:]+:" group)
2639 (substring group 0 (match-end 0))
2642 (defun gnus-group-method (group)
2643 "Return the server or method used for selecting GROUP.
2644 You should probably use `gnus-find-method-for-group' instead."
2645 (let ((prefix (gnus-group-real-prefix group)))
2646 (if (equal prefix "")
2648 (let ((servers gnus-opened-servers)
2650 backend possible found)
2651 (if (string-match "^[^\\+]+\\+" prefix)
2652 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2653 server (substring prefix (match-end 0) (1- (length prefix))))
2654 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2656 (when (eq (caaar servers) backend)
2657 (setq possible (caar servers))
2658 (when (equal (cadaar servers) server)
2659 (setq found (caar servers))))
2661 (or (car (rassoc found gnus-server-alist))
2663 (car (rassoc possible gnus-server-alist))
2665 (list backend server))))))
2667 (defsubst gnus-native-method-p (method)
2668 "Return whether METHOD is the native select method."
2669 (gnus-method-equal method gnus-select-method))
2671 (defsubst gnus-secondary-method-p (method)
2672 "Return whether METHOD is a secondary select method."
2673 (let ((methods gnus-secondary-select-methods)
2674 (gmethod (gnus-server-get-method nil method)))
2676 (not (gnus-method-equal
2677 (gnus-server-get-method nil (car methods))
2679 (setq methods (cdr methods)))
2682 (defun gnus-method-simplify (method)
2683 "Return the shortest uniquely identifying string or method for METHOD."
2684 (cond ((stringp method)
2686 ((gnus-native-method-p method)
2688 ((gnus-secondary-method-p method)
2689 (format "%s:%s" (nth 0 method) (nth 1 method)))
2693 (defun gnus-groups-from-server (server)
2694 "Return a list of all groups that are fetched from SERVER."
2695 (let ((alist (cdr gnus-newsrc-alist))
2697 (while (setq info (pop alist))
2698 (when (gnus-server-equal (gnus-info-method info) server)
2699 (push (gnus-info-group info) groups)))
2700 (sort groups 'string<)))
2702 (defun gnus-group-foreign-p (group)
2703 "Say whether a group is foreign or not."
2704 (and (not (gnus-group-native-p group))
2705 (not (gnus-group-secondary-p group))))
2707 (defun gnus-group-native-p (group)
2708 "Say whether the group is native or not."
2709 (not (string-match ":" group)))
2711 (defun gnus-group-secondary-p (group)
2712 "Say whether the group is secondary or not."
2713 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2715 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2716 "Return the group parameters for GROUP.
2717 If SYMBOL, return the value of that symbol in the group parameters."
2719 (set-buffer gnus-group-buffer)
2720 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2722 (gnus-group-parameter-value parameters symbol allow-list)
2725 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2726 "Return the group parameters for GROUP.
2727 If SYMBOL, return the value of that symbol in the group parameters.
2728 Most functions should use `gnus-group-find-parameter', which
2729 also examines the topic parameters."
2730 (let ((params (gnus-info-params (gnus-get-info group))))
2732 (gnus-group-parameter-value params symbol allow-list)
2735 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2736 "Return the value of SYMBOL in group PARAMS."
2737 ;; We only wish to return group parameters (dotted lists) and
2738 ;; not local variables, which may have the same names.
2739 ;; But first we handle single elements...
2740 (or (car (memq symbol params))
2744 (while (setq elem (pop params))
2745 (when (and (consp elem)
2746 (eq (car elem) symbol)
2749 (throw 'found (cdr elem))))))))
2751 (defun gnus-group-add-parameter (group param)
2752 "Add parameter PARAM to GROUP."
2753 (let ((info (gnus-get-info group)))
2755 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2756 ;; Cons the new param to the old one and update.
2757 (gnus-group-set-info (cons param (gnus-info-params info))
2760 (defun gnus-group-set-parameter (group name value)
2761 "Set parameter NAME to VALUE in GROUP."
2762 (let ((info (gnus-get-info group)))
2764 (gnus-group-remove-parameter group name)
2765 (let ((old-params (gnus-info-params info))
2766 (new-params (list (cons name value))))
2768 (when (or (not (listp (car old-params)))
2769 (not (eq (caar old-params) name)))
2770 (setq new-params (append new-params (list (car old-params)))))
2771 (setq old-params (cdr old-params)))
2772 (gnus-group-set-info new-params group 'params)))))
2774 (defun gnus-group-remove-parameter (group name)
2775 "Remove parameter NAME from GROUP."
2776 (let ((info (gnus-get-info group)))
2778 (let ((params (gnus-info-params info)))
2780 (setq params (delq name params))
2781 (while (assq name params)
2782 (gnus-pull name params))
2783 (gnus-info-set-params info params))))))
2785 (defun gnus-group-add-score (group &optional score)
2786 "Add SCORE to the GROUP score.
2787 If SCORE is nil, add 1 to the score of GROUP."
2788 (let ((info (gnus-get-info group)))
2790 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2792 (defun gnus-short-group-name (group &optional levels)
2793 "Collapse GROUP name LEVELS.
2794 Select methods are stripped and any remote host name is stripped down to
2795 just the host name."
2801 gnus-group-uncollapsed-levels
2803 (while (string-match "\\." group skip)
2804 (setq skip (match-end 0)
2807 ;; Separate foreign select method from group name and collapse.
2808 ;; If method contains a server, collapse to non-domain server name,
2809 ;; otherwise collapse to select method.
2810 (let* ((colon (string-match ":" group))
2811 (server (and colon (substring group 0 colon)))
2812 (plus (and server (string-match "+" server))))
2815 (setq foreign (substring server (+ 1 plus)
2816 (string-match "\\." server))
2817 group (substring group (+ 1 colon)))
2818 (setq foreign server
2819 group (substring group (+ 1 colon))))
2820 (setq foreign (concat foreign ":")))
2821 ;; Collapse group name leaving LEVELS uncollapsed elements
2822 (let* ((slist (split-string group "/"))
2823 (slen (length slist))
2824 (dlist (split-string group "\\."))
2825 (dlen (length dlist))
2837 (setq levels (- glen levels))
2839 (push (if (>= (decf levels) 0)
2840 (if (zerop (length g))
2845 (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2847 (defun gnus-narrow-to-body ()
2848 "Narrow to the body of an article."
2851 (goto-char (point-min))
2852 (or (search-forward "\n\n" nil t)
2858 ;;; Kill file handling.
2861 (defun gnus-apply-kill-file ()
2862 "Apply a kill file to the current newsgroup.
2863 Returns the number of articles marked as read."
2864 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2865 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2866 (gnus-apply-kill-file-internal)
2869 (defun gnus-kill-save-kill-buffer ()
2870 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2871 (when (get-file-buffer file)
2873 (set-buffer (get-file-buffer file))
2874 (when (buffer-modified-p)
2876 (kill-buffer (current-buffer))))))
2878 (defcustom gnus-kill-file-name "KILL"
2879 "Suffix of the kill files."
2880 :group 'gnus-score-kill
2881 :group 'gnus-score-files
2884 (defun gnus-newsgroup-kill-file (newsgroup)
2885 "Return the name of a kill file name for NEWSGROUP.
2886 If NEWSGROUP is nil, return the global kill file name instead."
2888 ;; The global KILL file is placed at top of the directory.
2889 ((or (null newsgroup)
2890 (string-equal newsgroup ""))
2891 (expand-file-name gnus-kill-file-name
2892 gnus-kill-files-directory))
2893 ;; Append ".KILL" to newsgroup name.
2894 ((gnus-use-long-file-name 'not-kill)
2895 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2896 "." gnus-kill-file-name)
2897 gnus-kill-files-directory))
2898 ;; Place "KILL" under the hierarchical directory.
2900 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2901 "/" gnus-kill-file-name)
2902 gnus-kill-files-directory))))
2906 (defun gnus-member-of-valid (symbol group)
2907 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2909 (symbol-name (car (gnus-find-method-for-group group)))
2910 gnus-valid-select-methods)))
2912 (defun gnus-method-option-p (method option)
2913 "Return non-nil if select METHOD has OPTION as a parameter."
2914 (when (stringp method)
2915 (setq method (gnus-server-to-method method)))
2916 (memq option (assoc (format "%s" (car method))
2917 gnus-valid-select-methods)))
2919 (defun gnus-similar-server-opened (method)
2920 (let ((opened gnus-opened-servers))
2921 (while (and method opened)
2922 (when (and (equal (cadr method) (cadaar opened))
2923 (equal (car method) (caaar opened))
2924 (not (equal method (caar opened))))
2929 (defun gnus-server-extend-method (group method)
2930 ;; This function "extends" a virtual server. If the server is
2931 ;; "hello", and the select method is ("hello" (my-var "something"))
2932 ;; in the group "alt.alt", this will result in a new virtual server
2933 ;; called "hello+alt.alt".
2934 (if (or (not (inline (gnus-similar-server-opened method)))
2935 (not (cddr method)))
2937 `(,(car method) ,(concat (cadr method) "+" group)
2938 (,(intern (format "%s-address" (car method))) ,(cadr method))
2941 (defun gnus-server-status (method)
2942 "Return the status of METHOD."
2943 (nth 1 (assoc method gnus-opened-servers)))
2945 (defun gnus-group-name-to-method (group)
2946 "Guess a select method based on GROUP."
2947 (if (string-match ":" group)
2948 (let ((server (substring group 0 (match-beginning 0))))
2949 (if (string-match "\\+" server)
2950 (list (intern (substring server 0 (match-beginning 0)))
2951 (substring server (match-end 0)))
2952 (list (intern server) "")))
2953 gnus-select-method))
2955 (defun gnus-find-method-for-group (group &optional info)
2956 "Find the select method that GROUP uses."
2957 (or gnus-override-method
2960 (and (not (gnus-group-entry group));; a new group
2961 (gnus-group-name-to-method group))
2962 (let ((info (or info (gnus-get-info group)))
2965 (not (setq method (gnus-info-method info)))
2966 (equal method "native"))
2969 (cond ((stringp method)
2970 (inline (gnus-server-to-method method)))
2971 ((stringp (cadr method))
2972 (inline (gnus-server-extend-method group method)))
2975 (cond ((equal (cadr method) "")
2977 ((null (cadr method))
2978 (list (car method) ""))
2980 (gnus-server-add-address method)))))))
2982 (defun gnus-methods-using (feature)
2983 "Find all methods that have FEATURE."
2984 (let ((valids gnus-valid-select-methods)
2987 (when (memq feature (car valids))
2988 (push (car valids) outs))
2989 (setq valids (cdr valids)))
2992 (defun gnus-read-group (prompt &optional default)
2993 "Prompt the user for a group name.
2994 Disallow invalid group names."
2999 gnus-invalid-group-regexp
3000 (setq group (read-string (concat prefix prompt)
3001 (cons (or default "") 0)
3002 'gnus-group-history)))
3003 (setq prefix (format "Invalid group name: \"%s\". " group)
3007 (defun gnus-read-method (prompt)
3008 "Prompt the user for a method.
3009 Allow completion over sensible values."
3011 (append gnus-valid-select-methods
3012 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
3014 gnus-opened-servers)
3015 gnus-predefined-server-alist
3020 nil t nil 'gnus-method-history)))
3023 (setq method gnus-select-method))
3024 ((assoc method gnus-valid-select-methods)
3025 (let ((address (if (memq 'prompt-address
3026 (assoc method gnus-valid-select-methods))
3027 (read-string "Address: ")
3029 (or (let ((opened gnus-opened-servers))
3031 (not (equal (format "%s:%s" method address)
3032 (format "%s:%s" (caaar opened)
3036 (list (intern method) address))))
3037 ((assoc method servers)
3040 (list (intern method) "")))))
3042 ;;; User-level commands.
3045 (defun gnus-slave-no-server (&optional arg)
3046 "Read network news as a slave, without connecting to local server."
3048 (gnus-no-server arg t))
3051 (defun gnus-no-server (&optional arg slave)
3053 If ARG is a positive number, Gnus will use that as the
3054 startup level. If ARG is nil, Gnus will be started at level 2.
3055 If ARG is non-nil and not a positive number, Gnus will
3056 prompt the user for the name of an NNTP server to use.
3057 As opposed to `gnus', this command will not connect to the local server."
3059 (gnus-no-server-1 arg slave))
3062 (defun gnus-slave (&optional arg)
3063 "Read news as a slave."
3065 (gnus arg nil 'slave))
3067 (defcustom gnus-frame-properties nil
3068 "The properties of the frame in which gnus is displayed. Under XEmacs,
3069 the variable `toolbar-news-frame-plist' will be refered instead."
3070 :type '(repeat (cons :format "%v"
3071 (symbol :tag "Parameter")
3072 (sexp :tag "Value")))
3075 (defvar gnus-frame nil
3076 "The frame in which gnus is displayed. It is not used under XEmacs.")
3079 (defun gnus-other-frame (&optional arg)
3080 "Pop up a frame to read news."
3082 (static-if (featurep 'xemacs)
3083 (let ((toolbar-news-use-separate-frame t))
3085 (if (frame-live-p gnus-frame)
3086 (raise-frame gnus-frame)
3087 (setq gnus-frame (make-frame gnus-frame-properties))
3088 (if (and (gnus-buffer-live-p gnus-group-buffer)
3089 (save-current-buffer
3090 (set-buffer gnus-group-buffer)
3091 (eq 'gnus-group-mode major-mode)))
3093 (select-frame gnus-frame)
3094 (switch-to-buffer gnus-group-buffer))
3095 (add-hook 'gnus-exit-gnus-hook
3097 (when (and (frame-live-p gnus-frame)
3099 (delete-frame gnus-frame))
3100 (setq gnus-frame nil)))
3101 (select-frame gnus-frame)
3105 (defun gnus (&optional arg dont-connect slave)
3107 If ARG is non-nil and a positive number, Gnus will use that as the
3108 startup level. If ARG is non-nil and not a positive number, Gnus will
3109 prompt the user for the name of an NNTP server to use."
3111 (gnus-1 arg dont-connect slave))
3113 ;; Allow redefinition of Gnus functions.
3117 (product-provide (provide 'gnus) 'gnus-vers)
3119 ;;; gnus.el ends here