1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
4 ;; Free Software Foundation, Inc.
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;; Keywords: news, mail
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
31 (eval '(run-hooks 'gnus-load-hook))
33 (eval-when-compile (require 'cl))
39 (if (< emacs-major-version 20)
40 (require 'gnus-load)))
44 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
48 (defgroup gnus-charset nil
49 "Group character set issues."
50 :link '(custom-manual "(gnus)Charsets")
53 (defgroup gnus-cache nil
57 (defgroup gnus-start nil
58 "Starting your favorite newsreader."
61 (defgroup gnus-start-server nil
62 "Server options at startup."
65 ;; These belong to gnus-group.el.
66 (defgroup gnus-group nil
68 :link '(custom-manual "(gnus)The Group Buffer")
71 (defgroup gnus-group-foreign nil
73 :link '(custom-manual "(gnus)Foreign Groups")
76 (defgroup gnus-group-new nil
77 "Automatic subscription of new groups."
80 (defgroup gnus-group-levels nil
82 :link '(custom-manual "(gnus)Group Levels")
85 (defgroup gnus-group-select nil
87 :link '(custom-manual "(gnus)Selecting a Group")
90 (defgroup gnus-group-listing nil
91 "Showing slices of the group list."
92 :link '(custom-manual "(gnus)Listing Groups")
95 (defgroup gnus-group-visual nil
96 "Sorting the group buffer."
97 :link '(custom-manual "(gnus)Group Buffer Format")
101 (defgroup gnus-group-various nil
102 "Various group options."
103 :link '(custom-manual "(gnus)Scanning New Messages")
106 ;; These belong to gnus-sum.el.
107 (defgroup gnus-summary nil
109 :link '(custom-manual "(gnus)The Summary Buffer")
112 (defgroup gnus-summary-exit nil
113 "Leaving summary buffers."
114 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
115 :group 'gnus-summary)
117 (defgroup gnus-summary-marks nil
118 "Marks used in summary buffers."
119 :link '(custom-manual "(gnus)Marking Articles")
120 :group 'gnus-summary)
122 (defgroup gnus-thread nil
123 "Ordering articles according to replies."
124 :link '(custom-manual "(gnus)Threading")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-format nil
128 "Formatting of the summary buffer."
129 :link '(custom-manual "(gnus)Summary Buffer Format")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-choose nil
134 :link '(custom-manual "(gnus)Choosing Articles")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-maneuvering nil
138 "Summary movement commands."
139 :link '(custom-manual "(gnus)Summary Maneuvering")
140 :group 'gnus-summary)
142 (defgroup gnus-summary-mail nil
143 "Mail group commands."
144 :link '(custom-manual "(gnus)Mail Group Commands")
145 :group 'gnus-summary)
147 (defgroup gnus-summary-sort nil
148 "Sorting the summary buffer."
149 :link '(custom-manual "(gnus)Sorting")
150 :group 'gnus-summary)
152 (defgroup gnus-summary-visual nil
153 "Highlighting and menus in the summary buffer."
154 :link '(custom-manual "(gnus)Summary Highlighting")
156 :group 'gnus-summary)
158 (defgroup gnus-summary-various nil
159 "Various summary buffer options."
160 :link '(custom-manual "(gnus)Various Summary Stuff")
161 :group 'gnus-summary)
163 (defgroup gnus-summary-pick nil
164 "Pick mode in the summary buffer."
165 :link '(custom-manual "(gnus)Pick and Read")
167 :group 'gnus-summary)
169 (defgroup gnus-summary-tree nil
170 "Tree display of threads in the summary buffer."
171 :link '(custom-manual "(gnus)Tree Display")
173 :group 'gnus-summary)
175 ;; Belongs to gnus-uu.el
176 (defgroup gnus-extract-view nil
177 "Viewing extracted files."
178 :link '(custom-manual "(gnus)Viewing Files")
179 :group 'gnus-extract)
181 ;; Belongs to gnus-score.el
182 (defgroup gnus-score nil
183 "Score and kill file handling."
186 (defgroup gnus-score-kill nil
190 (defgroup gnus-score-adapt nil
191 "Adaptive score files."
194 (defgroup gnus-score-default nil
195 "Default values for score files."
198 (defgroup gnus-score-expire nil
199 "Expiring score rules."
202 (defgroup gnus-score-decay nil
203 "Decaying score rules."
206 (defgroup gnus-score-files nil
207 "Score and kill file names."
211 (defgroup gnus-score-various nil
212 "Various scoring and killing options."
216 (defgroup gnus-visual nil
217 "Options controling the visual fluff."
221 (defgroup gnus-agent nil
222 "Offline support for Gnus."
225 (defgroup gnus-files nil
226 "Files used by Gnus."
229 (defgroup gnus-dribble-file nil
231 :link '(custom-manual "(gnus)Auto Save")
234 (defgroup gnus-newsrc nil
235 "Storing Gnus state."
238 (defgroup gnus-server nil
239 "Options related to newsservers and other servers used by Gnus."
242 (defgroup gnus-message '((message custom-group))
243 "Composing replies and followups in Gnus."
246 (defgroup gnus-meta nil
247 "Meta variables controling major portions of Gnus.
248 In general, modifying these variables does not take affect until Gnus
249 is restarted, and sometimes reloaded."
252 (defgroup gnus-various nil
253 "Other Gnus options."
254 :link '(custom-manual "(gnus)Various Various")
257 (defgroup gnus-mime nil
258 "Variables for controlling the Gnus MIME interface."
261 (defgroup gnus-exit nil
263 :link '(custom-manual "(gnus)Exiting Gnus")
266 (defconst gnus-original-version-number "5.8.5"
267 "Version number for this version of original Gnus.")
269 (defconst gnus-original-version
270 (format "Gnus v%s" gnus-original-version-number)
271 "Version string for this version of Gnus.")
273 (defconst gnus-version
274 (format "%s %s (based on %s; for SEMI 1.13, FLIM 1.13)"
275 gnus-product-name gnus-version-number gnus-original-version)
276 "Version string for this version of gnus.")
278 (defcustom gnus-inhibit-startup-message nil
279 "If non-nil, the startup message will not be displayed.
280 This variable is used before `.gnus.el' is loaded, so it should
281 be set in `.emacs' instead."
285 (defcustom gnus-play-startup-jingle nil
286 "If non-nil, play the Gnus jingle at startup."
290 (unless (featurep 'gnus-xmas)
291 (defalias 'gnus-make-overlay 'make-overlay)
292 (defalias 'gnus-delete-overlay 'delete-overlay)
293 (defalias 'gnus-overlay-put 'overlay-put)
294 (defalias 'gnus-move-overlay 'move-overlay)
295 (defalias 'gnus-overlay-end 'overlay-end)
296 (defalias 'gnus-extent-detached-p 'ignore)
297 (defalias 'gnus-extent-start-open 'ignore)
298 (defalias 'gnus-set-text-properties 'set-text-properties)
299 (defalias 'gnus-group-remove-excess-properties 'ignore)
300 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
301 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
302 (defalias 'gnus-character-to-event 'identity)
303 (defalias 'gnus-add-text-properties 'add-text-properties)
304 (defalias 'gnus-put-text-property 'put-text-property)
305 (defalias 'gnus-mode-line-buffer-identification 'identity)
306 (defalias 'gnus-characterp 'numberp)
307 (defalias 'gnus-deactivate-mark 'deactivate-mark)
308 (defalias 'gnus-window-edges 'window-edges)
309 (defalias 'gnus-key-press-event-p 'numberp)
310 (defalias 'gnus-decode-rfc1522 'ignore))
312 ;; We define these group faces here to avoid the display
313 ;; update forced when creating new faces.
315 (defface gnus-group-news-1-face
318 (:foreground "PaleTurquoise" :bold t))
321 (:foreground "ForestGreen" :bold t))
324 "Level 1 newsgroup face.")
326 (defface gnus-group-news-1-empty-face
329 (:foreground "PaleTurquoise"))
332 (:foreground "ForestGreen"))
335 "Level 1 empty newsgroup face.")
337 (defface gnus-group-news-2-face
340 (:foreground "turquoise" :bold t))
343 (:foreground "CadetBlue4" :bold t))
346 "Level 2 newsgroup face.")
348 (defface gnus-group-news-2-empty-face
351 (:foreground "turquoise"))
354 (:foreground "CadetBlue4"))
357 "Level 2 empty newsgroup face.")
359 (defface gnus-group-news-3-face
368 "Level 3 newsgroup face.")
370 (defface gnus-group-news-3-empty-face
379 "Level 3 empty newsgroup face.")
381 (defface gnus-group-news-4-face
390 "Level 4 newsgroup face.")
392 (defface gnus-group-news-4-empty-face
401 "Level 4 empty newsgroup face.")
403 (defface gnus-group-news-5-face
412 "Level 5 newsgroup face.")
414 (defface gnus-group-news-5-empty-face
423 "Level 5 empty newsgroup face.")
425 (defface gnus-group-news-6-face
434 "Level 6 newsgroup face.")
436 (defface gnus-group-news-6-empty-face
445 "Level 6 empty newsgroup face.")
447 (defface gnus-group-news-low-face
450 (:foreground "DarkTurquoise" :bold t))
453 (:foreground "DarkGreen" :bold t))
456 "Low level newsgroup face.")
458 (defface gnus-group-news-low-empty-face
461 (:foreground "DarkTurquoise"))
464 (:foreground "DarkGreen"))
467 "Low level empty newsgroup face.")
469 (defface gnus-group-mail-1-face
472 (:foreground "aquamarine1" :bold t))
475 (:foreground "DeepPink3" :bold t))
478 "Level 1 mailgroup face.")
480 (defface gnus-group-mail-1-empty-face
483 (:foreground "aquamarine1"))
486 (:foreground "DeepPink3"))
488 (:italic t :bold t)))
489 "Level 1 empty mailgroup face.")
491 (defface gnus-group-mail-2-face
494 (:foreground "aquamarine2" :bold t))
497 (:foreground "HotPink3" :bold t))
500 "Level 2 mailgroup face.")
502 (defface gnus-group-mail-2-empty-face
505 (:foreground "aquamarine2"))
508 (:foreground "HotPink3"))
511 "Level 2 empty mailgroup face.")
513 (defface gnus-group-mail-3-face
516 (:foreground "aquamarine3" :bold t))
519 (:foreground "magenta4" :bold t))
522 "Level 3 mailgroup face.")
524 (defface gnus-group-mail-3-empty-face
527 (:foreground "aquamarine3"))
530 (:foreground "magenta4"))
533 "Level 3 empty mailgroup face.")
535 (defface gnus-group-mail-low-face
538 (:foreground "aquamarine4" :bold t))
541 (:foreground "DeepPink4" :bold t))
544 "Low level mailgroup face.")
546 (defface gnus-group-mail-low-empty-face
549 (:foreground "aquamarine4"))
552 (:foreground "DeepPink4"))
555 "Low level empty mailgroup face.")
557 ;; Summary mode faces.
559 (defface gnus-summary-selected-face '((t
561 "Face used for selected articles.")
563 (defface gnus-summary-cancelled-face
565 (:foreground "yellow" :background "black")))
566 "Face used for cancelled articles.")
568 (defface gnus-summary-high-ticked-face
571 (:foreground "pink" :bold t))
574 (:foreground "firebrick" :bold t))
577 "Face used for high interest ticked articles.")
579 (defface gnus-summary-low-ticked-face
582 (:foreground "pink" :italic t))
585 (:foreground "firebrick" :italic t))
588 "Face used for low interest ticked articles.")
590 (defface gnus-summary-normal-ticked-face
593 (:foreground "pink"))
596 (:foreground "firebrick"))
599 "Face used for normal interest ticked articles.")
601 (defface gnus-summary-high-ancient-face
604 (:foreground "SkyBlue" :bold t))
607 (:foreground "RoyalBlue" :bold t))
610 "Face used for high interest ancient articles.")
612 (defface gnus-summary-low-ancient-face
615 (:foreground "SkyBlue" :italic t))
618 (:foreground "RoyalBlue" :italic t))
621 "Face used for low interest ancient articles.")
623 (defface gnus-summary-normal-ancient-face
626 (:foreground "SkyBlue"))
629 (:foreground "RoyalBlue"))
632 "Face used for normal interest ancient articles.")
634 (defface gnus-summary-high-unread-face
637 "Face used for high interest unread articles.")
639 (defface gnus-summary-low-unread-face
642 "Face used for low interest unread articles.")
644 (defface gnus-summary-normal-unread-face
647 "Face used for normal interest unread articles.")
649 (defface gnus-summary-high-read-face
652 (:foreground "PaleGreen"
656 (:foreground "DarkGreen"
660 "Face used for high interest read articles.")
662 (defface gnus-summary-low-read-face
665 (:foreground "PaleGreen"
669 (:foreground "DarkGreen"
673 "Face used for low interest read articles.")
675 (defface gnus-summary-normal-read-face
678 (:foreground "PaleGreen"))
681 (:foreground "DarkGreen"))
684 "Face used for normal interest read articles.")
691 (defvar gnus-buffers nil)
693 (defun gnus-get-buffer-create (name)
694 "Do the same as `get-buffer-create', but store the created buffer."
695 (or (get-buffer name)
696 (car (push (get-buffer-create name) gnus-buffers))))
698 (defun gnus-add-buffer ()
699 "Add the current buffer to the list of Gnus buffers."
700 (push (current-buffer) gnus-buffers))
702 (defun gnus-buffers ()
703 "Return a list of live Gnus buffers."
704 (while (and gnus-buffers
705 (not (buffer-name (car gnus-buffers))))
707 (let ((buffers gnus-buffers))
709 (if (buffer-name (cadr buffers))
711 (setcdr buffers (cddr buffers)))))
716 (defvar gnus-group-buffer "*Group*")
719 (autoload 'gnus-play-jingle "gnus-audio"))
721 (defface gnus-splash-face
724 (:foreground "Brown"))
727 (:foreground "Brown"))
730 "Face of the splash screen.")
732 (defun gnus-splash ()
734 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
735 (let ((buffer-read-only nil))
737 (unless gnus-inhibit-startup-message
738 (gnus-group-startup-message)
740 (when gnus-play-startup-jingle
741 (gnus-play-jingle))))))
743 (defun gnus-indent-rigidly (start end arg)
744 "Indent rigidly using only spaces and no tabs."
747 (narrow-to-region start end)
749 (indent-rigidly start end arg)
750 ;; We translate tabs into spaces -- not everybody uses
751 ;; an 8-character tab.
752 (goto-char (point-min))
753 (while (search-forward "\t" nil t)
754 (replace-match " " t t))))))
756 (defvar gnus-simple-splash nil)
758 (defun gnus-group-startup-message (&optional x y)
759 "Insert startup message in current buffer."
760 ;; Insert the message.
765 _ ___ __ ___ __ _ ___
785 (gnus-indent-rigidly (point-min) (point-max)
786 (/ (max (- (window-width) (or x 46)) 0) 2))
787 (goto-char (point-min))
789 (let* ((pheight (count-lines (point-min) (point-max)))
790 (wheight (window-height))
791 (rest (- wheight pheight)))
792 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
794 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
795 (goto-char (point-min))
796 (setq mode-line-buffer-identification (concat " " gnus-version))
797 (setq gnus-simple-splash t)
798 (set-buffer-modified-p t))
801 (let ((command (format "%s" this-command)))
802 (if (and (string-match "gnus" command)
803 (not (string-match "gnus-other-frame" command)))
805 (gnus-get-buffer-create gnus-group-buffer))))
813 (defmacro gnus-define-group-parameter (param &rest rest)
814 "Define a group parameter PARAM.
815 REST is a plist of following:
816 :type One of `bool', `list' or `nil'.
817 :function The name of the function.
818 :function-document The documentation of the function.
819 :parameter-type The type for customizing the parameter.
820 :parameter-document The documentation for the parameter.
821 :variable The name of the variable.
822 :variable-document The documentation for the variable.
823 :variable-group The group for customizing the variable.
824 :variable-type The type for customizing the variable.
825 :variable-default The default value of the variable."
826 (let* ((type (plist-get rest :type))
827 (parameter-type (plist-get rest :parameter-type))
828 (parameter-document (plist-get rest :parameter-document))
829 (function (or (plist-get rest :function)
830 (intern (format "gnus-parameter-%s" param))))
831 (function-document (or (plist-get rest :function-document) ""))
832 (variable (or (plist-get rest :variable)
833 (intern (format "gnus-parameter-%s-alist" param))))
834 (variable-document (or (plist-get rest :variable-document) ""))
835 (variable-group (plist-get rest :variable-group))
836 (variable-type (or (plist-get rest :variable-type)
838 (list (regexp :tag "Group")
839 ,(car (cdr parameter-type)))))))
840 (variable-default (plist-get rest :variable-default)))
843 `(defcustom ,variable ,variable-default
845 :group 'gnus-group-parameter
846 :group ',variable-group
847 :type ,variable-type)
849 `(defun ,function (name)
851 (let ((params (gnus-group-find-parameter name))
854 ((memq ',param params)
856 ((setq val (assq ',param params))
859 (string-match ,variable name))
861 (let ((alist ,variable)
863 (while (setq elem (pop alist))
865 (string-match (car elem) name))
868 (if (consp value) (car value) value))))))
869 `(defun ,function (name)
872 (or (gnus-group-find-parameter name ',param ,(and type t))
873 (let ((alist ,variable)
875 (while (setq elem (pop alist))
877 (string-match (car elem) name))
882 '(if (consp value) (car value) value))))))))))
884 (defcustom gnus-home-directory "~/"
885 "Directory variable that specifies the \"home\" directory.
886 All other Gnus path variables are initialized from this variable."
890 (defcustom gnus-directory (or (getenv "SAVEDIR")
891 (nnheader-concat gnus-home-directory "News/"))
892 "*Directory variable from which all other Gnus file variables are derived.
894 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
895 This means that other directory variables that are initialized from
896 this variable won't be set properly if you set this variable in `.gnus.el'.
897 Set this variable in `.emacs' instead."
901 (defcustom gnus-default-directory nil
902 "*Default directory for all Gnus buffers."
904 :type '(choice (const :tag "current" nil)
907 ;; Site dependent variables. These variables should be defined in
910 (defvar gnus-default-nntp-server nil
911 "Specify a default NNTP server.
912 This variable should be defined in paths.el, and should never be set
914 If you want to change servers, you should use `gnus-select-method'.
915 See the documentation to that variable.")
917 ;; Don't touch this variable.
918 (defvar gnus-nntp-service "nntp"
919 "NNTP service name (\"nntp\" or 119).
920 This is an obsolete variable, which is scarcely used. If you use an
921 nntp server for your newsgroup and want to change the port number
922 used to 899, you would say something along these lines:
924 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
926 (defcustom gnus-nntpserver-file "/etc/nntpserver"
927 "A file with only the name of the nntp server in it."
932 ;; This function is used to check both the environment variable
933 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
934 ;; an nntp server name default.
935 (defun gnus-getenv-nntpserver ()
936 (or (getenv "NNTPSERVER")
937 (and (file-readable-p gnus-nntpserver-file)
939 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
940 (insert-file-contents gnus-nntpserver-file)
941 (let ((name (buffer-string)))
943 (if (string-match "\\'[ \t\n]*$" name)
946 (kill-buffer (current-buffer))))))))
948 (defcustom gnus-select-method
951 (list 'nntp (or (condition-case nil
952 (gnus-getenv-nntpserver)
954 (when (and gnus-default-nntp-server
955 (not (string= gnus-default-nntp-server "")))
956 gnus-default-nntp-server)
958 (if (or (null gnus-nntp-service)
959 (equal gnus-nntp-service "nntp"))
961 (list gnus-nntp-service)))
963 "Default method for selecting a newsgroup.
964 This variable should be a list, where the first element is how the
965 news is to be fetched, the second is the address.
967 For instance, if you want to get your news via NNTP from
968 \"flab.flab.edu\", you could say:
970 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
972 If you want to use your local spool, say:
974 \(setq gnus-select-method (list 'nnspool (system-name)))
976 If you use this variable, you must set `gnus-nntp-server' to nil.
978 There is a lot more to know about select methods and virtual servers -
979 see the manual for details."
981 :type 'gnus-select-method)
983 (defcustom gnus-message-archive-method
986 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
987 (nnfolder-active-file
988 ,(nnheader-concat message-directory "archive/active"))
989 (nnfolder-get-new-mail nil)
990 (nnfolder-inhibit-expiry t))
991 "*Method used for archiving messages you've sent.
992 This should be a mail method.
994 It's probably not a very effective to change this variable once you've
995 run Gnus once. After doing that, you must edit this server from the
999 :type 'gnus-select-method)
1001 (defcustom gnus-message-archive-group nil
1002 "*Name of the group in which to save the messages you've written.
1003 This can either be a string; a list of strings; or an alist
1004 of regexps/functions/forms to be evaluated to return a string (or a list
1005 of strings). The functions are called with the name of the current
1006 group (or nil) as a parameter.
1008 If you want to save your mail in one group and the news articles you
1009 write in another group, you could say something like:
1011 \(setq gnus-message-archive-group
1012 '((if (message-news-p)
1016 Normally the group names returned by this variable should be
1017 unprefixed -- which implicitly means \"store on the archive server\".
1018 However, you may wish to store the message on some other server. In
1019 that case, just return a fully prefixed name of the group --
1020 \"nnml+private:mail.misc\", for instance."
1021 :group 'gnus-message
1022 :type '(choice (const :tag "none" nil)
1027 (defcustom gnus-secondary-servers nil
1028 "List of NNTP servers that the user can choose between interactively.
1029 To make Gnus query you for a server, you have to give `gnus' a
1030 non-numeric prefix - `C-u M-x gnus', in short."
1032 :type '(repeat string))
1034 (defcustom gnus-nntp-server nil
1035 "*The name of the host running the NNTP server.
1036 This variable is semi-obsolete. Use the `gnus-select-method'
1039 :type '(choice (const :tag "disable" nil)
1042 (defcustom gnus-secondary-select-methods nil
1043 "A list of secondary methods that will be used for reading news.
1044 This is a list where each element is a complete select method (see
1045 `gnus-select-method').
1047 If, for instance, you want to read your mail with the nnml backend,
1048 you could set this variable:
1050 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1052 :type '(repeat gnus-select-method))
1054 (defvar gnus-backup-default-subscribed-newsgroups
1055 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1056 "Default default new newsgroups the first time Gnus is run.
1057 Should be set in paths.el, and shouldn't be touched by the user.")
1059 (defcustom gnus-local-domain nil
1060 "Local domain name without a host name.
1061 The DOMAINNAME environment variable is used instead if it is defined.
1062 If the `system-name' function returns the full Internet name, there is
1063 no need to set this variable."
1064 :group 'gnus-message
1065 :type '(choice (const :tag "default" nil)
1068 (defvar gnus-local-organization nil
1069 "String with a description of what organization (if any) the user belongs to.
1070 Obsolete variable; use `message-user-organization' instead.")
1072 ;; Customization variables
1074 (defcustom gnus-refer-article-method nil
1075 "Preferred method for fetching an article by Message-ID.
1076 If you are reading news from the local spool (with nnspool), fetching
1077 articles by Message-ID is painfully slow. By setting this method to an
1078 nntp method, you might get acceptable results.
1080 The value of this variable must be a valid select method as discussed
1081 in the documentation of `gnus-select-method'.
1083 It can also be a list of select methods, as well as the special symbol
1084 `current', which means to use the current select method. If it is a
1085 list, Gnus will try all the methods in the list until it finds a match."
1087 :type '(choice (const :tag "default" nil)
1088 (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1090 (repeat :menu-tag "Try multiple"
1092 :value (current (nnweb "refer" (nnweb-type dejanews)))
1093 (choice :tag "Method"
1095 (const :tag "DejaNews"
1096 (nnweb "refer" (nnweb-type dejanews)))
1097 gnus-select-method))))
1099 (defcustom gnus-group-faq-directory
1100 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1101 "/ftp@sunsite.auc.dk:/pub/usenet/"
1102 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1103 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1104 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1105 "/ftp@rtfm.mit.edu:/pub/usenet/"
1106 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1107 "/ftp@ftp.sunet.se:/pub/usenet/"
1108 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1109 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1110 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1111 "*Directory where the group FAQs are stored.
1112 This will most commonly be on a remote machine, and the file will be
1113 fetched by ange-ftp.
1115 This variable can also be a list of directories. In that case, the
1116 first element in the list will be used by default. The others can
1117 be used when being prompted for a site.
1119 Note that Gnus uses an aol machine as the default directory. If this
1120 feels fundamentally unclean, just think of it as a way to finally get
1121 something of value back from them.
1123 If the default site is too slow, try one of these:
1125 North America: mirrors.aol.com /pub/rtfm/usenet
1126 ftp.seas.gwu.edu /pub/rtfm
1127 rtfm.mit.edu /pub/usenet
1128 Europe: ftp.uni-paderborn.de /pub/FAQ
1129 src.doc.ic.ac.uk /usenet/news-FAQS
1130 ftp.sunet.se /pub/usenet
1131 sunsite.auc.dk /pub/usenet
1132 Asia: nctuccca.edu.tw /USENET/FAQ
1133 hwarang.postech.ac.kr /pub/usenet
1134 ftp.hk.super.net /mirror/faqs"
1135 :group 'gnus-group-various
1136 :type '(choice directory
1137 (repeat directory)))
1139 (defcustom gnus-use-cross-reference t
1140 "*Non-nil means that cross referenced articles will be marked as read.
1141 If nil, ignore cross references. If t, mark articles as read in
1142 subscribed newsgroups. If neither t nor nil, mark as read in all
1145 :type '(choice (const :tag "off" nil)
1146 (const :tag "subscribed" t)
1150 (defcustom gnus-process-mark ?#
1152 :group 'gnus-group-visual
1153 :group 'gnus-summary-marks
1156 (defcustom gnus-asynchronous nil
1157 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1158 :group 'gnus-asynchronous
1161 (defcustom gnus-large-newsgroup 200
1162 "*The number of articles which indicates a large newsgroup.
1163 If the number of articles in a newsgroup is greater than this value,
1164 confirmation is required for selecting the newsgroup."
1165 :group 'gnus-group-select
1168 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1169 "*Non-nil means that the default name of a file to save articles in is the group name.
1170 If it's nil, the directory form of the group name is used instead.
1172 If this variable is a list, and the list contains the element
1173 `not-score', long file names will not be used for score files; if it
1174 contains the element `not-save', long file names will not be used for
1175 saving; and if it contains the element `not-kill', long file names
1176 will not be used for kill files.
1178 Note that the default for this variable varies according to what system
1179 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1180 to nil while on all other systems it defaults to t."
1184 (defcustom gnus-kill-files-directory gnus-directory
1185 "*Name of the directory where kill files will be stored (default \"~/News\")."
1186 :group 'gnus-score-files
1187 :group 'gnus-score-kill
1190 (defcustom gnus-save-score nil
1191 "*If non-nil, save group scoring info."
1192 :group 'gnus-score-various
1196 (defcustom gnus-use-undo t
1197 "*If non-nil, allow undoing in Gnus group mode buffers."
1201 (defcustom gnus-use-adaptive-scoring nil
1202 "*If non-nil, use some adaptive scoring scheme.
1203 If a list, then the values `word' and `line' are meaningful. The
1204 former will perform adaption on individual words in the subject
1205 header while `line' will perform adaption on several headers."
1207 :group 'gnus-score-adapt
1208 :type '(set (const word) (const line)))
1210 (defcustom gnus-use-cache 'passive
1211 "*If nil, Gnus will ignore the article cache.
1212 If `passive', it will allow entering (and reading) articles
1213 explicitly entered into the cache. If anything else, use the
1214 cache to the full extent of the law."
1217 :type '(choice (const :tag "off" nil)
1218 (const :tag "passive" passive)
1219 (const :tag "active" t)))
1221 (defcustom gnus-use-trees nil
1222 "*If non-nil, display a thread tree buffer."
1226 (defcustom gnus-use-grouplens nil
1227 "*If non-nil, use GroupLens ratings."
1231 (defcustom gnus-keep-backlog nil
1232 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1233 If it is a number N, then Gnus will only keep the last N articles
1234 read. If it is neither nil nor a number, Gnus will keep all read
1235 articles. This is not a good idea."
1237 :type '(choice (const :tag "off" nil)
1242 (defcustom gnus-use-nocem nil
1243 "*If non-nil, Gnus will read NoCeM cancel messages."
1247 (defcustom gnus-suppress-duplicates nil
1248 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1252 (defcustom gnus-use-scoring t
1253 "*If non-nil, enable scoring."
1257 (defcustom gnus-use-picons nil
1258 "*If non-nil, display picons in a frame of their own."
1262 (defcustom gnus-summary-prepare-exit-hook
1263 '(gnus-summary-expire-articles)
1264 "*A hook called when preparing to exit from the summary buffer.
1265 It calls `gnus-summary-expire-articles' by default."
1266 :group 'gnus-summary-exit
1269 (defcustom gnus-novice-user t
1270 "*Non-nil means that you are a usenet novice.
1271 If non-nil, verbose messages may be displayed and confirmations may be
1276 (defcustom gnus-expert-user nil
1277 "*Non-nil means that you will never be asked for confirmation about anything.
1278 That doesn't mean *anything* anything; particularly destructive
1279 commands will still require prompting."
1283 (defcustom gnus-interactive-catchup t
1284 "*If non-nil, require your confirmation when catching up a group."
1285 :group 'gnus-group-select
1288 (defcustom gnus-interactive-exit t
1289 "*If non-nil, require your confirmation when exiting Gnus."
1293 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1294 "*Function for extracting address components from a From header.
1295 Two pre-defined function exist: `gnus-extract-address-components',
1296 which is the default, quite fast, and too simplistic solution, and
1297 `mail-extract-address-components', which works much better, but is
1299 :group 'gnus-summary-format
1300 :type '(radio (function-item gnus-extract-address-components)
1301 (function-item mail-extract-address-components)
1302 (function :tag "Other")))
1304 (defcustom gnus-carpal nil
1305 "*If non-nil, display clickable icons."
1309 (defcustom gnus-shell-command-separator ";"
1310 "String used to separate to shell commands."
1314 (defcustom gnus-valid-select-methods
1315 '(("nntp" post address prompt-address physical-address)
1316 ("nnspool" post address)
1317 ("nnvirtual" post-mail virtual prompt-address)
1318 ("nnmbox" mail respool address)
1319 ("nnml" mail respool address)
1320 ("nnmh" mail respool address)
1321 ("nndir" post-mail prompt-address physical-address)
1322 ("nneething" none address prompt-address physical-address)
1323 ("nndoc" none address prompt-address)
1324 ("nnbabyl" mail address respool)
1325 ("nnkiboze" post virtual)
1326 ("nnsoup" post-mail address)
1327 ("nndraft" post-mail)
1328 ("nnfolder" mail respool address)
1329 ("nngateway" post-mail address prompt-address physical-address)
1335 ("nnagent" post-mail)
1336 ("nnimap" post-mail address prompt-address physical-address))
1337 "*An alist of valid select methods.
1338 The first element of each list lists should be a string with the name
1339 of the select method. The other elements may be the category of
1340 this method (i. e., `post', `mail', `none' or whatever) or other
1341 properties that this method has (like being respoolable).
1342 If you implement a new select method, all you should have to change is
1343 this variable. I think."
1345 :type '(repeat (group (string :tag "Name")
1346 (radio-button-choice (const :format "%v " post)
1347 (const :format "%v " mail)
1348 (const :format "%v " none)
1350 (checklist :inline t
1351 (const :format "%v " address)
1352 (const :format "%v " prompt-address)
1353 (const :format "%v " physical-address)
1354 (const :format "%v " virtual)
1357 (define-widget 'gnus-select-method 'list
1358 "Widget for entering a select method."
1360 :tag "Select Method"
1361 :args `((choice :tag "Method"
1362 ,@(mapcar (lambda (entry)
1363 (list 'const :format "%v\n"
1364 (intern (car entry))))
1365 gnus-valid-select-methods))
1366 (string :tag "Address")
1367 (repeat :tag "Options"
1371 (sexp :tag "Value")))))
1373 (defcustom gnus-updated-mode-lines '(group article summary tree)
1374 "List of buffers that should update their mode lines.
1375 The list may contain the symbols `group', `article', `tree' and
1376 `summary'. If the corresponding symbol is present, Gnus will keep
1377 that mode line updated with information that may be pertinent.
1378 If this variable is nil, screen refresh may be quicker."
1379 :group 'gnus-various
1380 :type '(set (const group)
1385 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1386 (defcustom gnus-mode-non-string-length nil
1387 "*Max length of mode-line non-string contents.
1388 If this is nil, Gnus will take space as is needed, leaving the rest
1389 of the modeline intact. Note that the default of nil is unlikely
1390 to be desirable; see the manual for further details."
1391 :group 'gnus-various
1392 :type '(choice (const nil)
1395 (defcustom gnus-auto-expirable-newsgroups nil
1396 "*Groups in which to automatically mark read articles as expirable.
1397 If non-nil, this should be a regexp that should match all groups in
1398 which to perform auto-expiry. This only makes sense for mail groups."
1399 :group 'nnmail-expire
1400 :type '(choice (const nil)
1403 (defcustom gnus-total-expirable-newsgroups nil
1404 "*Groups in which to perform expiry of all read articles.
1405 Use with extreme caution. All groups that match this regexp will be
1406 expiring - which means that all read articles will be deleted after
1407 \(say) one week. (This only goes for mail groups and the like, of
1409 :group 'nnmail-expire
1410 :type '(choice (const nil)
1413 (defcustom gnus-group-uncollapsed-levels 1
1414 "Number of group name elements to leave alone when making a short group name."
1415 :group 'gnus-group-visual
1418 (defcustom gnus-group-use-permanent-levels nil
1419 "*If non-nil, once you set a level, Gnus will use this level."
1420 :group 'gnus-group-levels
1425 (defcustom gnus-load-hook nil
1426 "A hook run while Gnus is loaded."
1430 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1431 "A hook called to apply kill files to a group.
1432 This hook is intended to apply a kill file to the selected newsgroup.
1433 The function `gnus-apply-kill-file' is called by default.
1435 Since a general kill file is too heavy to use only for a few
1436 newsgroups, I recommend you to use a lighter hook function. For
1437 example, if you'd like to apply a kill file to articles which contains
1438 a string `rmgroup' in subject in newsgroup `control', you can use the
1441 (setq gnus-apply-kill-hook
1444 (cond ((string-match \"control\" gnus-newsgroup-name)
1445 (gnus-kill \"Subject\" \"rmgroup\")
1446 (gnus-expunge \"X\"))))))"
1447 :group 'gnus-score-kill
1448 :options '(gnus-apply-kill-file)
1451 (defcustom gnus-group-change-level-function nil
1452 "Function run when a group level is changed.
1453 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1454 :group 'gnus-group-levels
1459 (defcustom gnus-visual
1460 '(summary-highlight group-highlight article-highlight
1462 summary-menu group-menu article-menu
1463 tree-highlight menu highlight
1464 browse-menu server-menu
1465 page-marker tree-menu binary-menu pick-menu
1467 "*Enable visual features.
1468 If `visual' is disabled, there will be no menus and few faces. Most of
1469 the visual customization options below will be ignored. Gnus will use
1470 less space and be faster as a result.
1472 This variable can also be a list of visual elements to switch on. For
1473 instance, to switch off all visual things except menus, you can say:
1475 (setq gnus-visual '(menu))
1477 Valid elements include `summary-highlight', `group-highlight',
1478 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1479 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1480 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1481 and `grouplens-menu'."
1484 :type '(set (const summary-highlight)
1485 (const group-highlight)
1486 (const article-highlight)
1488 (const summary-menu)
1490 (const article-menu)
1491 (const tree-highlight)
1500 (const grouplens-menu)))
1502 (defcustom gnus-mouse-face
1504 (if (gnus-visual-p 'mouse-face 'highlight)
1505 (if (boundp 'gnus-mouse-face)
1506 (or gnus-mouse-face 'highlight)
1510 "*Face used for group or summary buffer mouse highlighting.
1511 The line beneath the mouse pointer will be highlighted with this
1516 (defcustom gnus-article-save-directory gnus-directory
1517 "*Name of the directory articles will be saved in (default \"~/News\")."
1518 :group 'gnus-article-saving
1521 (defvar gnus-plugged t
1522 "Whether Gnus is plugged or not.")
1524 (defcustom gnus-default-charset 'iso-8859-1
1525 "Default charset assumed to be used when viewing non-ASCII characters.
1526 This variable is overridden on a group-to-group basis by the
1527 gnus-group-charset-alist variable and is only used on groups not
1528 covered by that variable."
1530 :group 'gnus-charset)
1532 (defcustom gnus-default-posting-charset nil
1533 "Default charset assumed to be used when posting non-ASCII characters.
1534 This variable is overridden on a group-to-group basis by the
1535 gnus-group-posting-charset-alist variable and is only used on groups not
1536 covered by that variable.
1537 If nil, no default charset is assumed when posting."
1539 :group 'gnus-charset)
1542 ;;; Internal variables
1544 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1545 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1546 (defvar gnus-original-article-buffer " *Original Article*")
1547 (defvar gnus-newsgroup-name nil)
1548 (defvar gnus-ephemeral-servers nil)
1550 (defvar gnus-agent nil
1551 "Whether we want to use the Gnus agent or not.")
1553 (defvar gnus-command-method nil
1554 "Dynamically bound variable that says what the current backend is.")
1556 (defvar gnus-current-select-method nil
1557 "The current method for selecting a newsgroup.")
1559 (defvar gnus-tree-buffer "*Tree*"
1560 "Buffer where Gnus thread trees are displayed.")
1563 (defvar gnus-use-generic-from nil)
1565 ;; Variable holding the user answers to all method prompts.
1566 (defvar gnus-method-history nil)
1568 ;; Variable holding the user answers to all mail method prompts.
1569 (defvar gnus-mail-method-history nil)
1571 ;; Variable holding the user answers to all group prompts.
1572 (defvar gnus-group-history nil)
1574 (defvar gnus-server-alist nil
1575 "List of available servers.")
1577 (defcustom gnus-cache-directory
1578 (nnheader-concat gnus-directory "cache/")
1579 "*The directory where cached articles will be stored."
1583 (defvar gnus-predefined-server-alist
1586 (nnspool-spool-directory ,gnus-cache-directory)
1587 (nnspool-nov-directory ,gnus-cache-directory)
1588 (nnspool-active-file
1589 ,(nnheader-concat gnus-cache-directory "active"))))
1590 "List of predefined (convenience) servers.")
1592 (defvar gnus-topic-indentation "");; Obsolete variable.
1594 (defconst gnus-article-mark-lists
1595 '((marked . tick) (replied . reply)
1596 (expirable . expire) (killed . killed)
1597 (bookmarks . bookmark) (dormant . dormant)
1598 (scored . score) (saved . save)
1599 (cached . cache) (downloadable . download)
1600 (unsendable . unsend)))
1602 (defvar gnus-headers-retrieved-by nil)
1603 (defvar gnus-article-reply nil)
1604 (defvar gnus-override-method nil)
1605 (defvar gnus-article-check-size nil)
1606 (defvar gnus-opened-servers nil)
1608 (defvar gnus-current-kill-article nil)
1610 (defvar gnus-have-read-active-file nil)
1612 (defconst gnus-maintainer
1613 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1614 "The mail address of the Gnus maintainers.")
1616 (defconst semi-gnus-developers
1617 "Semi-gnus Developers:
1618 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1619 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1620 "The mail address of the Semi-gnus developers.")
1622 (defvar gnus-info-nodes
1623 '((gnus-group-mode "(gnus)The Group Buffer")
1624 (gnus-summary-mode "(gnus)The Summary Buffer")
1625 (gnus-article-mode "(gnus)The Article Buffer")
1626 (gnus-server-mode "(gnus)The Server Buffer")
1627 (gnus-browse-mode "(gnus)Browse Foreign Server")
1628 (gnus-tree-mode "(gnus)Tree Display"))
1629 "Alist of major modes and related Info nodes.")
1631 (defvar gnus-group-buffer "*Group*")
1632 (defvar gnus-summary-buffer "*Summary*")
1633 (defvar gnus-article-buffer "*Article*")
1634 (defvar gnus-server-buffer "*Server*")
1636 (defvar gnus-slave nil
1637 "Whether this Gnus is a slave or not.")
1639 (defvar gnus-batch-mode nil
1640 "Whether this Gnus is running in batch mode or not.")
1642 (defvar gnus-variable-list
1643 '(gnus-newsrc-options gnus-newsrc-options-n
1644 gnus-newsrc-last-checked-date
1645 gnus-newsrc-alist gnus-server-alist
1646 gnus-killed-list gnus-zombie-list
1647 gnus-topic-topology gnus-topic-alist)
1648 "Gnus variables saved in the quick startup file.")
1650 (defvar gnus-product-variable-file-list
1651 '(("strict-cache" ((product-version (7 1 0 15)) (emacs-version))
1653 gnus-format-specs-compiled)
1654 ("cache" ((product-version (7 1 0 15)))
1657 "Gnus variables are saved in the produce depend quick startup files.")
1659 (defcustom gnus-compile-user-specs t
1660 "If non-nil, the user-defined format specs will be byte-compiled
1662 It has an effect on the values of `gnus-*-line-format-spec'."
1666 (defvar gnus-newsrc-alist nil
1667 "Assoc list of read articles.
1668 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1670 (defvar gnus-newsrc-hashtb nil
1671 "Hashtable of gnus-newsrc-alist.")
1673 (defvar gnus-killed-list nil
1674 "List of killed newsgroups.")
1676 (defvar gnus-killed-hashtb nil
1677 "Hash table equivalent of gnus-killed-list.")
1679 (defvar gnus-zombie-list nil
1680 "List of almost dead newsgroups.")
1682 (defvar gnus-description-hashtb nil
1683 "Descriptions of newsgroups.")
1685 (defvar gnus-list-of-killed-groups nil
1686 "List of newsgroups that have recently been killed by the user.")
1688 (defvar gnus-active-hashtb nil
1689 "Hashtable of active articles.")
1691 (defvar gnus-moderated-hashtb nil
1692 "Hashtable of moderated newsgroups.")
1694 ;; Save window configuration.
1695 (defvar gnus-prev-winconf nil)
1697 (defvar gnus-reffed-article-number nil)
1699 ;;; Let the byte-compiler know that we know about this variable.
1700 (defvar rmail-default-rmail-file)
1702 (defvar gnus-dead-summary nil)
1704 ;;; End of variables.
1706 ;; Define some autoload functions Gnus might use.
1709 ;; This little mapcar goes through the list below and marks the
1710 ;; symbols in question as autoloaded functions.
1713 (let ((interactive (nth 1 (memq ':interactive package))))
1717 (when (consp function)
1718 (setq keymap (car (memq 'keymap function)))
1719 (setq function (car function)))
1720 (unless (fboundp function)
1721 (autoload function (car package) nil interactive keymap))))
1722 (if (eq (nth 1 package) ':interactive)
1725 '(("info" :interactive t Info-goto-node)
1726 ("pp" pp pp-to-string pp-eval-expression)
1727 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1728 ("ps-print" ps-print-preprint)
1729 ("browse-url" :interactive t browse-url)
1730 ("message" :interactive t
1731 message-send-and-exit message-yank-original)
1732 ("babel" babel-as-string)
1733 ("nnmail" nnmail-split-fancy nnmail-article-group)
1734 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1735 ("rmailout" rmail-output rmail-output-to-rmail-file)
1736 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1737 rmail-show-message rmail-summary-exists
1738 rmail-select-summary rmail-update-summary)
1739 ("gnus-audio" :interactive t gnus-audio-play)
1740 ("gnus-xmas" gnus-xmas-splash)
1741 ("gnus-soup" :interactive t
1742 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1743 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1744 ("nnsoup" nnsoup-pack-replies)
1745 ("score-mode" :interactive t gnus-score-mode)
1746 ("gnus-mh" gnus-summary-save-article-folder
1747 gnus-Folder-save-name gnus-folder-save-name)
1748 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1749 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1750 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1751 gnus-demon-add-disconnection gnus-demon-add-handler
1752 gnus-demon-remove-handler)
1753 ("gnus-demon" :interactive t
1754 gnus-demon-init gnus-demon-cancel)
1755 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1756 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1757 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1758 gnus-nocem-unwanted-article-p)
1759 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1760 gnus-server-server-name)
1761 ("gnus-srvr" gnus-browse-foreign-server)
1762 ("gnus-cite" :interactive t
1763 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1764 gnus-article-hide-citation gnus-article-fill-cited-article
1765 gnus-article-hide-citation-in-followups)
1766 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1767 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1768 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1769 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1770 gnus-cache-possibly-remove-articles gnus-cache-request-article
1771 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1772 gnus-cache-enter-remove-article gnus-cached-article-p
1773 gnus-cache-open gnus-cache-close gnus-cache-update-article
1774 gnus-cache-articles-in-group)
1775 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1776 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1777 ("gnus-score" :interactive t
1778 gnus-summary-increase-score gnus-summary-set-score
1779 gnus-summary-raise-thread gnus-summary-raise-same-subject
1780 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1781 gnus-summary-lower-thread gnus-summary-lower-same-subject
1782 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1783 gnus-summary-current-score gnus-score-delta-default
1784 gnus-score-flush-cache gnus-score-close
1785 gnus-possibly-score-headers gnus-score-followup-article
1786 gnus-score-followup-thread)
1788 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1789 gnus-current-score-file-nondirectory gnus-score-adaptive
1790 gnus-score-find-trace gnus-score-file-name)
1791 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1792 ("gnus-topic" :interactive t gnus-topic-mode)
1793 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1794 gnus-subscribe-topics)
1795 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1796 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1797 ("gnus-uu" :interactive t
1798 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1799 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1800 gnus-uu-mark-by-regexp gnus-uu-mark-all
1801 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1802 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1803 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1804 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1805 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1806 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1807 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1808 gnus-uu-mark-over gnus-uu-post-news)
1809 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1810 ("gnus-msg" (gnus-summary-send-map keymap)
1811 gnus-article-mail gnus-copy-article-buffer)
1812 ("gnus-msg" :interactive t
1813 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1814 gnus-summary-followup gnus-summary-followup-with-original
1815 gnus-summary-cancel-article gnus-summary-supersede-article
1816 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1817 gnus-summary-mail-forward gnus-summary-mail-other-window
1818 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1819 gnus-summary-wide-reply gnus-summary-followup-to-mail
1820 gnus-summary-followup-to-mail-with-original gnus-bug
1821 gnus-summary-wide-reply-with-original
1822 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1823 gnus-summary-post-forward)
1824 ("gnus-picon" :interactive t gnus-article-display-picons
1825 gnus-group-display-picons gnus-picons-article-display-x-face
1826 gnus-picons-display-x-face)
1827 ("gnus-picon" gnus-picons-buffer-name)
1828 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1829 gnus-grouplens-mode)
1830 ("smiley" :interactive t gnus-smiley-display)
1831 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1832 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1833 gnus-list-of-unread-articles gnus-list-of-read-articles
1834 gnus-offer-save-summaries gnus-make-thread-indent-array
1835 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1836 gnus-summary-skip-intangible gnus-summary-article-number
1837 gnus-data-header gnus-data-find)
1838 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1839 gnus-group-list-groups gnus-group-first-unread-group
1840 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1841 gnus-group-setup-buffer gnus-group-get-new-news
1842 gnus-group-make-help-group gnus-group-update-group
1843 gnus-group-iterate gnus-group-group-name)
1844 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1845 gnus-backlog-remove-article)
1846 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1847 gnus-article-prepare gnus-article-set-window-start
1848 gnus-article-next-page gnus-article-prev-page
1849 gnus-request-article-this-buffer gnus-article-mode
1850 gnus-article-setup-buffer gnus-narrow-to-page
1851 gnus-article-delete-invisible-text gnus-treat-article)
1852 ("gnus-art" :interactive t
1853 gnus-article-hide-headers gnus-article-hide-boring-headers
1854 gnus-article-treat-overstrike
1855 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1856 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1857 gnus-article-decode-HZ
1858 gnus-article-hide-pgp
1859 gnus-article-hide-pem gnus-article-hide-signature
1860 gnus-article-strip-leading-blank-lines gnus-article-date-local
1861 gnus-article-date-original gnus-article-date-lapsed
1862 gnus-article-show-all-headers
1863 gnus-article-edit-mode gnus-article-edit-article
1864 gnus-article-edit-done gnus-article-decode-encoded-words
1865 gnus-start-date-timer gnus-stop-date-timer
1866 gnus-mime-view-all-parts)
1867 ("gnus-int" gnus-request-type)
1868 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1869 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1870 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1871 gnus-dup-enter-articles)
1872 ("gnus-range" gnus-copy-sequence)
1873 ("gnus-eform" gnus-edit-form)
1874 ("gnus-move" :interactive t
1875 gnus-group-move-group-to-server gnus-change-server)
1876 ("gnus-logic" gnus-score-advanced)
1877 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1878 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1879 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1880 gnus-async-halt-prefetch)
1881 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1882 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1883 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1884 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1885 ("gnus-agent" :interactive t
1886 gnus-unplugged gnus-agentize gnus-agent-batch)
1887 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1888 gnus-summary-save-article-vm)
1889 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1890 ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1891 ("gnus-mlspl" :interactive t gnus-group-split-setup
1892 gnus-group-split-update)
1893 ("gnus-namazu" :interactive t gnus-namazu-search)
1894 ("nnshimbun" :interactive t gnus-group-make-shimbun-group))))
1896 ;;; gnus-sum.el thingies
1899 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1900 "*The format specification of the lines in the summary buffer.
1902 It works along the same lines as a normal formatting string,
1903 with some simple extensions.
1905 %N Article number, left padded with spaces (string)
1907 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1908 %n Name of the poster (string)
1909 %a Extracted name of the poster (string)
1910 %A Extracted address of the poster (string)
1911 %F Contents of the From: header (string)
1912 %f Contents of the From: or To: headers (string)
1913 %x Contents of the Xref: header (string)
1914 %D Date of the article (string)
1915 %d Date of the article (string) in DD-MMM format
1916 %M Message-id of the article (string)
1917 %r References of the article (string)
1918 %c Number of characters in the article (integer)
1919 %L Number of lines in the article (integer)
1920 %I Indentation based on thread level (a string of spaces)
1921 %T A string with two possible values: 80 spaces if the article
1922 is on thread level two or larger and 0 spaces on level one
1923 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1924 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1925 %[ Opening bracket (character, \"[\" or \"<\")
1926 %] Closing bracket (character, \"]\" or \">\")
1927 %> Spaces of length thread-level (string)
1928 %< Spaces of length (- 20 thread-level) (string)
1929 %i Article score (number)
1930 %z Article zcore (character)
1931 %t Number of articles under the current thread (number).
1932 %e Whether the thread is empty or not (character).
1933 %l GroupLens score (string).
1934 %V Total thread score (number).
1935 %P The line number (number).
1936 %O Download mark (character).
1937 %u User defined specifier. The next character in the format string should
1938 be a letter. Gnus will call the function gnus-user-format-function-X,
1939 where X is the letter following %u. The function will be passed the
1940 current header as argument. The function should return a string, which
1941 will be inserted into the summary just like information from any other
1944 Text between %( and %) will be highlighted with `gnus-mouse-face'
1945 when the mouse point is placed inside the area. There can only be one
1948 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1949 with care. For reasons of efficiency, Gnus will compute what column
1950 these characters will end up in, and \"hard-code\" that. This means that
1951 it is invalid to have these specs after a variable-length spec. Well,
1952 you might not be arrested, but your summary buffer will look strange,
1953 which is bad enough.
1955 The smart choice is to have these specs as for to the left as
1958 This restriction may disappear in later versions of Gnus."
1960 :group 'gnus-summary-format)
1963 ;;; Skeleton keymaps
1966 (defun gnus-suppress-keymap (keymap)
1967 (suppress-keymap keymap)
1968 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1970 (define-key keymap (pop keys) 'undefined))))
1972 (defvar gnus-article-mode-map
1973 (let ((keymap (make-sparse-keymap)))
1974 (gnus-suppress-keymap keymap)
1976 (defvar gnus-summary-mode-map
1977 (let ((keymap (make-keymap)))
1978 (gnus-suppress-keymap keymap)
1980 (defvar gnus-group-mode-map
1981 (let ((keymap (make-keymap)))
1982 (gnus-suppress-keymap keymap)
1987 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1988 ;; If you want the cursor to go somewhere else, set these two
1989 ;; functions in some startup hook to whatever you want.
1990 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1991 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1993 ;;; Various macros and substs.
1995 (defun gnus-header-from (header)
1996 (mail-header-from header))
1998 (defmacro gnus-gethash (string hashtable)
1999 "Get hash value of STRING in HASHTABLE."
2000 `(symbol-value (intern-soft ,string ,hashtable)))
2002 (defmacro gnus-sethash (string value hashtable)
2003 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
2004 `(set (intern ,string ,hashtable) ,value))
2005 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2007 (defmacro gnus-group-unread (group)
2008 "Get the currently computed number of unread articles in GROUP."
2009 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2011 (defmacro gnus-group-entry (group)
2012 "Get the newsrc entry for GROUP."
2013 `(gnus-gethash ,group gnus-newsrc-hashtb))
2015 (defmacro gnus-active (group)
2016 "Get active info on GROUP."
2017 `(gnus-gethash ,group gnus-active-hashtb))
2019 (defmacro gnus-set-active (group active)
2020 "Set GROUP's active info."
2021 `(gnus-sethash ,group ,active gnus-active-hashtb))
2023 ;; Info access macros.
2025 (defmacro gnus-info-group (info)
2027 (defmacro gnus-info-rank (info)
2029 (defmacro gnus-info-read (info)
2031 (defmacro gnus-info-marks (info)
2033 (defmacro gnus-info-method (info)
2035 (defmacro gnus-info-params (info)
2038 (defmacro gnus-info-level (info)
2039 `(let ((rank (gnus-info-rank ,info)))
2043 (defmacro gnus-info-score (info)
2044 `(let ((rank (gnus-info-rank ,info)))
2045 (or (and (consp rank) (cdr rank)) 0)))
2047 (defmacro gnus-info-set-group (info group)
2048 `(setcar ,info ,group))
2049 (defmacro gnus-info-set-rank (info rank)
2050 `(setcar (nthcdr 1 ,info) ,rank))
2051 (defmacro gnus-info-set-read (info read)
2052 `(setcar (nthcdr 2 ,info) ,read))
2053 (defmacro gnus-info-set-marks (info marks &optional extend)
2055 `(gnus-info-set-entry ,info ,marks 3)
2056 `(setcar (nthcdr 3 ,info) ,marks)))
2057 (defmacro gnus-info-set-method (info method &optional extend)
2059 `(gnus-info-set-entry ,info ,method 4)
2060 `(setcar (nthcdr 4 ,info) ,method)))
2061 (defmacro gnus-info-set-params (info params &optional extend)
2063 `(gnus-info-set-entry ,info ,params 5)
2064 `(setcar (nthcdr 5 ,info) ,params)))
2066 (defun gnus-info-set-entry (info entry number)
2067 ;; Extend the info until we have enough elements.
2068 (while (<= (length info) number)
2069 (nconc info (list nil)))
2071 (setcar (nthcdr number info) entry))
2073 (defmacro gnus-info-set-level (info level)
2074 `(let ((rank (cdr ,info)))
2075 (if (consp (car rank))
2076 (setcar (car rank) ,level)
2077 (setcar rank ,level))))
2078 (defmacro gnus-info-set-score (info score)
2079 `(let ((rank (cdr ,info)))
2080 (if (consp (car rank))
2081 (setcdr (car rank) ,score)
2082 (setcar rank (cons (car rank) ,score)))))
2084 (defmacro gnus-get-info (group)
2085 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2087 ;; Byte-compiler warning.
2088 (defvar gnus-visual)
2089 ;; Find out whether the gnus-visual TYPE is wanted.
2090 (defun gnus-visual-p (&optional type class)
2091 (and gnus-visual ; Has to be non-nil, at least.
2092 (if (not type) ; We don't care about type.
2094 (if (listp gnus-visual) ; It's a list, so we check it.
2095 (or (memq type gnus-visual)
2096 (memq class gnus-visual))
2099 ;;; Load the compatability functions.
2108 (defvar gnus-shutdown-alist nil)
2110 (defun gnus-add-shutdown (function &rest symbols)
2111 "Run FUNCTION whenever one of SYMBOLS is shut down."
2112 (push (cons function symbols) gnus-shutdown-alist))
2114 (defun gnus-shutdown (symbol)
2115 "Shut down everything that waits for SYMBOL."
2116 (let ((alist gnus-shutdown-alist)
2118 (while (setq entry (pop alist))
2119 (when (memq symbol (cdr entry))
2120 (funcall (car entry))))))
2124 ;;; Gnus Utility Functions
2128 (defmacro gnus-string-or (&rest strings)
2129 "Return the first element of STRINGS that is a non-blank string.
2130 STRINGS will be evaluated in normal `or' order."
2131 `(gnus-string-or-1 ',strings))
2133 (defun gnus-string-or-1 (strings)
2136 (setq string (eval (pop strings)))
2137 (if (string-match "^[ \t]*$" string)
2139 (setq strings nil)))
2142 (defun gnus-version (&optional arg)
2143 "Version number of this version of Gnus.
2144 If ARG, insert string at point."
2147 (insert (message gnus-version))
2148 (message gnus-version)))
2150 (defun gnus-continuum-version (version)
2151 "Return VERSION as a floating point number."
2152 (when (string-match "(based on \\(.*Gnus[^;]+\\)" version)
2153 (setq version (match-string 1 version)))
2154 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2155 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2156 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2157 (number (match-string 2 version))
2159 (unless (string-match
2160 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2161 (error "Invalid version string: %s" version))
2162 (setq major (string-to-number (match-string 1 number))
2163 minor (string-to-number (match-string 2 number))
2164 least (if (match-beginning 3)
2165 (string-to-number (match-string 3 number))
2169 (format "%s00%02d%02d"
2170 (if (member alpha '("(ding)" "d"))
2174 (- (mm-char-int (aref (downcase alpha) 0))
2178 (format "%d.%02d%02d" major minor least))))))
2180 (defun gnus-info-find-node ()
2181 "Find Info documentation of Gnus."
2183 ;; Enlarge info window if needed.
2184 (let (gnus-info-buffer)
2185 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2186 (setq gnus-info-buffer (current-buffer))
2187 (gnus-configure-windows 'info)))
2190 ;;; gnus-interactive
2193 (defvar gnus-current-prefix-symbol nil
2194 "Current prefix symbol.")
2196 (defvar gnus-current-prefix-symbols nil
2197 "List of current prefix symbols.")
2199 (defun gnus-interactive (string &optional params)
2200 "Return a list that can be fed to `interactive'.
2201 See `interactive' for full documentation.
2203 Adds the following specs:
2205 y -- The current symbolic prefix.
2206 Y -- A list of the current symbolic prefix(es).
2207 A -- Article number.
2208 H -- Article header.
2212 (while (< i (length string))
2213 (string-match ".\\([^\n]*\\)\n?" string i)
2214 (setq c (aref string i))
2216 (setq prompt (match-string 1 string)))
2217 (setq i (match-end 0))
2218 ;; We basically emulate just about everything that
2219 ;; `interactive' does, but add the specs listed above.
2223 (completing-read prompt obarray 'fboundp t))
2225 (read-buffer prompt (current-buffer) t))
2227 (read-buffer prompt (other-buffer (current-buffer))))
2231 (completing-read prompt obarray 'commandp t))
2235 (read-file-name prompt nil default-directory 'lambda))
2237 (read-file-name prompt nil nil 'lambda))
2239 (read-file-name prompt))
2241 (read-key-sequence prompt))
2243 (error "Not implemented spec"))
2245 (error "Not implemented spec"))
2249 (error "Not implemented spec"))
2251 (string-to-number (read-from-minibuffer prompt)))
2253 (prefix-numeric-value current-prefix-arg))
2259 (read-string prompt))
2261 (intern (read-string prompt)))
2263 (read-variable prompt))
2265 (read-minibuffer prompt))
2267 (eval-minibuffer prompt))
2268 ;; And here the new specs come.
2270 gnus-current-prefix-symbol)
2272 gnus-current-prefix-symbols)
2274 (gnus-group-group-name))
2276 (gnus-summary-skip-intangible)
2277 (or (get-text-property (point) 'gnus-number)
2278 (gnus-summary-last-subject)))
2280 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2282 (error "Non-implemented spec")))
2286 (push (if (< (point) (mark) (point) (mark))) out)
2287 (push (if (> (point) (mark) (point) (mark))) out))))
2288 (setq out (delq 'gnus-prefix-nil out))
2291 (defun gnus-symbolic-argument (&optional arg)
2292 "Read a symbolic argument and a command, and then execute command."
2294 (let* ((in-command (this-command-keys))
2295 (command in-command)
2296 gnus-current-prefix-symbols
2297 gnus-current-prefix-symbol
2299 (while (equal in-command command)
2300 (message "%s-" (key-description (this-command-keys)))
2301 (push (intern (char-to-string (read-char))) syms)
2302 (setq command (read-key-sequence nil t)))
2303 (setq gnus-current-prefix-symbols (nreverse syms)
2304 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2305 (call-interactively (key-binding command t))))
2307 ;;; More various functions.
2309 (defsubst gnus-check-backend-function (func group)
2310 "Check whether GROUP supports function FUNC.
2311 GROUP can either be a string (a group name) or a select method."
2313 (let ((method (if (stringp group)
2314 (car (gnus-find-method-for-group group))
2316 (unless (featurep method)
2318 (fboundp (intern (format "%s-%s" method func))))))
2320 (defun gnus-group-read-only-p (&optional group)
2321 "Check whether GROUP supports editing or not.
2322 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2323 that that variable is buffer-local to the summary buffers."
2324 (let ((group (or group gnus-newsgroup-name)))
2325 (not (gnus-check-backend-function 'request-replace-article group))))
2327 (defun gnus-group-total-expirable-p (group)
2328 "Check whether GROUP is total-expirable or not."
2329 (let ((params (gnus-group-find-parameter group))
2332 ((memq 'total-expire params)
2334 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2336 (gnus-total-expirable-newsgroups ; Check var.
2337 (string-match gnus-total-expirable-newsgroups group)))))
2339 (defun gnus-group-auto-expirable-p (group)
2340 "Check whether GROUP is auto-expirable or not."
2341 (let ((params (gnus-group-find-parameter group))
2344 ((memq 'auto-expire params)
2346 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2348 (gnus-auto-expirable-newsgroups ; Check var.
2349 (string-match gnus-auto-expirable-newsgroups group)))))
2351 (defun gnus-virtual-group-p (group)
2352 "Say whether GROUP is virtual or not."
2353 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2354 gnus-valid-select-methods)))
2356 (defun gnus-news-group-p (group &optional article)
2357 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2358 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2359 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2360 (if (or (null article)
2361 (not (< article 0)))
2362 (eq (gnus-request-type group article) 'news)
2363 (if (not (vectorp article))
2365 ;; It's a real article.
2366 (eq (gnus-request-type group (mail-header-id article))
2369 ;; Returns a list of writable groups.
2370 (defun gnus-writable-groups ()
2371 (let ((alist gnus-newsrc-alist)
2373 (while (setq group (car (pop alist)))
2374 (unless (gnus-group-read-only-p group)
2375 (push group groups)))
2378 ;; Check whether to use long file names.
2379 (defun gnus-use-long-file-name (symbol)
2380 ;; The variable has to be set...
2381 (and gnus-use-long-file-name
2382 ;; If it isn't a list, then we return t.
2383 (or (not (listp gnus-use-long-file-name))
2384 ;; If it is a list, and the list contains `symbol', we
2386 (not (memq symbol gnus-use-long-file-name)))))
2388 ;; Generate a unique new group name.
2389 (defun gnus-generate-new-group-name (leaf)
2392 (while (gnus-gethash name gnus-newsrc-hashtb)
2393 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2396 (defun gnus-ephemeral-group-p (group)
2397 "Say whether GROUP is ephemeral or not."
2398 (gnus-group-get-parameter group 'quit-config t))
2400 (defun gnus-group-quit-config (group)
2401 "Return the quit-config of GROUP."
2402 (gnus-group-get-parameter group 'quit-config t))
2404 (defun gnus-kill-ephemeral-group (group)
2405 "Remove ephemeral GROUP from relevant structures."
2406 (gnus-sethash group nil gnus-newsrc-hashtb))
2408 (defun gnus-simplify-mode-line ()
2409 "Make mode lines a bit simpler."
2410 (setq mode-line-modified (cdr gnus-mode-line-modified))
2411 (when (listp mode-line-format)
2412 (make-local-variable 'mode-line-format)
2413 (setq mode-line-format (copy-sequence mode-line-format))
2414 (when (equal (nth 3 mode-line-format) " ")
2415 (setcar (nthcdr 3 mode-line-format) " "))))
2417 ;;; Servers and groups.
2419 (defsubst gnus-server-add-address (method)
2420 (let ((method-name (symbol-name (car method))))
2421 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2422 (not (assq (intern (concat method-name "-address")) method))
2423 (memq 'physical-address (assq (car method)
2424 gnus-valid-select-methods)))
2425 (append method (list (list (intern (concat method-name "-address"))
2429 (defsubst gnus-server-get-method (group method)
2430 ;; Input either a server name, and extended server name, or a
2431 ;; select method, and return a select method.
2432 (cond ((stringp method)
2433 (gnus-server-to-method method))
2434 ((equal method gnus-select-method)
2436 ((and (stringp (car method))
2438 (gnus-server-extend-method group method))
2441 (equal (cadr method) ""))
2444 (gnus-server-add-address method))))
2446 (defun gnus-server-to-method (server)
2447 "Map virtual server names to select methods."
2449 ;; Is this a method, perhaps?
2450 (and server (listp server) server)
2451 ;; Perhaps this is the native server?
2452 (and (equal server "native") gnus-select-method)
2453 ;; It should be in the server alist.
2454 (cdr (assoc server gnus-server-alist))
2455 ;; It could be in the predefined server alist.
2456 (cdr (assoc server gnus-predefined-server-alist))
2457 ;; If not, we look through all the opened server
2458 ;; to see whether we can find it there.
2459 (let ((opened gnus-opened-servers))
2461 (not (equal server (format "%s:%s" (caaar opened)
2465 ;; It could be a named method, search all servers
2466 (let ((servers gnus-secondary-select-methods))
2468 (not (equal server (format "%s:%s" (caar servers)
2473 (defmacro gnus-method-equal (ss1 ss2)
2474 "Say whether two servers are equal."
2478 (and (= (length s1) (length s2))
2480 (while (and s1 (member (car s1) s2))
2484 (defun gnus-methods-equal-p (m1 m2)
2485 (let ((m1 (or m1 gnus-select-method))
2486 (m2 (or m2 gnus-select-method)))
2488 (and (eq (car m1) (car m2))
2489 (or (not (memq 'address (assoc (symbol-name (car m1))
2490 gnus-valid-select-methods)))
2491 (equal (nth 1 m1) (nth 1 m2)))))))
2493 (defun gnus-server-equal (m1 m2)
2494 "Say whether two methods are equal."
2495 (let ((m1 (cond ((null m1) gnus-select-method)
2496 ((stringp m1) (gnus-server-to-method m1))
2498 (m2 (cond ((null m2) gnus-select-method)
2499 ((stringp m2) (gnus-server-to-method m2))
2501 (gnus-method-equal m1 m2)))
2503 (defun gnus-servers-using-backend (backend)
2504 "Return a list of known servers using BACKEND."
2505 (let ((opened gnus-opened-servers)
2508 (when (eq backend (caaar opened))
2509 (push (caar opened) out))
2513 (defun gnus-archive-server-wanted-p ()
2514 "Say whether the user wants to use the archive server."
2516 ((or (not gnus-message-archive-method)
2517 (not gnus-message-archive-group))
2519 ((and gnus-message-archive-method gnus-message-archive-group)
2522 (let ((active (cadr (assq 'nnfolder-active-file
2523 gnus-message-archive-method))))
2525 (file-exists-p active))))))
2527 (defun gnus-group-prefixed-name (group method)
2528 "Return the whole name from GROUP and METHOD."
2529 (and (stringp method) (setq method (gnus-server-to-method method)))
2530 (if (or (not method)
2531 (gnus-server-equal method "native"))
2533 (concat (format "%s" (car method))
2535 (or (assoc (format "%s" (car method))
2536 (gnus-methods-using 'address))
2537 (gnus-server-equal method gnus-message-archive-method))
2539 (not (string= (nth 1 method) "")))
2540 (concat "+" (nth 1 method)))
2543 (defun gnus-group-real-prefix (group)
2544 "Return the prefix of the current group name."
2545 (if (string-match "^[^:]+:" group)
2546 (substring group 0 (match-end 0))
2549 (defun gnus-group-method (group)
2550 "Return the server or method used for selecting GROUP.
2551 You should probably use `gnus-find-method-for-group' instead."
2552 (let ((prefix (gnus-group-real-prefix group)))
2553 (if (equal prefix "")
2555 (let ((servers gnus-opened-servers)
2557 backend possible found)
2558 (if (string-match "^[^\\+]+\\+" prefix)
2559 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2560 server (substring prefix (match-end 0) (1- (length prefix))))
2561 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2563 (when (eq (caaar servers) backend)
2564 (setq possible (caar servers))
2565 (when (equal (cadaar servers) server)
2566 (setq found (caar servers))))
2568 (or (car (rassoc found gnus-server-alist))
2570 (car (rassoc possible gnus-server-alist))
2572 (list backend server))))))
2574 (defsubst gnus-native-method-p (method)
2575 "Return whether METHOD is the native select method."
2576 (gnus-method-equal method gnus-select-method))
2578 (defsubst gnus-secondary-method-p (method)
2579 "Return whether METHOD is a secondary select method."
2580 (let ((methods gnus-secondary-select-methods)
2581 (gmethod (gnus-server-get-method nil method)))
2583 (not (gnus-method-equal
2584 (gnus-server-get-method nil (car methods))
2586 (setq methods (cdr methods)))
2589 (defun gnus-method-simplify (method)
2590 "Return the shortest uniquely identifying string or method for METHOD."
2591 (cond ((stringp method)
2593 ((gnus-native-method-p method)
2595 ((gnus-secondary-method-p method)
2596 (format "%s:%s" (nth 0 method) (nth 1 method)))
2600 (defun gnus-groups-from-server (server)
2601 "Return a list of all groups that are fetched from SERVER."
2602 (let ((alist (cdr gnus-newsrc-alist))
2604 (while (setq info (pop alist))
2605 (when (gnus-server-equal (gnus-info-method info) server)
2606 (push (gnus-info-group info) groups)))
2607 (sort groups 'string<)))
2609 (defun gnus-group-foreign-p (group)
2610 "Say whether a group is foreign or not."
2611 (and (not (gnus-group-native-p group))
2612 (not (gnus-group-secondary-p group))))
2614 (defun gnus-group-native-p (group)
2615 "Say whether the group is native or not."
2616 (not (string-match ":" group)))
2618 (defun gnus-group-secondary-p (group)
2619 "Say whether the group is secondary or not."
2620 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2622 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2623 "Return the group parameters for GROUP.
2624 If SYMBOL, return the value of that symbol in the group parameters."
2626 (set-buffer gnus-group-buffer)
2627 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2629 (gnus-group-parameter-value parameters symbol allow-list)
2632 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2633 "Return the group parameters for GROUP.
2634 If SYMBOL, return the value of that symbol in the group parameters.
2635 Most functions should use `gnus-group-find-parameter', which
2636 also examines the topic parameters."
2637 (let ((params (gnus-info-params (gnus-get-info group))))
2639 (gnus-group-parameter-value params symbol allow-list)
2642 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2643 "Return the value of SYMBOL in group PARAMS."
2644 ;; We only wish to return group parameters (dotted lists) and
2645 ;; not local variables, which may have the same names.
2646 ;; But first we handle single elements...
2647 (or (car (memq symbol params))
2651 (while (setq elem (pop params))
2652 (when (and (consp elem)
2653 (eq (car elem) symbol)
2656 (throw 'found (cdr elem))))))))
2658 (defun gnus-group-add-parameter (group param)
2659 "Add parameter PARAM to GROUP."
2660 (let ((info (gnus-get-info group)))
2662 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2663 ;; Cons the new param to the old one and update.
2664 (gnus-group-set-info (cons param (gnus-info-params info))
2667 (defun gnus-group-set-parameter (group name value)
2668 "Set parameter NAME to VALUE in GROUP."
2669 (let ((info (gnus-get-info group)))
2671 (gnus-group-remove-parameter group name)
2672 (let ((old-params (gnus-info-params info))
2673 (new-params (list (cons name value))))
2675 (when (or (not (listp (car old-params)))
2676 (not (eq (caar old-params) name)))
2677 (setq new-params (append new-params (list (car old-params)))))
2678 (setq old-params (cdr old-params)))
2679 (gnus-group-set-info new-params group 'params)))))
2681 (defun gnus-group-remove-parameter (group name)
2682 "Remove parameter NAME from GROUP."
2683 (let ((info (gnus-get-info group)))
2685 (let ((params (gnus-info-params info)))
2687 (setq params (delq name params))
2688 (while (assq name params)
2689 (gnus-pull name params))
2690 (gnus-info-set-params info params))))))
2692 (defun gnus-group-add-score (group &optional score)
2693 "Add SCORE to the GROUP score.
2694 If SCORE is nil, add 1 to the score of GROUP."
2695 (let ((info (gnus-get-info group)))
2697 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2699 (defun gnus-short-group-name (group &optional levels)
2700 "Collapse GROUP name LEVELS.
2701 Select methods are stripped and any remote host name is stripped down to
2702 just the host name."
2708 gnus-group-uncollapsed-levels
2710 (while (string-match "\\." group skip)
2711 (setq skip (match-end 0)
2714 ;; Separate foreign select method from group name and collapse.
2715 ;; If method contains a server, collapse to non-domain server name,
2716 ;; otherwise collapse to select method.
2717 (let* ((colon (string-match ":" group))
2718 (server (and colon (substring group 0 colon)))
2719 (plus (and server (string-match "+" server))))
2722 (setq foreign (substring server (+ 1 plus)
2723 (string-match "\\." server))
2724 group (substring group (+ 1 colon)))
2725 (setq foreign server
2726 group (substring group (+ 1 colon))))
2727 (setq foreign (concat foreign ":")))
2728 ;; Collapse group name leaving LEVELS uncollapsed elements
2729 (let* ((glist (split-string group "\\."))
2730 (glen (length glist))
2732 (setq levels (- glen levels))
2734 (push (if (>= (decf levels) 0)
2735 (if (zerop (length g))
2740 (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2742 (defun gnus-narrow-to-body ()
2743 "Narrow to the body of an article."
2746 (goto-char (point-min))
2747 (or (search-forward "\n\n" nil t)
2753 ;;; Kill file handling.
2756 (defun gnus-apply-kill-file ()
2757 "Apply a kill file to the current newsgroup.
2758 Returns the number of articles marked as read."
2759 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2760 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2761 (gnus-apply-kill-file-internal)
2764 (defun gnus-kill-save-kill-buffer ()
2765 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2766 (when (get-file-buffer file)
2768 (set-buffer (get-file-buffer file))
2769 (when (buffer-modified-p)
2771 (kill-buffer (current-buffer))))))
2773 (defcustom gnus-kill-file-name "KILL"
2774 "Suffix of the kill files."
2775 :group 'gnus-score-kill
2776 :group 'gnus-score-files
2779 (defun gnus-newsgroup-kill-file (newsgroup)
2780 "Return the name of a kill file name for NEWSGROUP.
2781 If NEWSGROUP is nil, return the global kill file name instead."
2783 ;; The global KILL file is placed at top of the directory.
2784 ((or (null newsgroup)
2785 (string-equal newsgroup ""))
2786 (expand-file-name gnus-kill-file-name
2787 gnus-kill-files-directory))
2788 ;; Append ".KILL" to newsgroup name.
2789 ((gnus-use-long-file-name 'not-kill)
2790 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2791 "." gnus-kill-file-name)
2792 gnus-kill-files-directory))
2793 ;; Place "KILL" under the hierarchical directory.
2795 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2796 "/" gnus-kill-file-name)
2797 gnus-kill-files-directory))))
2801 (defun gnus-member-of-valid (symbol group)
2802 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2804 (symbol-name (car (gnus-find-method-for-group group)))
2805 gnus-valid-select-methods)))
2807 (defun gnus-method-option-p (method option)
2808 "Return non-nil if select METHOD has OPTION as a parameter."
2809 (when (stringp method)
2810 (setq method (gnus-server-to-method method)))
2811 (memq option (assoc (format "%s" (car method))
2812 gnus-valid-select-methods)))
2814 (defun gnus-similar-server-opened (method)
2815 (let ((opened gnus-opened-servers))
2816 (while (and method opened)
2817 (when (and (equal (cadr method) (cadaar opened))
2818 (equal (car method) (caaar opened))
2819 (not (equal method (caar opened))))
2824 (defun gnus-server-extend-method (group method)
2825 ;; This function "extends" a virtual server. If the server is
2826 ;; "hello", and the select method is ("hello" (my-var "something"))
2827 ;; in the group "alt.alt", this will result in a new virtual server
2828 ;; called "hello+alt.alt".
2829 (if (or (not (inline (gnus-similar-server-opened method)))
2830 (not (cddr method)))
2832 `(,(car method) ,(concat (cadr method) "+" group)
2833 (,(intern (format "%s-address" (car method))) ,(cadr method))
2836 (defun gnus-server-status (method)
2837 "Return the status of METHOD."
2838 (nth 1 (assoc method gnus-opened-servers)))
2840 (defun gnus-group-name-to-method (group)
2841 "Guess a select method based on GROUP."
2842 (if (string-match ":" group)
2843 (let ((server (substring group 0 (match-beginning 0))))
2844 (if (string-match "\\+" server)
2845 (list (intern (substring server 0 (match-beginning 0)))
2846 (substring server (match-end 0)))
2847 (list (intern server) "")))
2848 gnus-select-method))
2850 (defun gnus-find-method-for-group (group &optional info)
2851 "Find the select method that GROUP uses."
2852 (or gnus-override-method
2855 (and (not (gnus-group-entry group));; a new group
2856 (gnus-group-name-to-method group))
2857 (let ((info (or info (gnus-get-info group)))
2860 (not (setq method (gnus-info-method info)))
2861 (equal method "native"))
2864 (cond ((stringp method)
2865 (inline (gnus-server-to-method method)))
2866 ((stringp (cadr method))
2867 (inline (gnus-server-extend-method group method)))
2870 (cond ((equal (cadr method) "")
2872 ((null (cadr method))
2873 (list (car method) ""))
2875 (gnus-server-add-address method)))))))
2877 (defun gnus-methods-using (feature)
2878 "Find all methods that have FEATURE."
2879 (let ((valids gnus-valid-select-methods)
2882 (when (memq feature (car valids))
2883 (push (car valids) outs))
2884 (setq valids (cdr valids)))
2887 (defun gnus-read-group (prompt &optional default)
2888 "Prompt the user for a group name.
2889 Disallow invalid group names."
2895 (setq group (read-string (concat prefix prompt)
2896 (cons (or default "") 0)
2897 'gnus-group-history)))
2898 (setq prefix (format "Invalid group name: \"%s\". " group)
2902 (defun gnus-read-method (prompt)
2903 "Prompt the user for a method.
2904 Allow completion over sensible values."
2906 (append gnus-valid-select-methods
2907 (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2909 gnus-opened-servers)
2910 gnus-predefined-server-alist
2915 nil t nil 'gnus-method-history)))
2918 (setq method gnus-select-method))
2919 ((assoc method gnus-valid-select-methods)
2920 (let ((address (if (memq 'prompt-address
2921 (assoc method gnus-valid-select-methods))
2922 (read-string "Address: ")
2924 (or (let ((opened gnus-opened-servers))
2926 (not (equal (format "%s:%s" method address)
2927 (format "%s:%s" (caaar opened)
2931 (list (intern method) address))))
2932 ((assoc method servers)
2935 (list (intern method) "")))))
2937 ;;; User-level commands.
2940 (defun gnus-slave-no-server (&optional arg)
2941 "Read network news as a slave, without connecting to local server."
2943 (gnus-no-server arg t))
2946 (defun gnus-no-server (&optional arg slave)
2948 If ARG is a positive number, Gnus will use that as the
2949 startup level. If ARG is nil, Gnus will be started at level 2.
2950 If ARG is non-nil and not a positive number, Gnus will
2951 prompt the user for the name of an NNTP server to use.
2952 As opposed to `gnus', this command will not connect to the local server."
2954 (gnus-no-server-1 arg slave))
2957 (defun gnus-slave (&optional arg)
2958 "Read news as a slave."
2960 (gnus arg nil 'slave))
2963 (defun gnus-other-frame (&optional arg)
2964 "Pop up a frame to read news."
2966 (let ((window (get-buffer-window gnus-group-buffer)))
2968 (select-frame (window-frame window)))
2970 (select-frame (make-frame)))))
2973 ;;(setq thing ? ; this is a comment
2977 (defun gnus (&optional arg dont-connect slave)
2979 If ARG is non-nil and a positive number, Gnus will use that as the
2980 startup level. If ARG is non-nil and not a positive number, Gnus will
2981 prompt the user for the name of an NNTP server to use."
2983 (gnus-1 arg dont-connect slave))
2985 ;; Allow redefinition of Gnus functions.
2989 (product-provide (provide 'gnus) 'gnus-vers)
2991 ;;; gnus.el ends here