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@ifi.uio.no>
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-start nil
45 "Starting your favorite newsreader."
48 (defgroup gnus-start-server nil
49 "Server options at startup."
52 ;; These belong to gnus-group.el.
53 (defgroup gnus-group nil
55 :link '(custom-manual "(gnus)The Group Buffer")
58 (defgroup gnus-group-foreign nil
60 :link '(custom-manual "(gnus)Foreign Groups")
63 (defgroup gnus-group-new nil
64 "Automatic subscription of new groups."
67 (defgroup gnus-group-levels nil
69 :link '(custom-manual "(gnus)Group Levels")
72 (defgroup gnus-group-select nil
74 :link '(custom-manual "(gnus)Selecting a Group")
77 (defgroup gnus-group-listing nil
78 "Showing slices of the group list."
79 :link '(custom-manual "(gnus)Listing Groups")
82 (defgroup gnus-group-visual nil
83 "Sorting the group buffer."
84 :link '(custom-manual "(gnus)Group Buffer Format")
88 (defgroup gnus-group-various nil
89 "Various group options."
90 :link '(custom-manual "(gnus)Scanning New Messages")
93 ;; These belong to gnus-sum.el.
94 (defgroup gnus-summary nil
96 :link '(custom-manual "(gnus)The Summary Buffer")
99 (defgroup gnus-summary-exit nil
100 "Leaving summary buffers."
101 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
102 :group 'gnus-summary)
104 (defgroup gnus-summary-marks nil
105 "Marks used in summary buffers."
106 :link '(custom-manual "(gnus)Marking Articles")
107 :group 'gnus-summary)
109 (defgroup gnus-thread nil
110 "Ordering articles according to replies."
111 :link '(custom-manual "(gnus)Threading")
112 :group 'gnus-summary)
114 (defgroup gnus-summary-format nil
115 "Formatting of the summary buffer."
116 :link '(custom-manual "(gnus)Summary Buffer Format")
117 :group 'gnus-summary)
119 (defgroup gnus-summary-choose nil
121 :link '(custom-manual "(gnus)Choosing Articles")
122 :group 'gnus-summary)
124 (defgroup gnus-summary-maneuvering nil
125 "Summary movement commands."
126 :link '(custom-manual "(gnus)Summary Maneuvering")
127 :group 'gnus-summary)
129 (defgroup gnus-summary-mail nil
130 "Mail group commands."
131 :link '(custom-manual "(gnus)Mail Group Commands")
132 :group 'gnus-summary)
134 (defgroup gnus-summary-sort nil
135 "Sorting the summary buffer."
136 :link '(custom-manual "(gnus)Sorting")
137 :group 'gnus-summary)
139 (defgroup gnus-summary-visual nil
140 "Highlighting and menus in the summary buffer."
141 :link '(custom-manual "(gnus)Summary Highlighting")
143 :group 'gnus-summary)
145 (defgroup gnus-summary-various nil
146 "Various summary buffer options."
147 :link '(custom-manual "(gnus)Various Summary Stuff")
148 :group 'gnus-summary)
150 (defgroup gnus-summary-pick nil
151 "Pick mode in the summary buffer."
152 :link '(custom-manual "(gnus)Pick and Read")
154 :group 'gnus-summary)
156 (defgroup gnus-summary-tree nil
157 "Tree display of threads in the summary buffer."
158 :link '(custom-manual "(gnus)Tree Display")
160 :group 'gnus-summary)
162 ;; Belongs to gnus-uu.el
163 (defgroup gnus-extract-view nil
164 "Viewing extracted files."
165 :link '(custom-manual "(gnus)Viewing Files")
166 :group 'gnus-extract)
168 ;; Belongs to gnus-score.el
169 (defgroup gnus-score nil
170 "Score and kill file handling."
173 (defgroup gnus-score-kill nil
177 (defgroup gnus-score-adapt nil
178 "Adaptive score files."
181 (defgroup gnus-score-default nil
182 "Default values for score files."
185 (defgroup gnus-score-expire nil
186 "Expiring score rules."
189 (defgroup gnus-score-decay nil
190 "Decaying score rules."
193 (defgroup gnus-score-files nil
194 "Score and kill file names."
198 (defgroup gnus-score-various nil
199 "Various scoring and killing options."
203 (defgroup gnus-visual nil
204 "Options controling the visual fluff."
208 (defgroup gnus-agent nil
209 "Offline support for Gnus."
212 (defgroup gnus-files nil
213 "Files used by Gnus."
216 (defgroup gnus-dribble-file nil
218 :link '(custom-manual "(gnus)Auto Save")
221 (defgroup gnus-newsrc nil
222 "Storing Gnus state."
225 (defgroup gnus-server nil
226 "Options related to newsservers and other servers used by Gnus."
229 (defgroup gnus-message '((message custom-group))
230 "Composing replies and followups in Gnus."
233 (defgroup gnus-meta nil
234 "Meta variables controling major portions of Gnus.
235 In general, modifying these variables does not take affect until Gnus
236 is restarted, and sometimes reloaded."
239 (defgroup gnus-various nil
240 "Other Gnus options."
241 :link '(custom-manual "(gnus)Various Various")
244 (defgroup gnus-exit nil
246 :link '(custom-manual "(gnus)Exiting Gnus")
249 (defconst gnus-version-number "5.6.4"
250 "Version number for this version of Gnus.")
252 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
253 "Version string for this version of Gnus.")
255 (defcustom gnus-inhibit-startup-message nil
256 "If non-nil, the startup message will not be displayed.
257 This variable is used before `.gnus.el' is loaded, so it should
258 be set in `.emacs' instead."
262 (defcustom gnus-play-startup-jingle nil
263 "If non-nil, play the Gnus jingle at startup."
267 ;;; Kludges to help the transition from the old `custom.el'.
269 (unless (featurep 'gnus-xmas)
270 (defalias 'gnus-make-overlay 'make-overlay)
271 (defalias 'gnus-delete-overlay 'delete-overlay)
272 (defalias 'gnus-overlay-put 'overlay-put)
273 (defalias 'gnus-move-overlay 'move-overlay)
274 (defalias 'gnus-overlay-end 'overlay-end)
275 (defalias 'gnus-extent-detached-p 'ignore)
276 (defalias 'gnus-extent-start-open 'ignore)
277 (defalias 'gnus-set-text-properties 'set-text-properties)
278 (defalias 'gnus-group-remove-excess-properties 'ignore)
279 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
280 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
281 (defalias 'gnus-character-to-event 'identity)
282 (defalias 'gnus-add-text-properties 'add-text-properties)
283 (defalias 'gnus-put-text-property 'put-text-property)
284 (defalias 'gnus-mode-line-buffer-identification 'identity)
285 (defalias 'gnus-characterp 'numberp)
286 (defalias 'gnus-deactivate-mark 'deactivate-mark)
287 (defalias 'gnus-window-edges 'window-edges)
288 (defalias 'gnus-key-press-event-p 'numberp))
290 ;; We define these group faces here to avoid the display
291 ;; update forced when creating new faces.
293 (defface gnus-group-news-1-face
296 (:foreground "PaleTurquoise" :bold t))
299 (:foreground "ForestGreen" :bold t))
302 "Level 1 newsgroup face.")
304 (defface gnus-group-news-1-empty-face
307 (:foreground "PaleTurquoise"))
310 (:foreground "ForestGreen"))
313 "Level 1 empty newsgroup face.")
315 (defface gnus-group-news-2-face
318 (:foreground "turquoise" :bold t))
321 (:foreground "CadetBlue4" :bold t))
324 "Level 2 newsgroup face.")
326 (defface gnus-group-news-2-empty-face
329 (:foreground "turquoise"))
332 (:foreground "CadetBlue4"))
335 "Level 2 empty newsgroup face.")
337 (defface gnus-group-news-3-face
346 "Level 3 newsgroup face.")
348 (defface gnus-group-news-3-empty-face
357 "Level 3 empty newsgroup face.")
359 (defface gnus-group-news-low-face
362 (:foreground "DarkTurquoise" :bold t))
365 (:foreground "DarkGreen" :bold t))
368 "Low level newsgroup face.")
370 (defface gnus-group-news-low-empty-face
373 (:foreground "DarkTurquoise"))
376 (:foreground "DarkGreen"))
379 "Low level empty newsgroup face.")
381 (defface gnus-group-mail-1-face
384 (:foreground "aquamarine1" :bold t))
387 (:foreground "DeepPink3" :bold t))
390 "Level 1 mailgroup face.")
392 (defface gnus-group-mail-1-empty-face
395 (:foreground "aquamarine1"))
398 (:foreground "DeepPink3"))
400 (:italic t :bold t)))
401 "Level 1 empty mailgroup face.")
403 (defface gnus-group-mail-2-face
406 (:foreground "aquamarine2" :bold t))
409 (:foreground "HotPink3" :bold t))
412 "Level 2 mailgroup face.")
414 (defface gnus-group-mail-2-empty-face
417 (:foreground "aquamarine2"))
420 (:foreground "HotPink3"))
423 "Level 2 empty mailgroup face.")
425 (defface gnus-group-mail-3-face
428 (:foreground "aquamarine3" :bold t))
431 (:foreground "magenta4" :bold t))
434 "Level 3 mailgroup face.")
436 (defface gnus-group-mail-3-empty-face
439 (:foreground "aquamarine3"))
442 (:foreground "magenta4"))
445 "Level 3 empty mailgroup face.")
447 (defface gnus-group-mail-low-face
450 (:foreground "aquamarine4" :bold t))
453 (:foreground "DeepPink4" :bold t))
456 "Low level mailgroup face.")
458 (defface gnus-group-mail-low-empty-face
461 (:foreground "aquamarine4"))
464 (:foreground "DeepPink4"))
467 "Low level empty mailgroup face.")
469 ;; Summary mode faces.
471 (defface gnus-summary-selected-face '((t
473 "Face used for selected articles.")
475 (defface gnus-summary-cancelled-face
477 (:foreground "yellow" :background "black")))
478 "Face used for cancelled articles.")
480 (defface gnus-summary-high-ticked-face
483 (:foreground "pink" :bold t))
486 (:foreground "firebrick" :bold t))
489 "Face used for high interest ticked articles.")
491 (defface gnus-summary-low-ticked-face
494 (:foreground "pink" :italic t))
497 (:foreground "firebrick" :italic t))
500 "Face used for low interest ticked articles.")
502 (defface gnus-summary-normal-ticked-face
505 (:foreground "pink"))
508 (:foreground "firebrick"))
511 "Face used for normal interest ticked articles.")
513 (defface gnus-summary-high-ancient-face
516 (:foreground "SkyBlue" :bold t))
519 (:foreground "RoyalBlue" :bold t))
522 "Face used for high interest ancient articles.")
524 (defface gnus-summary-low-ancient-face
527 (:foreground "SkyBlue" :italic t))
530 (:foreground "RoyalBlue" :italic t))
533 "Face used for low interest ancient articles.")
535 (defface gnus-summary-normal-ancient-face
538 (:foreground "SkyBlue"))
541 (:foreground "RoyalBlue"))
544 "Face used for normal interest ancient articles.")
546 (defface gnus-summary-high-unread-face
549 "Face used for high interest unread articles.")
551 (defface gnus-summary-low-unread-face
554 "Face used for low interest unread articles.")
556 (defface gnus-summary-normal-unread-face
559 "Face used for normal interest unread articles.")
561 (defface gnus-summary-high-read-face
564 (:foreground "PaleGreen"
568 (:foreground "DarkGreen"
572 "Face used for high interest read articles.")
574 (defface gnus-summary-low-read-face
577 (:foreground "PaleGreen"
581 (:foreground "DarkGreen"
585 "Face used for low interest read articles.")
587 (defface gnus-summary-normal-read-face
590 (:foreground "PaleGreen"))
593 (:foreground "DarkGreen"))
596 "Face used for normal interest read articles.")
601 (defvar gnus-group-buffer "*Group*")
604 (autoload 'gnus-play-jingle "gnus-audio"))
606 (defface gnus-splash-face
609 (:foreground "ForestGreen"))
612 (:foreground "ForestGreen"))
615 "Level 1 newsgroup face.")
617 (defun gnus-splash ()
619 (switch-to-buffer (get-buffer-create gnus-group-buffer))
620 (let ((buffer-read-only nil))
622 (unless gnus-inhibit-startup-message
623 (gnus-group-startup-message)
625 (when gnus-play-startup-jingle
626 (gnus-play-jingle))))))
628 (defun gnus-indent-rigidly (start end arg)
629 "Indent rigidly using only spaces and no tabs."
632 (narrow-to-region start end)
634 (indent-rigidly start end arg)
635 ;; We translate tabs into spaces -- not everybody uses
636 ;; an 8-character tab.
637 (goto-char (point-min))
638 (while (search-forward "\t" nil t)
639 (replace-match " " t t))))))
641 (defvar gnus-simple-splash nil)
643 (defun gnus-group-startup-message (&optional x y)
644 "Insert startup message in current buffer."
645 ;; Insert the message.
650 _ ___ __ ___ __ _ ___
670 (gnus-indent-rigidly (point-min) (point-max)
671 (/ (max (- (window-width) (or x 46)) 0) 2))
672 (goto-char (point-min))
674 (let* ((pheight (count-lines (point-min) (point-max)))
675 (wheight (window-height))
676 (rest (- wheight pheight)))
677 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
679 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
680 (goto-char (point-min))
681 (setq mode-line-buffer-identification (concat " " gnus-version))
682 (setq gnus-simple-splash t)
683 (set-buffer-modified-p t))
686 (let ((command (format "%s" this-command)))
687 (when (and (string-match "gnus" command)
688 (not (string-match "gnus-other-frame" command)))
697 (defcustom gnus-home-directory "~/"
698 "Directory variable that specifies the \"home\" directory.
699 All other Gnus path variables are initialized from this variable."
703 (defcustom gnus-directory (or (getenv "SAVEDIR")
704 (nnheader-concat gnus-home-directory "News/"))
705 "*Directory variable from which all other Gnus file variables are derived."
709 (defcustom gnus-default-directory nil
710 "*Default directory for all Gnus buffers."
712 :type '(choice (const :tag "current" nil)
715 ;; Site dependent variables. These variables should be defined in
718 (defvar gnus-default-nntp-server nil
719 "Specify a default NNTP server.
720 This variable should be defined in paths.el, and should never be set
722 If you want to change servers, you should use `gnus-select-method'.
723 See the documentation to that variable.")
725 ;; Don't touch this variable.
726 (defvar gnus-nntp-service "nntp"
727 "NNTP service name (\"nntp\" or 119).
728 This is an obsolete variable, which is scarcely used. If you use an
729 nntp server for your newsgroup and want to change the port number
730 used to 899, you would say something along these lines:
732 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
734 (defcustom gnus-nntpserver-file "/etc/nntpserver"
735 "A file with only the name of the nntp server in it."
740 ;; This function is used to check both the environment variable
741 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
742 ;; an nntp server name default.
743 (defun gnus-getenv-nntpserver ()
744 (or (getenv "NNTPSERVER")
745 (and (file-readable-p gnus-nntpserver-file)
747 (set-buffer (get-buffer-create " *gnus nntp*"))
748 (buffer-disable-undo (current-buffer))
749 (insert-file-contents gnus-nntpserver-file)
750 (let ((name (buffer-string)))
752 (if (string-match "^[ \t\n]*$" name)
755 (kill-buffer (current-buffer))))))))
757 (defcustom gnus-select-method
760 (list 'nntp (or (condition-case nil
761 (gnus-getenv-nntpserver)
763 (when (and gnus-default-nntp-server
764 (not (string= gnus-default-nntp-server "")))
765 gnus-default-nntp-server)
767 (if (or (null gnus-nntp-service)
768 (equal gnus-nntp-service "nntp"))
770 (list gnus-nntp-service)))
772 "*Default method for selecting a newsgroup.
773 This variable should be a list, where the first element is how the
774 news is to be fetched, the second is the address.
776 For instance, if you want to get your news via NNTP from
777 \"flab.flab.edu\", you could say:
779 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
781 If you want to use your local spool, say:
783 \(setq gnus-select-method (list 'nnspool (system-name)))
785 If you use this variable, you must set `gnus-nntp-server' to nil.
787 There is a lot more to know about select methods and virtual servers -
788 see the manual for details."
790 :type 'gnus-select-method)
792 (defcustom gnus-message-archive-method
795 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
796 (nnfolder-active-file
797 ,(nnheader-concat message-directory "archive/active"))
798 (nnfolder-get-new-mail nil)
799 (nnfolder-inhibit-expiry t))
800 "*Method used for archiving messages you've sent.
801 This should be a mail method.
803 It's probably not a very effective to change this variable once you've
804 run Gnus once. After doing that, you must edit this server from the
808 :type 'gnus-select-method)
810 (defcustom gnus-message-archive-group nil
811 "*Name of the group in which to save the messages you've written.
812 This can either be a string; a list of strings; or an alist
813 of regexps/functions/forms to be evaluated to return a string (or a list
814 of strings). The functions are called with the name of the current
815 group (or nil) as a parameter.
817 If you want to save your mail in one group and the news articles you
818 write in another group, you could say something like:
820 \(setq gnus-message-archive-group
821 '((if (message-news-p)
825 Normally the group names returned by this variable should be
826 unprefixed -- which implicitly means \"store on the archive server\".
827 However, you may wish to store the message on some other server. In
828 that case, just return a fully prefixed name of the group --
829 \"nnml+private:mail.misc\", for instance."
831 :type '(choice (const :tag "none" nil)
834 (defcustom gnus-secondary-servers nil
835 "List of NNTP servers that the user can choose between interactively.
836 To make Gnus query you for a server, you have to give `gnus' a
837 non-numeric prefix - `C-u M-x gnus', in short."
839 :type '(repeat string))
841 (defcustom gnus-nntp-server nil
842 "*The name of the host running the NNTP server.
843 This variable is semi-obsolete. Use the `gnus-select-method'
846 :type '(choice (const :tag "disable" nil)
849 (defcustom gnus-secondary-select-methods nil
850 "A list of secondary methods that will be used for reading news.
851 This is a list where each element is a complete select method (see
852 `gnus-select-method').
854 If, for instance, you want to read your mail with the nnml backend,
855 you could set this variable:
857 \(setq gnus-secondary-select-methods '((nnml \"\")))"
859 :type '(repeat gnus-select-method))
861 (defvar gnus-backup-default-subscribed-newsgroups
862 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
863 "Default default new newsgroups the first time Gnus is run.
864 Should be set in paths.el, and shouldn't be touched by the user.")
866 (defcustom gnus-local-domain nil
867 "Local domain name without a host name.
868 The DOMAINNAME environment variable is used instead if it is defined.
869 If the `system-name' function returns the full Internet name, there is
870 no need to set this variable."
872 :type '(choice (const :tag "default" nil)
875 (defvar gnus-local-organization nil
876 "String with a description of what organization (if any) the user belongs to.
877 Obsolete variable; use `message-user-organization' instead.")
879 ;; Customization variables
881 (defcustom gnus-refer-article-method nil
882 "Preferred method for fetching an article by Message-ID.
883 If you are reading news from the local spool (with nnspool), fetching
884 articles by Message-ID is painfully slow. By setting this method to an
885 nntp method, you might get acceptable results.
887 The value of this variable must be a valid select method as discussed
888 in the documentation of `gnus-select-method'."
890 :type '(choice (const :tag "default" nil)
893 (defcustom gnus-group-faq-directory
894 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
895 "/ftp@sunsite.auc.dk:/pub/usenet/"
896 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
897 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
898 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
899 "/ftp@rtfm.mit.edu:/pub/usenet/"
900 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
901 "/ftp@ftp.sunet.se:/pub/usenet/"
902 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
903 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
904 "/ftp@ftp.hk.super.net:/mirror/faqs/")
905 "*Directory where the group FAQs are stored.
906 This will most commonly be on a remote machine, and the file will be
909 This variable can also be a list of directories. In that case, the
910 first element in the list will be used by default. The others can
911 be used when being prompted for a site.
913 Note that Gnus uses an aol machine as the default directory. If this
914 feels fundamentally unclean, just think of it as a way to finally get
915 something of value back from them.
917 If the default site is too slow, try one of these:
919 North America: mirrors.aol.com /pub/rtfm/usenet
920 ftp.seas.gwu.edu /pub/rtfm
921 rtfm.mit.edu /pub/usenet
922 Europe: ftp.uni-paderborn.de /pub/FAQ
923 src.doc.ic.ac.uk /usenet/news-FAQS
924 ftp.sunet.se /pub/usenet
925 sunsite.auc.dk /pub/usenet
926 Asia: nctuccca.edu.tw /USENET/FAQ
927 hwarang.postech.ac.kr /pub/usenet
928 ftp.hk.super.net /mirror/faqs"
929 :group 'gnus-group-various
930 :type '(choice directory
933 (defcustom gnus-use-cross-reference t
934 "*Non-nil means that cross referenced articles will be marked as read.
935 If nil, ignore cross references. If t, mark articles as read in
936 subscribed newsgroups. If neither t nor nil, mark as read in all
939 :type '(choice (const :tag "off" nil)
940 (const :tag "subscribed" t)
944 (defcustom gnus-process-mark ?#
946 :group 'gnus-group-visual
947 :group 'gnus-summary-marks
950 (defcustom gnus-asynchronous nil
951 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
952 :group 'gnus-asynchronous
955 (defcustom gnus-large-newsgroup 200
956 "*The number of articles which indicates a large newsgroup.
957 If the number of articles in a newsgroup is greater than this value,
958 confirmation is required for selecting the newsgroup."
959 :group 'gnus-group-select
962 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
963 "*Non-nil means that the default name of a file to save articles in is the group name.
964 If it's nil, the directory form of the group name is used instead.
966 If this variable is a list, and the list contains the element
967 `not-score', long file names will not be used for score files; if it
968 contains the element `not-save', long file names will not be used for
969 saving; and if it contains the element `not-kill', long file names
970 will not be used for kill files.
972 Note that the default for this variable varies according to what system
973 type you're using. On `usg-unix-v' and `xenix' this variable defaults
974 to nil while on all other systems it defaults to t."
978 (defcustom gnus-kill-files-directory gnus-directory
979 "*Name of the directory where kill files will be stored (default \"~/News\")."
980 :group 'gnus-score-files
981 :group 'gnus-score-kill
984 (defcustom gnus-save-score nil
985 "*If non-nil, save group scoring info."
986 :group 'gnus-score-various
990 (defcustom gnus-use-undo t
991 "*If non-nil, allow undoing in Gnus group mode buffers."
995 (defcustom gnus-use-adaptive-scoring nil
996 "*If non-nil, use some adaptive scoring scheme.
997 If a list, then the values `word' and `line' are meaningful. The
998 former will perform adaption on individual words in the subject
999 header while `line' will perform adaption on several headers."
1001 :group 'gnus-score-adapt
1002 :type '(set (const word) (const line)))
1004 (defcustom gnus-use-cache 'passive
1005 "*If nil, Gnus will ignore the article cache.
1006 If `passive', it will allow entering (and reading) articles
1007 explicitly entered into the cache. If anything else, use the
1008 cache to the full extent of the law."
1011 :type '(choice (const :tag "off" nil)
1012 (const :tag "passive" passive)
1013 (const :tag "active" t)))
1015 (defcustom gnus-use-trees nil
1016 "*If non-nil, display a thread tree buffer."
1020 (defcustom gnus-use-grouplens nil
1021 "*If non-nil, use GroupLens ratings."
1025 (defcustom gnus-keep-backlog nil
1026 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1027 If it is a number N, then Gnus will only keep the last N articles
1028 read. If it is neither nil nor a number, Gnus will keep all read
1029 articles. This is not a good idea."
1031 :type '(choice (const :tag "off" nil)
1036 (defcustom gnus-use-nocem nil
1037 "*If non-nil, Gnus will read NoCeM cancel messages."
1041 (defcustom gnus-suppress-duplicates nil
1042 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1046 (defcustom gnus-use-demon nil
1047 "If non-nil, Gnus might use some demons."
1051 (defcustom gnus-use-scoring t
1052 "*If non-nil, enable scoring."
1056 (defcustom gnus-use-picons nil
1057 "*If non-nil, display picons."
1061 (defcustom gnus-summary-prepare-exit-hook
1062 '(gnus-summary-expire-articles)
1063 "*A hook called when preparing to exit from the summary buffer.
1064 It calls `gnus-summary-expire-articles' by default."
1065 :group 'gnus-summary-exit
1068 (defcustom gnus-novice-user t
1069 "*Non-nil means that you are a usenet novice.
1070 If non-nil, verbose messages may be displayed and confirmations may be
1075 (defcustom gnus-expert-user nil
1076 "*Non-nil means that you will never be asked for confirmation about anything.
1077 That doesn't mean *anything* anything; particularly destructive
1078 commands will still require prompting."
1082 (defcustom gnus-interactive-catchup t
1083 "*If non-nil, require your confirmation when catching up a group."
1084 :group 'gnus-group-select
1087 (defcustom gnus-interactive-exit t
1088 "*If non-nil, require your confirmation when exiting Gnus."
1092 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1093 "*Function for extracting address components from a From header.
1094 Two pre-defined function exist: `gnus-extract-address-components',
1095 which is the default, quite fast, and too simplistic solution, and
1096 `mail-extract-address-components', which works much better, but is
1098 :group 'gnus-summary-format
1099 :type '(radio (function-item gnus-extract-address-components)
1100 (function-item mail-extract-address-components)
1101 (function :tag "Other")))
1103 (defcustom gnus-carpal nil
1104 "*If non-nil, display clickable icons."
1108 (defcustom gnus-shell-command-separator ";"
1109 "String used to separate to shell commands."
1113 (defcustom gnus-valid-select-methods
1114 '(("nntp" post address prompt-address physical-address)
1115 ("nnspool" post address)
1116 ("nnvirtual" post-mail virtual prompt-address)
1117 ("nnmbox" mail respool address)
1118 ("nnml" mail respool address)
1119 ("nnmh" mail respool address)
1120 ("nndir" post-mail prompt-address physical-address)
1121 ("nneething" none address prompt-address physical-address)
1122 ("nndoc" none address prompt-address)
1123 ("nnbabyl" mail address respool)
1124 ("nnkiboze" post virtual)
1125 ("nnsoup" post-mail address)
1126 ("nndraft" post-mail)
1127 ("nnfolder" mail respool address)
1128 ("nngateway" none address prompt-address physical-address)
1131 ("nnagent" post-mail))
1132 "*An alist of valid select methods.
1133 The first element of each list lists should be a string with the name
1134 of the select method. The other elements may be the category of
1135 this method (i. e., `post', `mail', `none' or whatever) or other
1136 properties that this method has (like being respoolable).
1137 If you implement a new select method, all you should have to change is
1138 this variable. I think."
1140 :type '(repeat (group (string :tag "Name")
1141 (radio-button-choice (const :format "%v " post)
1142 (const :format "%v " mail)
1143 (const :format "%v " none)
1145 (checklist :inline t
1146 (const :format "%v " address)
1147 (const :format "%v " prompt-address)
1148 (const :format "%v " physical-address)
1149 (const :format "%v " virtual)
1152 (define-widget 'gnus-select-method 'list
1153 "Widget for entering a select method."
1154 :args `((choice :tag "Method"
1155 ,@(mapcar (lambda (entry)
1156 (list 'const :format "%v\n"
1157 (intern (car entry))))
1158 gnus-valid-select-methods))
1159 (string :tag "Address")
1160 (editable-list :inline t
1163 (sexp :tag "Value")))))
1165 (defcustom gnus-updated-mode-lines '(group article summary tree)
1166 "List of buffers that should update their mode lines.
1167 The list may contain the symbols `group', `article', `tree' and
1168 `summary'. If the corresponding symbol is present, Gnus will keep
1169 that mode line updated with information that may be pertinent.
1170 If this variable is nil, screen refresh may be quicker."
1171 :group 'gnus-various
1172 :type '(set (const group)
1177 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1178 (defcustom gnus-mode-non-string-length nil
1179 "*Max length of mode-line non-string contents.
1180 If this is nil, Gnus will take space as is needed, leaving the rest
1181 of the modeline intact. Note that the default of nil is unlikely
1182 to be desirable; see the manual for further details."
1183 :group 'gnus-various
1184 :type '(choice (const nil)
1187 (defcustom gnus-auto-expirable-newsgroups nil
1188 "*Groups in which to automatically mark read articles as expirable.
1189 If non-nil, this should be a regexp that should match all groups in
1190 which to perform auto-expiry. This only makes sense for mail groups."
1191 :group 'nnmail-expire
1192 :type '(choice (const nil)
1195 (defcustom gnus-total-expirable-newsgroups nil
1196 "*Groups in which to perform expiry of all read articles.
1197 Use with extreme caution. All groups that match this regexp will be
1198 expiring - which means that all read articles will be deleted after
1199 \(say) one week. (This only goes for mail groups and the like, of
1201 :group 'nnmail-expire
1202 :type '(choice (const nil)
1205 (defcustom gnus-group-uncollapsed-levels 1
1206 "Number of group name elements to leave alone when making a short group name."
1207 :group 'gnus-group-visual
1210 (defcustom gnus-group-use-permanent-levels nil
1211 "*If non-nil, once you set a level, Gnus will use this level."
1212 :group 'gnus-group-levels
1217 (defcustom gnus-load-hook nil
1218 "A hook run while Gnus is loaded."
1222 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1223 "A hook called to apply kill files to a group.
1224 This hook is intended to apply a kill file to the selected newsgroup.
1225 The function `gnus-apply-kill-file' is called by default.
1227 Since a general kill file is too heavy to use only for a few
1228 newsgroups, I recommend you to use a lighter hook function. For
1229 example, if you'd like to apply a kill file to articles which contains
1230 a string `rmgroup' in subject in newsgroup `control', you can use the
1233 (setq gnus-apply-kill-hook
1236 (cond ((string-match \"control\" gnus-newsgroup-name)
1237 (gnus-kill \"Subject\" \"rmgroup\")
1238 (gnus-expunge \"X\"))))))"
1239 :group 'gnus-score-kill
1240 :options '(gnus-apply-kill-file)
1243 (defcustom gnus-group-change-level-function nil
1244 "Function run when a group level is changed.
1245 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1246 :group 'gnus-group-level
1251 (defcustom gnus-visual
1252 '(summary-highlight group-highlight article-highlight
1254 summary-menu group-menu article-menu
1255 tree-highlight menu highlight
1256 browse-menu server-menu
1257 page-marker tree-menu binary-menu pick-menu
1259 "*Enable visual features.
1260 If `visual' is disabled, there will be no menus and few faces. Most of
1261 the visual customization options below will be ignored. Gnus will use
1262 less space and be faster as a result.
1264 This variable can also be a list of visual elements to switch on. For
1265 instance, to switch off all visual things except menus, you can say:
1267 (setq gnus-visual '(menu))
1269 Valid elements include `summary-highlight', `group-highlight',
1270 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1271 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1272 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1273 and `grouplens-menu'."
1276 :type '(set (const summary-highlight)
1277 (const group-highlight)
1278 (const article-highlight)
1280 (const summary-menu)
1282 (const article-menu)
1283 (const tree-highlight)
1292 (const grouplens-menu)))
1294 (defcustom gnus-mouse-face
1296 (if (gnus-visual-p 'mouse-face 'highlight)
1297 (if (boundp 'gnus-mouse-face)
1298 (or gnus-mouse-face 'highlight)
1302 "*Face used for group or summary buffer mouse highlighting.
1303 The line beneath the mouse pointer will be highlighted with this
1308 (defcustom gnus-article-display-hook
1309 (if (and (string-match "XEmacs" emacs-version)
1311 '(gnus-article-hide-headers-if-wanted
1312 gnus-article-hide-boring-headers
1313 gnus-article-treat-overstrike
1314 gnus-article-maybe-highlight
1315 gnus-article-display-x-face)
1316 '(gnus-article-hide-headers-if-wanted
1317 gnus-article-hide-boring-headers
1318 gnus-article-treat-overstrike
1319 gnus-article-maybe-highlight))
1320 "*Controls how the article buffer will look.
1322 If you leave the list empty, the article will appear exactly as it is
1323 stored on the disk. The list entries will hide or highlight various
1324 parts of the article, making it easier to find the information you
1326 :group 'gnus-article-highlight
1329 :options '(gnus-article-add-buttons
1330 gnus-article-add-buttons-to-head
1331 gnus-article-emphasize
1332 gnus-article-fill-cited-article
1333 gnus-article-remove-cr
1334 gnus-article-de-quoted-unreadable
1335 gnus-summary-stop-page-breaking
1336 ;; gnus-summary-caesar-message
1337 ;; gnus-summary-verbose-headers
1338 gnus-summary-toggle-mime
1340 gnus-article-hide-headers
1341 gnus-article-hide-boring-headers
1342 gnus-article-hide-signature
1343 gnus-article-hide-citation
1344 gnus-article-hide-pgp
1345 gnus-article-hide-pem
1346 gnus-article-highlight
1347 gnus-article-highlight-headers
1348 gnus-article-highlight-citation
1349 gnus-article-highlight-signature
1350 gnus-article-date-ut
1351 gnus-article-date-local
1352 gnus-article-date-lapsed
1353 gnus-article-date-original
1354 gnus-article-remove-trailing-blank-lines
1355 gnus-article-strip-leading-blank-lines
1356 gnus-article-strip-multiple-blank-lines
1357 gnus-article-strip-blank-lines
1358 gnus-article-treat-overstrike
1359 gnus-article-display-x-face
1360 gnus-smiley-display))
1362 (defcustom gnus-article-save-directory gnus-directory
1363 "*Name of the directory articles will be saved in (default \"~/News\")."
1364 :group 'gnus-article-saving
1367 (defvar gnus-plugged t
1368 "Whether Gnus is plugged or not.")
1371 ;;; Internal variables
1373 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1374 (defvar gnus-original-article-buffer " *Original Article*")
1375 (defvar gnus-newsgroup-name nil)
1376 (defvar gnus-ephemeral-servers nil)
1378 (defvar gnus-agent nil
1379 "Whether we want to use the Gnus agent or not.")
1381 (defvar gnus-command-method nil
1382 "Dynamically bound variable that says what the current backend is.")
1384 (defvar gnus-current-select-method nil
1385 "The current method for selecting a newsgroup.")
1387 (defvar gnus-tree-buffer "*Tree*"
1388 "Buffer where Gnus thread trees are displayed.")
1391 (defvar gnus-use-generic-from nil)
1393 ;; Variable holding the user answers to all method prompts.
1394 (defvar gnus-method-history nil)
1396 ;; Variable holding the user answers to all mail method prompts.
1397 (defvar gnus-mail-method-history nil)
1399 ;; Variable holding the user answers to all group prompts.
1400 (defvar gnus-group-history nil)
1402 (defvar gnus-server-alist nil
1403 "List of available servers.")
1405 (defvar gnus-predefined-server-alist
1408 (nnspool-spool-directory "~/News/cache/")
1409 (nnspool-nov-directory "~/News/cache/")
1410 (nnspool-active-file "~/News/cache/active"))))
1411 "List of predefined (convenience) servers.")
1413 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1415 (defconst gnus-article-mark-lists
1416 '((marked . tick) (replied . reply)
1417 (expirable . expire) (killed . killed)
1418 (bookmarks . bookmark) (dormant . dormant)
1419 (scored . score) (saved . save)
1420 (cached . cache) (downloadable . download)
1421 (unsendable . unsend)))
1423 (defvar gnus-headers-retrieved-by nil)
1424 (defvar gnus-article-reply nil)
1425 (defvar gnus-override-method nil)
1426 (defvar gnus-article-check-size nil)
1427 (defvar gnus-opened-servers nil)
1429 (defvar gnus-current-kill-article nil)
1431 (defvar gnus-have-read-active-file nil)
1433 (defconst gnus-maintainer
1434 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1435 "The mail address of the Gnus maintainers.")
1437 (defvar gnus-info-nodes
1438 '((gnus-group-mode "(gnus)The Group Buffer")
1439 (gnus-summary-mode "(gnus)The Summary Buffer")
1440 (gnus-article-mode "(gnus)The Article Buffer")
1441 (mime/viewer-mode "(gnus)The Article Buffer")
1442 (gnus-server-mode "(gnus)The Server Buffer")
1443 (gnus-browse-mode "(gnus)Browse Foreign Server")
1444 (gnus-tree-mode "(gnus)Tree Display"))
1445 "Alist of major modes and related Info nodes.")
1447 (defvar gnus-group-buffer "*Group*")
1448 (defvar gnus-summary-buffer "*Summary*")
1449 (defvar gnus-article-buffer "*Article*")
1450 (defvar gnus-server-buffer "*Server*")
1452 (defvar gnus-buffer-list nil
1453 "Gnus buffers that should be killed on exit.")
1455 (defvar gnus-slave nil
1456 "Whether this Gnus is a slave or not.")
1458 (defvar gnus-batch-mode nil
1459 "Whether this Gnus is running in batch mode or not.")
1461 (defvar gnus-variable-list
1462 '(gnus-newsrc-options gnus-newsrc-options-n
1463 gnus-newsrc-last-checked-date
1464 gnus-newsrc-alist gnus-server-alist
1465 gnus-killed-list gnus-zombie-list
1466 gnus-topic-topology gnus-topic-alist
1468 "Gnus variables saved in the quick startup file.")
1470 (defvar gnus-newsrc-alist nil
1471 "Assoc list of read articles.
1472 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1474 (defvar gnus-newsrc-hashtb nil
1475 "Hashtable of gnus-newsrc-alist.")
1477 (defvar gnus-killed-list nil
1478 "List of killed newsgroups.")
1480 (defvar gnus-killed-hashtb nil
1481 "Hash table equivalent of gnus-killed-list.")
1483 (defvar gnus-zombie-list nil
1484 "List of almost dead newsgroups.")
1486 (defvar gnus-description-hashtb nil
1487 "Descriptions of newsgroups.")
1489 (defvar gnus-list-of-killed-groups nil
1490 "List of newsgroups that have recently been killed by the user.")
1492 (defvar gnus-active-hashtb nil
1493 "Hashtable of active articles.")
1495 (defvar gnus-moderated-hashtb nil
1496 "Hashtable of moderated newsgroups.")
1498 ;; Save window configuration.
1499 (defvar gnus-prev-winconf nil)
1501 (defvar gnus-reffed-article-number nil)
1503 ;;; Let the byte-compiler know that we know about this variable.
1504 (defvar rmail-default-rmail-file)
1506 (defvar gnus-dead-summary nil)
1508 ;;; End of variables.
1510 ;; Define some autoload functions Gnus might use.
1513 ;; This little mapcar goes through the list below and marks the
1514 ;; symbols in question as autoloaded functions.
1517 (let ((interactive (nth 1 (memq ':interactive package))))
1521 (when (consp function)
1522 (setq keymap (car (memq 'keymap function)))
1523 (setq function (car function)))
1524 (autoload function (car package) nil interactive keymap)))
1525 (if (eq (nth 1 package) ':interactive)
1528 '(("metamail" metamail-buffer)
1529 ("info" Info-goto-node)
1530 ("hexl" hexl-hex-string-to-integer)
1531 ("pp" pp pp-to-string pp-eval-expression)
1532 ("ps-print" ps-print-preprint)
1533 ("mail-extr" mail-extract-address-components)
1534 ("browse-url" browse-url)
1535 ("message" :interactive t
1536 message-send-and-exit message-yank-original)
1537 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1538 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1539 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1540 timezone-make-sortable-date timezone-make-time-string)
1541 ("rmailout" rmail-output)
1542 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1544 ("gnus-audio" :interactive t gnus-audio-play)
1545 ("gnus-xmas" gnus-xmas-splash)
1546 ("gnus-soup" :interactive t
1547 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1548 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1549 ("nnsoup" nnsoup-pack-replies)
1550 ("score-mode" :interactive t gnus-score-mode)
1551 ("gnus-mh" gnus-summary-save-article-folder
1552 gnus-Folder-save-name gnus-folder-save-name)
1553 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1554 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1555 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1556 gnus-demon-add-disconnection gnus-demon-add-handler
1557 gnus-demon-remove-handler)
1558 ("gnus-demon" :interactive t
1559 gnus-demon-init gnus-demon-cancel)
1560 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1561 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1562 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1563 gnus-nocem-unwanted-article-p)
1564 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1565 gnus-server-server-name)
1566 ("gnus-srvr" gnus-browse-foreign-server)
1567 ("gnus-cite" :interactive t
1568 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1569 gnus-article-hide-citation gnus-article-fill-cited-article
1570 gnus-article-hide-citation-in-followups)
1571 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1572 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1573 gnus-execute gnus-expunge)
1574 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1575 gnus-cache-possibly-remove-articles gnus-cache-request-article
1576 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1577 gnus-cache-enter-remove-article gnus-cached-article-p
1578 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1579 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1580 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1581 ("gnus-score" :interactive t
1582 gnus-summary-increase-score gnus-summary-set-score
1583 gnus-summary-raise-thread gnus-summary-raise-same-subject
1584 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1585 gnus-summary-lower-thread gnus-summary-lower-same-subject
1586 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1587 gnus-summary-current-score gnus-score-default
1588 gnus-score-flush-cache gnus-score-close
1589 gnus-possibly-score-headers gnus-score-followup-article
1590 gnus-score-followup-thread)
1592 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1593 gnus-current-score-file-nondirectory gnus-score-adaptive
1594 gnus-score-find-trace gnus-score-file-name)
1595 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1596 ("gnus-topic" :interactive t gnus-topic-mode)
1597 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1598 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1599 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1600 ("gnus-uu" :interactive t
1601 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1602 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1603 gnus-uu-mark-by-regexp gnus-uu-mark-all
1604 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1605 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1606 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1607 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1608 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1609 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1610 gnus-uu-decode-binhex-view)
1611 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1612 ("gnus-msg" (gnus-summary-send-map keymap)
1613 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1614 ("gnus-msg" :interactive t
1615 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1616 gnus-summary-followup gnus-summary-followup-with-original
1617 gnus-summary-cancel-article gnus-summary-supersede-article
1618 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1619 gnus-summary-mail-forward gnus-summary-mail-other-window
1620 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1622 ("gnus-picon" :interactive t gnus-article-display-picons
1623 gnus-group-display-picons gnus-picons-article-display-x-face
1624 gnus-picons-display-x-face)
1625 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1626 gnus-grouplens-mode)
1627 ("smiley" :interactive t gnus-smiley-display)
1628 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1629 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1630 gnus-list-of-unread-articles gnus-list-of-read-articles
1631 gnus-offer-save-summaries gnus-make-thread-indent-array
1632 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1633 gnus-summary-skip-intangible gnus-summary-article-number
1634 gnus-data-header gnus-data-find)
1635 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1636 gnus-group-list-groups gnus-group-first-unread-group
1637 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1638 gnus-group-setup-buffer gnus-group-get-new-news
1639 gnus-group-make-help-group gnus-group-update-group
1640 gnus-clear-inboxes-moved gnus-group-iterate
1641 gnus-group-group-name)
1642 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1643 gnus-backlog-remove-article)
1644 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1645 gnus-article-prepare gnus-article-set-window-start
1646 gnus-article-next-page gnus-article-prev-page
1647 gnus-request-article-this-buffer gnus-article-mode
1648 gnus-article-setup-buffer gnus-narrow-to-page
1649 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1650 ("gnus-art" :interactive t
1651 gnus-article-hide-headers gnus-article-hide-boring-headers
1652 gnus-article-treat-overstrike gnus-article-word-wrap
1653 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1654 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1655 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1656 gnus-article-hide-pem gnus-article-hide-signature
1657 gnus-article-strip-leading-blank-lines gnus-article-date-local
1658 gnus-article-date-original gnus-article-date-lapsed
1659 gnus-article-show-all-headers
1660 gnus-article-edit-mode gnus-article-edit-article
1661 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1662 gnus-start-date-timer gnus-stop-date-timer)
1663 ("gnus-int" gnus-request-type)
1664 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1665 gnus-dribble-enter gnus-read-init-file)
1666 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1667 gnus-dup-enter-articles)
1668 ("gnus-range" gnus-copy-sequence)
1669 ("gnus-eform" gnus-edit-form)
1670 ("gnus-move" :interactive t
1671 gnus-group-move-group-to-server gnus-change-server)
1672 ("gnus-logic" gnus-score-advanced)
1673 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1674 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1675 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1676 gnus-async-halt-prefetch)
1677 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1678 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1679 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1680 gnus-summary-set-agent-mark)
1681 ("gnus-agent" :interactive t
1682 gnus-unplugged gnus-agentize gnus-agent-batch)
1683 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1684 gnus-summary-save-article-vm)
1685 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1687 ;;; gnus-sum.el thingies
1690 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1691 "*The format specification of the lines in the summary buffer.
1693 It works along the same lines as a normal formatting string,
1694 with some simple extensions.
1696 %N Article number, left padded with spaces (string)
1698 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1699 %n Name of the poster (string)
1700 %a Extracted name of the poster (string)
1701 %A Extracted address of the poster (string)
1702 %F Contents of the From: header (string)
1703 %x Contents of the Xref: header (string)
1704 %D Date of the article (string)
1705 %d Date of the article (string) in DD-MMM format
1706 %M Message-id of the article (string)
1707 %r References of the article (string)
1708 %c Number of characters in the article (integer)
1709 %L Number of lines in the article (integer)
1710 %I Indentation based on thread level (a string of spaces)
1711 %T A string with two possible values: 80 spaces if the article
1712 is on thread level two or larger and 0 spaces on level one
1713 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1714 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1715 %[ Opening bracket (character, \"[\" or \"<\")
1716 %] Closing bracket (character, \"]\" or \">\")
1717 %> Spaces of length thread-level (string)
1718 %< Spaces of length (- 20 thread-level) (string)
1719 %i Article score (number)
1720 %z Article zcore (character)
1721 %t Number of articles under the current thread (number).
1722 %e Whether the thread is empty or not (character).
1723 %l GroupLens score (string).
1724 %V Total thread score (number).
1725 %P The line number (number).
1726 %O Download mark (character).
1727 %u User defined specifier. The next character in the format string should
1728 be a letter. Gnus will call the function gnus-user-format-function-X,
1729 where X is the letter following %u. The function will be passed the
1730 current header as argument. The function should return a string, which
1731 will be inserted into the summary just like information from any other
1734 Text between %( and %) will be highlighted with `gnus-mouse-face'
1735 when the mouse point is placed inside the area. There can only be one
1738 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1739 with care. For reasons of efficiency, Gnus will compute what column
1740 these characters will end up in, and \"hard-code\" that. This means that
1741 it is illegal to have these specs after a variable-length spec. Well,
1742 you might not be arrested, but your summary buffer will look strange,
1743 which is bad enough.
1745 The smart choice is to have these specs as for to the left as
1748 This restriction may disappear in later versions of Gnus."
1750 :group 'gnus-summary-format)
1753 ;;; Skeleton keymaps
1756 (defun gnus-suppress-keymap (keymap)
1757 (suppress-keymap keymap)
1758 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1760 (define-key keymap (pop keys) 'undefined))))
1762 (defvar gnus-article-mode-map
1763 (let ((keymap (make-keymap)))
1764 (gnus-suppress-keymap keymap)
1766 (defvar gnus-summary-mode-map
1767 (let ((keymap (make-keymap)))
1768 (gnus-suppress-keymap keymap)
1770 (defvar gnus-group-mode-map
1771 (let ((keymap (make-keymap)))
1772 (gnus-suppress-keymap keymap)
1777 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1778 ;; If you want the cursor to go somewhere else, set these two
1779 ;; functions in some startup hook to whatever you want.
1780 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1781 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1783 ;;; Various macros and substs.
1785 (defun gnus-header-from (header)
1786 (mail-header-from header))
1788 (defmacro gnus-gethash (string hashtable)
1789 "Get hash value of STRING in HASHTABLE."
1790 `(symbol-value (intern-soft ,string ,hashtable)))
1792 (defmacro gnus-sethash (string value hashtable)
1793 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1794 `(set (intern ,string ,hashtable) ,value))
1795 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1797 (defmacro gnus-group-unread (group)
1798 "Get the currently computed number of unread articles in GROUP."
1799 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1801 (defmacro gnus-group-entry (group)
1802 "Get the newsrc entry for GROUP."
1803 `(gnus-gethash ,group gnus-newsrc-hashtb))
1805 (defmacro gnus-active (group)
1806 "Get active info on GROUP."
1807 `(gnus-gethash ,group gnus-active-hashtb))
1809 (defmacro gnus-set-active (group active)
1810 "Set GROUP's active info."
1811 `(gnus-sethash ,group ,active gnus-active-hashtb))
1813 (defun gnus-alive-p ()
1814 "Say whether Gnus is running or not."
1815 (and gnus-group-buffer
1816 (get-buffer gnus-group-buffer)
1818 (set-buffer gnus-group-buffer)
1819 (eq major-mode 'gnus-group-mode))))
1821 ;; Info access macros.
1823 (defmacro gnus-info-group (info)
1825 (defmacro gnus-info-rank (info)
1827 (defmacro gnus-info-read (info)
1829 (defmacro gnus-info-marks (info)
1831 (defmacro gnus-info-method (info)
1833 (defmacro gnus-info-params (info)
1836 (defmacro gnus-info-level (info)
1837 `(let ((rank (gnus-info-rank ,info)))
1841 (defmacro gnus-info-score (info)
1842 `(let ((rank (gnus-info-rank ,info)))
1843 (or (and (consp rank) (cdr rank)) 0)))
1845 (defmacro gnus-info-set-group (info group)
1846 `(setcar ,info ,group))
1847 (defmacro gnus-info-set-rank (info rank)
1848 `(setcar (nthcdr 1 ,info) ,rank))
1849 (defmacro gnus-info-set-read (info read)
1850 `(setcar (nthcdr 2 ,info) ,read))
1851 (defmacro gnus-info-set-marks (info marks &optional extend)
1853 `(gnus-info-set-entry ,info ,marks 3)
1854 `(setcar (nthcdr 3 ,info) ,marks)))
1855 (defmacro gnus-info-set-method (info method &optional extend)
1857 `(gnus-info-set-entry ,info ,method 4)
1858 `(setcar (nthcdr 4 ,info) ,method)))
1859 (defmacro gnus-info-set-params (info params &optional extend)
1861 `(gnus-info-set-entry ,info ,params 5)
1862 `(setcar (nthcdr 5 ,info) ,params)))
1864 (defun gnus-info-set-entry (info entry number)
1865 ;; Extend the info until we have enough elements.
1866 (while (<= (length info) number)
1867 (nconc info (list nil)))
1869 (setcar (nthcdr number info) entry))
1871 (defmacro gnus-info-set-level (info level)
1872 `(let ((rank (cdr ,info)))
1873 (if (consp (car rank))
1874 (setcar (car rank) ,level)
1875 (setcar rank ,level))))
1876 (defmacro gnus-info-set-score (info score)
1877 `(let ((rank (cdr ,info)))
1878 (if (consp (car rank))
1879 (setcdr (car rank) ,score)
1880 (setcar rank (cons (car rank) ,score)))))
1882 (defmacro gnus-get-info (group)
1883 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1885 ;; Byte-compiler warning.
1886 (defvar gnus-visual)
1887 ;; Find out whether the gnus-visual TYPE is wanted.
1888 (defun gnus-visual-p (&optional type class)
1889 (and gnus-visual ; Has to be non-nil, at least.
1890 (if (not type) ; We don't care about type.
1892 (if (listp gnus-visual) ; It's a list, so we check it.
1893 (or (memq type gnus-visual)
1894 (memq class gnus-visual))
1897 ;;; Load the compatability functions.
1906 (defvar gnus-shutdown-alist nil)
1908 (defun gnus-add-shutdown (function &rest symbols)
1909 "Run FUNCTION whenever one of SYMBOLS is shut down."
1910 (push (cons function symbols) gnus-shutdown-alist))
1912 (defun gnus-shutdown (symbol)
1913 "Shut down everything that waits for SYMBOL."
1914 (let ((alist gnus-shutdown-alist)
1916 (while (setq entry (pop alist))
1917 (when (memq symbol (cdr entry))
1918 (funcall (car entry))))))
1922 ;;; Gnus Utility Functions
1925 (defmacro gnus-string-or (&rest strings)
1926 "Return the first element of STRINGS that is a non-blank string.
1927 STRINGS will be evaluated in normal `or' order."
1928 `(gnus-string-or-1 ',strings))
1930 (defun gnus-string-or-1 (strings)
1933 (setq string (eval (pop strings)))
1934 (if (string-match "^[ \t]*$" string)
1936 (setq strings nil)))
1939 ;; Add the current buffer to the list of buffers to be killed on exit.
1940 (defun gnus-add-current-to-buffer-list ()
1941 (or (memq (current-buffer) gnus-buffer-list)
1942 (push (current-buffer) gnus-buffer-list)))
1944 (defun gnus-version (&optional arg)
1945 "Version number of this version of Gnus.
1946 If ARG, insert string at point."
1948 (let ((methods gnus-valid-select-methods)
1951 ;; Go through all the legal select methods and add their version
1952 ;; numbers to the total version string. Only the backends that are
1953 ;; currently in use will have their message numbers taken into
1956 (setq meth (intern (concat (caar methods) "-version")))
1958 (stringp (symbol-value meth))
1959 (setq mess (concat mess "; " (symbol-value meth))))
1960 (setq methods (cdr methods)))
1962 (insert (message mess))
1965 (defun gnus-continuum-version (version)
1966 "Return VERSION as a floating point number."
1967 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1968 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1969 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1970 (number (match-string 2 version))
1972 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1973 (setq major (string-to-number (match-string 1 number)))
1974 (setq minor (string-to-number (match-string 2 number)))
1975 (setq least (if (match-beginning 3)
1976 (string-to-number (match-string 3 number))
1980 (format "%s00%02d%02d"
1982 ((member alpha '("(ding)" "d")) "4.99")
1983 ((member alpha '("September" "s")) "5.01")
1984 ((member alpha '("Red" "r")) "5.03"))
1986 (format "%d.%02d%02d" major minor least))))))
1988 (defun gnus-info-find-node ()
1989 "Find Info documentation of Gnus."
1991 ;; Enlarge info window if needed.
1992 (let (gnus-info-buffer)
1993 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1994 (setq gnus-info-buffer (current-buffer))
1995 (gnus-configure-windows 'info)))
1998 ;;; gnus-interactive
2001 (defvar gnus-current-prefix-symbol nil
2002 "Current prefix symbol.")
2004 (defvar gnus-current-prefix-symbols nil
2005 "List of current prefix symbols.")
2007 (defun gnus-interactive (string &optional params)
2008 "Return a list that can be fed to `interactive'.
2009 See `interactive' for full documentation.
2011 Adds the following specs:
2013 y -- The current symbolic prefix.
2014 Y -- A list of the current symbolic prefix(es).
2015 A -- Article number.
2016 H -- Article header.
2020 (while (< i (length string))
2021 (string-match ".\\([^\n]*\\)\n?" string i)
2022 (setq c (aref string i))
2024 (setq prompt (match-string 1 string)))
2025 (setq i (match-end 0))
2026 ;; We basically emulate just about everything that
2027 ;; `interactive' does, but adds the "g" and "G" specs.
2031 (completing-read prompt obarray 'fboundp t))
2033 (read-buffer prompt (current-buffer) t))
2035 (read-buffer prompt (other-buffer (current-buffer))))
2039 (completing-read prompt obarray 'commandp t))
2043 (read-file-name prompt nil default-directory 'lambda))
2045 (read-file-name prompt nil nil 'lambda))
2047 (read-file-name prompt))
2049 (read-key-sequence prompt))
2051 (error "Not implemented spec"))
2053 (error "Not implemented spec"))
2057 (error "Not implemented spec"))
2059 (string-to-number (read-from-minibuffer prompt)))
2061 (prefix-numeric-value current-prefix-arg))
2067 (read-string prompt))
2069 (intern (read-string prompt)))
2071 (read-variable prompt))
2073 (read-minibuffer prompt))
2075 (eval-minibuffer prompt))
2076 ;; And here the new specs come.
2078 gnus-current-prefix-symbol)
2080 gnus-current-prefix-symbols)
2082 (gnus-group-group-name))
2084 (gnus-summary-skip-intangible)
2085 (or (get-text-property (point) 'gnus-number)
2086 (gnus-summary-last-subject)))
2088 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2090 (error "Non-implemented spec")))
2094 (push (if (< (point) (mark) (point) (mark))) out)
2095 (push (if (> (point) (mark) (point) (mark))) out))))
2096 (setq out (delq 'gnus-prefix-nil out))
2099 (defun gnus-symbolic-argument (&optional arg)
2100 "Read a symbolic argument and a command, and then execute command."
2102 (let* ((in-command (this-command-keys))
2103 (command in-command)
2104 gnus-current-prefix-symbols
2105 gnus-current-prefix-symbol
2107 (while (equal in-command command)
2108 (message "%s-" (key-description (this-command-keys)))
2109 (push (intern (char-to-string (read-char))) syms)
2110 (setq command (read-key-sequence nil t)))
2111 (setq gnus-current-prefix-symbols (nreverse syms)
2112 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2113 (call-interactively (key-binding command t))))
2115 ;;; More various functions.
2117 (defsubst gnus-check-backend-function (func group)
2118 "Check whether GROUP supports function FUNC.
2119 GROUP can either be a string (a group name) or a select method."
2121 (let ((method (if (stringp group)
2122 (car (gnus-find-method-for-group group))
2124 (unless (featurep method)
2126 (fboundp (intern (format "%s-%s" method func))))))
2128 (defun gnus-group-read-only-p (&optional group)
2129 "Check whether GROUP supports editing or not.
2130 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2131 that that variable is buffer-local to the summary buffers."
2132 (let ((group (or group gnus-newsgroup-name)))
2133 (not (gnus-check-backend-function 'request-replace-article group))))
2135 (defun gnus-group-total-expirable-p (group)
2136 "Check whether GROUP is total-expirable or not."
2137 (let ((params (gnus-group-find-parameter group))
2140 ((memq 'total-expire params)
2142 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2144 (gnus-total-expirable-newsgroups ; Check var.
2145 (string-match gnus-total-expirable-newsgroups group)))))
2147 (defun gnus-group-auto-expirable-p (group)
2148 "Check whether GROUP is auto-expirable or not."
2149 (let ((params (gnus-group-find-parameter group))
2152 ((memq 'auto-expire params)
2154 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2156 (gnus-auto-expirable-newsgroups ; Check var.
2157 (string-match gnus-auto-expirable-newsgroups group)))))
2159 (defun gnus-virtual-group-p (group)
2160 "Say whether GROUP is virtual or not."
2161 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2162 gnus-valid-select-methods)))
2164 (defun gnus-news-group-p (group &optional article)
2165 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2166 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2167 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2168 (eq (gnus-request-type group article) 'news))))
2170 ;; Returns a list of writable groups.
2171 (defun gnus-writable-groups ()
2172 (let ((alist gnus-newsrc-alist)
2174 (while (setq group (car (pop alist)))
2175 (unless (gnus-group-read-only-p group)
2176 (push group groups)))
2179 ;; Check whether to use long file names.
2180 (defun gnus-use-long-file-name (symbol)
2181 ;; The variable has to be set...
2182 (and gnus-use-long-file-name
2183 ;; If it isn't a list, then we return t.
2184 (or (not (listp gnus-use-long-file-name))
2185 ;; If it is a list, and the list contains `symbol', we
2187 (not (memq symbol gnus-use-long-file-name)))))
2189 ;; Generate a unique new group name.
2190 (defun gnus-generate-new-group-name (leaf)
2193 (while (gnus-gethash name gnus-newsrc-hashtb)
2194 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2197 (defun gnus-ephemeral-group-p (group)
2198 "Say whether GROUP is ephemeral or not."
2199 (gnus-group-get-parameter group 'quit-config))
2201 (defun gnus-group-quit-config (group)
2202 "Return the quit-config of GROUP."
2203 (gnus-group-get-parameter group 'quit-config))
2205 (defun gnus-kill-ephemeral-group (group)
2206 "Remove ephemeral GROUP from relevant structures."
2207 (gnus-sethash group nil gnus-newsrc-hashtb))
2209 (defun gnus-simplify-mode-line ()
2210 "Make mode lines a bit simpler."
2211 (setq mode-line-modified (cdr gnus-mode-line-modified))
2212 (when (listp mode-line-format)
2213 (make-local-variable 'mode-line-format)
2214 (setq mode-line-format (copy-sequence mode-line-format))
2215 (when (equal (nth 3 mode-line-format) " ")
2216 (setcar (nthcdr 3 mode-line-format) " "))))
2218 ;;; Servers and groups.
2220 (defsubst gnus-server-add-address (method)
2221 (let ((method-name (symbol-name (car method))))
2222 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2223 (not (assq (intern (concat method-name "-address")) method))
2224 (memq 'physical-address (assq (car method)
2225 gnus-valid-select-methods)))
2226 (append method (list (list (intern (concat method-name "-address"))
2230 (defsubst gnus-server-get-method (group method)
2231 ;; Input either a server name, and extended server name, or a
2232 ;; select method, and return a select method.
2233 (cond ((stringp method)
2234 (gnus-server-to-method method))
2235 ((equal method gnus-select-method)
2237 ((and (stringp (car method)) group)
2238 (gnus-server-extend-method group method))
2239 ((and method (not group)
2240 (equal (cadr method) ""))
2243 (gnus-server-add-address method))))
2245 (defun gnus-server-to-method (server)
2246 "Map virtual server names to select methods."
2248 ;; Is this a method, perhaps?
2249 (and server (listp server) server)
2250 ;; Perhaps this is the native server?
2251 (and (equal server "native") gnus-select-method)
2252 ;; It should be in the server alist.
2253 (cdr (assoc server gnus-server-alist))
2254 ;; It could be in the predefined server alist.
2255 (cdr (assoc server gnus-predefined-server-alist))
2256 ;; If not, we look through all the opened server
2257 ;; to see whether we can find it there.
2258 (let ((opened gnus-opened-servers))
2260 (not (equal server (format "%s:%s" (caaar opened)
2265 (defmacro gnus-method-equal (ss1 ss2)
2266 "Say whether two servers are equal."
2270 (and (= (length s1) (length s2))
2272 (while (and s1 (member (car s1) s2))
2276 (defun gnus-server-equal (m1 m2)
2277 "Say whether two methods are equal."
2278 (let ((m1 (cond ((null m1) gnus-select-method)
2279 ((stringp m1) (gnus-server-to-method m1))
2281 (m2 (cond ((null m2) gnus-select-method)
2282 ((stringp m2) (gnus-server-to-method m2))
2284 (gnus-method-equal m1 m2)))
2286 (defun gnus-servers-using-backend (backend)
2287 "Return a list of known servers using BACKEND."
2288 (let ((opened gnus-opened-servers)
2291 (when (eq backend (caaar opened))
2292 (push (caar opened) out))
2296 (defun gnus-archive-server-wanted-p ()
2297 "Say whether the user wants to use the archive server."
2299 ((or (not gnus-message-archive-method)
2300 (not gnus-message-archive-group))
2302 ((and gnus-message-archive-method gnus-message-archive-group)
2305 (let ((active (cadr (assq 'nnfolder-active-file
2306 gnus-message-archive-method))))
2308 (file-exists-p active))))))
2310 (defun gnus-group-prefixed-name (group method)
2311 "Return the whole name from GROUP and METHOD."
2312 (and (stringp method) (setq method (gnus-server-to-method method)))
2313 (if (or (not method)
2314 (gnus-server-equal method "native"))
2316 (concat (format "%s" (car method))
2318 (or (assoc (format "%s" (car method))
2319 (gnus-methods-using 'address))
2320 (gnus-server-equal method gnus-message-archive-method))
2322 (not (string= (nth 1 method) "")))
2323 (concat "+" (nth 1 method)))
2326 (defun gnus-group-real-prefix (group)
2327 "Return the prefix of the current group name."
2328 (if (string-match "^[^:]+:" group)
2329 (substring group 0 (match-end 0))
2332 (defun gnus-group-method (group)
2333 "Return the server or method used for selecting GROUP.
2334 You should probably use `gnus-find-method-for-group' instead."
2335 (let ((prefix (gnus-group-real-prefix group)))
2336 (if (equal prefix "")
2338 (let ((servers gnus-opened-servers)
2340 backend possible found)
2341 (if (string-match "^[^\\+]+\\+" prefix)
2342 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2343 server (substring prefix (match-end 0) (1- (length prefix))))
2344 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2346 (when (eq (caaar servers) backend)
2347 (setq possible (caar servers))
2348 (when (equal (cadaar servers) server)
2349 (setq found (caar servers))))
2351 (or (car (rassoc found gnus-server-alist))
2353 (car (rassoc possible gnus-server-alist))
2355 (list backend server))))))
2357 (defsubst gnus-secondary-method-p (method)
2358 "Return whether METHOD is a secondary select method."
2359 (let ((methods gnus-secondary-select-methods)
2360 (gmethod (gnus-server-get-method nil method)))
2362 (not (equal (gnus-server-get-method nil (car methods))
2364 (setq methods (cdr methods)))
2367 (defun gnus-groups-from-server (server)
2368 "Return a list of all groups that are fetched from SERVER."
2369 (let ((alist (cdr gnus-newsrc-alist))
2371 (while (setq info (pop alist))
2372 (when (gnus-server-equal (gnus-info-method info) server)
2373 (push (gnus-info-group info) groups)))
2374 (sort groups 'string<)))
2376 (defun gnus-group-foreign-p (group)
2377 "Say whether a group is foreign or not."
2378 (and (not (gnus-group-native-p group))
2379 (not (gnus-group-secondary-p group))))
2381 (defun gnus-group-native-p (group)
2382 "Say whether the group is native or not."
2383 (not (string-match ":" group)))
2385 (defun gnus-group-secondary-p (group)
2386 "Say whether the group is secondary or not."
2387 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2389 (defun gnus-group-find-parameter (group &optional symbol)
2390 "Return the group parameters for GROUP.
2391 If SYMBOL, return the value of that symbol in the group parameters."
2393 (set-buffer gnus-group-buffer)
2394 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2396 (gnus-group-parameter-value parameters symbol)
2399 (defun gnus-group-get-parameter (group &optional symbol)
2400 "Return the group parameters for GROUP.
2401 If SYMBOL, return the value of that symbol in the group parameters.
2402 Most functions should use `gnus-group-find-parameter', which
2403 also examines the topic parameters."
2404 (let ((params (gnus-info-params (gnus-get-info group))))
2406 (gnus-group-parameter-value params symbol)
2409 (defun gnus-group-parameter-value (params symbol)
2410 "Return the value of SYMBOL in group PARAMS."
2411 (or (car (memq symbol params)) ; It's either a simple symbol
2412 (cdr (assq symbol params)))) ; or a cons.
2414 (defun gnus-group-add-parameter (group param)
2415 "Add parameter PARAM to GROUP."
2416 (let ((info (gnus-get-info group)))
2418 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2419 ;; Cons the new param to the old one and update.
2420 (gnus-group-set-info (cons param (gnus-info-params info))
2423 (defun gnus-group-set-parameter (group name value)
2424 "Set parameter NAME to VALUE in GROUP."
2425 (let ((info (gnus-get-info group)))
2427 (gnus-group-remove-parameter group name)
2428 (let ((old-params (gnus-info-params info))
2429 (new-params (list (cons name value))))
2431 (when (or (not (listp (car old-params)))
2432 (not (eq (caar old-params) name)))
2433 (setq new-params (append new-params (list (car old-params)))))
2434 (setq old-params (cdr old-params)))
2435 (gnus-group-set-info new-params group 'params)))))
2437 (defun gnus-group-remove-parameter (group name)
2438 "Remove parameter NAME from GROUP."
2439 (let ((info (gnus-get-info group)))
2441 (let ((params (gnus-info-params info)))
2443 (setq params (delq name params))
2444 (while (assq name params)
2445 (setq params (delq (assq name params) params)))
2446 (gnus-info-set-params info params))))))
2448 (defun gnus-group-add-score (group &optional score)
2449 "Add SCORE to the GROUP score.
2450 If SCORE is nil, add 1 to the score of GROUP."
2451 (let ((info (gnus-get-info group)))
2453 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2455 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2456 (defun gnus-short-group-name (group &optional levels)
2457 "Collapse GROUP name LEVELS.
2458 Select methods are stripped and any remote host name is stripped down to
2459 just the host name."
2460 (let* ((name "") (foreign "") (depth -1) (skip 1)
2463 (while (string-match "\\." group skip)
2464 (setq skip (match-end 0)
2467 ;; separate foreign select method from group name and collapse.
2468 ;; if method contains a server, collapse to non-domain server name,
2469 ;; otherwise collapse to select method
2470 (when (string-match ":" group)
2471 (cond ((string-match "+" group)
2472 (let* ((plus (string-match "+" group))
2473 (colon (string-match ":" group (or plus 0)))
2474 (dot (string-match "\\." group)))
2475 (setq foreign (concat
2476 (substring group (+ 1 plus)
2477 (cond ((null dot) colon)
2478 ((< colon dot) colon)
2479 ((< dot colon) dot)))
2481 group (substring group (+ 1 colon)))))
2483 (let* ((colon (string-match ":" group)))
2484 (setq foreign (concat (substring group 0 (+ 1 colon)))
2485 group (substring group (+ 1 colon)))))))
2486 ;; collapse group name leaving LEVELS uncollapsed elements
2488 (if (and (string-match "\\." group) (> levels 0))
2489 (setq name (concat name (substring group 0 1))
2490 group (substring group (match-end 0))
2492 name (concat name "."))
2493 (setq name (concat foreign name group)
2497 (defun gnus-narrow-to-body ()
2498 "Narrow to the body of an article."
2501 (goto-char (point-min))
2502 (or (search-forward "\n\n" nil t)
2508 ;;; Kill file handling.
2511 (defun gnus-apply-kill-file ()
2512 "Apply a kill file to the current newsgroup.
2513 Returns the number of articles marked as read."
2514 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2515 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2516 (gnus-apply-kill-file-internal)
2519 (defun gnus-kill-save-kill-buffer ()
2520 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2521 (when (get-file-buffer file)
2523 (set-buffer (get-file-buffer file))
2524 (when (buffer-modified-p)
2526 (kill-buffer (current-buffer))))))
2528 (defcustom gnus-kill-file-name "KILL"
2529 "Suffix of the kill files."
2530 :group 'gnus-score-kill
2531 :group 'gnus-score-files
2534 (defun gnus-newsgroup-kill-file (newsgroup)
2535 "Return the name of a kill file name for NEWSGROUP.
2536 If NEWSGROUP is nil, return the global kill file name instead."
2538 ;; The global KILL file is placed at top of the directory.
2539 ((or (null newsgroup)
2540 (string-equal newsgroup ""))
2541 (expand-file-name gnus-kill-file-name
2542 gnus-kill-files-directory))
2543 ;; Append ".KILL" to newsgroup name.
2544 ((gnus-use-long-file-name 'not-kill)
2545 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2546 "." gnus-kill-file-name)
2547 gnus-kill-files-directory))
2548 ;; Place "KILL" under the hierarchical directory.
2550 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2551 "/" gnus-kill-file-name)
2552 gnus-kill-files-directory))))
2556 (defun gnus-member-of-valid (symbol group)
2557 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2559 (symbol-name (car (gnus-find-method-for-group group)))
2560 gnus-valid-select-methods)))
2562 (defun gnus-method-option-p (method option)
2563 "Return non-nil if select METHOD has OPTION as a parameter."
2564 (when (stringp method)
2565 (setq method (gnus-server-to-method method)))
2566 (memq option (assoc (format "%s" (car method))
2567 gnus-valid-select-methods)))
2569 (defun gnus-similar-server-opened (method)
2570 (let ((opened gnus-opened-servers))
2571 (while (and method opened)
2572 (when (and (equal (cadr method) (cadaar opened))
2573 (not (equal method (caar opened))))
2578 (defun gnus-server-extend-method (group method)
2579 ;; This function "extends" a virtual server. If the server is
2580 ;; "hello", and the select method is ("hello" (my-var "something"))
2581 ;; in the group "alt.alt", this will result in a new virtual server
2582 ;; called "hello+alt.alt".
2583 (if (or (not (inline (gnus-similar-server-opened method)))
2584 (not (cddr method)))
2586 `(,(car method) ,(concat (cadr method) "+" group)
2587 (,(intern (format "%s-address" (car method))) ,(cadr method))
2590 (defun gnus-server-status (method)
2591 "Return the status of METHOD."
2592 (nth 1 (assoc method gnus-opened-servers)))
2594 (defun gnus-group-name-to-method (group)
2595 "Guess a select method based on GROUP."
2596 (if (string-match ":" group)
2597 (let ((server (substring group 0 (match-beginning 0))))
2598 (if (string-match "\\+" server)
2599 (list (intern (substring server 0 (match-beginning 0)))
2600 (substring server (match-end 0)))
2601 (list (intern server) "")))
2602 gnus-select-method))
2604 (defun gnus-find-method-for-group (group &optional info)
2605 "Find the select method that GROUP uses."
2606 (or gnus-override-method
2609 (let ((info (or info (gnus-get-info group)))
2612 (not (setq method (gnus-info-method info)))
2613 (equal method "native"))
2616 (cond ((stringp method)
2617 (inline (gnus-server-to-method method)))
2618 ((stringp (cadr method))
2619 (inline (gnus-server-extend-method group method)))
2622 (cond ((equal (cadr method) "")
2624 ((null (cadr method))
2625 (list (car method) ""))
2627 (gnus-server-add-address method)))))))
2629 (defun gnus-methods-using (feature)
2630 "Find all methods that have FEATURE."
2631 (let ((valids gnus-valid-select-methods)
2634 (when (memq feature (car valids))
2635 (push (car valids) outs))
2636 (setq valids (cdr valids)))
2639 (defun gnus-read-group (prompt &optional default)
2640 "Prompt the user for a group name.
2641 Disallow illegal group names."
2647 (setq group (read-string (concat prefix prompt)
2648 (cons (or default "") 0)
2649 'gnus-group-history)))
2650 (setq prefix (format "Illegal group name: \"%s\". " group)
2654 (defun gnus-read-method (prompt)
2655 "Prompt the user for a method.
2656 Allow completion over sensible values."
2659 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2661 nil t nil 'gnus-method-history)))
2664 (setq method gnus-select-method))
2665 ((assoc method gnus-valid-select-methods)
2666 (list (intern method)
2667 (if (memq 'prompt-address
2668 (assoc method gnus-valid-select-methods))
2669 (read-string "Address: ")
2671 ((assoc method gnus-server-alist)
2674 (list (intern method) "")))))
2676 ;;; User-level commands.
2679 (defun gnus-slave-no-server (&optional arg)
2680 "Read network news as a slave, without connecting to local server"
2682 (gnus-no-server arg t))
2685 (defun gnus-no-server (&optional arg slave)
2687 If ARG is a positive number, Gnus will use that as the
2688 startup level. If ARG is nil, Gnus will be started at level 2.
2689 If ARG is non-nil and not a positive number, Gnus will
2690 prompt the user for the name of an NNTP server to use.
2691 As opposed to `gnus', this command will not connect to the local server."
2693 (gnus-no-server-1 arg slave))
2696 (defun gnus-slave (&optional arg)
2697 "Read news as a slave."
2699 (gnus arg nil 'slave))
2702 (defun gnus-other-frame (&optional arg)
2703 "Pop up a frame to read news."
2705 (let ((window (get-buffer-window gnus-group-buffer)))
2707 (select-frame (window-frame window)))
2708 ((= (length (frame-list)) 1)
2709 (select-frame (make-frame)))
2715 (defun gnus (&optional arg dont-connect slave)
2717 If ARG is non-nil and a positive number, Gnus will use that as the
2718 startup level. If ARG is non-nil and not a positive number, Gnus will
2719 prompt the user for the name of an NNTP server to use."
2721 (gnus-1 arg dont-connect slave))
2723 ;; Allow redefinition of Gnus functions.
2729 ;;; gnus.el ends here