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-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 "5.6.6"
254 "Version number for this version of Gnus.")
256 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
257 "Version string for this version of Gnus.")
259 (defcustom gnus-inhibit-startup-message nil
260 "If non-nil, the startup message will not be displayed.
261 This variable is used before `.gnus.el' is loaded, so it should
262 be set in `.emacs' instead."
266 (defcustom gnus-play-startup-jingle nil
267 "If non-nil, play the Gnus jingle at startup."
271 ;;; Kludges to help the transition from the old `custom.el'.
273 (unless (featurep 'gnus-xmas)
274 (defalias 'gnus-make-overlay 'make-overlay)
275 (defalias 'gnus-delete-overlay 'delete-overlay)
276 (defalias 'gnus-overlay-put 'overlay-put)
277 (defalias 'gnus-move-overlay 'move-overlay)
278 (defalias 'gnus-overlay-end 'overlay-end)
279 (defalias 'gnus-extent-detached-p 'ignore)
280 (defalias 'gnus-extent-start-open 'ignore)
281 (defalias 'gnus-set-text-properties 'set-text-properties)
282 (defalias 'gnus-group-remove-excess-properties 'ignore)
283 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
284 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
285 (defalias 'gnus-character-to-event 'identity)
286 (defalias 'gnus-add-text-properties 'add-text-properties)
287 (defalias 'gnus-put-text-property 'put-text-property)
288 (defalias 'gnus-mode-line-buffer-identification 'identity)
289 (defalias 'gnus-characterp 'numberp)
290 (defalias 'gnus-deactivate-mark 'deactivate-mark)
291 (defalias 'gnus-window-edges 'window-edges)
292 (defalias 'gnus-key-press-event-p 'numberp))
294 ;; We define these group faces here to avoid the display
295 ;; update forced when creating new faces.
297 (defface gnus-group-news-1-face
300 (:foreground "PaleTurquoise" :bold t))
303 (:foreground "ForestGreen" :bold t))
306 "Level 1 newsgroup face.")
308 (defface gnus-group-news-1-empty-face
311 (:foreground "PaleTurquoise"))
314 (:foreground "ForestGreen"))
317 "Level 1 empty newsgroup face.")
319 (defface gnus-group-news-2-face
322 (:foreground "turquoise" :bold t))
325 (:foreground "CadetBlue4" :bold t))
328 "Level 2 newsgroup face.")
330 (defface gnus-group-news-2-empty-face
333 (:foreground "turquoise"))
336 (:foreground "CadetBlue4"))
339 "Level 2 empty newsgroup face.")
341 (defface gnus-group-news-3-face
350 "Level 3 newsgroup face.")
352 (defface gnus-group-news-3-empty-face
361 "Level 3 empty newsgroup face.")
363 (defface gnus-group-news-low-face
366 (:foreground "DarkTurquoise" :bold t))
369 (:foreground "DarkGreen" :bold t))
372 "Low level newsgroup face.")
374 (defface gnus-group-news-low-empty-face
377 (:foreground "DarkTurquoise"))
380 (:foreground "DarkGreen"))
383 "Low level empty newsgroup face.")
385 (defface gnus-group-mail-1-face
388 (:foreground "aquamarine1" :bold t))
391 (:foreground "DeepPink3" :bold t))
394 "Level 1 mailgroup face.")
396 (defface gnus-group-mail-1-empty-face
399 (:foreground "aquamarine1"))
402 (:foreground "DeepPink3"))
404 (:italic t :bold t)))
405 "Level 1 empty mailgroup face.")
407 (defface gnus-group-mail-2-face
410 (:foreground "aquamarine2" :bold t))
413 (:foreground "HotPink3" :bold t))
416 "Level 2 mailgroup face.")
418 (defface gnus-group-mail-2-empty-face
421 (:foreground "aquamarine2"))
424 (:foreground "HotPink3"))
427 "Level 2 empty mailgroup face.")
429 (defface gnus-group-mail-3-face
432 (:foreground "aquamarine3" :bold t))
435 (:foreground "magenta4" :bold t))
438 "Level 3 mailgroup face.")
440 (defface gnus-group-mail-3-empty-face
443 (:foreground "aquamarine3"))
446 (:foreground "magenta4"))
449 "Level 3 empty mailgroup face.")
451 (defface gnus-group-mail-low-face
454 (:foreground "aquamarine4" :bold t))
457 (:foreground "DeepPink4" :bold t))
460 "Low level mailgroup face.")
462 (defface gnus-group-mail-low-empty-face
465 (:foreground "aquamarine4"))
468 (:foreground "DeepPink4"))
471 "Low level empty mailgroup face.")
473 ;; Summary mode faces.
475 (defface gnus-summary-selected-face '((t
477 "Face used for selected articles.")
479 (defface gnus-summary-cancelled-face
481 (:foreground "yellow" :background "black")))
482 "Face used for cancelled articles.")
484 (defface gnus-summary-high-ticked-face
487 (:foreground "pink" :bold t))
490 (:foreground "firebrick" :bold t))
493 "Face used for high interest ticked articles.")
495 (defface gnus-summary-low-ticked-face
498 (:foreground "pink" :italic t))
501 (:foreground "firebrick" :italic t))
504 "Face used for low interest ticked articles.")
506 (defface gnus-summary-normal-ticked-face
509 (:foreground "pink"))
512 (:foreground "firebrick"))
515 "Face used for normal interest ticked articles.")
517 (defface gnus-summary-high-ancient-face
520 (:foreground "SkyBlue" :bold t))
523 (:foreground "RoyalBlue" :bold t))
526 "Face used for high interest ancient articles.")
528 (defface gnus-summary-low-ancient-face
531 (:foreground "SkyBlue" :italic t))
534 (:foreground "RoyalBlue" :italic t))
537 "Face used for low interest ancient articles.")
539 (defface gnus-summary-normal-ancient-face
542 (:foreground "SkyBlue"))
545 (:foreground "RoyalBlue"))
548 "Face used for normal interest ancient articles.")
550 (defface gnus-summary-high-unread-face
553 "Face used for high interest unread articles.")
555 (defface gnus-summary-low-unread-face
558 "Face used for low interest unread articles.")
560 (defface gnus-summary-normal-unread-face
563 "Face used for normal interest unread articles.")
565 (defface gnus-summary-high-read-face
568 (:foreground "PaleGreen"
572 (:foreground "DarkGreen"
576 "Face used for high interest read articles.")
578 (defface gnus-summary-low-read-face
581 (:foreground "PaleGreen"
585 (:foreground "DarkGreen"
589 "Face used for low interest read articles.")
591 (defface gnus-summary-normal-read-face
594 (:foreground "PaleGreen"))
597 (:foreground "DarkGreen"))
600 "Face used for normal interest read articles.")
605 (defvar gnus-group-buffer "*Group*")
608 (autoload 'gnus-play-jingle "gnus-audio"))
610 (defface gnus-splash-face
613 (:foreground "ForestGreen"))
616 (:foreground "ForestGreen"))
619 "Level 1 newsgroup face.")
621 (defun gnus-splash ()
623 (switch-to-buffer (get-buffer-create gnus-group-buffer))
624 (let ((buffer-read-only nil))
626 (unless gnus-inhibit-startup-message
627 (gnus-group-startup-message)
629 (when gnus-play-startup-jingle
630 (gnus-play-jingle))))))
632 (defun gnus-indent-rigidly (start end arg)
633 "Indent rigidly using only spaces and no tabs."
636 (narrow-to-region start end)
638 (indent-rigidly start end arg)
639 ;; We translate tabs into spaces -- not everybody uses
640 ;; an 8-character tab.
641 (goto-char (point-min))
642 (while (search-forward "\t" nil t)
643 (replace-match " " t t))))))
645 (defvar gnus-simple-splash nil)
647 (defun gnus-group-startup-message (&optional x y)
648 "Insert startup message in current buffer."
649 ;; Insert the message.
654 _ ___ __ ___ __ _ ___
674 (gnus-indent-rigidly (point-min) (point-max)
675 (/ (max (- (window-width) (or x 46)) 0) 2))
676 (goto-char (point-min))
678 (let* ((pheight (count-lines (point-min) (point-max)))
679 (wheight (window-height))
680 (rest (- wheight pheight)))
681 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
683 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
684 (goto-char (point-min))
685 (setq mode-line-buffer-identification (concat " " gnus-version))
686 (setq gnus-simple-splash t)
687 (set-buffer-modified-p t))
690 (let ((command (format "%s" this-command)))
691 (when (and (string-match "gnus" command)
692 (not (string-match "gnus-other-frame" command)))
701 (defcustom gnus-home-directory "~/"
702 "Directory variable that specifies the \"home\" directory.
703 All other Gnus path variables are initialized from this variable."
707 (defcustom gnus-directory (or (getenv "SAVEDIR")
708 (nnheader-concat gnus-home-directory "News/"))
709 "*Directory variable from which all other Gnus file variables are derived."
713 (defcustom gnus-default-directory nil
714 "*Default directory for all Gnus buffers."
716 :type '(choice (const :tag "current" nil)
719 ;; Site dependent variables. These variables should be defined in
722 (defvar gnus-default-nntp-server nil
723 "Specify a default NNTP server.
724 This variable should be defined in paths.el, and should never be set
726 If you want to change servers, you should use `gnus-select-method'.
727 See the documentation to that variable.")
729 ;; Don't touch this variable.
730 (defvar gnus-nntp-service "nntp"
731 "NNTP service name (\"nntp\" or 119).
732 This is an obsolete variable, which is scarcely used. If you use an
733 nntp server for your newsgroup and want to change the port number
734 used to 899, you would say something along these lines:
736 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
738 (defcustom gnus-nntpserver-file "/etc/nntpserver"
739 "A file with only the name of the nntp server in it."
744 ;; This function is used to check both the environment variable
745 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
746 ;; an nntp server name default.
747 (defun gnus-getenv-nntpserver ()
748 (or (getenv "NNTPSERVER")
749 (and (file-readable-p gnus-nntpserver-file)
751 (set-buffer (get-buffer-create " *gnus nntp*"))
752 (buffer-disable-undo (current-buffer))
753 (insert-file-contents gnus-nntpserver-file)
754 (let ((name (buffer-string)))
756 (if (string-match "^[ \t\n]*$" name)
759 (kill-buffer (current-buffer))))))))
761 (defcustom gnus-select-method
764 (list 'nntp (or (condition-case nil
765 (gnus-getenv-nntpserver)
767 (when (and gnus-default-nntp-server
768 (not (string= gnus-default-nntp-server "")))
769 gnus-default-nntp-server)
771 (if (or (null gnus-nntp-service)
772 (equal gnus-nntp-service "nntp"))
774 (list gnus-nntp-service)))
776 "*Default method for selecting a newsgroup.
777 This variable should be a list, where the first element is how the
778 news is to be fetched, the second is the address.
780 For instance, if you want to get your news via NNTP from
781 \"flab.flab.edu\", you could say:
783 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
785 If you want to use your local spool, say:
787 \(setq gnus-select-method (list 'nnspool (system-name)))
789 If you use this variable, you must set `gnus-nntp-server' to nil.
791 There is a lot more to know about select methods and virtual servers -
792 see the manual for details."
794 :type 'gnus-select-method)
796 (defcustom gnus-message-archive-method
799 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
800 (nnfolder-active-file
801 ,(nnheader-concat message-directory "archive/active"))
802 (nnfolder-get-new-mail nil)
803 (nnfolder-inhibit-expiry t))
804 "*Method used for archiving messages you've sent.
805 This should be a mail method.
807 It's probably not a very effective to change this variable once you've
808 run Gnus once. After doing that, you must edit this server from the
812 :type 'gnus-select-method)
814 (defcustom gnus-message-archive-group nil
815 "*Name of the group in which to save the messages you've written.
816 This can either be a string; a list of strings; or an alist
817 of regexps/functions/forms to be evaluated to return a string (or a list
818 of strings). The functions are called with the name of the current
819 group (or nil) as a parameter.
821 If you want to save your mail in one group and the news articles you
822 write in another group, you could say something like:
824 \(setq gnus-message-archive-group
825 '((if (message-news-p)
829 Normally the group names returned by this variable should be
830 unprefixed -- which implicitly means \"store on the archive server\".
831 However, you may wish to store the message on some other server. In
832 that case, just return a fully prefixed name of the group --
833 \"nnml+private:mail.misc\", for instance."
835 :type '(choice (const :tag "none" nil)
838 (defcustom gnus-secondary-servers nil
839 "List of NNTP servers that the user can choose between interactively.
840 To make Gnus query you for a server, you have to give `gnus' a
841 non-numeric prefix - `C-u M-x gnus', in short."
843 :type '(repeat string))
845 (defcustom gnus-nntp-server nil
846 "*The name of the host running the NNTP server.
847 This variable is semi-obsolete. Use the `gnus-select-method'
850 :type '(choice (const :tag "disable" nil)
853 (defcustom gnus-secondary-select-methods nil
854 "A list of secondary methods that will be used for reading news.
855 This is a list where each element is a complete select method (see
856 `gnus-select-method').
858 If, for instance, you want to read your mail with the nnml backend,
859 you could set this variable:
861 \(setq gnus-secondary-select-methods '((nnml \"\")))"
863 :type '(repeat gnus-select-method))
865 (defvar gnus-backup-default-subscribed-newsgroups
866 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
867 "Default default new newsgroups the first time Gnus is run.
868 Should be set in paths.el, and shouldn't be touched by the user.")
870 (defcustom gnus-local-domain nil
871 "Local domain name without a host name.
872 The DOMAINNAME environment variable is used instead if it is defined.
873 If the `system-name' function returns the full Internet name, there is
874 no need to set this variable."
876 :type '(choice (const :tag "default" nil)
879 (defvar gnus-local-organization nil
880 "String with a description of what organization (if any) the user belongs to.
881 Obsolete variable; use `message-user-organization' instead.")
883 ;; Customization variables
885 (defcustom gnus-refer-article-method nil
886 "Preferred method for fetching an article by Message-ID.
887 If you are reading news from the local spool (with nnspool), fetching
888 articles by Message-ID is painfully slow. By setting this method to an
889 nntp method, you might get acceptable results.
891 The value of this variable must be a valid select method as discussed
892 in the documentation of `gnus-select-method'."
894 :type '(choice (const :tag "default" nil)
897 (defcustom gnus-group-faq-directory
898 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
899 "/ftp@sunsite.auc.dk:/pub/usenet/"
900 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
901 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
902 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
903 "/ftp@rtfm.mit.edu:/pub/usenet/"
904 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
905 "/ftp@ftp.sunet.se:/pub/usenet/"
906 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
907 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
908 "/ftp@ftp.hk.super.net:/mirror/faqs/")
909 "*Directory where the group FAQs are stored.
910 This will most commonly be on a remote machine, and the file will be
913 This variable can also be a list of directories. In that case, the
914 first element in the list will be used by default. The others can
915 be used when being prompted for a site.
917 Note that Gnus uses an aol machine as the default directory. If this
918 feels fundamentally unclean, just think of it as a way to finally get
919 something of value back from them.
921 If the default site is too slow, try one of these:
923 North America: mirrors.aol.com /pub/rtfm/usenet
924 ftp.seas.gwu.edu /pub/rtfm
925 rtfm.mit.edu /pub/usenet
926 Europe: ftp.uni-paderborn.de /pub/FAQ
927 src.doc.ic.ac.uk /usenet/news-FAQS
928 ftp.sunet.se /pub/usenet
929 sunsite.auc.dk /pub/usenet
930 Asia: nctuccca.edu.tw /USENET/FAQ
931 hwarang.postech.ac.kr /pub/usenet
932 ftp.hk.super.net /mirror/faqs"
933 :group 'gnus-group-various
934 :type '(choice directory
937 (defcustom gnus-use-cross-reference t
938 "*Non-nil means that cross referenced articles will be marked as read.
939 If nil, ignore cross references. If t, mark articles as read in
940 subscribed newsgroups. If neither t nor nil, mark as read in all
943 :type '(choice (const :tag "off" nil)
944 (const :tag "subscribed" t)
948 (defcustom gnus-process-mark ?#
950 :group 'gnus-group-visual
951 :group 'gnus-summary-marks
954 (defcustom gnus-asynchronous nil
955 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
956 :group 'gnus-asynchronous
959 (defcustom gnus-large-newsgroup 200
960 "*The number of articles which indicates a large newsgroup.
961 If the number of articles in a newsgroup is greater than this value,
962 confirmation is required for selecting the newsgroup."
963 :group 'gnus-group-select
966 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
967 "*Non-nil means that the default name of a file to save articles in is the group name.
968 If it's nil, the directory form of the group name is used instead.
970 If this variable is a list, and the list contains the element
971 `not-score', long file names will not be used for score files; if it
972 contains the element `not-save', long file names will not be used for
973 saving; and if it contains the element `not-kill', long file names
974 will not be used for kill files.
976 Note that the default for this variable varies according to what system
977 type you're using. On `usg-unix-v' and `xenix' this variable defaults
978 to nil while on all other systems it defaults to t."
982 (defcustom gnus-kill-files-directory gnus-directory
983 "*Name of the directory where kill files will be stored (default \"~/News\")."
984 :group 'gnus-score-files
985 :group 'gnus-score-kill
988 (defcustom gnus-save-score nil
989 "*If non-nil, save group scoring info."
990 :group 'gnus-score-various
994 (defcustom gnus-use-undo t
995 "*If non-nil, allow undoing in Gnus group mode buffers."
999 (defcustom gnus-use-adaptive-scoring nil
1000 "*If non-nil, use some adaptive scoring scheme.
1001 If a list, then the values `word' and `line' are meaningful. The
1002 former will perform adaption on individual words in the subject
1003 header while `line' will perform adaption on several headers."
1005 :group 'gnus-score-adapt
1006 :type '(set (const word) (const line)))
1008 (defcustom gnus-use-cache 'passive
1009 "*If nil, Gnus will ignore the article cache.
1010 If `passive', it will allow entering (and reading) articles
1011 explicitly entered into the cache. If anything else, use the
1012 cache to the full extent of the law."
1015 :type '(choice (const :tag "off" nil)
1016 (const :tag "passive" passive)
1017 (const :tag "active" t)))
1019 (defcustom gnus-use-trees nil
1020 "*If non-nil, display a thread tree buffer."
1024 (defcustom gnus-use-grouplens nil
1025 "*If non-nil, use GroupLens ratings."
1029 (defcustom gnus-keep-backlog nil
1030 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1031 If it is a number N, then Gnus will only keep the last N articles
1032 read. If it is neither nil nor a number, Gnus will keep all read
1033 articles. This is not a good idea."
1035 :type '(choice (const :tag "off" nil)
1040 (defcustom gnus-use-nocem nil
1041 "*If non-nil, Gnus will read NoCeM cancel messages."
1045 (defcustom gnus-suppress-duplicates nil
1046 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1050 (defcustom gnus-use-demon nil
1051 "If non-nil, Gnus might use some demons."
1055 (defcustom gnus-use-scoring t
1056 "*If non-nil, enable scoring."
1060 (defcustom gnus-use-picons nil
1061 "*If non-nil, display picons."
1065 (defcustom gnus-summary-prepare-exit-hook
1066 '(gnus-summary-expire-articles)
1067 "*A hook called when preparing to exit from the summary buffer.
1068 It calls `gnus-summary-expire-articles' by default."
1069 :group 'gnus-summary-exit
1072 (defcustom gnus-novice-user t
1073 "*Non-nil means that you are a usenet novice.
1074 If non-nil, verbose messages may be displayed and confirmations may be
1079 (defcustom gnus-expert-user nil
1080 "*Non-nil means that you will never be asked for confirmation about anything.
1081 That doesn't mean *anything* anything; particularly destructive
1082 commands will still require prompting."
1086 (defcustom gnus-interactive-catchup t
1087 "*If non-nil, require your confirmation when catching up a group."
1088 :group 'gnus-group-select
1091 (defcustom gnus-interactive-exit t
1092 "*If non-nil, require your confirmation when exiting Gnus."
1096 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1097 "*Function for extracting address components from a From header.
1098 Two pre-defined function exist: `gnus-extract-address-components',
1099 which is the default, quite fast, and too simplistic solution, and
1100 `mail-extract-address-components', which works much better, but is
1102 :group 'gnus-summary-format
1103 :type '(radio (function-item gnus-extract-address-components)
1104 (function-item mail-extract-address-components)
1105 (function :tag "Other")))
1107 (defcustom gnus-carpal nil
1108 "*If non-nil, display clickable icons."
1112 (defcustom gnus-shell-command-separator ";"
1113 "String used to separate to shell commands."
1117 (defcustom gnus-valid-select-methods
1118 '(("nntp" post address prompt-address physical-address)
1119 ("nnspool" post address)
1120 ("nnvirtual" post-mail virtual prompt-address)
1121 ("nnmbox" mail respool address)
1122 ("nnml" mail respool address)
1123 ("nnmh" mail respool address)
1124 ("nndir" post-mail prompt-address physical-address)
1125 ("nneething" none address prompt-address physical-address)
1126 ("nndoc" none address prompt-address)
1127 ("nnbabyl" mail address respool)
1128 ("nnkiboze" post virtual)
1129 ("nnsoup" post-mail address)
1130 ("nndraft" post-mail)
1131 ("nnfolder" mail respool address)
1132 ("nngateway" post-mail address prompt-address physical-address)
1135 ("nnagent" post-mail))
1136 "*An alist of valid select methods.
1137 The first element of each list lists should be a string with the name
1138 of the select method. The other elements may be the category of
1139 this method (i. e., `post', `mail', `none' or whatever) or other
1140 properties that this method has (like being respoolable).
1141 If you implement a new select method, all you should have to change is
1142 this variable. I think."
1144 :type '(repeat (group (string :tag "Name")
1145 (radio-button-choice (const :format "%v " post)
1146 (const :format "%v " mail)
1147 (const :format "%v " none)
1149 (checklist :inline t
1150 (const :format "%v " address)
1151 (const :format "%v " prompt-address)
1152 (const :format "%v " physical-address)
1153 (const :format "%v " virtual)
1156 (define-widget 'gnus-select-method 'list
1157 "Widget for entering a select method."
1158 :args `((choice :tag "Method"
1159 ,@(mapcar (lambda (entry)
1160 (list 'const :format "%v\n"
1161 (intern (car entry))))
1162 gnus-valid-select-methods))
1163 (string :tag "Address")
1164 (editable-list :inline t
1167 (sexp :tag "Value")))))
1169 (defcustom gnus-updated-mode-lines '(group article summary tree)
1170 "List of buffers that should update their mode lines.
1171 The list may contain the symbols `group', `article', `tree' and
1172 `summary'. If the corresponding symbol is present, Gnus will keep
1173 that mode line updated with information that may be pertinent.
1174 If this variable is nil, screen refresh may be quicker."
1175 :group 'gnus-various
1176 :type '(set (const group)
1181 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1182 (defcustom gnus-mode-non-string-length nil
1183 "*Max length of mode-line non-string contents.
1184 If this is nil, Gnus will take space as is needed, leaving the rest
1185 of the modeline intact. Note that the default of nil is unlikely
1186 to be desirable; see the manual for further details."
1187 :group 'gnus-various
1188 :type '(choice (const nil)
1191 (defcustom gnus-auto-expirable-newsgroups nil
1192 "*Groups in which to automatically mark read articles as expirable.
1193 If non-nil, this should be a regexp that should match all groups in
1194 which to perform auto-expiry. This only makes sense for mail groups."
1195 :group 'nnmail-expire
1196 :type '(choice (const nil)
1199 (defcustom gnus-total-expirable-newsgroups nil
1200 "*Groups in which to perform expiry of all read articles.
1201 Use with extreme caution. All groups that match this regexp will be
1202 expiring - which means that all read articles will be deleted after
1203 \(say) one week. (This only goes for mail groups and the like, of
1205 :group 'nnmail-expire
1206 :type '(choice (const nil)
1209 (defcustom gnus-group-uncollapsed-levels 1
1210 "Number of group name elements to leave alone when making a short group name."
1211 :group 'gnus-group-visual
1214 (defcustom gnus-group-use-permanent-levels nil
1215 "*If non-nil, once you set a level, Gnus will use this level."
1216 :group 'gnus-group-levels
1221 (defcustom gnus-load-hook nil
1222 "A hook run while Gnus is loaded."
1226 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1227 "A hook called to apply kill files to a group.
1228 This hook is intended to apply a kill file to the selected newsgroup.
1229 The function `gnus-apply-kill-file' is called by default.
1231 Since a general kill file is too heavy to use only for a few
1232 newsgroups, I recommend you to use a lighter hook function. For
1233 example, if you'd like to apply a kill file to articles which contains
1234 a string `rmgroup' in subject in newsgroup `control', you can use the
1237 (setq gnus-apply-kill-hook
1240 (cond ((string-match \"control\" gnus-newsgroup-name)
1241 (gnus-kill \"Subject\" \"rmgroup\")
1242 (gnus-expunge \"X\"))))))"
1243 :group 'gnus-score-kill
1244 :options '(gnus-apply-kill-file)
1247 (defcustom gnus-group-change-level-function nil
1248 "Function run when a group level is changed.
1249 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1250 :group 'gnus-group-level
1255 (defcustom gnus-visual
1256 '(summary-highlight group-highlight article-highlight
1258 summary-menu group-menu article-menu
1259 tree-highlight menu highlight
1260 browse-menu server-menu
1261 page-marker tree-menu binary-menu pick-menu
1263 "*Enable visual features.
1264 If `visual' is disabled, there will be no menus and few faces. Most of
1265 the visual customization options below will be ignored. Gnus will use
1266 less space and be faster as a result.
1268 This variable can also be a list of visual elements to switch on. For
1269 instance, to switch off all visual things except menus, you can say:
1271 (setq gnus-visual '(menu))
1273 Valid elements include `summary-highlight', `group-highlight',
1274 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1275 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1276 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1277 and `grouplens-menu'."
1280 :type '(set (const summary-highlight)
1281 (const group-highlight)
1282 (const article-highlight)
1284 (const summary-menu)
1286 (const article-menu)
1287 (const tree-highlight)
1296 (const grouplens-menu)))
1298 (defcustom gnus-mouse-face
1300 (if (gnus-visual-p 'mouse-face 'highlight)
1301 (if (boundp 'gnus-mouse-face)
1302 (or gnus-mouse-face 'highlight)
1306 "*Face used for group or summary buffer mouse highlighting.
1307 The line beneath the mouse pointer will be highlighted with this
1312 (defcustom gnus-article-display-hook
1313 (if (and (string-match "XEmacs" emacs-version)
1315 '(gnus-article-hide-headers-if-wanted
1316 gnus-article-hide-boring-headers
1317 gnus-article-treat-overstrike
1318 gnus-article-maybe-highlight
1319 gnus-article-display-x-face)
1320 '(gnus-article-hide-headers-if-wanted
1321 gnus-article-hide-boring-headers
1322 gnus-article-treat-overstrike
1323 gnus-article-maybe-highlight))
1324 "*Controls how the article buffer will look.
1326 If you leave the list empty, the article will appear exactly as it is
1327 stored on the disk. The list entries will hide or highlight various
1328 parts of the article, making it easier to find the information you
1330 :group 'gnus-article-highlight
1333 :options '(gnus-article-add-buttons
1334 gnus-article-add-buttons-to-head
1335 gnus-article-emphasize
1336 gnus-article-fill-cited-article
1337 gnus-article-remove-cr
1338 gnus-article-de-quoted-unreadable
1339 gnus-summary-stop-page-breaking
1340 ;; gnus-summary-caesar-message
1341 ;; gnus-summary-verbose-headers
1342 gnus-summary-toggle-mime
1344 gnus-article-hide-headers
1345 gnus-article-hide-boring-headers
1346 gnus-article-hide-signature
1347 gnus-article-hide-citation
1348 gnus-article-hide-pgp
1349 gnus-article-hide-pem
1350 gnus-article-highlight
1351 gnus-article-highlight-headers
1352 gnus-article-highlight-citation
1353 gnus-article-highlight-signature
1354 gnus-article-date-ut
1355 gnus-article-date-local
1356 gnus-article-date-lapsed
1357 gnus-article-date-original
1358 gnus-article-remove-trailing-blank-lines
1359 gnus-article-strip-leading-blank-lines
1360 gnus-article-strip-multiple-blank-lines
1361 gnus-article-strip-blank-lines
1362 gnus-article-treat-overstrike
1363 gnus-article-display-x-face
1364 gnus-smiley-display))
1366 (defcustom gnus-article-save-directory gnus-directory
1367 "*Name of the directory articles will be saved in (default \"~/News\")."
1368 :group 'gnus-article-saving
1371 (defvar gnus-plugged t
1372 "Whether Gnus is plugged or not.")
1375 ;;; Internal variables
1377 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1378 (defvar gnus-original-article-buffer " *Original Article*")
1379 (defvar gnus-newsgroup-name nil)
1380 (defvar gnus-ephemeral-servers nil)
1382 (defvar gnus-agent nil
1383 "Whether we want to use the Gnus agent or not.")
1385 (defvar gnus-command-method nil
1386 "Dynamically bound variable that says what the current backend is.")
1388 (defvar gnus-current-select-method nil
1389 "The current method for selecting a newsgroup.")
1391 (defvar gnus-tree-buffer "*Tree*"
1392 "Buffer where Gnus thread trees are displayed.")
1395 (defvar gnus-use-generic-from nil)
1397 ;; Variable holding the user answers to all method prompts.
1398 (defvar gnus-method-history nil)
1400 ;; Variable holding the user answers to all mail method prompts.
1401 (defvar gnus-mail-method-history nil)
1403 ;; Variable holding the user answers to all group prompts.
1404 (defvar gnus-group-history nil)
1406 (defvar gnus-server-alist nil
1407 "List of available servers.")
1409 (defcustom gnus-cache-directory
1410 (nnheader-concat gnus-directory "cache/")
1411 "*The directory where cached articles will be stored."
1415 (defvar gnus-predefined-server-alist
1418 (nnspool-spool-directory gnus-cache-directory)
1419 (nnspool-nov-directory gnus-cache-directory)
1420 (nnspool-active-file
1421 (nnheader-concat gnus-cache-directory "active")))))
1422 "List of predefined (convenience) servers.")
1424 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1426 (defconst gnus-article-mark-lists
1427 '((marked . tick) (replied . reply)
1428 (expirable . expire) (killed . killed)
1429 (bookmarks . bookmark) (dormant . dormant)
1430 (scored . score) (saved . save)
1431 (cached . cache) (downloadable . download)
1432 (unsendable . unsend)))
1434 (defvar gnus-headers-retrieved-by nil)
1435 (defvar gnus-article-reply nil)
1436 (defvar gnus-override-method nil)
1437 (defvar gnus-article-check-size nil)
1438 (defvar gnus-opened-servers nil)
1440 (defvar gnus-current-kill-article nil)
1442 (defvar gnus-have-read-active-file nil)
1444 (defconst gnus-maintainer
1445 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1446 "The mail address of the Gnus maintainers.")
1448 (defvar gnus-info-nodes
1449 '((gnus-group-mode "(gnus)The Group Buffer")
1450 (gnus-summary-mode "(gnus)The Summary Buffer")
1451 (gnus-article-mode "(gnus)The Article Buffer")
1452 (mime/viewer-mode "(gnus)The Article Buffer")
1453 (gnus-server-mode "(gnus)The Server Buffer")
1454 (gnus-browse-mode "(gnus)Browse Foreign Server")
1455 (gnus-tree-mode "(gnus)Tree Display"))
1456 "Alist of major modes and related Info nodes.")
1458 (defvar gnus-group-buffer "*Group*")
1459 (defvar gnus-summary-buffer "*Summary*")
1460 (defvar gnus-article-buffer "*Article*")
1461 (defvar gnus-server-buffer "*Server*")
1463 (defvar gnus-buffer-list nil
1464 "Gnus buffers that should be killed on exit.")
1466 (defvar gnus-slave nil
1467 "Whether this Gnus is a slave or not.")
1469 (defvar gnus-batch-mode nil
1470 "Whether this Gnus is running in batch mode or not.")
1472 (defvar gnus-variable-list
1473 '(gnus-newsrc-options gnus-newsrc-options-n
1474 gnus-newsrc-last-checked-date
1475 gnus-newsrc-alist gnus-server-alist
1476 gnus-killed-list gnus-zombie-list
1477 gnus-topic-topology gnus-topic-alist
1479 "Gnus variables saved in the quick startup file.")
1481 (defvar gnus-newsrc-alist nil
1482 "Assoc list of read articles.
1483 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1485 (defvar gnus-newsrc-hashtb nil
1486 "Hashtable of gnus-newsrc-alist.")
1488 (defvar gnus-killed-list nil
1489 "List of killed newsgroups.")
1491 (defvar gnus-killed-hashtb nil
1492 "Hash table equivalent of gnus-killed-list.")
1494 (defvar gnus-zombie-list nil
1495 "List of almost dead newsgroups.")
1497 (defvar gnus-description-hashtb nil
1498 "Descriptions of newsgroups.")
1500 (defvar gnus-list-of-killed-groups nil
1501 "List of newsgroups that have recently been killed by the user.")
1503 (defvar gnus-active-hashtb nil
1504 "Hashtable of active articles.")
1506 (defvar gnus-moderated-hashtb nil
1507 "Hashtable of moderated newsgroups.")
1509 ;; Save window configuration.
1510 (defvar gnus-prev-winconf nil)
1512 (defvar gnus-reffed-article-number nil)
1514 ;;; Let the byte-compiler know that we know about this variable.
1515 (defvar rmail-default-rmail-file)
1517 (defvar gnus-dead-summary nil)
1519 ;;; End of variables.
1521 ;; Define some autoload functions Gnus might use.
1524 ;; This little mapcar goes through the list below and marks the
1525 ;; symbols in question as autoloaded functions.
1528 (let ((interactive (nth 1 (memq ':interactive package))))
1532 (when (consp function)
1533 (setq keymap (car (memq 'keymap function)))
1534 (setq function (car function)))
1535 (autoload function (car package) nil interactive keymap)))
1536 (if (eq (nth 1 package) ':interactive)
1539 '(("metamail" metamail-buffer)
1540 ("info" Info-goto-node)
1541 ("hexl" hexl-hex-string-to-integer)
1542 ("pp" pp pp-to-string pp-eval-expression)
1543 ("ps-print" ps-print-preprint)
1544 ("mail-extr" mail-extract-address-components)
1545 ("browse-url" browse-url)
1546 ("message" :interactive t
1547 message-send-and-exit message-yank-original)
1548 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1549 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1550 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1551 timezone-make-sortable-date timezone-make-time-string)
1552 ("rmailout" rmail-output)
1553 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1555 ("gnus-audio" :interactive t gnus-audio-play)
1556 ("gnus-xmas" gnus-xmas-splash)
1557 ("gnus-soup" :interactive t
1558 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1559 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1560 ("nnsoup" nnsoup-pack-replies)
1561 ("score-mode" :interactive t gnus-score-mode)
1562 ("gnus-mh" gnus-summary-save-article-folder
1563 gnus-Folder-save-name gnus-folder-save-name)
1564 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1565 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1566 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1567 gnus-demon-add-disconnection gnus-demon-add-handler
1568 gnus-demon-remove-handler)
1569 ("gnus-demon" :interactive t
1570 gnus-demon-init gnus-demon-cancel)
1571 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1572 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1573 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1574 gnus-nocem-unwanted-article-p)
1575 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1576 gnus-server-server-name)
1577 ("gnus-srvr" gnus-browse-foreign-server)
1578 ("gnus-cite" :interactive t
1579 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1580 gnus-article-hide-citation gnus-article-fill-cited-article
1581 gnus-article-hide-citation-in-followups)
1582 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1583 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1584 gnus-execute gnus-expunge)
1585 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1586 gnus-cache-possibly-remove-articles gnus-cache-request-article
1587 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1588 gnus-cache-enter-remove-article gnus-cached-article-p
1589 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1590 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1591 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1592 ("gnus-score" :interactive t
1593 gnus-summary-increase-score gnus-summary-set-score
1594 gnus-summary-raise-thread gnus-summary-raise-same-subject
1595 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1596 gnus-summary-lower-thread gnus-summary-lower-same-subject
1597 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1598 gnus-summary-current-score gnus-score-default
1599 gnus-score-flush-cache gnus-score-close
1600 gnus-possibly-score-headers gnus-score-followup-article
1601 gnus-score-followup-thread)
1603 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1604 gnus-current-score-file-nondirectory gnus-score-adaptive
1605 gnus-score-find-trace gnus-score-file-name)
1606 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1607 ("gnus-topic" :interactive t gnus-topic-mode)
1608 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1609 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1610 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1611 ("gnus-uu" :interactive t
1612 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1613 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1614 gnus-uu-mark-by-regexp gnus-uu-mark-all
1615 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1616 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1617 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1618 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1619 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1620 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1621 gnus-uu-decode-binhex-view)
1622 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1623 ("gnus-msg" (gnus-summary-send-map keymap)
1624 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1625 ("gnus-msg" :interactive t
1626 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1627 gnus-summary-followup gnus-summary-followup-with-original
1628 gnus-summary-cancel-article gnus-summary-supersede-article
1629 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1630 gnus-summary-mail-forward gnus-summary-mail-other-window
1631 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1633 ("gnus-picon" :interactive t gnus-article-display-picons
1634 gnus-group-display-picons gnus-picons-article-display-x-face
1635 gnus-picons-display-x-face)
1636 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1637 gnus-grouplens-mode)
1638 ("smiley" :interactive t gnus-smiley-display)
1639 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1640 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1641 gnus-list-of-unread-articles gnus-list-of-read-articles
1642 gnus-offer-save-summaries gnus-make-thread-indent-array
1643 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1644 gnus-summary-skip-intangible gnus-summary-article-number
1645 gnus-data-header gnus-data-find)
1646 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1647 gnus-group-list-groups gnus-group-first-unread-group
1648 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1649 gnus-group-setup-buffer gnus-group-get-new-news
1650 gnus-group-make-help-group gnus-group-update-group
1651 gnus-clear-inboxes-moved gnus-group-iterate
1652 gnus-group-group-name)
1653 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1654 gnus-backlog-remove-article)
1655 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1656 gnus-article-prepare gnus-article-set-window-start
1657 gnus-article-next-page gnus-article-prev-page
1658 gnus-request-article-this-buffer gnus-article-mode
1659 gnus-article-setup-buffer gnus-narrow-to-page
1660 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1661 ("gnus-art" :interactive t
1662 gnus-article-hide-headers gnus-article-hide-boring-headers
1663 gnus-article-treat-overstrike gnus-article-word-wrap
1664 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1665 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1666 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1667 gnus-article-hide-pem gnus-article-hide-signature
1668 gnus-article-strip-leading-blank-lines gnus-article-date-local
1669 gnus-article-date-original gnus-article-date-lapsed
1670 gnus-article-show-all-headers
1671 gnus-article-edit-mode gnus-article-edit-article
1672 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1673 gnus-start-date-timer gnus-stop-date-timer)
1674 ("gnus-int" gnus-request-type)
1675 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1676 gnus-dribble-enter gnus-read-init-file)
1677 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1678 gnus-dup-enter-articles)
1679 ("gnus-range" gnus-copy-sequence)
1680 ("gnus-eform" gnus-edit-form)
1681 ("gnus-move" :interactive t
1682 gnus-group-move-group-to-server gnus-change-server)
1683 ("gnus-logic" gnus-score-advanced)
1684 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1685 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1686 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1687 gnus-async-halt-prefetch)
1688 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1689 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1690 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1691 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1692 ("gnus-agent" :interactive t
1693 gnus-unplugged gnus-agentize gnus-agent-batch)
1694 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1695 gnus-summary-save-article-vm)
1696 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1698 ;;; gnus-sum.el thingies
1701 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1702 "*The format specification of the lines in the summary buffer.
1704 It works along the same lines as a normal formatting string,
1705 with some simple extensions.
1707 %N Article number, left padded with spaces (string)
1709 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1710 %n Name of the poster (string)
1711 %a Extracted name of the poster (string)
1712 %A Extracted address of the poster (string)
1713 %F Contents of the From: header (string)
1714 %x Contents of the Xref: header (string)
1715 %D Date of the article (string)
1716 %d Date of the article (string) in DD-MMM format
1717 %M Message-id of the article (string)
1718 %r References of the article (string)
1719 %c Number of characters in the article (integer)
1720 %L Number of lines in the article (integer)
1721 %I Indentation based on thread level (a string of spaces)
1722 %T A string with two possible values: 80 spaces if the article
1723 is on thread level two or larger and 0 spaces on level one
1724 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1725 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1726 %[ Opening bracket (character, \"[\" or \"<\")
1727 %] Closing bracket (character, \"]\" or \">\")
1728 %> Spaces of length thread-level (string)
1729 %< Spaces of length (- 20 thread-level) (string)
1730 %i Article score (number)
1731 %z Article zcore (character)
1732 %t Number of articles under the current thread (number).
1733 %e Whether the thread is empty or not (character).
1734 %l GroupLens score (string).
1735 %V Total thread score (number).
1736 %P The line number (number).
1737 %O Download mark (character).
1738 %u User defined specifier. The next character in the format string should
1739 be a letter. Gnus will call the function gnus-user-format-function-X,
1740 where X is the letter following %u. The function will be passed the
1741 current header as argument. The function should return a string, which
1742 will be inserted into the summary just like information from any other
1745 Text between %( and %) will be highlighted with `gnus-mouse-face'
1746 when the mouse point is placed inside the area. There can only be one
1749 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1750 with care. For reasons of efficiency, Gnus will compute what column
1751 these characters will end up in, and \"hard-code\" that. This means that
1752 it is illegal to have these specs after a variable-length spec. Well,
1753 you might not be arrested, but your summary buffer will look strange,
1754 which is bad enough.
1756 The smart choice is to have these specs as for to the left as
1759 This restriction may disappear in later versions of Gnus."
1761 :group 'gnus-summary-format)
1764 ;;; Skeleton keymaps
1767 (defun gnus-suppress-keymap (keymap)
1768 (suppress-keymap keymap)
1769 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1771 (define-key keymap (pop keys) 'undefined))))
1773 (defvar gnus-article-mode-map
1774 (let ((keymap (make-keymap)))
1775 (gnus-suppress-keymap keymap)
1777 (defvar gnus-summary-mode-map
1778 (let ((keymap (make-keymap)))
1779 (gnus-suppress-keymap keymap)
1781 (defvar gnus-group-mode-map
1782 (let ((keymap (make-keymap)))
1783 (gnus-suppress-keymap keymap)
1788 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1789 ;; If you want the cursor to go somewhere else, set these two
1790 ;; functions in some startup hook to whatever you want.
1791 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1792 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1794 ;;; Various macros and substs.
1796 (defun gnus-header-from (header)
1797 (mail-header-from header))
1799 (defmacro gnus-gethash (string hashtable)
1800 "Get hash value of STRING in HASHTABLE."
1801 `(symbol-value (intern-soft ,string ,hashtable)))
1803 (defmacro gnus-sethash (string value hashtable)
1804 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1805 `(set (intern ,string ,hashtable) ,value))
1806 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1808 (defmacro gnus-group-unread (group)
1809 "Get the currently computed number of unread articles in GROUP."
1810 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1812 (defmacro gnus-group-entry (group)
1813 "Get the newsrc entry for GROUP."
1814 `(gnus-gethash ,group gnus-newsrc-hashtb))
1816 (defmacro gnus-active (group)
1817 "Get active info on GROUP."
1818 `(gnus-gethash ,group gnus-active-hashtb))
1820 (defmacro gnus-set-active (group active)
1821 "Set GROUP's active info."
1822 `(gnus-sethash ,group ,active gnus-active-hashtb))
1824 ;; Info access macros.
1826 (defmacro gnus-info-group (info)
1828 (defmacro gnus-info-rank (info)
1830 (defmacro gnus-info-read (info)
1832 (defmacro gnus-info-marks (info)
1834 (defmacro gnus-info-method (info)
1836 (defmacro gnus-info-params (info)
1839 (defmacro gnus-info-level (info)
1840 `(let ((rank (gnus-info-rank ,info)))
1844 (defmacro gnus-info-score (info)
1845 `(let ((rank (gnus-info-rank ,info)))
1846 (or (and (consp rank) (cdr rank)) 0)))
1848 (defmacro gnus-info-set-group (info group)
1849 `(setcar ,info ,group))
1850 (defmacro gnus-info-set-rank (info rank)
1851 `(setcar (nthcdr 1 ,info) ,rank))
1852 (defmacro gnus-info-set-read (info read)
1853 `(setcar (nthcdr 2 ,info) ,read))
1854 (defmacro gnus-info-set-marks (info marks &optional extend)
1856 `(gnus-info-set-entry ,info ,marks 3)
1857 `(setcar (nthcdr 3 ,info) ,marks)))
1858 (defmacro gnus-info-set-method (info method &optional extend)
1860 `(gnus-info-set-entry ,info ,method 4)
1861 `(setcar (nthcdr 4 ,info) ,method)))
1862 (defmacro gnus-info-set-params (info params &optional extend)
1864 `(gnus-info-set-entry ,info ,params 5)
1865 `(setcar (nthcdr 5 ,info) ,params)))
1867 (defun gnus-info-set-entry (info entry number)
1868 ;; Extend the info until we have enough elements.
1869 (while (<= (length info) number)
1870 (nconc info (list nil)))
1872 (setcar (nthcdr number info) entry))
1874 (defmacro gnus-info-set-level (info level)
1875 `(let ((rank (cdr ,info)))
1876 (if (consp (car rank))
1877 (setcar (car rank) ,level)
1878 (setcar rank ,level))))
1879 (defmacro gnus-info-set-score (info score)
1880 `(let ((rank (cdr ,info)))
1881 (if (consp (car rank))
1882 (setcdr (car rank) ,score)
1883 (setcar rank (cons (car rank) ,score)))))
1885 (defmacro gnus-get-info (group)
1886 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1888 ;; Byte-compiler warning.
1889 (defvar gnus-visual)
1890 ;; Find out whether the gnus-visual TYPE is wanted.
1891 (defun gnus-visual-p (&optional type class)
1892 (and gnus-visual ; Has to be non-nil, at least.
1893 (if (not type) ; We don't care about type.
1895 (if (listp gnus-visual) ; It's a list, so we check it.
1896 (or (memq type gnus-visual)
1897 (memq class gnus-visual))
1900 ;;; Load the compatability functions.
1909 (defvar gnus-shutdown-alist nil)
1911 (defun gnus-add-shutdown (function &rest symbols)
1912 "Run FUNCTION whenever one of SYMBOLS is shut down."
1913 (push (cons function symbols) gnus-shutdown-alist))
1915 (defun gnus-shutdown (symbol)
1916 "Shut down everything that waits for SYMBOL."
1917 (let ((alist gnus-shutdown-alist)
1919 (while (setq entry (pop alist))
1920 (when (memq symbol (cdr entry))
1921 (funcall (car entry))))))
1925 ;;; Gnus Utility Functions
1928 (defmacro gnus-string-or (&rest strings)
1929 "Return the first element of STRINGS that is a non-blank string.
1930 STRINGS will be evaluated in normal `or' order."
1931 `(gnus-string-or-1 ',strings))
1933 (defun gnus-string-or-1 (strings)
1936 (setq string (eval (pop strings)))
1937 (if (string-match "^[ \t]*$" string)
1939 (setq strings nil)))
1942 ;; Add the current buffer to the list of buffers to be killed on exit.
1943 (defun gnus-add-current-to-buffer-list ()
1944 (or (memq (current-buffer) gnus-buffer-list)
1945 (push (current-buffer) gnus-buffer-list)))
1947 (defun gnus-version (&optional arg)
1948 "Version number of this version of Gnus.
1949 If ARG, insert string at point."
1951 (let ((methods gnus-valid-select-methods)
1954 ;; Go through all the legal select methods and add their version
1955 ;; numbers to the total version string. Only the backends that are
1956 ;; currently in use will have their message numbers taken into
1959 (setq meth (intern (concat (caar methods) "-version")))
1961 (stringp (symbol-value meth))
1962 (setq mess (concat mess "; " (symbol-value meth))))
1963 (setq methods (cdr methods)))
1965 (insert (message mess))
1968 (defun gnus-continuum-version (version)
1969 "Return VERSION as a floating point number."
1970 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1971 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1972 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1973 (number (match-string 2 version))
1975 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1976 (setq major (string-to-number (match-string 1 number)))
1977 (setq minor (string-to-number (match-string 2 number)))
1978 (setq least (if (match-beginning 3)
1979 (string-to-number (match-string 3 number))
1983 (format "%s00%02d%02d"
1985 ((member alpha '("(ding)" "d")) "4.99")
1986 ((member alpha '("September" "s")) "5.01")
1987 ((member alpha '("Red" "r")) "5.03"))
1989 (format "%d.%02d%02d" major minor least))))))
1991 (defun gnus-info-find-node ()
1992 "Find Info documentation of Gnus."
1994 ;; Enlarge info window if needed.
1995 (let (gnus-info-buffer)
1996 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1997 (setq gnus-info-buffer (current-buffer))
1998 (gnus-configure-windows 'info)))
2001 ;;; gnus-interactive
2004 (defvar gnus-current-prefix-symbol nil
2005 "Current prefix symbol.")
2007 (defvar gnus-current-prefix-symbols nil
2008 "List of current prefix symbols.")
2010 (defun gnus-interactive (string &optional params)
2011 "Return a list that can be fed to `interactive'.
2012 See `interactive' for full documentation.
2014 Adds the following specs:
2016 y -- The current symbolic prefix.
2017 Y -- A list of the current symbolic prefix(es).
2018 A -- Article number.
2019 H -- Article header.
2023 (while (< i (length string))
2024 (string-match ".\\([^\n]*\\)\n?" string i)
2025 (setq c (aref string i))
2027 (setq prompt (match-string 1 string)))
2028 (setq i (match-end 0))
2029 ;; We basically emulate just about everything that
2030 ;; `interactive' does, but adds the "g" and "G" specs.
2034 (completing-read prompt obarray 'fboundp t))
2036 (read-buffer prompt (current-buffer) t))
2038 (read-buffer prompt (other-buffer (current-buffer))))
2042 (completing-read prompt obarray 'commandp t))
2046 (read-file-name prompt nil default-directory 'lambda))
2048 (read-file-name prompt nil nil 'lambda))
2050 (read-file-name prompt))
2052 (read-key-sequence prompt))
2054 (error "Not implemented spec"))
2056 (error "Not implemented spec"))
2060 (error "Not implemented spec"))
2062 (string-to-number (read-from-minibuffer prompt)))
2064 (prefix-numeric-value current-prefix-arg))
2070 (read-string prompt))
2072 (intern (read-string prompt)))
2074 (read-variable prompt))
2076 (read-minibuffer prompt))
2078 (eval-minibuffer prompt))
2079 ;; And here the new specs come.
2081 gnus-current-prefix-symbol)
2083 gnus-current-prefix-symbols)
2085 (gnus-group-group-name))
2087 (gnus-summary-skip-intangible)
2088 (or (get-text-property (point) 'gnus-number)
2089 (gnus-summary-last-subject)))
2091 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2093 (error "Non-implemented spec")))
2097 (push (if (< (point) (mark) (point) (mark))) out)
2098 (push (if (> (point) (mark) (point) (mark))) out))))
2099 (setq out (delq 'gnus-prefix-nil out))
2102 (defun gnus-symbolic-argument (&optional arg)
2103 "Read a symbolic argument and a command, and then execute command."
2105 (let* ((in-command (this-command-keys))
2106 (command in-command)
2107 gnus-current-prefix-symbols
2108 gnus-current-prefix-symbol
2110 (while (equal in-command command)
2111 (message "%s-" (key-description (this-command-keys)))
2112 (push (intern (char-to-string (read-char))) syms)
2113 (setq command (read-key-sequence nil t)))
2114 (setq gnus-current-prefix-symbols (nreverse syms)
2115 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2116 (call-interactively (key-binding command t))))
2118 ;;; More various functions.
2120 (defsubst gnus-check-backend-function (func group)
2121 "Check whether GROUP supports function FUNC.
2122 GROUP can either be a string (a group name) or a select method."
2124 (let ((method (if (stringp group)
2125 (car (gnus-find-method-for-group group))
2127 (unless (featurep method)
2129 (fboundp (intern (format "%s-%s" method func))))))
2131 (defun gnus-group-read-only-p (&optional group)
2132 "Check whether GROUP supports editing or not.
2133 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2134 that that variable is buffer-local to the summary buffers."
2135 (let ((group (or group gnus-newsgroup-name)))
2136 (not (gnus-check-backend-function 'request-replace-article group))))
2138 (defun gnus-group-total-expirable-p (group)
2139 "Check whether GROUP is total-expirable or not."
2140 (let ((params (gnus-group-find-parameter group))
2143 ((memq 'total-expire params)
2145 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2147 (gnus-total-expirable-newsgroups ; Check var.
2148 (string-match gnus-total-expirable-newsgroups group)))))
2150 (defun gnus-group-auto-expirable-p (group)
2151 "Check whether GROUP is auto-expirable or not."
2152 (let ((params (gnus-group-find-parameter group))
2155 ((memq 'auto-expire params)
2157 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2159 (gnus-auto-expirable-newsgroups ; Check var.
2160 (string-match gnus-auto-expirable-newsgroups group)))))
2162 (defun gnus-virtual-group-p (group)
2163 "Say whether GROUP is virtual or not."
2164 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2165 gnus-valid-select-methods)))
2167 (defun gnus-news-group-p (group &optional article)
2168 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2169 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2170 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2171 (eq (gnus-request-type group article) 'news))))
2173 ;; Returns a list of writable groups.
2174 (defun gnus-writable-groups ()
2175 (let ((alist gnus-newsrc-alist)
2177 (while (setq group (car (pop alist)))
2178 (unless (gnus-group-read-only-p group)
2179 (push group groups)))
2182 ;; Check whether to use long file names.
2183 (defun gnus-use-long-file-name (symbol)
2184 ;; The variable has to be set...
2185 (and gnus-use-long-file-name
2186 ;; If it isn't a list, then we return t.
2187 (or (not (listp gnus-use-long-file-name))
2188 ;; If it is a list, and the list contains `symbol', we
2190 (not (memq symbol gnus-use-long-file-name)))))
2192 ;; Generate a unique new group name.
2193 (defun gnus-generate-new-group-name (leaf)
2196 (while (gnus-gethash name gnus-newsrc-hashtb)
2197 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2200 (defun gnus-ephemeral-group-p (group)
2201 "Say whether GROUP is ephemeral or not."
2202 (gnus-group-get-parameter group 'quit-config t))
2204 (defun gnus-group-quit-config (group)
2205 "Return the quit-config of GROUP."
2206 (gnus-group-get-parameter group 'quit-config t))
2208 (defun gnus-kill-ephemeral-group (group)
2209 "Remove ephemeral GROUP from relevant structures."
2210 (gnus-sethash group nil gnus-newsrc-hashtb))
2212 (defun gnus-simplify-mode-line ()
2213 "Make mode lines a bit simpler."
2214 (setq mode-line-modified (cdr gnus-mode-line-modified))
2215 (when (listp mode-line-format)
2216 (make-local-variable 'mode-line-format)
2217 (setq mode-line-format (copy-sequence mode-line-format))
2218 (when (equal (nth 3 mode-line-format) " ")
2219 (setcar (nthcdr 3 mode-line-format) " "))))
2221 ;;; Servers and groups.
2223 (defsubst gnus-server-add-address (method)
2224 (let ((method-name (symbol-name (car method))))
2225 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2226 (not (assq (intern (concat method-name "-address")) method))
2227 (memq 'physical-address (assq (car method)
2228 gnus-valid-select-methods)))
2229 (append method (list (list (intern (concat method-name "-address"))
2233 (defsubst gnus-server-get-method (group method)
2234 ;; Input either a server name, and extended server name, or a
2235 ;; select method, and return a select method.
2236 (cond ((stringp method)
2237 (gnus-server-to-method method))
2238 ((equal method gnus-select-method)
2240 ((and (stringp (car method)) group)
2241 (gnus-server-extend-method group method))
2242 ((and method (not group)
2243 (equal (cadr method) ""))
2246 (gnus-server-add-address method))))
2248 (defun gnus-server-to-method (server)
2249 "Map virtual server names to select methods."
2251 ;; Is this a method, perhaps?
2252 (and server (listp server) server)
2253 ;; Perhaps this is the native server?
2254 (and (equal server "native") gnus-select-method)
2255 ;; It should be in the server alist.
2256 (cdr (assoc server gnus-server-alist))
2257 ;; It could be in the predefined server alist.
2258 (cdr (assoc server gnus-predefined-server-alist))
2259 ;; If not, we look through all the opened server
2260 ;; to see whether we can find it there.
2261 (let ((opened gnus-opened-servers))
2263 (not (equal server (format "%s:%s" (caaar opened)
2268 (defmacro gnus-method-equal (ss1 ss2)
2269 "Say whether two servers are equal."
2273 (and (= (length s1) (length s2))
2275 (while (and s1 (member (car s1) s2))
2279 (defun gnus-server-equal (m1 m2)
2280 "Say whether two methods are equal."
2281 (let ((m1 (cond ((null m1) gnus-select-method)
2282 ((stringp m1) (gnus-server-to-method m1))
2284 (m2 (cond ((null m2) gnus-select-method)
2285 ((stringp m2) (gnus-server-to-method m2))
2287 (gnus-method-equal m1 m2)))
2289 (defun gnus-servers-using-backend (backend)
2290 "Return a list of known servers using BACKEND."
2291 (let ((opened gnus-opened-servers)
2294 (when (eq backend (caaar opened))
2295 (push (caar opened) out))
2299 (defun gnus-archive-server-wanted-p ()
2300 "Say whether the user wants to use the archive server."
2302 ((or (not gnus-message-archive-method)
2303 (not gnus-message-archive-group))
2305 ((and gnus-message-archive-method gnus-message-archive-group)
2308 (let ((active (cadr (assq 'nnfolder-active-file
2309 gnus-message-archive-method))))
2311 (file-exists-p active))))))
2313 (defun gnus-group-prefixed-name (group method)
2314 "Return the whole name from GROUP and METHOD."
2315 (and (stringp method) (setq method (gnus-server-to-method method)))
2316 (if (or (not method)
2317 (gnus-server-equal method "native"))
2319 (concat (format "%s" (car method))
2321 (or (assoc (format "%s" (car method))
2322 (gnus-methods-using 'address))
2323 (gnus-server-equal method gnus-message-archive-method))
2325 (not (string= (nth 1 method) "")))
2326 (concat "+" (nth 1 method)))
2329 (defun gnus-group-real-prefix (group)
2330 "Return the prefix of the current group name."
2331 (if (string-match "^[^:]+:" group)
2332 (substring group 0 (match-end 0))
2335 (defun gnus-group-method (group)
2336 "Return the server or method used for selecting GROUP.
2337 You should probably use `gnus-find-method-for-group' instead."
2338 (let ((prefix (gnus-group-real-prefix group)))
2339 (if (equal prefix "")
2341 (let ((servers gnus-opened-servers)
2343 backend possible found)
2344 (if (string-match "^[^\\+]+\\+" prefix)
2345 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2346 server (substring prefix (match-end 0) (1- (length prefix))))
2347 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2349 (when (eq (caaar servers) backend)
2350 (setq possible (caar servers))
2351 (when (equal (cadaar servers) server)
2352 (setq found (caar servers))))
2354 (or (car (rassoc found gnus-server-alist))
2356 (car (rassoc possible gnus-server-alist))
2358 (list backend server))))))
2360 (defsubst gnus-secondary-method-p (method)
2361 "Return whether METHOD is a secondary select method."
2362 (let ((methods gnus-secondary-select-methods)
2363 (gmethod (gnus-server-get-method nil method)))
2365 (not (equal (gnus-server-get-method nil (car methods))
2367 (setq methods (cdr methods)))
2370 (defun gnus-groups-from-server (server)
2371 "Return a list of all groups that are fetched from SERVER."
2372 (let ((alist (cdr gnus-newsrc-alist))
2374 (while (setq info (pop alist))
2375 (when (gnus-server-equal (gnus-info-method info) server)
2376 (push (gnus-info-group info) groups)))
2377 (sort groups 'string<)))
2379 (defun gnus-group-foreign-p (group)
2380 "Say whether a group is foreign or not."
2381 (and (not (gnus-group-native-p group))
2382 (not (gnus-group-secondary-p group))))
2384 (defun gnus-group-native-p (group)
2385 "Say whether the group is native or not."
2386 (not (string-match ":" group)))
2388 (defun gnus-group-secondary-p (group)
2389 "Say whether the group is secondary or not."
2390 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2392 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2393 "Return the group parameters for GROUP.
2394 If SYMBOL, return the value of that symbol in the group parameters."
2396 (set-buffer gnus-group-buffer)
2397 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2399 (gnus-group-parameter-value parameters symbol allow-list)
2402 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2403 "Return the group parameters for GROUP.
2404 If SYMBOL, return the value of that symbol in the group parameters.
2405 Most functions should use `gnus-group-find-parameter', which
2406 also examines the topic parameters."
2407 (let ((params (gnus-info-params (gnus-get-info group))))
2409 (gnus-group-parameter-value params symbol allow-list)
2412 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2413 "Return the value of SYMBOL in group PARAMS."
2414 (or (car (memq symbol params)) ; It's either a simple symbol,
2416 (atom (cdr (assq symbol params)))) ; and it's not a local variable
2417 (cdr (assq symbol params))))) ; but a cons.
2419 (defun gnus-group-add-parameter (group param)
2420 "Add parameter PARAM to GROUP."
2421 (let ((info (gnus-get-info group)))
2423 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2424 ;; Cons the new param to the old one and update.
2425 (gnus-group-set-info (cons param (gnus-info-params info))
2428 (defun gnus-group-set-parameter (group name value)
2429 "Set parameter NAME to VALUE in GROUP."
2430 (let ((info (gnus-get-info group)))
2432 (gnus-group-remove-parameter group name)
2433 (let ((old-params (gnus-info-params info))
2434 (new-params (list (cons name value))))
2436 (when (or (not (listp (car old-params)))
2437 (not (eq (caar old-params) name)))
2438 (setq new-params (append new-params (list (car old-params)))))
2439 (setq old-params (cdr old-params)))
2440 (gnus-group-set-info new-params group 'params)))))
2442 (defun gnus-group-remove-parameter (group name)
2443 "Remove parameter NAME from GROUP."
2444 (let ((info (gnus-get-info group)))
2446 (let ((params (gnus-info-params info)))
2448 (setq params (delq name params))
2449 (while (assq name params)
2450 (setq params (delq (assq name params) params)))
2451 (gnus-info-set-params info params))))))
2453 (defun gnus-group-add-score (group &optional score)
2454 "Add SCORE to the GROUP score.
2455 If SCORE is nil, add 1 to the score of GROUP."
2456 (let ((info (gnus-get-info group)))
2458 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2460 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2461 (defun gnus-short-group-name (group &optional levels)
2462 "Collapse GROUP name LEVELS.
2463 Select methods are stripped and any remote host name is stripped down to
2464 just the host name."
2465 (let* ((name "") (foreign "") (depth -1) (skip 1)
2468 (while (string-match "\\." group skip)
2469 (setq skip (match-end 0)
2472 ;; separate foreign select method from group name and collapse.
2473 ;; if method contains a server, collapse to non-domain server name,
2474 ;; otherwise collapse to select method
2475 (when (string-match ":" group)
2476 (cond ((string-match "+" group)
2477 (let* ((plus (string-match "+" group))
2478 (colon (string-match ":" group (or plus 0)))
2479 (dot (string-match "\\." group)))
2480 (setq foreign (concat
2481 (substring group (+ 1 plus)
2482 (cond ((null dot) colon)
2483 ((< colon dot) colon)
2484 ((< dot colon) dot)))
2486 group (substring group (+ 1 colon)))))
2488 (let* ((colon (string-match ":" group)))
2489 (setq foreign (concat (substring group 0 (+ 1 colon)))
2490 group (substring group (+ 1 colon)))))))
2491 ;; collapse group name leaving LEVELS uncollapsed elements
2493 (if (and (string-match "\\." group) (> levels 0))
2494 (setq name (concat name (substring group 0 1))
2495 group (substring group (match-end 0))
2497 name (concat name "."))
2498 (setq name (concat foreign name group)
2502 (defun gnus-narrow-to-body ()
2503 "Narrow to the body of an article."
2506 (goto-char (point-min))
2507 (or (search-forward "\n\n" nil t)
2513 ;;; Kill file handling.
2516 (defun gnus-apply-kill-file ()
2517 "Apply a kill file to the current newsgroup.
2518 Returns the number of articles marked as read."
2519 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2520 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2521 (gnus-apply-kill-file-internal)
2524 (defun gnus-kill-save-kill-buffer ()
2525 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2526 (when (get-file-buffer file)
2528 (set-buffer (get-file-buffer file))
2529 (when (buffer-modified-p)
2531 (kill-buffer (current-buffer))))))
2533 (defcustom gnus-kill-file-name "KILL"
2534 "Suffix of the kill files."
2535 :group 'gnus-score-kill
2536 :group 'gnus-score-files
2539 (defun gnus-newsgroup-kill-file (newsgroup)
2540 "Return the name of a kill file name for NEWSGROUP.
2541 If NEWSGROUP is nil, return the global kill file name instead."
2543 ;; The global KILL file is placed at top of the directory.
2544 ((or (null newsgroup)
2545 (string-equal newsgroup ""))
2546 (expand-file-name gnus-kill-file-name
2547 gnus-kill-files-directory))
2548 ;; Append ".KILL" to newsgroup name.
2549 ((gnus-use-long-file-name 'not-kill)
2550 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2551 "." gnus-kill-file-name)
2552 gnus-kill-files-directory))
2553 ;; Place "KILL" under the hierarchical directory.
2555 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2556 "/" gnus-kill-file-name)
2557 gnus-kill-files-directory))))
2561 (defun gnus-member-of-valid (symbol group)
2562 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2564 (symbol-name (car (gnus-find-method-for-group group)))
2565 gnus-valid-select-methods)))
2567 (defun gnus-method-option-p (method option)
2568 "Return non-nil if select METHOD has OPTION as a parameter."
2569 (when (stringp method)
2570 (setq method (gnus-server-to-method method)))
2571 (memq option (assoc (format "%s" (car method))
2572 gnus-valid-select-methods)))
2574 (defun gnus-similar-server-opened (method)
2575 (let ((opened gnus-opened-servers))
2576 (while (and method opened)
2577 (when (and (equal (cadr method) (cadaar opened))
2578 (not (equal method (caar opened))))
2583 (defun gnus-server-extend-method (group method)
2584 ;; This function "extends" a virtual server. If the server is
2585 ;; "hello", and the select method is ("hello" (my-var "something"))
2586 ;; in the group "alt.alt", this will result in a new virtual server
2587 ;; called "hello+alt.alt".
2588 (if (or (not (inline (gnus-similar-server-opened method)))
2589 (not (cddr method)))
2591 `(,(car method) ,(concat (cadr method) "+" group)
2592 (,(intern (format "%s-address" (car method))) ,(cadr method))
2595 (defun gnus-server-status (method)
2596 "Return the status of METHOD."
2597 (nth 1 (assoc method gnus-opened-servers)))
2599 (defun gnus-group-name-to-method (group)
2600 "Guess a select method based on GROUP."
2601 (if (string-match ":" group)
2602 (let ((server (substring group 0 (match-beginning 0))))
2603 (if (string-match "\\+" server)
2604 (list (intern (substring server 0 (match-beginning 0)))
2605 (substring server (match-end 0)))
2606 (list (intern server) "")))
2607 gnus-select-method))
2609 (defun gnus-find-method-for-group (group &optional info)
2610 "Find the select method that GROUP uses."
2611 (or gnus-override-method
2614 (let ((info (or info (gnus-get-info group)))
2617 (not (setq method (gnus-info-method info)))
2618 (equal method "native"))
2621 (cond ((stringp method)
2622 (inline (gnus-server-to-method method)))
2623 ((stringp (cadr method))
2624 (inline (gnus-server-extend-method group method)))
2627 (cond ((equal (cadr method) "")
2629 ((null (cadr method))
2630 (list (car method) ""))
2632 (gnus-server-add-address method)))))))
2634 (defun gnus-methods-using (feature)
2635 "Find all methods that have FEATURE."
2636 (let ((valids gnus-valid-select-methods)
2639 (when (memq feature (car valids))
2640 (push (car valids) outs))
2641 (setq valids (cdr valids)))
2644 (defun gnus-read-group (prompt &optional default)
2645 "Prompt the user for a group name.
2646 Disallow illegal group names."
2652 (setq group (read-string (concat prefix prompt)
2653 (cons (or default "") 0)
2654 'gnus-group-history)))
2655 (setq prefix (format "Illegal group name: \"%s\". " group)
2659 (defun gnus-read-method (prompt)
2660 "Prompt the user for a method.
2661 Allow completion over sensible values."
2664 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2666 nil t nil 'gnus-method-history)))
2669 (setq method gnus-select-method))
2670 ((assoc method gnus-valid-select-methods)
2671 (list (intern method)
2672 (if (memq 'prompt-address
2673 (assoc method gnus-valid-select-methods))
2674 (read-string "Address: ")
2676 ((assoc method gnus-server-alist)
2679 (list (intern method) "")))))
2681 ;;; User-level commands.
2684 (defun gnus-slave-no-server (&optional arg)
2685 "Read network news as a slave, without connecting to local server"
2687 (gnus-no-server arg t))
2690 (defun gnus-no-server (&optional arg slave)
2692 If ARG is a positive number, Gnus will use that as the
2693 startup level. If ARG is nil, Gnus will be started at level 2.
2694 If ARG is non-nil and not a positive number, Gnus will
2695 prompt the user for the name of an NNTP server to use.
2696 As opposed to `gnus', this command will not connect to the local server."
2698 (gnus-no-server-1 arg slave))
2701 (defun gnus-slave (&optional arg)
2702 "Read news as a slave."
2704 (gnus arg nil 'slave))
2707 (defun gnus-other-frame (&optional arg)
2708 "Pop up a frame to read news."
2710 (let ((window (get-buffer-window gnus-group-buffer)))
2712 (select-frame (window-frame window)))
2713 ((= (length (frame-list)) 1)
2714 (select-frame (make-frame)))
2720 (defun gnus (&optional arg dont-connect slave)
2722 If ARG is non-nil and a positive number, Gnus will use that as the
2723 startup level. If ARG is non-nil and not a positive number, Gnus will
2724 prompt the user for the name of an NNTP server to use."
2726 (gnus-1 arg dont-connect slave))
2728 ;; Allow redefinition of Gnus functions.
2734 ;;; gnus.el ends here
projects / elisp / gnus.git- / blob