1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval '(run-hooks 'gnus-load-hook))
31 (eval-when-compile (require 'cl))
35 (if (< emacs-major-version 20)
36 (require 'gnus-load)))
40 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
44 (defgroup gnus-cache nil
48 (defgroup gnus-start nil
49 "Starting your favorite newsreader."
52 (defgroup gnus-start-server nil
53 "Server options at startup."
56 ;; These belong to gnus-group.el.
57 (defgroup gnus-group nil
59 :link '(custom-manual "(gnus)The Group Buffer")
62 (defgroup gnus-group-foreign nil
64 :link '(custom-manual "(gnus)Foreign Groups")
67 (defgroup gnus-group-new nil
68 "Automatic subscription of new groups."
71 (defgroup gnus-group-levels nil
73 :link '(custom-manual "(gnus)Group Levels")
76 (defgroup gnus-group-select nil
78 :link '(custom-manual "(gnus)Selecting a Group")
81 (defgroup gnus-group-listing nil
82 "Showing slices of the group list."
83 :link '(custom-manual "(gnus)Listing Groups")
86 (defgroup gnus-group-visual nil
87 "Sorting the group buffer."
88 :link '(custom-manual "(gnus)Group Buffer Format")
92 (defgroup gnus-group-various nil
93 "Various group options."
94 :link '(custom-manual "(gnus)Scanning New Messages")
97 ;; These belong to gnus-sum.el.
98 (defgroup gnus-summary nil
100 :link '(custom-manual "(gnus)The Summary Buffer")
103 (defgroup gnus-summary-exit nil
104 "Leaving summary buffers."
105 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
106 :group 'gnus-summary)
108 (defgroup gnus-summary-marks nil
109 "Marks used in summary buffers."
110 :link '(custom-manual "(gnus)Marking Articles")
111 :group 'gnus-summary)
113 (defgroup gnus-thread nil
114 "Ordering articles according to replies."
115 :link '(custom-manual "(gnus)Threading")
116 :group 'gnus-summary)
118 (defgroup gnus-summary-format nil
119 "Formatting of the summary buffer."
120 :link '(custom-manual "(gnus)Summary Buffer Format")
121 :group 'gnus-summary)
123 (defgroup gnus-summary-choose nil
125 :link '(custom-manual "(gnus)Choosing Articles")
126 :group 'gnus-summary)
128 (defgroup gnus-summary-maneuvering nil
129 "Summary movement commands."
130 :link '(custom-manual "(gnus)Summary Maneuvering")
131 :group 'gnus-summary)
133 (defgroup gnus-summary-mail nil
134 "Mail group commands."
135 :link '(custom-manual "(gnus)Mail Group Commands")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-sort nil
139 "Sorting the summary buffer."
140 :link '(custom-manual "(gnus)Sorting")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-visual nil
144 "Highlighting and menus in the summary buffer."
145 :link '(custom-manual "(gnus)Summary Highlighting")
147 :group 'gnus-summary)
149 (defgroup gnus-summary-various nil
150 "Various summary buffer options."
151 :link '(custom-manual "(gnus)Various Summary Stuff")
152 :group 'gnus-summary)
154 (defgroup gnus-summary-pick nil
155 "Pick mode in the summary buffer."
156 :link '(custom-manual "(gnus)Pick and Read")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-tree nil
161 "Tree display of threads in the summary buffer."
162 :link '(custom-manual "(gnus)Tree Display")
164 :group 'gnus-summary)
166 ;; Belongs to gnus-uu.el
167 (defgroup gnus-extract-view nil
168 "Viewing extracted files."
169 :link '(custom-manual "(gnus)Viewing Files")
170 :group 'gnus-extract)
172 ;; Belongs to gnus-score.el
173 (defgroup gnus-score nil
174 "Score and kill file handling."
177 (defgroup gnus-score-kill nil
181 (defgroup gnus-score-adapt nil
182 "Adaptive score files."
185 (defgroup gnus-score-default nil
186 "Default values for score files."
189 (defgroup gnus-score-expire nil
190 "Expiring score rules."
193 (defgroup gnus-score-decay nil
194 "Decaying score rules."
197 (defgroup gnus-score-files nil
198 "Score and kill file names."
202 (defgroup gnus-score-various nil
203 "Various scoring and killing options."
207 (defgroup gnus-visual nil
208 "Options controling the visual fluff."
212 (defgroup gnus-agent nil
213 "Offline support for Gnus."
216 (defgroup gnus-files nil
217 "Files used by Gnus."
220 (defgroup gnus-dribble-file nil
222 :link '(custom-manual "(gnus)Auto Save")
225 (defgroup gnus-newsrc nil
226 "Storing Gnus state."
229 (defgroup gnus-server nil
230 "Options related to newsservers and other servers used by Gnus."
233 (defgroup gnus-message '((message custom-group))
234 "Composing replies and followups in Gnus."
237 (defgroup gnus-meta nil
238 "Meta variables controling major portions of Gnus.
239 In general, modifying these variables does not take affect until Gnus
240 is restarted, and sometimes reloaded."
243 (defgroup gnus-various nil
244 "Other Gnus options."
245 :link '(custom-manual "(gnus)Various Various")
248 (defgroup gnus-exit nil
250 :link '(custom-manual "(gnus)Exiting Gnus")
253 (defconst gnus-version-number "6.8.16"
254 "Version number for this version of gnus.")
256 (defconst gnus-version
257 (format "Semi-gnus %s (based on Gnus 5.6.41; for SEMI 1.8, FLIM 1.8/1.9)"
259 "Version string for this version of gnus.")
261 (defcustom gnus-inhibit-startup-message nil
262 "If non-nil, the startup message will not be displayed.
263 This variable is used before `.gnus.el' is loaded, so it should
264 be set in `.emacs' instead."
268 (defcustom gnus-play-startup-jingle nil
269 "If non-nil, play the Gnus jingle at startup."
273 ;;; Kludges to help the transition from the old `custom.el'.
275 (unless (featurep 'gnus-xmas)
276 (defalias 'gnus-make-overlay 'make-overlay)
277 (defalias 'gnus-delete-overlay 'delete-overlay)
278 (defalias 'gnus-overlay-put 'overlay-put)
279 (defalias 'gnus-move-overlay 'move-overlay)
280 (defalias 'gnus-overlay-end 'overlay-end)
281 (defalias 'gnus-extent-detached-p 'ignore)
282 (defalias 'gnus-extent-start-open 'ignore)
283 (defalias 'gnus-set-text-properties 'set-text-properties)
284 (defalias 'gnus-group-remove-excess-properties 'ignore)
285 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
286 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
287 (defalias 'gnus-character-to-event 'identity)
288 (defalias 'gnus-add-text-properties 'add-text-properties)
289 (defalias 'gnus-put-text-property 'put-text-property)
290 (defalias 'gnus-mode-line-buffer-identification 'identity)
291 (defalias 'gnus-characterp 'numberp)
292 (defalias 'gnus-deactivate-mark 'deactivate-mark)
293 (defalias 'gnus-window-edges 'window-edges)
294 (defalias 'gnus-key-press-event-p 'numberp))
296 ;; We define these group faces here to avoid the display
297 ;; update forced when creating new faces.
299 (defface gnus-group-news-1-face
302 (:foreground "PaleTurquoise" :bold t))
305 (:foreground "ForestGreen" :bold t))
308 "Level 1 newsgroup face.")
310 (defface gnus-group-news-1-empty-face
313 (:foreground "PaleTurquoise"))
316 (:foreground "ForestGreen"))
319 "Level 1 empty newsgroup face.")
321 (defface gnus-group-news-2-face
324 (:foreground "turquoise" :bold t))
327 (:foreground "CadetBlue4" :bold t))
330 "Level 2 newsgroup face.")
332 (defface gnus-group-news-2-empty-face
335 (:foreground "turquoise"))
338 (:foreground "CadetBlue4"))
341 "Level 2 empty newsgroup face.")
343 (defface gnus-group-news-3-face
352 "Level 3 newsgroup face.")
354 (defface gnus-group-news-3-empty-face
363 "Level 3 empty newsgroup face.")
365 (defface gnus-group-news-low-face
368 (:foreground "DarkTurquoise" :bold t))
371 (:foreground "DarkGreen" :bold t))
374 "Low level newsgroup face.")
376 (defface gnus-group-news-low-empty-face
379 (:foreground "DarkTurquoise"))
382 (:foreground "DarkGreen"))
385 "Low level empty newsgroup face.")
387 (defface gnus-group-mail-1-face
390 (:foreground "aquamarine1" :bold t))
393 (:foreground "DeepPink3" :bold t))
396 "Level 1 mailgroup face.")
398 (defface gnus-group-mail-1-empty-face
401 (:foreground "aquamarine1"))
404 (:foreground "DeepPink3"))
406 (:italic t :bold t)))
407 "Level 1 empty mailgroup face.")
409 (defface gnus-group-mail-2-face
412 (:foreground "aquamarine2" :bold t))
415 (:foreground "HotPink3" :bold t))
418 "Level 2 mailgroup face.")
420 (defface gnus-group-mail-2-empty-face
423 (:foreground "aquamarine2"))
426 (:foreground "HotPink3"))
429 "Level 2 empty mailgroup face.")
431 (defface gnus-group-mail-3-face
434 (:foreground "aquamarine3" :bold t))
437 (:foreground "magenta4" :bold t))
440 "Level 3 mailgroup face.")
442 (defface gnus-group-mail-3-empty-face
445 (:foreground "aquamarine3"))
448 (:foreground "magenta4"))
451 "Level 3 empty mailgroup face.")
453 (defface gnus-group-mail-low-face
456 (:foreground "aquamarine4" :bold t))
459 (:foreground "DeepPink4" :bold t))
462 "Low level mailgroup face.")
464 (defface gnus-group-mail-low-empty-face
467 (:foreground "aquamarine4"))
470 (:foreground "DeepPink4"))
473 "Low level empty mailgroup face.")
475 ;; Summary mode faces.
477 (defface gnus-summary-selected-face '((t
479 "Face used for selected articles.")
481 (defface gnus-summary-cancelled-face
483 (:foreground "yellow" :background "black")))
484 "Face used for cancelled articles.")
486 (defface gnus-summary-high-ticked-face
489 (:foreground "pink" :bold t))
492 (:foreground "firebrick" :bold t))
495 "Face used for high interest ticked articles.")
497 (defface gnus-summary-low-ticked-face
500 (:foreground "pink" :italic t))
503 (:foreground "firebrick" :italic t))
506 "Face used for low interest ticked articles.")
508 (defface gnus-summary-normal-ticked-face
511 (:foreground "pink"))
514 (:foreground "firebrick"))
517 "Face used for normal interest ticked articles.")
519 (defface gnus-summary-high-ancient-face
522 (:foreground "SkyBlue" :bold t))
525 (:foreground "RoyalBlue" :bold t))
528 "Face used for high interest ancient articles.")
530 (defface gnus-summary-low-ancient-face
533 (:foreground "SkyBlue" :italic t))
536 (:foreground "RoyalBlue" :italic t))
539 "Face used for low interest ancient articles.")
541 (defface gnus-summary-normal-ancient-face
544 (:foreground "SkyBlue"))
547 (:foreground "RoyalBlue"))
550 "Face used for normal interest ancient articles.")
552 (defface gnus-summary-high-unread-face
555 "Face used for high interest unread articles.")
557 (defface gnus-summary-low-unread-face
560 "Face used for low interest unread articles.")
562 (defface gnus-summary-normal-unread-face
565 "Face used for normal interest unread articles.")
567 (defface gnus-summary-high-read-face
570 (:foreground "PaleGreen"
574 (:foreground "DarkGreen"
578 "Face used for high interest read articles.")
580 (defface gnus-summary-low-read-face
583 (:foreground "PaleGreen"
587 (:foreground "DarkGreen"
591 "Face used for low interest read articles.")
593 (defface gnus-summary-normal-read-face
596 (:foreground "PaleGreen"))
599 (:foreground "DarkGreen"))
602 "Face used for normal interest read articles.")
609 (defvar gnus-buffers nil)
611 (defun gnus-get-buffer-create (name)
612 "Do the same as `get-buffer-create', but store the created buffer."
613 (or (get-buffer name)
614 (car (push (get-buffer-create name) gnus-buffers))))
616 (defun gnus-add-buffer ()
617 "Add the current buffer to the list of Gnus buffers."
618 (push (current-buffer) gnus-buffers))
620 (defun gnus-buffers ()
621 "Return a list of live Gnus buffers."
622 (while (and gnus-buffers
623 (not (buffer-name (car gnus-buffers))))
625 (let ((buffers gnus-buffers))
627 (if (buffer-name (cadr buffers))
629 (setcdr buffers (cddr buffers)))))
634 (defvar gnus-group-buffer "*Group*")
637 (autoload 'gnus-play-jingle "gnus-audio"))
639 (defface gnus-splash-face
642 (:foreground "ForestGreen"))
645 (:foreground "ForestGreen"))
648 "Level 1 newsgroup face.")
650 (defun gnus-splash ()
652 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
653 (let ((buffer-read-only nil))
655 (unless gnus-inhibit-startup-message
656 (gnus-group-startup-message)
658 (when gnus-play-startup-jingle
659 (gnus-play-jingle))))))
661 (defun gnus-indent-rigidly (start end arg)
662 "Indent rigidly using only spaces and no tabs."
665 (narrow-to-region start end)
667 (indent-rigidly start end arg)
668 ;; We translate tabs into spaces -- not everybody uses
669 ;; an 8-character tab.
670 (goto-char (point-min))
671 (while (search-forward "\t" nil t)
672 (replace-match " " t t))))))
674 (defvar gnus-simple-splash nil)
676 (defun gnus-group-startup-message (&optional x y)
677 "Insert startup message in current buffer."
678 ;; Insert the message.
683 _ ___ __ ___ __ _ ___
703 (gnus-indent-rigidly (point-min) (point-max)
704 (/ (max (- (window-width) (or x 46)) 0) 2))
705 (goto-char (point-min))
707 (let* ((pheight (count-lines (point-min) (point-max)))
708 (wheight (window-height))
709 (rest (- wheight pheight)))
710 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
712 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
713 (goto-char (point-min))
714 (setq mode-line-buffer-identification (concat " " gnus-version))
715 (setq gnus-simple-splash t)
716 (set-buffer-modified-p t))
719 (let ((command (format "%s" this-command)))
720 (if (and (string-match "gnus" command)
721 (not (string-match "gnus-other-frame" command)))
723 (gnus-get-buffer-create gnus-group-buffer))))
731 (defcustom gnus-home-directory "~/"
732 "Directory variable that specifies the \"home\" directory.
733 All other Gnus path variables are initialized from this variable."
737 (defcustom gnus-directory (or (getenv "SAVEDIR")
738 (nnheader-concat gnus-home-directory "News/"))
739 "*Directory variable from which all other Gnus file variables are derived.
741 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
742 This means that other directory variables that are initialized from
743 this variable won't be set properly if you set this variable in `.gnus.el'.
744 Set this variable in `.emacs' instead."
748 (defcustom gnus-default-directory nil
749 "*Default directory for all Gnus buffers."
751 :type '(choice (const :tag "current" nil)
754 ;; Site dependent variables. These variables should be defined in
757 (defvar gnus-default-nntp-server nil
758 "Specify a default NNTP server.
759 This variable should be defined in paths.el, and should never be set
761 If you want to change servers, you should use `gnus-select-method'.
762 See the documentation to that variable.")
764 ;; Don't touch this variable.
765 (defvar gnus-nntp-service "nntp"
766 "NNTP service name (\"nntp\" or 119).
767 This is an obsolete variable, which is scarcely used. If you use an
768 nntp server for your newsgroup and want to change the port number
769 used to 899, you would say something along these lines:
771 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
773 (defcustom gnus-nntpserver-file "/etc/nntpserver"
774 "A file with only the name of the nntp server in it."
779 ;; This function is used to check both the environment variable
780 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
781 ;; an nntp server name default.
782 (defun gnus-getenv-nntpserver ()
783 (or (getenv "NNTPSERVER")
784 (and (file-readable-p gnus-nntpserver-file)
786 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
787 (buffer-disable-undo (current-buffer))
788 (insert-file-contents gnus-nntpserver-file)
789 (let ((name (buffer-string)))
791 (if (string-match "^[ \t\n]*$" name)
794 (kill-buffer (current-buffer))))))))
796 (defcustom gnus-select-method
799 (list 'nntp (or (condition-case nil
800 (gnus-getenv-nntpserver)
802 (when (and gnus-default-nntp-server
803 (not (string= gnus-default-nntp-server "")))
804 gnus-default-nntp-server)
806 (if (or (null gnus-nntp-service)
807 (equal gnus-nntp-service "nntp"))
809 (list gnus-nntp-service)))
811 "*Default method for selecting a newsgroup.
812 This variable should be a list, where the first element is how the
813 news is to be fetched, the second is the address.
815 For instance, if you want to get your news via NNTP from
816 \"flab.flab.edu\", you could say:
818 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
820 If you want to use your local spool, say:
822 \(setq gnus-select-method (list 'nnspool (system-name)))
824 If you use this variable, you must set `gnus-nntp-server' to nil.
826 There is a lot more to know about select methods and virtual servers -
827 see the manual for details."
829 :type 'gnus-select-method)
831 (defcustom gnus-message-archive-method
834 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
835 (nnfolder-active-file
836 ,(nnheader-concat message-directory "archive/active"))
837 (nnfolder-get-new-mail nil)
838 (nnfolder-inhibit-expiry t))
839 "*Method used for archiving messages you've sent.
840 This should be a mail method.
842 It's probably not a very effective to change this variable once you've
843 run Gnus once. After doing that, you must edit this server from the
847 :type 'gnus-select-method)
849 (defcustom gnus-message-archive-group nil
850 "*Name of the group in which to save the messages you've written.
851 This can either be a string; a list of strings; or an alist
852 of regexps/functions/forms to be evaluated to return a string (or a list
853 of strings). The functions are called with the name of the current
854 group (or nil) as a parameter.
856 If you want to save your mail in one group and the news articles you
857 write in another group, you could say something like:
859 \(setq gnus-message-archive-group
860 '((if (message-news-p)
864 Normally the group names returned by this variable should be
865 unprefixed -- which implicitly means \"store on the archive server\".
866 However, you may wish to store the message on some other server. In
867 that case, just return a fully prefixed name of the group --
868 \"nnml+private:mail.misc\", for instance."
870 :type '(choice (const :tag "none" nil)
874 (defcustom gnus-secondary-servers nil
875 "List of NNTP servers that the user can choose between interactively.
876 To make Gnus query you for a server, you have to give `gnus' a
877 non-numeric prefix - `C-u M-x gnus', in short."
879 :type '(repeat string))
881 (defcustom gnus-nntp-server nil
882 "*The name of the host running the NNTP server.
883 This variable is semi-obsolete. Use the `gnus-select-method'
886 :type '(choice (const :tag "disable" nil)
889 (defcustom gnus-secondary-select-methods nil
890 "A list of secondary methods that will be used for reading news.
891 This is a list where each element is a complete select method (see
892 `gnus-select-method').
894 If, for instance, you want to read your mail with the nnml backend,
895 you could set this variable:
897 \(setq gnus-secondary-select-methods '((nnml \"\")))"
899 :type '(repeat gnus-select-method))
901 (defvar gnus-backup-default-subscribed-newsgroups
902 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
903 "Default default new newsgroups the first time Gnus is run.
904 Should be set in paths.el, and shouldn't be touched by the user.")
906 (defcustom gnus-local-domain nil
907 "Local domain name without a host name.
908 The DOMAINNAME environment variable is used instead if it is defined.
909 If the `system-name' function returns the full Internet name, there is
910 no need to set this variable."
912 :type '(choice (const :tag "default" nil)
915 (defvar gnus-local-organization nil
916 "String with a description of what organization (if any) the user belongs to.
917 Obsolete variable; use `message-user-organization' instead.")
919 ;; Customization variables
921 (defcustom gnus-refer-article-method nil
922 "Preferred method for fetching an article by Message-ID.
923 If you are reading news from the local spool (with nnspool), fetching
924 articles by Message-ID is painfully slow. By setting this method to an
925 nntp method, you might get acceptable results.
927 The value of this variable must be a valid select method as discussed
928 in the documentation of `gnus-select-method'."
930 :type '(choice (const :tag "default" nil)
933 (defcustom gnus-group-faq-directory
934 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
935 "/ftp@sunsite.auc.dk:/pub/usenet/"
936 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
937 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
938 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
939 "/ftp@rtfm.mit.edu:/pub/usenet/"
940 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
941 "/ftp@ftp.sunet.se:/pub/usenet/"
942 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
943 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
944 "/ftp@ftp.hk.super.net:/mirror/faqs/")
945 "*Directory where the group FAQs are stored.
946 This will most commonly be on a remote machine, and the file will be
949 This variable can also be a list of directories. In that case, the
950 first element in the list will be used by default. The others can
951 be used when being prompted for a site.
953 Note that Gnus uses an aol machine as the default directory. If this
954 feels fundamentally unclean, just think of it as a way to finally get
955 something of value back from them.
957 If the default site is too slow, try one of these:
959 North America: mirrors.aol.com /pub/rtfm/usenet
960 ftp.seas.gwu.edu /pub/rtfm
961 rtfm.mit.edu /pub/usenet
962 Europe: ftp.uni-paderborn.de /pub/FAQ
963 src.doc.ic.ac.uk /usenet/news-FAQS
964 ftp.sunet.se /pub/usenet
965 sunsite.auc.dk /pub/usenet
966 Asia: nctuccca.edu.tw /USENET/FAQ
967 hwarang.postech.ac.kr /pub/usenet
968 ftp.hk.super.net /mirror/faqs"
969 :group 'gnus-group-various
970 :type '(choice directory
973 (defcustom gnus-use-cross-reference t
974 "*Non-nil means that cross referenced articles will be marked as read.
975 If nil, ignore cross references. If t, mark articles as read in
976 subscribed newsgroups. If neither t nor nil, mark as read in all
979 :type '(choice (const :tag "off" nil)
980 (const :tag "subscribed" t)
984 (defcustom gnus-process-mark ?#
986 :group 'gnus-group-visual
987 :group 'gnus-summary-marks
990 (defcustom gnus-asynchronous nil
991 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
992 :group 'gnus-asynchronous
995 (defcustom gnus-large-newsgroup 200
996 "*The number of articles which indicates a large newsgroup.
997 If the number of articles in a newsgroup is greater than this value,
998 confirmation is required for selecting the newsgroup."
999 :group 'gnus-group-select
1002 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1003 "*Non-nil means that the default name of a file to save articles in is the group name.
1004 If it's nil, the directory form of the group name is used instead.
1006 If this variable is a list, and the list contains the element
1007 `not-score', long file names will not be used for score files; if it
1008 contains the element `not-save', long file names will not be used for
1009 saving; and if it contains the element `not-kill', long file names
1010 will not be used for kill files.
1012 Note that the default for this variable varies according to what system
1013 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1014 to nil while on all other systems it defaults to t."
1018 (defcustom gnus-kill-files-directory gnus-directory
1019 "*Name of the directory where kill files will be stored (default \"~/News\")."
1020 :group 'gnus-score-files
1021 :group 'gnus-score-kill
1024 (defcustom gnus-save-score nil
1025 "*If non-nil, save group scoring info."
1026 :group 'gnus-score-various
1030 (defcustom gnus-use-undo t
1031 "*If non-nil, allow undoing in Gnus group mode buffers."
1035 (defcustom gnus-use-adaptive-scoring nil
1036 "*If non-nil, use some adaptive scoring scheme.
1037 If a list, then the values `word' and `line' are meaningful. The
1038 former will perform adaption on individual words in the subject
1039 header while `line' will perform adaption on several headers."
1041 :group 'gnus-score-adapt
1042 :type '(set (const word) (const line)))
1044 (defcustom gnus-use-cache 'passive
1045 "*If nil, Gnus will ignore the article cache.
1046 If `passive', it will allow entering (and reading) articles
1047 explicitly entered into the cache. If anything else, use the
1048 cache to the full extent of the law."
1051 :type '(choice (const :tag "off" nil)
1052 (const :tag "passive" passive)
1053 (const :tag "active" t)))
1055 (defcustom gnus-use-trees nil
1056 "*If non-nil, display a thread tree buffer."
1060 (defcustom gnus-use-grouplens nil
1061 "*If non-nil, use GroupLens ratings."
1065 (defcustom gnus-keep-backlog nil
1066 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1067 If it is a number N, then Gnus will only keep the last N articles
1068 read. If it is neither nil nor a number, Gnus will keep all read
1069 articles. This is not a good idea."
1071 :type '(choice (const :tag "off" nil)
1076 (defcustom gnus-use-nocem nil
1077 "*If non-nil, Gnus will read NoCeM cancel messages."
1081 (defcustom gnus-suppress-duplicates nil
1082 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1086 (defcustom gnus-use-demon nil
1087 "If non-nil, Gnus might use some demons."
1091 (defcustom gnus-use-scoring t
1092 "*If non-nil, enable scoring."
1096 (defcustom gnus-use-picons nil
1097 "*If non-nil, display picons."
1101 (defcustom gnus-summary-prepare-exit-hook
1102 '(gnus-summary-expire-articles)
1103 "*A hook called when preparing to exit from the summary buffer.
1104 It calls `gnus-summary-expire-articles' by default."
1105 :group 'gnus-summary-exit
1108 (defcustom gnus-novice-user t
1109 "*Non-nil means that you are a usenet novice.
1110 If non-nil, verbose messages may be displayed and confirmations may be
1115 (defcustom gnus-expert-user nil
1116 "*Non-nil means that you will never be asked for confirmation about anything.
1117 That doesn't mean *anything* anything; particularly destructive
1118 commands will still require prompting."
1122 (defcustom gnus-interactive-catchup t
1123 "*If non-nil, require your confirmation when catching up a group."
1124 :group 'gnus-group-select
1127 (defcustom gnus-interactive-exit t
1128 "*If non-nil, require your confirmation when exiting Gnus."
1132 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1133 "*Function for extracting address components from a From header.
1134 Two pre-defined function exist: `gnus-extract-address-components',
1135 which is the default, quite fast, and too simplistic solution, and
1136 `mail-extract-address-components', which works much better, but is
1138 :group 'gnus-summary-format
1139 :type '(radio (function-item gnus-extract-address-components)
1140 (function-item mail-extract-address-components)
1141 (function-item std11-extract-address-components)
1142 (function :tag "Other")))
1144 (defcustom gnus-carpal nil
1145 "*If non-nil, display clickable icons."
1149 (defcustom gnus-shell-command-separator ";"
1150 "String used to separate to shell commands."
1154 (defcustom gnus-valid-select-methods
1155 '(("nntp" post address prompt-address physical-address)
1156 ("nnspool" post address)
1157 ("nnvirtual" post-mail virtual prompt-address)
1158 ("nnmbox" mail respool address)
1159 ("nnml" mail respool address)
1160 ("nnmh" mail respool address)
1161 ("nndir" post-mail prompt-address physical-address)
1162 ("nneething" none address prompt-address physical-address)
1163 ("nndoc" none address prompt-address)
1164 ("nnbabyl" mail address respool)
1165 ("nnkiboze" post virtual)
1166 ("nnsoup" post-mail address)
1167 ("nndraft" post-mail)
1168 ("nnfolder" mail respool address)
1169 ("nngateway" post-mail address prompt-address physical-address)
1172 ("nnagent" post-mail))
1173 "*An alist of valid select methods.
1174 The first element of each list lists should be a string with the name
1175 of the select method. The other elements may be the category of
1176 this method (i. e., `post', `mail', `none' or whatever) or other
1177 properties that this method has (like being respoolable).
1178 If you implement a new select method, all you should have to change is
1179 this variable. I think."
1181 :type '(repeat (group (string :tag "Name")
1182 (radio-button-choice (const :format "%v " post)
1183 (const :format "%v " mail)
1184 (const :format "%v " none)
1186 (checklist :inline t
1187 (const :format "%v " address)
1188 (const :format "%v " prompt-address)
1189 (const :format "%v " physical-address)
1190 (const :format "%v " virtual)
1193 (define-widget 'gnus-select-method 'list
1194 "Widget for entering a select method."
1195 :args `((choice :tag "Method"
1196 ,@(mapcar (lambda (entry)
1197 (list 'const :format "%v\n"
1198 (intern (car entry))))
1199 gnus-valid-select-methods))
1200 (string :tag "Address")
1201 (editable-list :inline t
1204 (sexp :tag "Value")))))
1206 (defcustom gnus-updated-mode-lines '(group article summary tree)
1207 "List of buffers that should update their mode lines.
1208 The list may contain the symbols `group', `article', `tree' and
1209 `summary'. If the corresponding symbol is present, Gnus will keep
1210 that mode line updated with information that may be pertinent.
1211 If this variable is nil, screen refresh may be quicker."
1212 :group 'gnus-various
1213 :type '(set (const group)
1218 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1219 (defcustom gnus-mode-non-string-length nil
1220 "*Max length of mode-line non-string contents.
1221 If this is nil, Gnus will take space as is needed, leaving the rest
1222 of the modeline intact. Note that the default of nil is unlikely
1223 to be desirable; see the manual for further details."
1224 :group 'gnus-various
1225 :type '(choice (const nil)
1228 (defcustom gnus-auto-expirable-newsgroups nil
1229 "*Groups in which to automatically mark read articles as expirable.
1230 If non-nil, this should be a regexp that should match all groups in
1231 which to perform auto-expiry. This only makes sense for mail groups."
1232 :group 'nnmail-expire
1233 :type '(choice (const nil)
1236 (defcustom gnus-total-expirable-newsgroups nil
1237 "*Groups in which to perform expiry of all read articles.
1238 Use with extreme caution. All groups that match this regexp will be
1239 expiring - which means that all read articles will be deleted after
1240 \(say) one week. (This only goes for mail groups and the like, of
1242 :group 'nnmail-expire
1243 :type '(choice (const nil)
1246 (defcustom gnus-group-uncollapsed-levels 1
1247 "Number of group name elements to leave alone when making a short group name."
1248 :group 'gnus-group-visual
1251 (defcustom gnus-group-use-permanent-levels nil
1252 "*If non-nil, once you set a level, Gnus will use this level."
1253 :group 'gnus-group-levels
1258 (defcustom gnus-load-hook nil
1259 "A hook run while Gnus is loaded."
1263 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1264 "A hook called to apply kill files to a group.
1265 This hook is intended to apply a kill file to the selected newsgroup.
1266 The function `gnus-apply-kill-file' is called by default.
1268 Since a general kill file is too heavy to use only for a few
1269 newsgroups, I recommend you to use a lighter hook function. For
1270 example, if you'd like to apply a kill file to articles which contains
1271 a string `rmgroup' in subject in newsgroup `control', you can use the
1274 (setq gnus-apply-kill-hook
1277 (cond ((string-match \"control\" gnus-newsgroup-name)
1278 (gnus-kill \"Subject\" \"rmgroup\")
1279 (gnus-expunge \"X\"))))))"
1280 :group 'gnus-score-kill
1281 :options '(gnus-apply-kill-file)
1284 (defcustom gnus-group-change-level-function nil
1285 "Function run when a group level is changed.
1286 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1287 :group 'gnus-group-level
1292 (defcustom gnus-visual
1293 '(summary-highlight group-highlight article-highlight
1295 summary-menu group-menu article-menu
1296 tree-highlight menu highlight
1297 browse-menu server-menu
1298 page-marker tree-menu binary-menu pick-menu
1300 "*Enable visual features.
1301 If `visual' is disabled, there will be no menus and few faces. Most of
1302 the visual customization options below will be ignored. Gnus will use
1303 less space and be faster as a result.
1305 This variable can also be a list of visual elements to switch on. For
1306 instance, to switch off all visual things except menus, you can say:
1308 (setq gnus-visual '(menu))
1310 Valid elements include `summary-highlight', `group-highlight',
1311 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1312 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1313 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1314 and `grouplens-menu'."
1317 :type '(set (const summary-highlight)
1318 (const group-highlight)
1319 (const article-highlight)
1321 (const summary-menu)
1323 (const article-menu)
1324 (const tree-highlight)
1333 (const grouplens-menu)))
1335 (defcustom gnus-mouse-face
1337 (if (gnus-visual-p 'mouse-face 'highlight)
1338 (if (boundp 'gnus-mouse-face)
1339 (or gnus-mouse-face 'highlight)
1343 "*Face used for group or summary buffer mouse highlighting.
1344 The line beneath the mouse pointer will be highlighted with this
1349 (defcustom gnus-article-display-hook
1350 (if (and (string-match "XEmacs" emacs-version)
1352 '(gnus-article-hide-headers-if-wanted
1353 gnus-article-hide-boring-headers
1354 gnus-article-treat-overstrike
1355 gnus-article-maybe-highlight
1356 gnus-article-display-x-face)
1357 '(gnus-article-hide-headers-if-wanted
1358 gnus-article-hide-boring-headers
1359 gnus-article-treat-overstrike
1360 gnus-article-maybe-highlight))
1361 "*Controls how the article buffer will look.
1363 If you leave the list empty, the article will appear exactly as it is
1364 stored on the disk. The list entries will hide or highlight various
1365 parts of the article, making it easier to find the information you
1367 :group 'gnus-article-highlight
1370 :options '(gnus-article-add-buttons
1371 gnus-article-add-buttons-to-head
1372 gnus-article-emphasize
1373 gnus-article-fill-cited-article
1374 gnus-article-remove-cr
1375 gnus-summary-stop-page-breaking
1376 ;; gnus-summary-caesar-message
1377 ;; gnus-summary-verbose-headers
1378 gnus-summary-toggle-mime
1380 gnus-article-hide-headers
1381 gnus-article-hide-boring-headers
1382 gnus-article-hide-signature
1383 gnus-article-hide-citation
1384 gnus-article-hide-pgp
1385 gnus-article-hide-pem
1386 gnus-article-highlight
1387 gnus-article-highlight-headers
1388 gnus-article-highlight-citation
1389 gnus-article-highlight-signature
1390 gnus-article-date-ut
1391 gnus-article-date-local
1392 gnus-article-date-lapsed
1393 gnus-article-date-original
1394 gnus-article-remove-trailing-blank-lines
1395 gnus-article-strip-leading-blank-lines
1396 gnus-article-strip-multiple-blank-lines
1397 gnus-article-strip-blank-lines
1398 gnus-article-treat-overstrike
1399 gnus-article-display-x-face
1400 gnus-smiley-display))
1402 (defcustom gnus-article-save-directory gnus-directory
1403 "*Name of the directory articles will be saved in (default \"~/News\")."
1404 :group 'gnus-article-saving
1407 (defvar gnus-plugged t
1408 "Whether Gnus is plugged or not.")
1411 ;;; Internal variables
1413 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1414 (defvar gnus-original-article-buffer " *Original Article*")
1415 (defvar gnus-newsgroup-name nil)
1416 (defvar gnus-ephemeral-servers nil)
1418 (defvar gnus-agent nil
1419 "Whether we want to use the Gnus agent or not.")
1421 (defvar gnus-command-method nil
1422 "Dynamically bound variable that says what the current backend is.")
1424 (defvar gnus-current-select-method nil
1425 "The current method for selecting a newsgroup.")
1427 (defvar gnus-tree-buffer "*Tree*"
1428 "Buffer where Gnus thread trees are displayed.")
1431 (defvar gnus-use-generic-from nil)
1433 ;; Variable holding the user answers to all method prompts.
1434 (defvar gnus-method-history nil)
1436 ;; Variable holding the user answers to all mail method prompts.
1437 (defvar gnus-mail-method-history nil)
1439 ;; Variable holding the user answers to all group prompts.
1440 (defvar gnus-group-history nil)
1442 (defvar gnus-server-alist nil
1443 "List of available servers.")
1445 (defcustom gnus-cache-directory
1446 (nnheader-concat gnus-directory "cache/")
1447 "*The directory where cached articles will be stored."
1451 (defvar gnus-predefined-server-alist
1454 (nnspool-spool-directory ,gnus-cache-directory)
1455 (nnspool-nov-directory ,gnus-cache-directory)
1456 (nnspool-active-file
1457 ,(nnheader-concat gnus-cache-directory "active"))))
1458 "List of predefined (convenience) servers.")
1460 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1462 (defconst gnus-article-mark-lists
1463 '((marked . tick) (replied . reply)
1464 (expirable . expire) (killed . killed)
1465 (bookmarks . bookmark) (dormant . dormant)
1466 (scored . score) (saved . save)
1467 (cached . cache) (downloadable . download)
1468 (unsendable . unsend)))
1470 (defvar gnus-headers-retrieved-by nil)
1471 (defvar gnus-article-reply nil)
1472 (defvar gnus-override-method nil)
1473 (defvar gnus-article-check-size nil)
1474 (defvar gnus-opened-servers nil)
1476 (defvar gnus-current-kill-article nil)
1478 (defvar gnus-have-read-active-file nil)
1480 (defconst gnus-maintainer
1481 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1482 "The mail address of the Gnus maintainers.")
1484 (defvar gnus-info-nodes
1485 '((gnus-group-mode "(gnus)The Group Buffer")
1486 (gnus-summary-mode "(gnus)The Summary Buffer")
1487 (gnus-article-mode "(gnus)The Article Buffer")
1488 (mime/viewer-mode "(gnus)The Article Buffer")
1489 (gnus-server-mode "(gnus)The Server Buffer")
1490 (gnus-browse-mode "(gnus)Browse Foreign Server")
1491 (gnus-tree-mode "(gnus)Tree Display"))
1492 "Alist of major modes and related Info nodes.")
1494 (defvar gnus-group-buffer "*Group*")
1495 (defvar gnus-summary-buffer "*Summary*")
1496 (defvar gnus-article-buffer "*Article*")
1497 (defvar gnus-server-buffer "*Server*")
1499 (defvar gnus-slave nil
1500 "Whether this Gnus is a slave or not.")
1502 (defvar gnus-batch-mode nil
1503 "Whether this Gnus is running in batch mode or not.")
1505 (defvar gnus-variable-list
1506 '(gnus-newsrc-options gnus-newsrc-options-n
1507 gnus-newsrc-last-checked-date
1508 gnus-newsrc-alist gnus-server-alist
1509 gnus-killed-list gnus-zombie-list
1510 gnus-topic-topology gnus-topic-alist
1512 "Gnus variables saved in the quick startup file.")
1514 (defvar gnus-newsrc-alist nil
1515 "Assoc list of read articles.
1516 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1518 (defvar gnus-newsrc-hashtb nil
1519 "Hashtable of gnus-newsrc-alist.")
1521 (defvar gnus-killed-list nil
1522 "List of killed newsgroups.")
1524 (defvar gnus-killed-hashtb nil
1525 "Hash table equivalent of gnus-killed-list.")
1527 (defvar gnus-zombie-list nil
1528 "List of almost dead newsgroups.")
1530 (defvar gnus-description-hashtb nil
1531 "Descriptions of newsgroups.")
1533 (defvar gnus-list-of-killed-groups nil
1534 "List of newsgroups that have recently been killed by the user.")
1536 (defvar gnus-active-hashtb nil
1537 "Hashtable of active articles.")
1539 (defvar gnus-moderated-hashtb nil
1540 "Hashtable of moderated newsgroups.")
1542 ;; Save window configuration.
1543 (defvar gnus-prev-winconf nil)
1545 (defvar gnus-reffed-article-number nil)
1547 ;;; Let the byte-compiler know that we know about this variable.
1548 (defvar rmail-default-rmail-file)
1550 (defvar gnus-dead-summary nil)
1552 ;;; End of variables.
1554 ;; Define some autoload functions Gnus might use.
1557 ;; This little mapcar goes through the list below and marks the
1558 ;; symbols in question as autoloaded functions.
1561 (let ((interactive (nth 1 (memq ':interactive package))))
1565 (when (consp function)
1566 (setq keymap (car (memq 'keymap function)))
1567 (setq function (car function)))
1568 (autoload function (car package) nil interactive keymap)))
1569 (if (eq (nth 1 package) ':interactive)
1572 '(("info" Info-goto-node)
1573 ("hexl" hexl-hex-string-to-integer)
1574 ("pp" pp pp-to-string pp-eval-expression)
1575 ("ps-print" ps-print-preprint)
1576 ("mail-extr" mail-extract-address-components)
1577 ("browse-url" browse-url)
1578 ("message" :interactive t
1579 message-send-and-exit message-yank-original)
1580 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1581 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1582 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1583 timezone-make-sortable-date timezone-make-time-string)
1584 ("rmailout" rmail-output)
1585 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1587 ("gnus-audio" :interactive t gnus-audio-play)
1588 ("gnus-xmas" gnus-xmas-splash)
1589 ("gnus-soup" :interactive t
1590 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1591 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1592 ("nnsoup" nnsoup-pack-replies)
1593 ("score-mode" :interactive t gnus-score-mode)
1594 ("gnus-mh" gnus-summary-save-article-folder
1595 gnus-Folder-save-name gnus-folder-save-name)
1596 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1597 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1598 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1599 gnus-demon-add-disconnection gnus-demon-add-handler
1600 gnus-demon-remove-handler)
1601 ("gnus-demon" :interactive t
1602 gnus-demon-init gnus-demon-cancel)
1603 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1604 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1605 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1606 gnus-nocem-unwanted-article-p)
1607 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1608 gnus-server-server-name)
1609 ("gnus-srvr" gnus-browse-foreign-server)
1610 ("gnus-cite" :interactive t
1611 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1612 gnus-article-hide-citation gnus-article-fill-cited-article
1613 gnus-article-hide-citation-in-followups)
1614 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1615 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1616 gnus-execute gnus-expunge)
1617 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1618 gnus-cache-possibly-remove-articles gnus-cache-request-article
1619 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1620 gnus-cache-enter-remove-article gnus-cached-article-p
1621 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1622 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1623 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1624 ("gnus-score" :interactive t
1625 gnus-summary-increase-score gnus-summary-set-score
1626 gnus-summary-raise-thread gnus-summary-raise-same-subject
1627 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1628 gnus-summary-lower-thread gnus-summary-lower-same-subject
1629 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1630 gnus-summary-current-score gnus-score-default
1631 gnus-score-flush-cache gnus-score-close
1632 gnus-possibly-score-headers gnus-score-followup-article
1633 gnus-score-followup-thread)
1635 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1636 gnus-current-score-file-nondirectory gnus-score-adaptive
1637 gnus-score-find-trace gnus-score-file-name)
1638 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1639 ("gnus-topic" :interactive t gnus-topic-mode)
1640 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1641 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1642 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1643 ("gnus-uu" :interactive t
1644 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1645 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1646 gnus-uu-mark-by-regexp gnus-uu-mark-all
1647 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1648 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1649 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1650 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1651 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1652 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1653 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1655 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1656 gnus-uu-unmark-thread)
1657 ("gnus-msg" (gnus-summary-send-map keymap)
1658 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1659 ("gnus-msg" :interactive t
1660 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1661 gnus-summary-followup gnus-summary-followup-with-original
1662 gnus-summary-cancel-article gnus-summary-supersede-article
1663 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1664 gnus-summary-mail-forward gnus-summary-mail-other-window
1665 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1666 gnus-summary-wide-reply
1668 ("gnus-picon" :interactive t gnus-article-display-picons
1669 gnus-group-display-picons gnus-picons-article-display-x-face
1670 gnus-picons-display-x-face)
1671 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1672 gnus-grouplens-mode)
1673 ("smiley" :interactive t gnus-smiley-display)
1674 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1675 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1676 gnus-list-of-unread-articles gnus-list-of-read-articles
1677 gnus-offer-save-summaries gnus-make-thread-indent-array
1678 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1679 gnus-summary-skip-intangible gnus-summary-article-number
1680 gnus-data-header gnus-data-find)
1681 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1682 gnus-group-list-groups gnus-group-first-unread-group
1683 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1684 gnus-group-setup-buffer gnus-group-get-new-news
1685 gnus-group-make-help-group gnus-group-update-group
1686 gnus-clear-inboxes-moved gnus-group-iterate
1687 gnus-group-group-name)
1688 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1689 gnus-backlog-remove-article)
1690 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1691 gnus-article-prepare gnus-article-set-window-start
1692 gnus-article-next-page gnus-article-prev-page
1693 gnus-request-article-this-buffer gnus-article-mode
1694 gnus-article-setup-buffer gnus-narrow-to-page
1695 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1696 ("gnus-art" :interactive t
1697 gnus-article-hide-headers gnus-article-hide-boring-headers
1698 gnus-article-treat-overstrike gnus-article-word-wrap
1699 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1700 gnus-article-display-x-face
1701 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1702 gnus-article-hide-pem gnus-article-hide-signature
1703 gnus-article-strip-leading-blank-lines gnus-article-date-local
1704 gnus-article-date-original gnus-article-date-lapsed
1705 gnus-article-show-all-headers
1706 gnus-article-edit-mode gnus-article-edit-article
1707 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1708 gnus-start-date-timer gnus-stop-date-timer)
1709 ("gnus-int" gnus-request-type)
1710 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1711 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1712 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1713 gnus-dup-enter-articles)
1714 ("gnus-range" gnus-copy-sequence)
1715 ("gnus-eform" gnus-edit-form)
1716 ("gnus-move" :interactive t
1717 gnus-group-move-group-to-server gnus-change-server)
1718 ("gnus-logic" gnus-score-advanced)
1719 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1720 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1721 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1722 gnus-async-halt-prefetch)
1723 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1724 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1725 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1726 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1727 ("gnus-agent" :interactive t
1728 gnus-unplugged gnus-agentize gnus-agent-batch)
1729 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1730 gnus-summary-save-article-vm)
1731 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1733 ;;; gnus-sum.el thingies
1736 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1737 "*The format specification of the lines in the summary buffer.
1739 It works along the same lines as a normal formatting string,
1740 with some simple extensions.
1742 %N Article number, left padded with spaces (string)
1744 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1745 %n Name of the poster (string)
1746 %a Extracted name of the poster (string)
1747 %A Extracted address of the poster (string)
1748 %F Contents of the From: header (string)
1749 %x Contents of the Xref: header (string)
1750 %D Date of the article (string)
1751 %d Date of the article (string) in DD-MMM format
1752 %M Message-id of the article (string)
1753 %r References of the article (string)
1754 %c Number of characters in the article (integer)
1755 %L Number of lines in the article (integer)
1756 %I Indentation based on thread level (a string of spaces)
1757 %T A string with two possible values: 80 spaces if the article
1758 is on thread level two or larger and 0 spaces on level one
1759 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1760 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1761 %[ Opening bracket (character, \"[\" or \"<\")
1762 %] Closing bracket (character, \"]\" or \">\")
1763 %> Spaces of length thread-level (string)
1764 %< Spaces of length (- 20 thread-level) (string)
1765 %i Article score (number)
1766 %z Article zcore (character)
1767 %t Number of articles under the current thread (number).
1768 %e Whether the thread is empty or not (character).
1769 %l GroupLens score (string).
1770 %V Total thread score (number).
1771 %P The line number (number).
1772 %O Download mark (character).
1773 %u User defined specifier. The next character in the format string should
1774 be a letter. Gnus will call the function gnus-user-format-function-X,
1775 where X is the letter following %u. The function will be passed the
1776 current header as argument. The function should return a string, which
1777 will be inserted into the summary just like information from any other
1780 Text between %( and %) will be highlighted with `gnus-mouse-face'
1781 when the mouse point is placed inside the area. There can only be one
1784 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1785 with care. For reasons of efficiency, Gnus will compute what column
1786 these characters will end up in, and \"hard-code\" that. This means that
1787 it is illegal to have these specs after a variable-length spec. Well,
1788 you might not be arrested, but your summary buffer will look strange,
1789 which is bad enough.
1791 The smart choice is to have these specs as for to the left as
1794 This restriction may disappear in later versions of Gnus."
1796 :group 'gnus-summary-format)
1799 ;;; Skeleton keymaps
1802 (defun gnus-suppress-keymap (keymap)
1803 (suppress-keymap keymap)
1804 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1806 (define-key keymap (pop keys) 'undefined))))
1808 (defvar gnus-article-mode-map
1809 (let ((keymap (make-keymap)))
1810 (gnus-suppress-keymap keymap)
1812 (defvar gnus-summary-mode-map
1813 (let ((keymap (make-keymap)))
1814 (gnus-suppress-keymap keymap)
1816 (defvar gnus-group-mode-map
1817 (let ((keymap (make-keymap)))
1818 (gnus-suppress-keymap keymap)
1823 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1824 ;; If you want the cursor to go somewhere else, set these two
1825 ;; functions in some startup hook to whatever you want.
1826 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1827 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1829 ;;; Various macros and substs.
1831 (defun gnus-header-from (header)
1832 (mail-header-from header))
1834 (defmacro gnus-gethash (string hashtable)
1835 "Get hash value of STRING in HASHTABLE."
1836 `(symbol-value (intern-soft ,string ,hashtable)))
1838 (defmacro gnus-sethash (string value hashtable)
1839 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1840 `(set (intern ,string ,hashtable) ,value))
1841 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1843 (defmacro gnus-group-unread (group)
1844 "Get the currently computed number of unread articles in GROUP."
1845 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1847 (defmacro gnus-group-entry (group)
1848 "Get the newsrc entry for GROUP."
1849 `(gnus-gethash ,group gnus-newsrc-hashtb))
1851 (defmacro gnus-active (group)
1852 "Get active info on GROUP."
1853 `(gnus-gethash ,group gnus-active-hashtb))
1855 (defmacro gnus-set-active (group active)
1856 "Set GROUP's active info."
1857 `(gnus-sethash ,group ,active gnus-active-hashtb))
1859 ;; Info access macros.
1861 (defmacro gnus-info-group (info)
1863 (defmacro gnus-info-rank (info)
1865 (defmacro gnus-info-read (info)
1867 (defmacro gnus-info-marks (info)
1869 (defmacro gnus-info-method (info)
1871 (defmacro gnus-info-params (info)
1874 (defmacro gnus-info-level (info)
1875 `(let ((rank (gnus-info-rank ,info)))
1879 (defmacro gnus-info-score (info)
1880 `(let ((rank (gnus-info-rank ,info)))
1881 (or (and (consp rank) (cdr rank)) 0)))
1883 (defmacro gnus-info-set-group (info group)
1884 `(setcar ,info ,group))
1885 (defmacro gnus-info-set-rank (info rank)
1886 `(setcar (nthcdr 1 ,info) ,rank))
1887 (defmacro gnus-info-set-read (info read)
1888 `(setcar (nthcdr 2 ,info) ,read))
1889 (defmacro gnus-info-set-marks (info marks &optional extend)
1891 `(gnus-info-set-entry ,info ,marks 3)
1892 `(setcar (nthcdr 3 ,info) ,marks)))
1893 (defmacro gnus-info-set-method (info method &optional extend)
1895 `(gnus-info-set-entry ,info ,method 4)
1896 `(setcar (nthcdr 4 ,info) ,method)))
1897 (defmacro gnus-info-set-params (info params &optional extend)
1899 `(gnus-info-set-entry ,info ,params 5)
1900 `(setcar (nthcdr 5 ,info) ,params)))
1902 (defun gnus-info-set-entry (info entry number)
1903 ;; Extend the info until we have enough elements.
1904 (while (<= (length info) number)
1905 (nconc info (list nil)))
1907 (setcar (nthcdr number info) entry))
1909 (defmacro gnus-info-set-level (info level)
1910 `(let ((rank (cdr ,info)))
1911 (if (consp (car rank))
1912 (setcar (car rank) ,level)
1913 (setcar rank ,level))))
1914 (defmacro gnus-info-set-score (info score)
1915 `(let ((rank (cdr ,info)))
1916 (if (consp (car rank))
1917 (setcdr (car rank) ,score)
1918 (setcar rank (cons (car rank) ,score)))))
1920 (defmacro gnus-get-info (group)
1921 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1923 ;; Byte-compiler warning.
1924 (defvar gnus-visual)
1925 ;; Find out whether the gnus-visual TYPE is wanted.
1926 (defun gnus-visual-p (&optional type class)
1927 (and gnus-visual ; Has to be non-nil, at least.
1928 (if (not type) ; We don't care about type.
1930 (if (listp gnus-visual) ; It's a list, so we check it.
1931 (or (memq type gnus-visual)
1932 (memq class gnus-visual))
1935 ;;; Load the compatability functions.
1944 (defvar gnus-shutdown-alist nil)
1946 (defun gnus-add-shutdown (function &rest symbols)
1947 "Run FUNCTION whenever one of SYMBOLS is shut down."
1948 (push (cons function symbols) gnus-shutdown-alist))
1950 (defun gnus-shutdown (symbol)
1951 "Shut down everything that waits for SYMBOL."
1952 (let ((alist gnus-shutdown-alist)
1954 (while (setq entry (pop alist))
1955 (when (memq symbol (cdr entry))
1956 (funcall (car entry))))))
1960 ;;; Gnus Utility Functions
1964 (defmacro gnus-string-or (&rest strings)
1965 "Return the first element of STRINGS that is a non-blank string.
1966 STRINGS will be evaluated in normal `or' order."
1967 `(gnus-string-or-1 ',strings))
1969 (defun gnus-string-or-1 (strings)
1972 (setq string (eval (pop strings)))
1973 (if (string-match "^[ \t]*$" string)
1975 (setq strings nil)))
1978 (defun gnus-version (&optional arg)
1979 "Version number of this version of Gnus.
1980 If ARG, insert string at point."
1983 (insert (message gnus-version))
1984 (message gnus-version)))
1986 (defun gnus-continuum-version (version)
1987 "Return VERSION as a floating point number."
1988 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1989 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1990 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
1991 (number (match-string 2 version))
1993 (unless (string-match
1994 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1995 (error "Invalid version string: %s" version))
1996 (setq major (string-to-number (match-string 1 number))
1997 minor (string-to-number (match-string 2 number))
1998 least (if (match-beginning 3)
1999 (string-to-number (match-string 3 number))
2003 (format "%s00%02d%02d"
2005 ((member alpha '("(ding)" "d")) "4.99")
2006 ((member alpha '("September" "s")) "5.01")
2007 ((member alpha '("Red" "r")) "5.03")
2008 ((member alpha '("Quassia" "q")) "5.05")
2009 ((member alpha '("p")) "5.07")
2010 ((member alpha '("o")) "5.09")
2011 ((member alpha '("n")) "5.11"))
2013 (format "%d.%02d%02d" major minor least))))))
2015 (defun gnus-info-find-node ()
2016 "Find Info documentation of Gnus."
2018 ;; Enlarge info window if needed.
2019 (let (gnus-info-buffer)
2020 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2021 (setq gnus-info-buffer (current-buffer))
2022 (gnus-configure-windows 'info)))
2025 ;;; gnus-interactive
2028 (defvar gnus-current-prefix-symbol nil
2029 "Current prefix symbol.")
2031 (defvar gnus-current-prefix-symbols nil
2032 "List of current prefix symbols.")
2034 (defun gnus-interactive (string &optional params)
2035 "Return a list that can be fed to `interactive'.
2036 See `interactive' for full documentation.
2038 Adds the following specs:
2040 y -- The current symbolic prefix.
2041 Y -- A list of the current symbolic prefix(es).
2042 A -- Article number.
2043 H -- Article header.
2047 (while (< i (length string))
2048 (string-match ".\\([^\n]*\\)\n?" string i)
2049 (setq c (aref string i))
2051 (setq prompt (match-string 1 string)))
2052 (setq i (match-end 0))
2053 ;; We basically emulate just about everything that
2054 ;; `interactive' does, but add the specs listed above.
2058 (completing-read prompt obarray 'fboundp t))
2060 (read-buffer prompt (current-buffer) t))
2062 (read-buffer prompt (other-buffer (current-buffer))))
2066 (completing-read prompt obarray 'commandp t))
2070 (read-file-name prompt nil default-directory 'lambda))
2072 (read-file-name prompt nil nil 'lambda))
2074 (read-file-name prompt))
2076 (read-key-sequence prompt))
2078 (error "Not implemented spec"))
2080 (error "Not implemented spec"))
2084 (error "Not implemented spec"))
2086 (string-to-number (read-from-minibuffer prompt)))
2088 (prefix-numeric-value current-prefix-arg))
2094 (read-string prompt))
2096 (intern (read-string prompt)))
2098 (read-variable prompt))
2100 (read-minibuffer prompt))
2102 (eval-minibuffer prompt))
2103 ;; And here the new specs come.
2105 gnus-current-prefix-symbol)
2107 gnus-current-prefix-symbols)
2109 (gnus-group-group-name))
2111 (gnus-summary-skip-intangible)
2112 (or (get-text-property (point) 'gnus-number)
2113 (gnus-summary-last-subject)))
2115 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2117 (error "Non-implemented spec")))
2121 (push (if (< (point) (mark) (point) (mark))) out)
2122 (push (if (> (point) (mark) (point) (mark))) out))))
2123 (setq out (delq 'gnus-prefix-nil out))
2126 (defun gnus-symbolic-argument (&optional arg)
2127 "Read a symbolic argument and a command, and then execute command."
2129 (let* ((in-command (this-command-keys))
2130 (command in-command)
2131 gnus-current-prefix-symbols
2132 gnus-current-prefix-symbol
2134 (while (equal in-command command)
2135 (message "%s-" (key-description (this-command-keys)))
2136 (push (intern (char-to-string (read-char))) syms)
2137 (setq command (read-key-sequence nil t)))
2138 (setq gnus-current-prefix-symbols (nreverse syms)
2139 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2140 (call-interactively (key-binding command t))))
2142 ;;; More various functions.
2144 (defsubst gnus-check-backend-function (func group)
2145 "Check whether GROUP supports function FUNC.
2146 GROUP can either be a string (a group name) or a select method."
2148 (let ((method (if (stringp group)
2149 (car (gnus-find-method-for-group group))
2151 (unless (featurep method)
2153 (fboundp (intern (format "%s-%s" method func))))))
2155 (defun gnus-group-read-only-p (&optional group)
2156 "Check whether GROUP supports editing or not.
2157 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2158 that that variable is buffer-local to the summary buffers."
2159 (let ((group (or group gnus-newsgroup-name)))
2160 (not (gnus-check-backend-function 'request-replace-article group))))
2162 (defun gnus-group-total-expirable-p (group)
2163 "Check whether GROUP is total-expirable or not."
2164 (let ((params (gnus-group-find-parameter group))
2167 ((memq 'total-expire params)
2169 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2171 (gnus-total-expirable-newsgroups ; Check var.
2172 (string-match gnus-total-expirable-newsgroups group)))))
2174 (defun gnus-group-auto-expirable-p (group)
2175 "Check whether GROUP is auto-expirable or not."
2176 (let ((params (gnus-group-find-parameter group))
2179 ((memq 'auto-expire params)
2181 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2183 (gnus-auto-expirable-newsgroups ; Check var.
2184 (string-match gnus-auto-expirable-newsgroups group)))))
2186 (defun gnus-virtual-group-p (group)
2187 "Say whether GROUP is virtual or not."
2188 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2189 gnus-valid-select-methods)))
2191 (defun gnus-news-group-p (group &optional article)
2192 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2193 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2194 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2195 (if (or (null article)
2196 (not (< article 0)))
2197 (eq (gnus-request-type group article) 'news)
2198 (if (not (vectorp article))
2200 ;; It's a real article.
2201 (eq (gnus-request-type group (mail-header-id article))
2204 ;; Returns a list of writable groups.
2205 (defun gnus-writable-groups ()
2206 (let ((alist gnus-newsrc-alist)
2208 (while (setq group (car (pop alist)))
2209 (unless (gnus-group-read-only-p group)
2210 (push group groups)))
2213 ;; Check whether to use long file names.
2214 (defun gnus-use-long-file-name (symbol)
2215 ;; The variable has to be set...
2216 (and gnus-use-long-file-name
2217 ;; If it isn't a list, then we return t.
2218 (or (not (listp gnus-use-long-file-name))
2219 ;; If it is a list, and the list contains `symbol', we
2221 (not (memq symbol gnus-use-long-file-name)))))
2223 ;; Generate a unique new group name.
2224 (defun gnus-generate-new-group-name (leaf)
2227 (while (gnus-gethash name gnus-newsrc-hashtb)
2228 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2231 (defun gnus-ephemeral-group-p (group)
2232 "Say whether GROUP is ephemeral or not."
2233 (gnus-group-get-parameter group 'quit-config t))
2235 (defun gnus-group-quit-config (group)
2236 "Return the quit-config of GROUP."
2237 (gnus-group-get-parameter group 'quit-config t))
2239 (defun gnus-kill-ephemeral-group (group)
2240 "Remove ephemeral GROUP from relevant structures."
2241 (gnus-sethash group nil gnus-newsrc-hashtb))
2243 (defun gnus-simplify-mode-line ()
2244 "Make mode lines a bit simpler."
2245 (setq mode-line-modified (cdr gnus-mode-line-modified))
2246 (when (listp mode-line-format)
2247 (make-local-variable 'mode-line-format)
2248 (setq mode-line-format (copy-sequence mode-line-format))
2249 (when (equal (nth 3 mode-line-format) " ")
2250 (setcar (nthcdr 3 mode-line-format) " "))))
2252 ;;; Servers and groups.
2254 (defsubst gnus-server-add-address (method)
2255 (let ((method-name (symbol-name (car method))))
2256 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2257 (not (assq (intern (concat method-name "-address")) method))
2258 (memq 'physical-address (assq (car method)
2259 gnus-valid-select-methods)))
2260 (append method (list (list (intern (concat method-name "-address"))
2264 (defsubst gnus-server-get-method (group method)
2265 ;; Input either a server name, and extended server name, or a
2266 ;; select method, and return a select method.
2267 (cond ((stringp method)
2268 (gnus-server-to-method method))
2269 ((equal method gnus-select-method)
2271 ((and (stringp (car method))
2273 (gnus-server-extend-method group method))
2276 (equal (cadr method) ""))
2279 (gnus-server-add-address method))))
2281 (defun gnus-server-to-method (server)
2282 "Map virtual server names to select methods."
2284 ;; Is this a method, perhaps?
2285 (and server (listp server) server)
2286 ;; Perhaps this is the native server?
2287 (and (equal server "native") gnus-select-method)
2288 ;; It should be in the server alist.
2289 (cdr (assoc server gnus-server-alist))
2290 ;; It could be in the predefined server alist.
2291 (cdr (assoc server gnus-predefined-server-alist))
2292 ;; If not, we look through all the opened server
2293 ;; to see whether we can find it there.
2294 (let ((opened gnus-opened-servers))
2296 (not (equal server (format "%s:%s" (caaar opened)
2301 (defmacro gnus-method-equal (ss1 ss2)
2302 "Say whether two servers are equal."
2306 (and (= (length s1) (length s2))
2308 (while (and s1 (member (car s1) s2))
2312 (defun gnus-server-equal (m1 m2)
2313 "Say whether two methods are equal."
2314 (let ((m1 (cond ((null m1) gnus-select-method)
2315 ((stringp m1) (gnus-server-to-method m1))
2317 (m2 (cond ((null m2) gnus-select-method)
2318 ((stringp m2) (gnus-server-to-method m2))
2320 (gnus-method-equal m1 m2)))
2322 (defun gnus-servers-using-backend (backend)
2323 "Return a list of known servers using BACKEND."
2324 (let ((opened gnus-opened-servers)
2327 (when (eq backend (caaar opened))
2328 (push (caar opened) out))
2332 (defun gnus-archive-server-wanted-p ()
2333 "Say whether the user wants to use the archive server."
2335 ((or (not gnus-message-archive-method)
2336 (not gnus-message-archive-group))
2338 ((and gnus-message-archive-method gnus-message-archive-group)
2341 (let ((active (cadr (assq 'nnfolder-active-file
2342 gnus-message-archive-method))))
2344 (file-exists-p active))))))
2346 (defun gnus-group-prefixed-name (group method)
2347 "Return the whole name from GROUP and METHOD."
2348 (and (stringp method) (setq method (gnus-server-to-method method)))
2349 (if (or (not method)
2350 (gnus-server-equal method "native"))
2352 (concat (format "%s" (car method))
2354 (or (assoc (format "%s" (car method))
2355 (gnus-methods-using 'address))
2356 (gnus-server-equal method gnus-message-archive-method))
2358 (not (string= (nth 1 method) "")))
2359 (concat "+" (nth 1 method)))
2362 (defun gnus-group-real-prefix (group)
2363 "Return the prefix of the current group name."
2364 (if (string-match "^[^:]+:" group)
2365 (substring group 0 (match-end 0))
2368 (defun gnus-group-method (group)
2369 "Return the server or method used for selecting GROUP.
2370 You should probably use `gnus-find-method-for-group' instead."
2371 (let ((prefix (gnus-group-real-prefix group)))
2372 (if (equal prefix "")
2374 (let ((servers gnus-opened-servers)
2376 backend possible found)
2377 (if (string-match "^[^\\+]+\\+" prefix)
2378 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2379 server (substring prefix (match-end 0) (1- (length prefix))))
2380 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2382 (when (eq (caaar servers) backend)
2383 (setq possible (caar servers))
2384 (when (equal (cadaar servers) server)
2385 (setq found (caar servers))))
2387 (or (car (rassoc found gnus-server-alist))
2389 (car (rassoc possible gnus-server-alist))
2391 (list backend server))))))
2393 (defsubst gnus-secondary-method-p (method)
2394 "Return whether METHOD is a secondary select method."
2395 (let ((methods gnus-secondary-select-methods)
2396 (gmethod (gnus-server-get-method nil method)))
2398 (not (equal (gnus-server-get-method nil (car methods))
2400 (setq methods (cdr methods)))
2403 (defun gnus-groups-from-server (server)
2404 "Return a list of all groups that are fetched from SERVER."
2405 (let ((alist (cdr gnus-newsrc-alist))
2407 (while (setq info (pop alist))
2408 (when (gnus-server-equal (gnus-info-method info) server)
2409 (push (gnus-info-group info) groups)))
2410 (sort groups 'string<)))
2412 (defun gnus-group-foreign-p (group)
2413 "Say whether a group is foreign or not."
2414 (and (not (gnus-group-native-p group))
2415 (not (gnus-group-secondary-p group))))
2417 (defun gnus-group-native-p (group)
2418 "Say whether the group is native or not."
2419 (not (string-match ":" group)))
2421 (defun gnus-group-secondary-p (group)
2422 "Say whether the group is secondary or not."
2423 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2425 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2426 "Return the group parameters for GROUP.
2427 If SYMBOL, return the value of that symbol in the group parameters."
2429 (set-buffer gnus-group-buffer)
2430 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2432 (gnus-group-parameter-value parameters symbol allow-list)
2435 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2436 "Return the group parameters for GROUP.
2437 If SYMBOL, return the value of that symbol in the group parameters.
2438 Most functions should use `gnus-group-find-parameter', which
2439 also examines the topic parameters."
2440 (let ((params (gnus-info-params (gnus-get-info group))))
2442 (gnus-group-parameter-value params symbol allow-list)
2445 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2446 "Return the value of SYMBOL in group PARAMS."
2447 ;; We only wish to return group parameters (dotted lists) and
2448 ;; not local variables, which may have the same names.
2449 ;; But first we handle single elements...
2450 (or (car (memq symbol params))
2454 (while (setq elem (pop params))
2455 (when (and (consp elem)
2456 (eq (car elem) symbol)
2459 (throw 'found (cdr elem))))))))
2461 (defun gnus-group-add-parameter (group param)
2462 "Add parameter PARAM to GROUP."
2463 (let ((info (gnus-get-info group)))
2465 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2466 ;; Cons the new param to the old one and update.
2467 (gnus-group-set-info (cons param (gnus-info-params info))
2470 (defun gnus-group-set-parameter (group name value)
2471 "Set parameter NAME to VALUE in GROUP."
2472 (let ((info (gnus-get-info group)))
2474 (gnus-group-remove-parameter group name)
2475 (let ((old-params (gnus-info-params info))
2476 (new-params (list (cons name value))))
2478 (when (or (not (listp (car old-params)))
2479 (not (eq (caar old-params) name)))
2480 (setq new-params (append new-params (list (car old-params)))))
2481 (setq old-params (cdr old-params)))
2482 (gnus-group-set-info new-params group 'params)))))
2484 (defun gnus-group-remove-parameter (group name)
2485 "Remove parameter NAME from GROUP."
2486 (let ((info (gnus-get-info group)))
2488 (let ((params (gnus-info-params info)))
2490 (setq params (delq name params))
2491 (while (assq name params)
2492 (gnus-pull name params))
2493 (gnus-info-set-params info params))))))
2495 (defun gnus-group-add-score (group &optional score)
2496 "Add SCORE to the GROUP score.
2497 If SCORE is nil, add 1 to the score of GROUP."
2498 (let ((info (gnus-get-info group)))
2500 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2502 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2503 (defun gnus-short-group-name (group &optional levels)
2504 "Collapse GROUP name LEVELS.
2505 Select methods are stripped and any remote host name is stripped down to
2506 just the host name."
2513 (while (string-match "\\." group skip)
2514 (setq skip (match-end 0)
2517 ;; separate foreign select method from group name and collapse.
2518 ;; if method contains a server, collapse to non-domain server name,
2519 ;; otherwise collapse to select method
2520 (when (string-match ":" group)
2521 (cond ((string-match "+" group)
2522 (let* ((plus (string-match "+" group))
2523 (colon (string-match ":" group (or plus 0)))
2524 (dot (string-match "\\." group)))
2525 (setq foreign (concat
2526 (substring group (+ 1 plus)
2527 (cond ((null dot) colon)
2528 ((< colon dot) colon)
2529 ((< dot colon) dot)))
2531 group (substring group (+ 1 colon)))))
2533 (let* ((colon (string-match ":" group)))
2534 (setq foreign (concat (substring group 0 (+ 1 colon)))
2535 group (substring group (+ 1 colon)))))))
2536 ;; collapse group name leaving LEVELS uncollapsed elements
2538 (if (and (string-match "\\." group) (> levels 0))
2539 (setq name (concat name (substring group 0 1))
2540 group (substring group (match-end 0))
2542 name (concat name "."))
2543 (setq name (concat foreign name group)
2547 (defun gnus-narrow-to-body ()
2548 "Narrow to the body of an article."
2551 (goto-char (point-min))
2552 (or (search-forward "\n\n" nil t)
2558 ;;; Kill file handling.
2561 (defun gnus-apply-kill-file ()
2562 "Apply a kill file to the current newsgroup.
2563 Returns the number of articles marked as read."
2564 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2565 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2566 (gnus-apply-kill-file-internal)
2569 (defun gnus-kill-save-kill-buffer ()
2570 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2571 (when (get-file-buffer file)
2573 (set-buffer (get-file-buffer file))
2574 (when (buffer-modified-p)
2576 (kill-buffer (current-buffer))))))
2578 (defcustom gnus-kill-file-name "KILL"
2579 "Suffix of the kill files."
2580 :group 'gnus-score-kill
2581 :group 'gnus-score-files
2584 (defun gnus-newsgroup-kill-file (newsgroup)
2585 "Return the name of a kill file name for NEWSGROUP.
2586 If NEWSGROUP is nil, return the global kill file name instead."
2588 ;; The global KILL file is placed at top of the directory.
2589 ((or (null newsgroup)
2590 (string-equal newsgroup ""))
2591 (expand-file-name gnus-kill-file-name
2592 gnus-kill-files-directory))
2593 ;; Append ".KILL" to newsgroup name.
2594 ((gnus-use-long-file-name 'not-kill)
2595 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2596 "." gnus-kill-file-name)
2597 gnus-kill-files-directory))
2598 ;; Place "KILL" under the hierarchical directory.
2600 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2601 "/" gnus-kill-file-name)
2602 gnus-kill-files-directory))))
2606 (defun gnus-member-of-valid (symbol group)
2607 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2609 (symbol-name (car (gnus-find-method-for-group group)))
2610 gnus-valid-select-methods)))
2612 (defun gnus-method-option-p (method option)
2613 "Return non-nil if select METHOD has OPTION as a parameter."
2614 (when (stringp method)
2615 (setq method (gnus-server-to-method method)))
2616 (memq option (assoc (format "%s" (car method))
2617 gnus-valid-select-methods)))
2619 (defun gnus-similar-server-opened (method)
2620 (let ((opened gnus-opened-servers))
2621 (while (and method opened)
2622 (when (and (equal (cadr method) (cadaar opened))
2623 (not (equal method (caar opened))))
2628 (defun gnus-server-extend-method (group method)
2629 ;; This function "extends" a virtual server. If the server is
2630 ;; "hello", and the select method is ("hello" (my-var "something"))
2631 ;; in the group "alt.alt", this will result in a new virtual server
2632 ;; called "hello+alt.alt".
2633 (if (or (not (inline (gnus-similar-server-opened method)))
2634 (not (cddr method)))
2636 `(,(car method) ,(concat (cadr method) "+" group)
2637 (,(intern (format "%s-address" (car method))) ,(cadr method))
2640 (defun gnus-server-status (method)
2641 "Return the status of METHOD."
2642 (nth 1 (assoc method gnus-opened-servers)))
2644 (defun gnus-group-name-to-method (group)
2645 "Guess a select method based on GROUP."
2646 (if (string-match ":" group)
2647 (let ((server (substring group 0 (match-beginning 0))))
2648 (if (string-match "\\+" server)
2649 (list (intern (substring server 0 (match-beginning 0)))
2650 (substring server (match-end 0)))
2651 (list (intern server) "")))
2652 gnus-select-method))
2654 (defun gnus-find-method-for-group (group &optional info)
2655 "Find the select method that GROUP uses."
2656 (or gnus-override-method
2659 (let ((info (or info (gnus-get-info group)))
2662 (not (setq method (gnus-info-method info)))
2663 (equal method "native"))
2666 (cond ((stringp method)
2667 (inline (gnus-server-to-method method)))
2668 ((stringp (cadr method))
2669 (inline (gnus-server-extend-method group method)))
2672 (cond ((equal (cadr method) "")
2674 ((null (cadr method))
2675 (list (car method) ""))
2677 (gnus-server-add-address method)))))))
2679 (defun gnus-methods-using (feature)
2680 "Find all methods that have FEATURE."
2681 (let ((valids gnus-valid-select-methods)
2684 (when (memq feature (car valids))
2685 (push (car valids) outs))
2686 (setq valids (cdr valids)))
2689 (defun gnus-read-group (prompt &optional default)
2690 "Prompt the user for a group name.
2691 Disallow illegal group names."
2697 (setq group (read-string (concat prefix prompt)
2698 (cons (or default "") 0)
2699 'gnus-group-history)))
2700 (setq prefix (format "Illegal group name: \"%s\". " group)
2704 (defun gnus-read-method (prompt)
2705 "Prompt the user for a method.
2706 Allow completion over sensible values."
2708 (append gnus-valid-select-methods
2709 gnus-predefined-server-alist
2714 nil t nil 'gnus-method-history)))
2717 (setq method gnus-select-method))
2718 ((assoc method gnus-valid-select-methods)
2719 (list (intern method)
2720 (if (memq 'prompt-address
2721 (assoc method gnus-valid-select-methods))
2722 (read-string "Address: ")
2724 ((assoc method servers)
2727 (list (intern method) "")))))
2729 ;;; User-level commands.
2732 (defun gnus-slave-no-server (&optional arg)
2733 "Read network news as a slave, without connecting to local server."
2735 (gnus-no-server arg t))
2738 (defun gnus-no-server (&optional arg slave)
2740 If ARG is a positive number, Gnus will use that as the
2741 startup level. If ARG is nil, Gnus will be started at level 2.
2742 If ARG is non-nil and not a positive number, Gnus will
2743 prompt the user for the name of an NNTP server to use.
2744 As opposed to `gnus', this command will not connect to the local server."
2746 (gnus-no-server-1 arg slave))
2749 (defun gnus-slave (&optional arg)
2750 "Read news as a slave."
2752 (gnus arg nil 'slave))
2755 (defun gnus-other-frame (&optional arg)
2756 "Pop up a frame to read news."
2758 (let ((window (get-buffer-window gnus-group-buffer)))
2760 (select-frame (window-frame window)))
2761 ((= (length (frame-list)) 1)
2762 (select-frame (make-frame)))
2768 (defun gnus (&optional arg dont-connect slave)
2770 If ARG is non-nil and a positive number, Gnus will use that as the
2771 startup level. If ARG is non-nil and not a positive number, Gnus will
2772 prompt the user for the name of an NNTP server to use."
2774 (gnus-1 arg dont-connect slave))
2776 ;; Allow redefinition of Gnus functions.
2782 ;;; gnus.el ends here