1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97 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))
36 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
40 (defgroup gnus-start nil
41 "Starting your favorite newsreader."
44 (defgroup gnus-start-server nil
45 "Server options at startup."
48 ;; These belong to gnus-group.el.
49 (defgroup gnus-group nil
51 :link '(custom-manual "(gnus)The Group Buffer")
54 (defgroup gnus-group-foreign nil
56 :link '(custom-manual "(gnus)Foreign Groups")
59 (defgroup gnus-group-new nil
60 "Automatic subscription of new groups."
63 (defgroup gnus-group-levels nil
65 :link '(custom-manual "(gnus)Group Levels")
68 (defgroup gnus-group-select nil
70 :link '(custom-manual "(gnus)Selecting a Group")
73 (defgroup gnus-group-listing nil
74 "Showing slices of the group list."
75 :link '(custom-manual "(gnus)Listing Groups")
78 (defgroup gnus-group-visual nil
79 "Sorting the group buffer."
80 :link '(custom-manual "(gnus)Group Buffer Format")
84 (defgroup gnus-group-various nil
85 "Various group options."
86 :link '(custom-manual "(gnus)Scanning New Messages")
89 ;; These belong to gnus-sum.el.
90 (defgroup gnus-summary nil
92 :link '(custom-manual "(gnus)The Summary Buffer")
95 (defgroup gnus-summary-exit nil
96 "Leaving summary buffers."
97 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
100 (defgroup gnus-summary-marks nil
101 "Marks used in summary buffers."
102 :link '(custom-manual "(gnus)Marking Articles")
103 :group 'gnus-summary)
105 (defgroup gnus-thread nil
106 "Ordering articles according to replies."
107 :link '(custom-manual "(gnus)Threading")
108 :group 'gnus-summary)
110 (defgroup gnus-summary-format nil
111 "Formatting of the summary buffer."
112 :link '(custom-manual "(gnus)Summary Buffer Format")
113 :group 'gnus-summary)
115 (defgroup gnus-summary-choose nil
117 :link '(custom-manual "(gnus)Choosing Articles")
118 :group 'gnus-summary)
120 (defgroup gnus-summary-maneuvering nil
121 "Summary movement commands."
122 :link '(custom-manual "(gnus)Summary Maneuvering")
123 :group 'gnus-summary)
125 (defgroup gnus-summary-mail nil
126 "Mail group commands."
127 :link '(custom-manual "(gnus)Mail Group Commands")
128 :group 'gnus-summary)
130 (defgroup gnus-summary-sort nil
131 "Sorting the summary buffer."
132 :link '(custom-manual "(gnus)Sorting")
133 :group 'gnus-summary)
135 (defgroup gnus-summary-visual nil
136 "Highlighting and menus in the summary buffer."
137 :link '(custom-manual "(gnus)Summary Highlighting")
139 :group 'gnus-summary)
141 (defgroup gnus-summary-various nil
142 "Various summary buffer options."
143 :link '(custom-manual "(gnus)Various Summary Stuff")
144 :group 'gnus-summary)
146 ;; Belongs to gnus-uu.el
147 (defgroup gnus-extract-view nil
148 "Viewing extracted files."
149 :link '(custom-manual "(gnus)Viewing Files")
150 :group 'gnus-extract)
152 ;; Belongs to gnus-score.el
153 (defgroup gnus-score nil
154 "Score and kill file handling."
157 (defgroup gnus-score-kill nil
161 (defgroup gnus-score-adapt nil
162 "Adaptive score files."
165 (defgroup gnus-score-default nil
166 "Default values for score files."
169 (defgroup gnus-score-expire nil
170 "Expiring score rules."
173 (defgroup gnus-score-decay nil
174 "Decaying score rules."
177 (defgroup gnus-score-files nil
178 "Score and kill file names."
182 (defgroup gnus-score-various nil
183 "Various scoring and killing options."
187 (defgroup gnus-visual nil
188 "Options controling the visual fluff."
192 (defgroup gnus-files nil
193 "Files used by Gnus."
196 (defgroup gnus-dribble-file nil
198 :link '(custom-manual "(gnus)Auto Save")
201 (defgroup gnus-newsrc nil
202 "Storing Gnus state."
205 (defgroup gnus-server nil
206 "Options related to newsservers and other servers used by Gnus."
209 (defgroup gnus-message '((message custom-group))
210 "Composing replies and followups in Gnus."
213 (defgroup gnus-meta nil
214 "Meta variables controling major portions of Gnus.
215 In general, modifying these variables does not take affect until Gnus
216 is restarted, and sometimes reloaded."
219 (defgroup gnus-various nil
220 "Other Gnus options."
221 :link '(custom-manual "(gnus)Various Various")
224 (defgroup gnus-exit nil
226 :link '(custom-manual "(gnus)Exiting Gnus")
229 (defconst gnus-version-number "5.4.24"
230 "Version number for this version of Gnus.")
232 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
233 "Version string for this version of Gnus.")
235 (defcustom gnus-inhibit-startup-message nil
236 "If non-nil, the startup message will not be displayed.
237 This variable is used before `.gnus.el' is loaded, so it should
238 be set in `.emacs' instead."
242 (defcustom gnus-play-startup-jingle nil
243 "If non-nil, play the Gnus jingle at startup."
247 ;;; Kludges to help the transition from the old `custom.el'.
249 (unless (featurep 'gnus-xmas)
250 (defalias 'gnus-make-overlay 'make-overlay)
251 (defalias 'gnus-overlay-put 'overlay-put)
252 (defalias 'gnus-move-overlay 'move-overlay)
253 (defalias 'gnus-overlay-end 'overlay-end)
254 (defalias 'gnus-extent-detached-p 'ignore)
255 (defalias 'gnus-extent-start-open 'ignore)
256 (defalias 'gnus-set-text-properties 'set-text-properties)
257 (defalias 'gnus-group-remove-excess-properties 'ignore)
258 (defalias 'gnus-topic-remove-excess-properties 'ignore)
259 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
260 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
261 (defalias 'gnus-add-hook 'add-hook)
262 (defalias 'gnus-character-to-event 'identity)
263 (defalias 'gnus-add-text-properties 'add-text-properties)
264 (defalias 'gnus-put-text-property 'put-text-property)
265 (defalias 'gnus-mode-line-buffer-identification 'identity)
266 (defalias 'gnus-characterp 'numberp)
267 (defalias 'gnus-key-press-event-p 'numberp))
269 ;; The XEmacs people think this is evil, so it must go.
270 (defun custom-face-lookup (&optional fg bg stipple bold italic underline)
271 "Lookup or create a face with specified attributes."
272 (let ((name (intern (format "custom-face-%s-%s-%s-%S-%S-%S"
275 (or stipple "default")
276 bold italic underline))))
277 (if (and (custom-facep name)
278 (fboundp 'make-face))
280 (copy-face 'default name)
282 (not (string-equal fg "default")))
284 (set-face-foreground name fg)))
286 (not (string-equal bg "default")))
288 (set-face-background name bg)))
290 (not (string-equal stipple "default"))
291 (not (eq stipple 'custom:asis))
292 (fboundp 'set-face-stipple))
293 (set-face-stipple name stipple))
295 (not (eq bold 'custom:asis)))
297 (make-face-bold name)))
299 (not (eq italic 'custom:asis)))
301 (make-face-italic name)))
303 (not (eq underline 'custom:asis)))
305 (set-face-underline-p name t))))
308 ;; We define these group faces here to avoid the display
309 ;; update forced when creating new faces.
311 (defface gnus-group-news-1-face
314 (:foreground "PaleTurquoise" :bold t))
317 (:foreground "ForestGreen" :bold t))
320 "Level 1 newsgroup face.")
322 (defface gnus-group-news-1-empty-face
325 (:foreground "PaleTurquoise"))
328 (:foreground "ForestGreen"))
331 "Level 1 empty newsgroup face.")
333 (defface gnus-group-news-2-face
336 (:foreground "turquoise" :bold t))
339 (:foreground "CadetBlue4" :bold t))
342 "Level 2 newsgroup face.")
344 (defface gnus-group-news-2-empty-face
347 (:foreground "turquoise"))
350 (:foreground "CadetBlue4"))
353 "Level 2 empty newsgroup face.")
355 (defface gnus-group-news-3-face
364 "Level 3 newsgroup face.")
366 (defface gnus-group-news-3-empty-face
375 "Level 3 empty newsgroup face.")
377 (defface gnus-group-news-low-face
380 (:foreground "DarkTurquoise" :bold t))
383 (:foreground "DarkGreen" :bold t))
386 "Low level newsgroup face.")
388 (defface gnus-group-news-low-empty-face
391 (:foreground "DarkTurquoise"))
394 (:foreground "DarkGreen"))
397 "Low level empty newsgroup face.")
399 (defface gnus-group-mail-1-face
402 (:foreground "aquamarine1" :bold t))
405 (:foreground "DeepPink3" :bold t))
408 "Level 1 mailgroup face.")
410 (defface gnus-group-mail-1-empty-face
413 (:foreground "aquamarine1"))
416 (:foreground "DeepPink3"))
418 (:italic t :bold t)))
419 "Level 1 empty mailgroup face.")
421 (defface gnus-group-mail-2-face
424 (:foreground "aquamarine2" :bold t))
427 (:foreground "HotPink3" :bold t))
430 "Level 2 mailgroup face.")
432 (defface gnus-group-mail-2-empty-face
435 (:foreground "aquamarine2"))
438 (:foreground "HotPink3"))
441 "Level 2 empty mailgroup face.")
443 (defface gnus-group-mail-3-face
446 (:foreground "aquamarine3" :bold t))
449 (:foreground "magenta4" :bold t))
452 "Level 3 mailgroup face.")
454 (defface gnus-group-mail-3-empty-face
457 (:foreground "aquamarine3"))
460 (:foreground "magenta4"))
463 "Level 3 empty mailgroup face.")
465 (defface gnus-group-mail-low-face
468 (:foreground "aquamarine4" :bold t))
471 (:foreground "DeepPink4" :bold t))
474 "Low level mailgroup face.")
476 (defface gnus-group-mail-low-empty-face
479 (:foreground "aquamarine4"))
482 (:foreground "DeepPink4"))
485 "Low level empty mailgroup face.")
487 ;; Summary mode faces.
489 (defface gnus-summary-selected-face '((t
491 "Face used for selected articles.")
493 (defface gnus-summary-cancelled-face
495 (:foreground "yellow" :background "black")))
496 "Face used for cancelled articles.")
498 (defface gnus-summary-high-ticked-face
501 (:foreground "pink" :bold t))
504 (:foreground "firebrick" :bold t))
507 "Face used for high interest ticked articles.")
509 (defface gnus-summary-low-ticked-face
512 (:foreground "pink" :italic t))
515 (:foreground "firebrick" :italic t))
518 "Face used for low interest ticked articles.")
520 (defface gnus-summary-normal-ticked-face
523 (:foreground "pink"))
526 (:foreground "firebrick"))
529 "Face used for normal interest ticked articles.")
531 (defface gnus-summary-high-ancient-face
534 (:foreground "SkyBlue" :bold t))
537 (:foreground "RoyalBlue" :bold t))
540 "Face used for high interest ancient articles.")
542 (defface gnus-summary-low-ancient-face
545 (:foreground "SkyBlue" :italic t))
548 (:foreground "RoyalBlue" :italic t))
551 "Face used for low interest ancient articles.")
553 (defface gnus-summary-normal-ancient-face
556 (:foreground "SkyBlue"))
559 (:foreground "RoyalBlue"))
562 "Face used for normal interest ancient articles.")
564 (defface gnus-summary-high-unread-face
567 "Face used for high interest unread articles.")
569 (defface gnus-summary-low-unread-face
572 "Face used for low interest unread articles.")
574 (defface gnus-summary-normal-unread-face
577 "Face used for normal interest unread articles.")
579 (defface gnus-summary-high-read-face
582 (:foreground "PaleGreen"
586 (:foreground "DarkGreen"
590 "Face used for high interest read articles.")
592 (defface gnus-summary-low-read-face
595 (:foreground "PaleGreen"
599 (:foreground "DarkGreen"
603 "Face used for low interest read articles.")
605 (defface gnus-summary-normal-read-face
608 (:foreground "PaleGreen"))
611 (:foreground "DarkGreen"))
614 "Face used for normal interest read articles.")
619 (defvar gnus-group-buffer "*Group*")
622 (autoload 'gnus-play-jingle "gnus-audio"))
624 (defface gnus-splash-face
633 "Level 1 newsgroup face.")
635 (defun gnus-splash ()
637 (switch-to-buffer gnus-group-buffer)
638 (let ((buffer-read-only nil))
640 (unless gnus-inhibit-startup-message
641 (gnus-group-startup-message)
643 (when gnus-play-startup-jingle
644 (gnus-play-jingle))))))
646 (defun gnus-indent-rigidly (start end arg)
647 "Indent rigidly using only spaces and no tabs."
650 (narrow-to-region start end)
651 (indent-rigidly start end arg)
652 ;; We translate tabs into spaces -- not everybody uses
653 ;; an 8-character tab.
654 (goto-char (point-min))
655 (while (search-forward "\t" nil t)
656 (replace-match " " t t)))))
658 (defvar gnus-simple-splash nil)
660 (defun gnus-group-startup-message (&optional x y)
661 "Insert startup message in current buffer."
662 ;; Insert the message.
667 _ ___ __ ___ __ _ ___
687 (gnus-indent-rigidly (point-min) (point-max)
688 (/ (max (- (window-width) (or x 46)) 0) 2))
689 (goto-char (point-min))
691 (let* ((pheight (count-lines (point-min) (point-max)))
692 (wheight (window-height))
693 (rest (- wheight pheight)))
694 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
696 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
697 (goto-char (point-min))
698 (setq mode-line-buffer-identification (concat " " gnus-version))
699 (setq gnus-simple-splash t)
700 (set-buffer-modified-p t))
703 (let ((command (format "%s" this-command)))
704 (when (and (string-match "gnus" command)
705 (not (string-match "gnus-other-frame" command)))
714 (defcustom gnus-directory (or (getenv "SAVEDIR") "~/News/")
715 "Directory variable from which all other Gnus file variables are derived."
719 (defcustom gnus-default-directory nil
720 "*Default directory for all Gnus buffers."
722 :type '(choice (const :tag "current" nil)
725 ;; Site dependent variables. These variables should be defined in
728 (defvar gnus-default-nntp-server nil
729 "Specify a default NNTP server.
730 This variable should be defined in paths.el, and should never be set
732 If you want to change servers, you should use `gnus-select-method'.
733 See the documentation to that variable.")
735 ;; Don't touch this variable.
736 (defvar gnus-nntp-service "nntp"
737 "NNTP service name (\"nntp\" or 119).
738 This is an obsolete variable, which is scarcely used. If you use an
739 nntp server for your newsgroup and want to change the port number
740 used to 899, you would say something along these lines:
742 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
744 (defcustom gnus-nntpserver-file "/etc/nntpserver"
745 "A file with only the name of the nntp server in it."
750 ;; This function is used to check both the environment variable
751 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
752 ;; an nntp server name default.
753 (defun gnus-getenv-nntpserver ()
754 (or (getenv "NNTPSERVER")
755 (and (file-readable-p gnus-nntpserver-file)
757 (set-buffer (get-buffer-create " *gnus nntp*"))
758 (buffer-disable-undo (current-buffer))
759 (insert-file-contents gnus-nntpserver-file)
760 (let ((name (buffer-string)))
762 (if (string-match "^[ \t\n]*$" name)
765 (kill-buffer (current-buffer))))))))
767 (defcustom gnus-select-method
770 (list 'nntp (or (ignore-errors
771 (gnus-getenv-nntpserver))
772 (when (and gnus-default-nntp-server
773 (not (string= gnus-default-nntp-server "")))
774 gnus-default-nntp-server)
776 (if (or (null gnus-nntp-service)
777 (equal gnus-nntp-service "nntp"))
779 (list gnus-nntp-service))))
780 "Default method for selecting a newsgroup.
781 This variable should be a list, where the first element is how the
782 news is to be fetched, the second is the address.
784 For instance, if you want to get your news via NNTP from
785 \"flab.flab.edu\", you could say:
787 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
789 If you want to use your local spool, say:
791 \(setq gnus-select-method (list 'nnspool (system-name)))
793 If you use this variable, you must set `gnus-nntp-server' to nil.
795 There is a lot more to know about select methods and virtual servers -
796 see the manual for details."
798 :type 'gnus-select-method)
800 (defcustom gnus-message-archive-method
803 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
804 (nnfolder-active-file
805 ,(nnheader-concat message-directory "archive/active"))
806 (nnfolder-get-new-mail nil)
807 (nnfolder-inhibit-expiry t))
808 "Method used for archiving messages you've sent.
809 This should be a mail method.
811 It's probably not a very effective to change this variable once you've
812 run Gnus once. After doing that, you must edit this server from the
816 :type 'gnus-select-method)
818 (defcustom gnus-message-archive-group nil
819 "*Name of the group in which to save the messages you've written.
820 This can either be a string; a list of strings; or an alist
821 of regexps/functions/forms to be evaluated to return a string (or a list
822 of strings). The functions are called with the name of the current
823 group (or nil) as a parameter.
825 If you want to save your mail in one group and the news articles you
826 write in another group, you could say something like:
828 \(setq gnus-message-archive-group
829 '((if (message-news-p)
833 Normally the group names returned by this variable should be
834 unprefixed -- which implicitly means \"store on the archive server\".
835 However, you may wish to store the message on some other server. In
836 that case, just return a fully prefixed name of the group --
837 \"nnml+private:mail.misc\", for instance."
839 :type '(choice (const :tag "none" nil)
842 (defcustom gnus-secondary-servers nil
843 "List of NNTP servers that the user can choose between interactively.
844 To make Gnus query you for a server, you have to give `gnus' a
845 non-numeric prefix - `C-u M-x gnus', in short."
847 :type '(repeat string))
849 (defcustom gnus-nntp-server nil
850 "*The name of the host running the NNTP server.
851 This variable is semi-obsolete. Use the `gnus-select-method'
854 :type '(choice (const :tag "disable" nil)
857 (defcustom gnus-secondary-select-methods nil
858 "A list of secondary methods that will be used for reading news.
859 This is a list where each element is a complete select method (see
860 `gnus-select-method').
862 If, for instance, you want to read your mail with the nnml backend,
863 you could set this variable:
865 \(setq gnus-secondary-select-methods '((nnml \"\")))"
867 :type '(repeat gnus-select-method))
869 (defvar gnus-backup-default-subscribed-newsgroups
870 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
871 "Default default new newsgroups the first time Gnus is run.
872 Should be set in paths.el, and shouldn't be touched by the user.")
874 (defcustom gnus-local-domain nil
875 "Local domain name without a host name.
876 The DOMAINNAME environment variable is used instead if it is defined.
877 If the `system-name' function returns the full Internet name, there is
878 no need to set this variable."
880 :type '(choice (const :tag "default" nil)
883 (defvar gnus-local-organization nil
884 "String with a description of what organization (if any) the user belongs to.
885 Obsolete variable; use `message-user-organization' instead.")
887 ;; Customization variables
889 (defcustom gnus-refer-article-method nil
890 "Preferred method for fetching an article by Message-ID.
891 If you are reading news from the local spool (with nnspool), fetching
892 articles by Message-ID is painfully slow. By setting this method to an
893 nntp method, you might get acceptable results.
895 The value of this variable must be a valid select method as discussed
896 in the documentation of `gnus-select-method'."
898 :type '(choice (const :tag "default" nil)
901 (defcustom gnus-group-faq-directory
902 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
903 "/ftp@sunsite.auc.dk:/pub/usenet/"
904 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
905 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
906 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
907 "/ftp@rtfm.mit.edu:/pub/usenet/"
908 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
909 "/ftp@ftp.sunet.se:/pub/usenet/"
910 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
911 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
912 "/ftp@ftp.hk.super.net:/mirror/faqs/")
913 "Directory where the group FAQs are stored.
914 This will most commonly be on a remote machine, and the file will be
917 This variable can also be a list of directories. In that case, the
918 first element in the list will be used by default. The others can
919 be used when being prompted for a site.
921 Note that Gnus uses an aol machine as the default directory. If this
922 feels fundamentally unclean, just think of it as a way to finally get
923 something of value back from them.
925 If the default site is too slow, try one of these:
927 North America: mirrors.aol.com /pub/rtfm/usenet
928 ftp.seas.gwu.edu /pub/rtfm
929 rtfm.mit.edu /pub/usenet
930 Europe: ftp.uni-paderborn.de /pub/FAQ
931 src.doc.ic.ac.uk /usenet/news-FAQS
932 ftp.sunet.se /pub/usenet
933 sunsite.auc.dk /pub/usenet
934 Asia: nctuccca.edu.tw /USENET/FAQ
935 hwarang.postech.ac.kr /pub/usenet
936 ftp.hk.super.net /mirror/faqs"
937 :group 'gnus-group-various
938 :type '(choice directory
941 (defcustom gnus-use-cross-reference t
942 "*Non-nil means that cross referenced articles will be marked as read.
943 If nil, ignore cross references. If t, mark articles as read in
944 subscribed newsgroups. If neither t nor nil, mark as read in all
947 :type '(choice (const :tag "off" nil)
948 (const :tag "subscribed" t)
952 (defcustom gnus-process-mark ?#
954 :group 'gnus-group-visual
955 :group 'gnus-summary-marks
958 (defcustom gnus-asynchronous nil
959 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
960 :group 'gnus-asynchronous
963 (defcustom gnus-large-newsgroup 200
964 "*The number of articles which indicates a large newsgroup.
965 If the number of articles in a newsgroup is greater than this value,
966 confirmation is required for selecting the newsgroup."
967 :group 'gnus-group-select
970 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
971 "*Non-nil means that the default name of a file to save articles in is the group name.
972 If it's nil, the directory form of the group name is used instead.
974 If this variable is a list, and the list contains the element
975 `not-score', long file names will not be used for score files; if it
976 contains the element `not-save', long file names will not be used for
977 saving; and if it contains the element `not-kill', long file names
978 will not be used for kill files.
980 Note that the default for this variable varies according to what system
981 type you're using. On `usg-unix-v' and `xenix' this variable defaults
982 to nil while on all other systems it defaults to t."
986 (defcustom gnus-kill-files-directory gnus-directory
987 "*Name of the directory where kill files will be stored (default \"~/News\")."
988 :group 'gnus-score-files
989 :group 'gnus-score-kill
992 (defcustom gnus-save-score nil
993 "*If non-nil, save group scoring info."
994 :group 'gnus-score-various
998 (defcustom gnus-use-undo t
999 "*If non-nil, allow undoing in Gnus group mode buffers."
1003 (defcustom gnus-use-adaptive-scoring nil
1004 "*If non-nil, use some adaptive scoring scheme.
1005 If a list, then the values `word' and `line' are meaningful. The
1006 former will perform adaption on individual words in the subject
1007 header while `line' will perform adaption on several headers."
1009 :group 'gnus-score-adapt
1010 :type '(set (const word) (const line)))
1012 (defcustom gnus-use-cache 'passive
1013 "*If nil, Gnus will ignore the article cache.
1014 If `passive', it will allow entering (and reading) articles
1015 explicitly entered into the cache. If anything else, use the
1016 cache to the full extent of the law."
1019 :type '(choice (const :tag "off" nil)
1020 (const :tag "passive" passive)
1021 (const :tag "active" t)))
1023 (defcustom gnus-use-trees nil
1024 "*If non-nil, display a thread tree buffer."
1028 (defcustom gnus-use-grouplens nil
1029 "*If non-nil, use GroupLens ratings."
1033 (defcustom gnus-keep-backlog nil
1034 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1035 If it is a number N, then Gnus will only keep the last N articles
1036 read. If it is neither nil nor a number, Gnus will keep all read
1037 articles. This is not a good idea."
1039 :type '(choice (const :tag "off" nil)
1044 (defcustom gnus-use-nocem nil
1045 "*If non-nil, Gnus will read NoCeM cancel messages."
1049 (defcustom gnus-suppress-duplicates nil
1050 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1054 (defcustom gnus-use-demon nil
1055 "If non-nil, Gnus might use some demons."
1059 (defcustom gnus-use-scoring t
1060 "*If non-nil, enable scoring."
1064 (defcustom gnus-use-picons nil
1065 "*If non-nil, display picons."
1069 (defcustom gnus-summary-prepare-exit-hook
1070 '(gnus-summary-expire-articles)
1071 "A hook called when preparing to exit from the summary buffer.
1072 It calls `gnus-summary-expire-articles' by default."
1073 :group 'gnus-summary-exit
1076 (defcustom gnus-novice-user t
1077 "*Non-nil means that you are a usenet novice.
1078 If non-nil, verbose messages may be displayed and confirmations may be
1083 (defcustom gnus-expert-user nil
1084 "*Non-nil means that you will never be asked for confirmation about anything.
1085 And that means *anything*."
1089 (defcustom gnus-interactive-catchup t
1090 "*If non-nil, require your confirmation when catching up a group."
1091 :group 'gnus-group-select
1094 (defcustom gnus-interactive-exit t
1095 "*If non-nil, require your confirmation when exiting Gnus."
1099 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1100 "*Function for extracting address components from a From header.
1101 Two pre-defined function exist: `gnus-extract-address-components',
1102 which is the default, quite fast, and too simplistic solution, and
1103 `mail-extract-address-components', which works much better, but is
1105 :group 'gnus-summary-format
1106 :type '(radio (function-item gnus-extract-address-components)
1107 (function-item mail-extract-address-components)
1108 (function :tag "Other")))
1110 (defcustom gnus-carpal nil
1111 "*If non-nil, display clickable icons."
1115 (defcustom gnus-shell-command-separator ";"
1116 "String used to separate to shell commands."
1120 (defcustom gnus-valid-select-methods
1121 '(("nntp" post address prompt-address physical-address)
1122 ("nnspool" post address)
1123 ("nnvirtual" post-mail virtual prompt-address)
1124 ("nnmbox" mail respool address)
1125 ("nnml" mail respool address)
1126 ("nnmh" mail respool address)
1127 ("nndir" post-mail prompt-address physical-address)
1128 ("nneething" none address prompt-address physical-address)
1129 ("nndoc" none address prompt-address)
1130 ("nnbabyl" mail address respool)
1131 ("nnkiboze" post virtual)
1132 ("nnsoup" post-mail address)
1133 ("nndraft" post-mail)
1134 ("nnfolder" mail respool address)
1135 ("nngateway" none address prompt-address physical-address)
1137 "An alist of valid select methods.
1138 The first element of each list lists should be a string with the name
1139 of the select method. The other elements may be the category of
1140 this method (i. e., `post', `mail', `none' or whatever) or other
1141 properties that this method has (like being respoolable).
1142 If you implement a new select method, all you should have to change is
1143 this variable. I think."
1145 :type '(repeat (group (string :tag "Name")
1146 (radio-button-choice (const :format "%v " post)
1147 (const :format "%v " mail)
1148 (const :format "%v " none)
1150 (checklist :inline t
1151 (const :format "%v " address)
1152 (const :format "%v " prompt-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-article-display-x-face
1340 gnus-summary-stop-page-breaking
1341 ;; gnus-summary-caesar-message
1342 ;; gnus-summary-verbose-headers
1343 gnus-summary-toggle-mime
1345 gnus-article-hide-headers
1346 gnus-article-hide-boring-headers
1347 gnus-article-hide-signature
1348 gnus-article-hide-citation
1349 gnus-article-hide-pgp
1350 gnus-article-hide-pem
1351 gnus-article-highlight
1352 gnus-article-highlight-headers
1353 gnus-article-highlight-citation
1354 gnus-article-highlight-signature
1355 gnus-article-date-ut
1356 gnus-article-date-local
1357 gnus-article-date-lapsed
1358 gnus-article-date-original
1359 gnus-article-remove-trailing-blank-lines
1360 gnus-article-strip-leading-blank-lines
1361 gnus-article-strip-multiple-blank-lines
1362 gnus-article-strip-blank-lines
1363 gnus-article-treat-overstrike))
1365 (defcustom gnus-article-save-directory gnus-directory
1366 "*Name of the directory articles will be saved in (default \"~/News\")."
1367 :group 'gnus-article-saving
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)
1377 (defvar gnus-current-select-method nil
1378 "The current method for selecting a newsgroup.")
1380 (defvar gnus-tree-buffer "*Tree*"
1381 "Buffer where Gnus thread trees are displayed.")
1384 (defvar gnus-use-generic-from nil)
1386 ;; Variable holding the user answers to all method prompts.
1387 (defvar gnus-method-history nil)
1388 (defvar gnus-group-history nil)
1390 ;; Variable holding the user answers to all mail method prompts.
1391 (defvar gnus-mail-method-history nil)
1393 ;; Variable holding the user answers to all group prompts.
1394 (defvar gnus-group-history nil)
1396 (defvar gnus-server-alist nil
1397 "List of available servers.")
1399 (defvar gnus-predefined-server-alist
1402 (nnspool-spool-directory "~/News/cache/")
1403 (nnspool-nov-directory "~/News/cache/")
1404 (nnspool-active-file "~/News/cache/active"))))
1405 "List of predefined (convenience) servers.")
1407 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1409 (defconst gnus-article-mark-lists
1410 '((marked . tick) (replied . reply)
1411 (expirable . expire) (killed . killed)
1412 (bookmarks . bookmark) (dormant . dormant)
1413 (scored . score) (saved . save)
1416 (defvar gnus-headers-retrieved-by nil)
1417 (defvar gnus-article-reply nil)
1418 (defvar gnus-override-method nil)
1419 (defvar gnus-article-check-size nil)
1420 (defvar gnus-opened-servers nil)
1422 (defvar gnus-current-kill-article nil)
1424 (defvar gnus-have-read-active-file nil)
1426 (defconst gnus-maintainer
1427 "gnus-bug@ifi.uio.no (The Gnus Bugfixing Girls + Boys)"
1428 "The mail address of the Gnus maintainers.")
1430 (defvar gnus-info-nodes
1431 '((gnus-group-mode "(gnus)The Group Buffer")
1432 (gnus-summary-mode "(gnus)The Summary Buffer")
1433 (gnus-article-mode "(gnus)The Article Buffer")
1434 (mime/viewer-mode "(gnus)The Article Buffer")
1435 (gnus-server-mode "(gnus)The Server Buffer")
1436 (gnus-browse-mode "(gnus)Browse Foreign Server")
1437 (gnus-tree-mode "(gnus)Tree Display"))
1438 "Alist of major modes and related Info nodes.")
1440 (defvar gnus-group-buffer "*Group*")
1441 (defvar gnus-summary-buffer "*Summary*")
1442 (defvar gnus-article-buffer "*Article*")
1443 (defvar gnus-server-buffer "*Server*")
1445 (defvar gnus-buffer-list nil
1446 "Gnus buffers that should be killed on exit.")
1448 (defvar gnus-slave nil
1449 "Whether this Gnus is a slave or not.")
1451 (defvar gnus-batch-mode nil
1452 "Whether this Gnus is running in batch mode or not.")
1454 (defvar gnus-variable-list
1455 '(gnus-newsrc-options gnus-newsrc-options-n
1456 gnus-newsrc-last-checked-date
1457 gnus-newsrc-alist gnus-server-alist
1458 gnus-killed-list gnus-zombie-list
1459 gnus-topic-topology gnus-topic-alist
1461 "Gnus variables saved in the quick startup file.")
1463 (defvar gnus-newsrc-alist nil
1464 "Assoc list of read articles.
1465 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1467 (defvar gnus-newsrc-hashtb nil
1468 "Hashtable of gnus-newsrc-alist.")
1470 (defvar gnus-killed-list nil
1471 "List of killed newsgroups.")
1473 (defvar gnus-killed-hashtb nil
1474 "Hash table equivalent of gnus-killed-list.")
1476 (defvar gnus-zombie-list nil
1477 "List of almost dead newsgroups.")
1479 (defvar gnus-description-hashtb nil
1480 "Descriptions of newsgroups.")
1482 (defvar gnus-list-of-killed-groups nil
1483 "List of newsgroups that have recently been killed by the user.")
1485 (defvar gnus-active-hashtb nil
1486 "Hashtable of active articles.")
1488 (defvar gnus-moderated-hashtb nil
1489 "Hashtable of moderated newsgroups.")
1491 ;; Save window configuration.
1492 (defvar gnus-prev-winconf nil)
1494 (defvar gnus-reffed-article-number nil)
1496 ;;; Let the byte-compiler know that we know about this variable.
1497 (defvar rmail-default-rmail-file)
1499 (defvar gnus-dead-summary nil)
1501 ;;; End of variables.
1503 ;; Define some autoload functions Gnus might use.
1506 ;; This little mapcar goes through the list below and marks the
1507 ;; symbols in question as autoloaded functions.
1510 (let ((interactive (nth 1 (memq ':interactive package))))
1514 (when (consp function)
1515 (setq keymap (car (memq 'keymap function)))
1516 (setq function (car function)))
1517 (autoload function (car package) nil interactive keymap)))
1518 (if (eq (nth 1 package) ':interactive)
1521 '(("metamail" metamail-buffer)
1522 ("info" Info-goto-node)
1523 ("hexl" hexl-hex-string-to-integer)
1524 ("pp" pp pp-to-string pp-eval-expression)
1525 ("ps-print" ps-print-preprint)
1526 ("mail-extr" mail-extract-address-components)
1527 ("message" :interactive t
1528 message-send-and-exit message-yank-original)
1529 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1530 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1531 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1532 timezone-make-sortable-date timezone-make-time-string)
1533 ("rmailout" rmail-output)
1534 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1536 ("gnus-audio" :interactive t gnus-audio-play)
1537 ("gnus-xmas" gnus-xmas-splash)
1538 ("gnus-soup" :interactive t
1539 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1540 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1541 ("nnsoup" nnsoup-pack-replies)
1542 ("score-mode" :interactive t gnus-score-mode)
1543 ("gnus-mh" gnus-summary-save-article-folder
1544 gnus-Folder-save-name gnus-folder-save-name)
1545 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1546 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1547 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1548 gnus-demon-add-disconnection gnus-demon-add-handler
1549 gnus-demon-remove-handler)
1550 ("gnus-demon" :interactive t
1551 gnus-demon-init gnus-demon-cancel)
1552 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1553 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1554 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1555 gnus-nocem-unwanted-article-p)
1556 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info)
1557 ("gnus-srvr" gnus-browse-foreign-server)
1558 ("gnus-cite" :interactive t
1559 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1560 gnus-article-hide-citation gnus-article-fill-cited-article
1561 gnus-article-hide-citation-in-followups)
1562 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1563 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1564 gnus-execute gnus-expunge)
1565 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1566 gnus-cache-possibly-remove-articles gnus-cache-request-article
1567 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1568 gnus-cache-enter-remove-article gnus-cached-article-p
1569 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1570 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1571 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1572 ("gnus-score" :interactive t
1573 gnus-summary-increase-score gnus-summary-set-score
1574 gnus-summary-raise-thread gnus-summary-raise-same-subject
1575 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1576 gnus-summary-lower-thread gnus-summary-lower-same-subject
1577 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1578 gnus-summary-current-score gnus-score-default
1579 gnus-score-flush-cache gnus-score-close
1580 gnus-possibly-score-headers gnus-score-followup-article
1581 gnus-score-followup-thread)
1583 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1584 gnus-current-score-file-nondirectory gnus-score-adaptive
1585 gnus-score-find-trace gnus-score-file-name)
1586 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1587 ("gnus-topic" :interactive t gnus-topic-mode)
1588 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1589 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1590 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1591 ("gnus-uu" :interactive t
1592 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1593 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1594 gnus-uu-mark-by-regexp gnus-uu-mark-all
1595 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1596 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1597 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1598 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1599 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1600 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1601 gnus-uu-decode-binhex-view)
1602 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1603 ("gnus-msg" (gnus-summary-send-map keymap)
1604 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1605 ("gnus-msg" :interactive t
1606 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1607 gnus-summary-followup gnus-summary-followup-with-original
1608 gnus-summary-cancel-article gnus-summary-supersede-article
1609 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1610 gnus-summary-mail-forward gnus-summary-mail-other-window
1611 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1613 ("gnus-picon" :interactive t gnus-article-display-picons
1614 gnus-group-display-picons gnus-picons-article-display-x-face
1615 gnus-picons-display-x-face)
1616 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1617 gnus-grouplens-mode)
1618 ("smiley" :interactive t gnus-smiley-display)
1619 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1620 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1621 gnus-list-of-unread-articles gnus-list-of-read-articles
1622 gnus-offer-save-summaries gnus-make-thread-indent-array
1623 gnus-summary-exit gnus-update-read-articles)
1624 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1625 gnus-group-list-groups gnus-group-first-unread-group
1626 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1627 gnus-group-setup-buffer gnus-group-get-new-news
1628 gnus-group-make-help-group gnus-group-update-group)
1629 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1630 gnus-backlog-remove-article)
1631 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1632 gnus-article-prepare gnus-article-set-window-start
1633 gnus-article-next-page gnus-article-prev-page
1634 gnus-request-article-this-buffer gnus-article-mode
1635 gnus-article-setup-buffer gnus-narrow-to-page
1636 gnus-article-delete-invisible-text)
1637 ("gnus-art" :interactive t
1638 gnus-article-hide-headers gnus-article-hide-boring-headers
1639 gnus-article-treat-overstrike gnus-article-word-wrap
1640 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1641 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1642 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1643 gnus-article-hide-pem gnus-article-hide-signature
1644 gnus-article-strip-leading-blank-lines gnus-article-date-local
1645 gnus-article-date-original gnus-article-date-lapsed
1646 gnus-article-show-all-headers
1647 gnus-article-edit-mode gnus-article-edit-article
1648 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522)
1649 ("gnus-int" gnus-request-type)
1650 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1652 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1653 gnus-dup-enter-articles)
1654 ("gnus-range" gnus-copy-sequence)
1655 ("gnus-eform" gnus-edit-form)
1656 ("gnus-move" :interactive t
1657 gnus-group-move-group-to-server gnus-change-server)
1658 ("gnus-logic" gnus-score-advanced)
1659 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1660 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1661 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1662 gnus-async-halt-prefetch)
1663 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1664 gnus-summary-save-article-vm))))
1666 ;;; gnus-sum.el thingies
1669 (defcustom gnus-summary-line-format "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
1670 "*The format specification of the lines in the summary buffer.
1672 It works along the same lines as a normal formatting string,
1673 with some simple extensions.
1675 %N Article number, left padded with spaces (string)
1677 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1678 %n Name of the poster (string)
1679 %a Extracted name of the poster (string)
1680 %A Extracted address of the poster (string)
1681 %F Contents of the From: header (string)
1682 %x Contents of the Xref: header (string)
1683 %D Date of the article (string)
1684 %d Date of the article (string) in DD-MMM format
1685 %M Message-id of the article (string)
1686 %r References of the article (string)
1687 %c Number of characters in the article (integer)
1688 %L Number of lines in the article (integer)
1689 %I Indentation based on thread level (a string of spaces)
1690 %T A string with two possible values: 80 spaces if the article
1691 is on thread level two or larger and 0 spaces on level one
1692 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1693 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1694 %[ Opening bracket (character, \"[\" or \"<\")
1695 %] Closing bracket (character, \"]\" or \">\")
1696 %> Spaces of length thread-level (string)
1697 %< Spaces of length (- 20 thread-level) (string)
1698 %i Article score (number)
1699 %z Article zcore (character)
1700 %t Number of articles under the current thread (number).
1701 %e Whether the thread is empty or not (character).
1702 %l GroupLens score (string).
1703 %V Total thread score (number).
1704 %P The line number (number).
1705 %u User defined specifier. The next character in the format string should
1706 be a letter. Gnus will call the function gnus-user-format-function-X,
1707 where X is the letter following %u. The function will be passed the
1708 current header as argument. The function should return a string, which
1709 will be inserted into the summary just like information from any other
1712 Text between %( and %) will be highlighted with `gnus-mouse-face'
1713 when the mouse point is placed inside the area. There can only be one
1716 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1717 with care. For reasons of efficiency, Gnus will compute what column
1718 these characters will end up in, and \"hard-code\" that. This means that
1719 it is illegal to have these specs after a variable-length spec. Well,
1720 you might not be arrested, but your summary buffer will look strange,
1721 which is bad enough.
1723 The smart choice is to have these specs as for to the left as
1726 This restriction may disappear in later versions of Gnus."
1728 :group 'gnus-summary-format)
1731 ;;; Skeleton keymaps
1734 (defun gnus-suppress-keymap (keymap)
1735 (suppress-keymap keymap)
1736 (let ((keys `([delete] "\177" "\M-u"))) ;gnus-mouse-2
1738 (define-key keymap (pop keys) 'undefined))))
1740 (defvar gnus-article-mode-map
1741 (let ((keymap (make-keymap)))
1742 (gnus-suppress-keymap keymap)
1744 (defvar gnus-summary-mode-map
1745 (let ((keymap (make-keymap)))
1746 (gnus-suppress-keymap keymap)
1748 (defvar gnus-group-mode-map
1749 (let ((keymap (make-keymap)))
1750 (gnus-suppress-keymap keymap)
1755 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1756 ;; If you want the cursor to go somewhere else, set these two
1757 ;; functions in some startup hook to whatever you want.
1758 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1759 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1761 ;;; Various macros and substs.
1763 (defun gnus-header-from (header)
1764 (mail-header-from header))
1766 (defmacro gnus-gethash (string hashtable)
1767 "Get hash value of STRING in HASHTABLE."
1768 `(symbol-value (intern-soft ,string ,hashtable)))
1770 (defmacro gnus-sethash (string value hashtable)
1771 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1772 `(set (intern ,string ,hashtable) ,value))
1773 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1775 (defmacro gnus-group-unread (group)
1776 "Get the currently computed number of unread articles in GROUP."
1777 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1779 (defmacro gnus-group-entry (group)
1780 "Get the newsrc entry for GROUP."
1781 `(gnus-gethash ,group gnus-newsrc-hashtb))
1783 (defmacro gnus-active (group)
1784 "Get active info on GROUP."
1785 `(gnus-gethash ,group gnus-active-hashtb))
1787 (defmacro gnus-set-active (group active)
1788 "Set GROUP's active info."
1789 `(gnus-sethash ,group ,active gnus-active-hashtb))
1791 (defun gnus-alive-p ()
1792 "Say whether Gnus is running or not."
1793 (and gnus-group-buffer
1794 (get-buffer gnus-group-buffer)
1796 (set-buffer gnus-group-buffer)
1797 (eq major-mode 'gnus-group-mode))))
1799 ;; Info access macros.
1801 (defmacro gnus-info-group (info)
1803 (defmacro gnus-info-rank (info)
1805 (defmacro gnus-info-read (info)
1807 (defmacro gnus-info-marks (info)
1809 (defmacro gnus-info-method (info)
1811 (defmacro gnus-info-params (info)
1814 (defmacro gnus-info-level (info)
1815 `(let ((rank (gnus-info-rank ,info)))
1819 (defmacro gnus-info-score (info)
1820 `(let ((rank (gnus-info-rank ,info)))
1821 (or (and (consp rank) (cdr rank)) 0)))
1823 (defmacro gnus-info-set-group (info group)
1824 `(setcar ,info ,group))
1825 (defmacro gnus-info-set-rank (info rank)
1826 `(setcar (nthcdr 1 ,info) ,rank))
1827 (defmacro gnus-info-set-read (info read)
1828 `(setcar (nthcdr 2 ,info) ,read))
1829 (defmacro gnus-info-set-marks (info marks &optional extend)
1831 `(gnus-info-set-entry ,info ,marks 3)
1832 `(setcar (nthcdr 3 ,info) ,marks)))
1833 (defmacro gnus-info-set-method (info method &optional extend)
1835 `(gnus-info-set-entry ,info ,method 4)
1836 `(setcar (nthcdr 4 ,info) ,method)))
1837 (defmacro gnus-info-set-params (info params &optional extend)
1839 `(gnus-info-set-entry ,info ,params 5)
1840 `(setcar (nthcdr 5 ,info) ,params)))
1842 (defun gnus-info-set-entry (info entry number)
1843 ;; Extend the info until we have enough elements.
1844 (while (<= (length info) number)
1845 (nconc info (list nil)))
1847 (setcar (nthcdr number info) entry))
1849 (defmacro gnus-info-set-level (info level)
1850 `(let ((rank (cdr ,info)))
1851 (if (consp (car rank))
1852 (setcar (car rank) ,level)
1853 (setcar rank ,level))))
1854 (defmacro gnus-info-set-score (info score)
1855 `(let ((rank (cdr ,info)))
1856 (if (consp (car rank))
1857 (setcdr (car rank) ,score)
1858 (setcar rank (cons (car rank) ,score)))))
1860 (defmacro gnus-get-info (group)
1861 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1863 ;; Byte-compiler warning.
1864 (defvar gnus-visual)
1865 ;; Find out whether the gnus-visual TYPE is wanted.
1866 (defun gnus-visual-p (&optional type class)
1867 (and gnus-visual ; Has to be non-nil, at least.
1868 (if (not type) ; We don't care about type.
1870 (if (listp gnus-visual) ; It's a list, so we check it.
1871 (or (memq type gnus-visual)
1872 (memq class gnus-visual))
1875 ;;; Load the compatability functions.
1884 (defvar gnus-shutdown-alist nil)
1886 (defun gnus-add-shutdown (function &rest symbols)
1887 "Run FUNCTION whenever one of SYMBOLS is shut down."
1888 (push (cons function symbols) gnus-shutdown-alist))
1890 (defun gnus-shutdown (symbol)
1891 "Shut down everything that waits for SYMBOL."
1892 (let ((alist gnus-shutdown-alist)
1894 (while (setq entry (pop alist))
1895 (when (memq symbol (cdr entry))
1896 (funcall (car entry))))))
1900 ;;; Gnus Utility Functions
1903 ;; Add the current buffer to the list of buffers to be killed on exit.
1904 (defun gnus-add-current-to-buffer-list ()
1905 (or (memq (current-buffer) gnus-buffer-list)
1906 (push (current-buffer) gnus-buffer-list)))
1908 (defun gnus-version (&optional arg)
1909 "Version number of this version of Gnus.
1910 If ARG, insert string at point."
1912 (let ((methods gnus-valid-select-methods)
1915 ;; Go through all the legal select methods and add their version
1916 ;; numbers to the total version string. Only the backends that are
1917 ;; currently in use will have their message numbers taken into
1920 (setq meth (intern (concat (caar methods) "-version")))
1922 (stringp (symbol-value meth))
1923 (setq mess (concat mess "; " (symbol-value meth))))
1924 (setq methods (cdr methods)))
1926 (insert (message mess))
1929 (defun gnus-continuum-version (version)
1930 "Return VERSION as a floating point number."
1931 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1932 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1933 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1934 (number (match-string 2 version))
1936 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1937 (setq major (string-to-number (match-string 1 number)))
1938 (setq minor (string-to-number (match-string 2 number)))
1939 (setq least (if (match-beginning 3)
1940 (string-to-number (match-string 3 number))
1944 (format "%s00%02d%02d"
1946 ((member alpha '("(ding)" "d")) "4.99")
1947 ((member alpha '("September" "s")) "5.01")
1948 ((member alpha '("Red" "r")) "5.03"))
1950 (format "%d.%02d%02d" major minor least))))))
1952 (defun gnus-info-find-node ()
1953 "Find Info documentation of Gnus."
1955 ;; Enlarge info window if needed.
1956 (let (gnus-info-buffer)
1957 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1958 (setq gnus-info-buffer (current-buffer))
1959 (gnus-configure-windows 'info)))
1961 ;;; More various functions.
1963 (defun gnus-group-read-only-p (&optional group)
1964 "Check whether GROUP supports editing or not.
1965 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
1966 that that variable is buffer-local to the summary buffers."
1967 (let ((group (or group gnus-newsgroup-name)))
1968 (not (gnus-check-backend-function 'request-replace-article group))))
1970 (defun gnus-group-total-expirable-p (group)
1971 "Check whether GROUP is total-expirable or not."
1972 (let ((params (gnus-group-find-parameter group))
1975 ((memq 'total-expire params)
1977 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
1979 (gnus-total-expirable-newsgroups ; Check var.
1980 (string-match gnus-total-expirable-newsgroups group)))))
1982 (defun gnus-group-auto-expirable-p (group)
1983 "Check whether GROUP is total-expirable or not."
1984 (let ((params (gnus-group-find-parameter group))
1987 ((memq 'auto-expire params)
1989 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
1991 (gnus-auto-expirable-newsgroups ; Check var.
1992 (string-match gnus-auto-expirable-newsgroups group)))))
1994 (defun gnus-virtual-group-p (group)
1995 "Say whether GROUP is virtual or not."
1996 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
1997 gnus-valid-select-methods)))
1999 (defun gnus-news-group-p (group &optional article)
2000 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2001 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2002 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2003 (eq (gnus-request-type group article) 'news))))
2005 ;; Returns a list of writable groups.
2006 (defun gnus-writable-groups ()
2007 (let ((alist gnus-newsrc-alist)
2009 (while (setq group (car (pop alist)))
2010 (unless (gnus-group-read-only-p group)
2011 (push group groups)))
2014 ;; Check whether to use long file names.
2015 (defun gnus-use-long-file-name (symbol)
2016 ;; The variable has to be set...
2017 (and gnus-use-long-file-name
2018 ;; If it isn't a list, then we return t.
2019 (or (not (listp gnus-use-long-file-name))
2020 ;; If it is a list, and the list contains `symbol', we
2022 (not (memq symbol gnus-use-long-file-name)))))
2024 ;; Generate a unique new group name.
2025 (defun gnus-generate-new-group-name (leaf)
2028 (while (gnus-gethash name gnus-newsrc-hashtb)
2029 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2032 (defun gnus-ephemeral-group-p (group)
2033 "Say whether GROUP is ephemeral or not."
2034 (gnus-group-get-parameter group 'quit-config))
2036 (defun gnus-group-quit-config (group)
2037 "Return the quit-config of GROUP."
2038 (gnus-group-get-parameter group 'quit-config))
2040 (defun gnus-kill-ephemeral-group (group)
2041 "Remove ephemeral GROUP from relevant structures."
2042 (gnus-sethash group nil gnus-newsrc-hashtb))
2044 (defun gnus-simplify-mode-line ()
2045 "Make mode lines a bit simpler."
2046 (setq mode-line-modified "-- ")
2047 (when (listp mode-line-format)
2048 (make-local-variable 'mode-line-format)
2049 (setq mode-line-format (copy-sequence mode-line-format))
2050 (when (equal (nth 3 mode-line-format) " ")
2051 (setcar (nthcdr 3 mode-line-format) " "))))
2053 ;;; Servers and groups.
2055 (defsubst gnus-server-add-address (method)
2056 (let ((method-name (symbol-name (car method))))
2057 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2058 (not (assq (intern (concat method-name "-address")) method))
2059 (memq 'physical-address (assq (car method)
2060 gnus-valid-select-methods)))
2061 (append method (list (list (intern (concat method-name "-address"))
2065 (defsubst gnus-server-get-method (group method)
2066 ;; Input either a server name, and extended server name, or a
2067 ;; select method, and return a select method.
2068 (cond ((stringp method)
2069 (gnus-server-to-method method))
2070 ((equal method gnus-select-method)
2072 ((and (stringp (car method)) group)
2073 (gnus-server-extend-method group method))
2074 ((and method (not group)
2075 (equal (cadr method) ""))
2078 (gnus-server-add-address method))))
2080 (defun gnus-server-to-method (server)
2081 "Map virtual server names to select methods."
2083 ;; Is this a method, perhaps?
2084 (and server (listp server) server)
2085 ;; Perhaps this is the native server?
2086 (and (equal server "native") gnus-select-method)
2087 ;; It should be in the server alist.
2088 (cdr (assoc server gnus-server-alist))
2089 ;; It could be in the predefined server alist.
2090 (cdr (assoc server gnus-predefined-server-alist))
2091 ;; If not, we look through all the opened server
2092 ;; to see whether we can find it there.
2093 (let ((opened gnus-opened-servers))
2095 (not (equal server (format "%s:%s" (caaar opened)
2100 (defmacro gnus-method-equal (ss1 ss2)
2101 "Say whether two servers are equal."
2105 (and (= (length s1) (length s2))
2107 (while (and s1 (member (car s1) s2))
2111 (defun gnus-server-equal (m1 m2)
2112 "Say whether two methods are equal."
2113 (let ((m1 (cond ((null m1) gnus-select-method)
2114 ((stringp m1) (gnus-server-to-method m1))
2116 (m2 (cond ((null m2) gnus-select-method)
2117 ((stringp m2) (gnus-server-to-method m2))
2119 (gnus-method-equal m1 m2)))
2121 (defun gnus-servers-using-backend (backend)
2122 "Return a list of known servers using BACKEND."
2123 (let ((opened gnus-opened-servers)
2126 (when (eq backend (caaar opened))
2127 (push (caar opened) out))
2131 (defun gnus-archive-server-wanted-p ()
2132 "Say whether the user wants to use the archive server."
2134 ((or (not gnus-message-archive-method)
2135 (not gnus-message-archive-group))
2137 ((and gnus-message-archive-method gnus-message-archive-group)
2140 (let ((active (cadr (assq 'nnfolder-active-file
2141 gnus-message-archive-method))))
2143 (file-exists-p active))))))
2145 (defun gnus-group-prefixed-name (group method)
2146 "Return the whole name from GROUP and METHOD."
2147 (and (stringp method) (setq method (gnus-server-to-method method)))
2150 (concat (format "%s" (car method))
2152 (or (assoc (format "%s" (car method))
2153 (gnus-methods-using 'address))
2154 (gnus-server-equal method gnus-message-archive-method))
2156 (not (string= (nth 1 method) "")))
2157 (concat "+" (nth 1 method)))
2160 (defun gnus-group-real-prefix (group)
2161 "Return the prefix of the current group name."
2162 (if (string-match "^[^:]+:" group)
2163 (substring group 0 (match-end 0))
2166 (defun gnus-group-method (group)
2167 "Return the server or method used for selecting GROUP.
2168 You should probably use `gnus-find-method-for-group' instead."
2169 (let ((prefix (gnus-group-real-prefix group)))
2170 (if (equal prefix "")
2172 (let ((servers gnus-opened-servers)
2174 backend possible found)
2175 (if (string-match "^[^\\+]+\\+" prefix)
2176 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2177 server (substring prefix (match-end 0) (1- (length prefix))))
2178 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2180 (when (eq (caaar servers) backend)
2181 (setq possible (caar servers))
2182 (when (equal (cadaar servers) server)
2183 (setq found (caar servers))))
2185 (or (car (rassoc found gnus-server-alist))
2187 (car (rassoc possible gnus-server-alist))
2189 (list backend server))))))
2191 (defsubst gnus-secondary-method-p (method)
2192 "Return whether METHOD is a secondary select method."
2193 (let ((methods gnus-secondary-select-methods)
2194 (gmethod (gnus-server-get-method nil method)))
2196 (not (equal (gnus-server-get-method nil (car methods))
2198 (setq methods (cdr methods)))
2201 (defun gnus-group-foreign-p (group)
2202 "Say whether a group is foreign or not."
2203 (and (not (gnus-group-native-p group))
2204 (not (gnus-group-secondary-p group))))
2206 (defun gnus-group-native-p (group)
2207 "Say whether the group is native or not."
2208 (not (string-match ":" group)))
2210 (defun gnus-group-secondary-p (group)
2211 "Say whether the group is secondary or not."
2212 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2214 (defun gnus-group-find-parameter (group &optional symbol)
2215 "Return the group parameters for GROUP.
2216 If SYMBOL, return the value of that symbol in the group parameters."
2218 (set-buffer gnus-group-buffer)
2219 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2221 (gnus-group-parameter-value parameters symbol)
2224 (defun gnus-group-get-parameter (group &optional symbol)
2225 "Return the group parameters for GROUP.
2226 If SYMBOL, return the value of that symbol in the group parameters."
2227 (let ((params (gnus-info-params (gnus-get-info group))))
2229 (gnus-group-parameter-value params symbol)
2232 (defun gnus-group-parameter-value (params symbol)
2233 "Return the value of SYMBOL in group PARAMS."
2234 (or (car (memq symbol params)) ; It's either a simple symbol
2235 (cdr (assq symbol params)))) ; or a cons.
2237 (defun gnus-group-add-parameter (group param)
2238 "Add parameter PARAM to GROUP."
2239 (let ((info (gnus-get-info group)))
2241 () ; This is a dead group. We just ignore it.
2242 ;; Cons the new param to the old one and update.
2243 (gnus-group-set-info (cons param (gnus-info-params info))
2246 (defun gnus-group-set-parameter (group name value)
2247 "Set parameter NAME to VALUE in GROUP."
2248 (let ((info (gnus-get-info group)))
2250 () ; This is a dead group. We just ignore it.
2251 (let ((old-params (gnus-info-params info))
2252 (new-params (list (cons name value))))
2254 (when (or (not (listp (car old-params)))
2255 (not (eq (caar old-params) name)))
2256 (setq new-params (append new-params (list (car old-params)))))
2257 (setq old-params (cdr old-params)))
2258 (gnus-group-set-info new-params group 'params)))))
2260 (defun gnus-group-add-score (group &optional score)
2261 "Add SCORE to the GROUP score.
2262 If SCORE is nil, add 1 to the score of GROUP."
2263 (let ((info (gnus-get-info group)))
2265 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2267 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2268 (defun gnus-short-group-name (group &optional levels)
2269 "Collapse GROUP name LEVELS.
2270 Select methods are stripped and any remote host name is stripped down to
2271 just the host name."
2272 (let* ((name "") (foreign "") (depth -1) (skip 1)
2275 (while (string-match "\\." group skip)
2276 (setq skip (match-end 0)
2279 ;; separate foreign select method from group name and collapse.
2280 ;; if method contains a server, collapse to non-domain server name,
2281 ;; otherwise collapse to select method
2282 (when (string-match ":" group)
2283 (cond ((string-match "+" group)
2284 (let* ((plus (string-match "+" group))
2285 (colon (string-match ":" group (or plus 0)))
2286 (dot (string-match "\\." group)))
2287 (setq foreign (concat
2288 (substring group (+ 1 plus)
2289 (cond ((null dot) colon)
2290 ((< colon dot) colon)
2291 ((< dot colon) dot)))
2293 group (substring group (+ 1 colon)))))
2295 (let* ((colon (string-match ":" group)))
2296 (setq foreign (concat (substring group 0 (+ 1 colon)))
2297 group (substring group (+ 1 colon)))))))
2298 ;; collapse group name leaving LEVELS uncollapsed elements
2300 (if (and (string-match "\\." group) (> levels 0))
2301 (setq name (concat name (substring group 0 1))
2302 group (substring group (match-end 0))
2304 name (concat name "."))
2305 (setq name (concat foreign name group)
2309 (defun gnus-narrow-to-body ()
2310 "Narrow to the body of an article."
2313 (goto-char (point-min))
2314 (or (search-forward "\n\n" nil t)
2320 ;;; Kill file handling.
2323 (defun gnus-apply-kill-file ()
2324 "Apply a kill file to the current newsgroup.
2325 Returns the number of articles marked as read."
2326 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2327 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2328 (gnus-apply-kill-file-internal)
2331 (defun gnus-kill-save-kill-buffer ()
2332 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2333 (when (get-file-buffer file)
2335 (set-buffer (get-file-buffer file))
2336 (when (buffer-modified-p)
2338 (kill-buffer (current-buffer))))))
2340 (defcustom gnus-kill-file-name "KILL"
2341 "Suffix of the kill files."
2342 :group 'gnus-score-kill
2343 :group 'gnus-score-files
2346 (defun gnus-newsgroup-kill-file (newsgroup)
2347 "Return the name of a kill file name for NEWSGROUP.
2348 If NEWSGROUP is nil, return the global kill file name instead."
2350 ;; The global KILL file is placed at top of the directory.
2351 ((or (null newsgroup)
2352 (string-equal newsgroup ""))
2353 (expand-file-name gnus-kill-file-name
2354 gnus-kill-files-directory))
2355 ;; Append ".KILL" to newsgroup name.
2356 ((gnus-use-long-file-name 'not-kill)
2357 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2358 "." gnus-kill-file-name)
2359 gnus-kill-files-directory))
2360 ;; Place "KILL" under the hierarchical directory.
2362 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2363 "/" gnus-kill-file-name)
2364 gnus-kill-files-directory))))
2368 (defun gnus-member-of-valid (symbol group)
2369 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2371 (symbol-name (car (gnus-find-method-for-group group)))
2372 gnus-valid-select-methods)))
2374 (defun gnus-method-option-p (method option)
2375 "Return non-nil if select METHOD has OPTION as a parameter."
2376 (when (stringp method)
2377 (setq method (gnus-server-to-method method)))
2378 (memq option (assoc (format "%s" (car method))
2379 gnus-valid-select-methods)))
2381 (defun gnus-server-extend-method (group method)
2382 ;; This function "extends" a virtual server. If the server is
2383 ;; "hello", and the select method is ("hello" (my-var "something"))
2384 ;; in the group "alt.alt", this will result in a new virtual server
2385 ;; called "hello+alt.alt".
2386 (if (or (not (gnus-similar-server-opened method))
2387 (not (cddr method)))
2389 `(,(car method) ,(concat (cadr method) "+" group)
2390 (,(intern (format "%s-address" (car method))) ,(cadr method))
2393 (defun gnus-similar-server-opened (method)
2394 (let ((opened gnus-opened-servers))
2395 (while (and method opened)
2396 (when (and (equal (cadr method) (cadaar opened))
2397 (not (equal method (caar opened))))
2402 (defun gnus-server-status (method)
2403 "Return the status of METHOD."
2404 (nth 1 (assoc method gnus-opened-servers)))
2406 (defun gnus-group-name-to-method (group)
2407 "Guess a select method based on GROUP."
2408 (if (string-match ":" group)
2409 (let ((server (substring group 0 (match-beginning 0))))
2410 (if (string-match "\\+" server)
2411 (list (intern (substring server 0 (match-beginning 0)))
2412 (substring server (match-end 0)))
2413 (list (intern server) "")))
2414 gnus-select-method))
2416 (defun gnus-find-method-for-group (group &optional info)
2417 "Find the select method that GROUP uses."
2418 (or gnus-override-method
2421 (let ((info (or info (gnus-get-info group)))
2424 (not (setq method (gnus-info-method info)))
2425 (equal method "native"))
2428 (cond ((stringp method)
2429 (gnus-server-to-method method))
2430 ((stringp (cadr method))
2431 (gnus-server-extend-method group method))
2434 (cond ((equal (cadr method) "")
2436 ((null (cadr method))
2437 (list (car method) ""))
2439 (gnus-server-add-address method)))))))
2441 (defun gnus-check-backend-function (func group)
2442 "Check whether GROUP supports function FUNC.
2443 GROUP can either be a string (a group name) or a select method."
2445 (let ((method (if (stringp group)
2446 (car (gnus-find-method-for-group group))
2448 (unless (featurep method)
2450 (fboundp (intern (format "%s-%s" method func))))))
2452 (defun gnus-methods-using (feature)
2453 "Find all methods that have FEATURE."
2454 (let ((valids gnus-valid-select-methods)
2457 (when (memq feature (car valids))
2458 (push (car valids) outs))
2459 (setq valids (cdr valids)))
2462 (defun gnus-read-group (prompt &optional default)
2463 "Prompt the user for a group name.
2464 Disallow illegal group names."
2470 (setq group (read-string (concat prefix prompt)
2471 (cons (or default "") 0)
2472 'gnus-group-history)))
2473 (setq prefix (format "Illegal group name: \"%s\". " group)
2477 (defun gnus-read-method (prompt)
2478 "Prompt the user for a method.
2479 Allow completion over sensible values."
2482 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2484 nil t nil 'gnus-method-history)))
2487 (setq method gnus-select-method))
2488 ((assoc method gnus-valid-select-methods)
2489 (list (intern method)
2490 (if (memq 'prompt-address
2491 (assoc method gnus-valid-select-methods))
2492 (read-string "Address: ")
2494 ((assoc method gnus-server-alist)
2497 (list (intern method) "")))))
2499 ;;; User-level commands.
2502 (defun gnus-slave-no-server (&optional arg)
2503 "Read network news as a slave, without connecting to local server"
2505 (gnus-no-server arg t))
2508 (defun gnus-no-server (&optional arg slave)
2510 If ARG is a positive number, Gnus will use that as the
2511 startup level. If ARG is nil, Gnus will be started at level 2.
2512 If ARG is non-nil and not a positive number, Gnus will
2513 prompt the user for the name of an NNTP server to use.
2514 As opposed to `gnus', this command will not connect to the local server."
2516 (gnus-no-server-1 arg slave))
2519 (defun gnus-slave (&optional arg)
2520 "Read news as a slave."
2522 (gnus arg nil 'slave))
2525 (defun gnus-other-frame (&optional arg)
2526 "Pop up a frame to read news."
2528 (let ((window (get-buffer-window gnus-group-buffer)))
2530 (select-frame (window-frame window)))
2531 ((= (length (frame-list)) 1)
2532 (select-frame (make-frame)))
2538 (defun gnus (&optional arg dont-connect slave)
2540 If ARG is non-nil and a positive number, Gnus will use that as the
2541 startup level. If ARG is non-nil and not a positive number, Gnus will
2542 prompt the user for the name of an NNTP server to use."
2544 (gnus-1 arg dont-connect slave))
2546 ;; Allow redefinition of Gnus functions.
2552 ;;; gnus.el ends here