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.58"
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-character-to-event 'identity)
262 (defalias 'gnus-add-text-properties 'add-text-properties)
263 (defalias 'gnus-put-text-property 'put-text-property)
264 (defalias 'gnus-mode-line-buffer-identification 'identity)
265 (defalias 'gnus-characterp 'numberp)
266 (defalias 'gnus-key-press-event-p 'numberp))
268 ;; The XEmacs people think this is evil, so it must go.
269 (defun custom-face-lookup (&optional fg bg stipple bold italic underline)
270 "Lookup or create a face with specified attributes."
271 (let ((name (intern (format "custom-face-%s-%s-%s-%S-%S-%S"
274 (or stipple "default")
275 bold italic underline))))
276 (if (and (custom-facep name)
277 (fboundp 'make-face))
279 (copy-face 'default name)
281 (not (string-equal fg "default")))
283 (set-face-foreground name fg)))
285 (not (string-equal bg "default")))
287 (set-face-background name bg)))
289 (not (string-equal stipple "default"))
290 (not (eq stipple 'custom:asis))
291 (fboundp 'set-face-stipple))
292 (set-face-stipple name stipple))
294 (not (eq bold 'custom:asis)))
296 (make-face-bold name)))
298 (not (eq italic 'custom:asis)))
300 (make-face-italic name)))
302 (not (eq underline 'custom:asis)))
304 (set-face-underline-p name t))))
307 ;; We define these group faces here to avoid the display
308 ;; update forced when creating new faces.
310 (defface gnus-group-news-1-face
313 (:foreground "PaleTurquoise" :bold t))
316 (:foreground "ForestGreen" :bold t))
319 "Level 1 newsgroup face.")
321 (defface gnus-group-news-1-empty-face
324 (:foreground "PaleTurquoise"))
327 (:foreground "ForestGreen"))
330 "Level 1 empty newsgroup face.")
332 (defface gnus-group-news-2-face
335 (:foreground "turquoise" :bold t))
338 (:foreground "CadetBlue4" :bold t))
341 "Level 2 newsgroup face.")
343 (defface gnus-group-news-2-empty-face
346 (:foreground "turquoise"))
349 (:foreground "CadetBlue4"))
352 "Level 2 empty newsgroup face.")
354 (defface gnus-group-news-3-face
363 "Level 3 newsgroup face.")
365 (defface gnus-group-news-3-empty-face
374 "Level 3 empty newsgroup face.")
376 (defface gnus-group-news-low-face
379 (:foreground "DarkTurquoise" :bold t))
382 (:foreground "DarkGreen" :bold t))
385 "Low level newsgroup face.")
387 (defface gnus-group-news-low-empty-face
390 (:foreground "DarkTurquoise"))
393 (:foreground "DarkGreen"))
396 "Low level empty newsgroup face.")
398 (defface gnus-group-mail-1-face
401 (:foreground "aquamarine1" :bold t))
404 (:foreground "DeepPink3" :bold t))
407 "Level 1 mailgroup face.")
409 (defface gnus-group-mail-1-empty-face
412 (:foreground "aquamarine1"))
415 (:foreground "DeepPink3"))
417 (:italic t :bold t)))
418 "Level 1 empty mailgroup face.")
420 (defface gnus-group-mail-2-face
423 (:foreground "aquamarine2" :bold t))
426 (:foreground "HotPink3" :bold t))
429 "Level 2 mailgroup face.")
431 (defface gnus-group-mail-2-empty-face
434 (:foreground "aquamarine2"))
437 (:foreground "HotPink3"))
440 "Level 2 empty mailgroup face.")
442 (defface gnus-group-mail-3-face
445 (:foreground "aquamarine3" :bold t))
448 (:foreground "magenta4" :bold t))
451 "Level 3 mailgroup face.")
453 (defface gnus-group-mail-3-empty-face
456 (:foreground "aquamarine3"))
459 (:foreground "magenta4"))
462 "Level 3 empty mailgroup face.")
464 (defface gnus-group-mail-low-face
467 (:foreground "aquamarine4" :bold t))
470 (:foreground "DeepPink4" :bold t))
473 "Low level mailgroup face.")
475 (defface gnus-group-mail-low-empty-face
478 (:foreground "aquamarine4"))
481 (:foreground "DeepPink4"))
484 "Low level empty mailgroup face.")
486 ;; Summary mode faces.
488 (defface gnus-summary-selected-face '((t
490 "Face used for selected articles.")
492 (defface gnus-summary-cancelled-face
494 (:foreground "yellow" :background "black")))
495 "Face used for cancelled articles.")
497 (defface gnus-summary-high-ticked-face
500 (:foreground "pink" :bold t))
503 (:foreground "firebrick" :bold t))
506 "Face used for high interest ticked articles.")
508 (defface gnus-summary-low-ticked-face
511 (:foreground "pink" :italic t))
514 (:foreground "firebrick" :italic t))
517 "Face used for low interest ticked articles.")
519 (defface gnus-summary-normal-ticked-face
522 (:foreground "pink"))
525 (:foreground "firebrick"))
528 "Face used for normal interest ticked articles.")
530 (defface gnus-summary-high-ancient-face
533 (:foreground "SkyBlue" :bold t))
536 (:foreground "RoyalBlue" :bold t))
539 "Face used for high interest ancient articles.")
541 (defface gnus-summary-low-ancient-face
544 (:foreground "SkyBlue" :italic t))
547 (:foreground "RoyalBlue" :italic t))
550 "Face used for low interest ancient articles.")
552 (defface gnus-summary-normal-ancient-face
555 (:foreground "SkyBlue"))
558 (:foreground "RoyalBlue"))
561 "Face used for normal interest ancient articles.")
563 (defface gnus-summary-high-unread-face
566 "Face used for high interest unread articles.")
568 (defface gnus-summary-low-unread-face
571 "Face used for low interest unread articles.")
573 (defface gnus-summary-normal-unread-face
576 "Face used for normal interest unread articles.")
578 (defface gnus-summary-high-read-face
581 (:foreground "PaleGreen"
585 (:foreground "DarkGreen"
589 "Face used for high interest read articles.")
591 (defface gnus-summary-low-read-face
594 (:foreground "PaleGreen"
598 (:foreground "DarkGreen"
602 "Face used for low interest read articles.")
604 (defface gnus-summary-normal-read-face
607 (:foreground "PaleGreen"))
610 (:foreground "DarkGreen"))
613 "Face used for normal interest read articles.")
618 (defvar gnus-group-buffer "*Group*")
621 (autoload 'gnus-play-jingle "gnus-audio"))
623 (defface gnus-splash-face
632 "Level 1 newsgroup face.")
634 (defun gnus-splash ()
636 (switch-to-buffer gnus-group-buffer)
637 (let ((buffer-read-only nil))
639 (unless gnus-inhibit-startup-message
640 (gnus-group-startup-message)
642 (when gnus-play-startup-jingle
643 (gnus-play-jingle))))))
645 (defun gnus-indent-rigidly (start end arg)
646 "Indent rigidly using only spaces and no tabs."
649 (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-home-directory "~/"
715 "Directory variable that specifies the \"home\" directory.
716 All other Gnus path variables are initialized from this variable."
720 (defcustom gnus-directory (or (getenv "SAVEDIR")
721 (nnheader-concat gnus-home-directory "News/"))
722 "Directory variable from which all other Gnus file variables are derived."
726 (defcustom gnus-default-directory nil
727 "*Default directory for all Gnus buffers."
729 :type '(choice (const :tag "current" nil)
732 ;; Site dependent variables. These variables should be defined in
735 (defvar gnus-default-nntp-server nil
736 "Specify a default NNTP server.
737 This variable should be defined in paths.el, and should never be set
739 If you want to change servers, you should use `gnus-select-method'.
740 See the documentation to that variable.")
742 ;; Don't touch this variable.
743 (defvar gnus-nntp-service "nntp"
744 "NNTP service name (\"nntp\" or 119).
745 This is an obsolete variable, which is scarcely used. If you use an
746 nntp server for your newsgroup and want to change the port number
747 used to 899, you would say something along these lines:
749 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
751 (defcustom gnus-nntpserver-file "/etc/nntpserver"
752 "A file with only the name of the nntp server in it."
757 ;; This function is used to check both the environment variable
758 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
759 ;; an nntp server name default.
760 (defun gnus-getenv-nntpserver ()
761 (or (getenv "NNTPSERVER")
762 (and (file-readable-p gnus-nntpserver-file)
764 (set-buffer (get-buffer-create " *gnus nntp*"))
765 (buffer-disable-undo (current-buffer))
766 (insert-file-contents gnus-nntpserver-file)
767 (let ((name (buffer-string)))
769 (if (string-match "^[ \t\n]*$" name)
772 (kill-buffer (current-buffer))))))))
774 (defcustom gnus-select-method
777 (list 'nntp (or (ignore-errors
778 (gnus-getenv-nntpserver))
779 (when (and gnus-default-nntp-server
780 (not (string= gnus-default-nntp-server "")))
781 gnus-default-nntp-server)
783 (if (or (null gnus-nntp-service)
784 (equal gnus-nntp-service "nntp"))
786 (list gnus-nntp-service))))
787 "Default method for selecting a newsgroup.
788 This variable should be a list, where the first element is how the
789 news is to be fetched, the second is the address.
791 For instance, if you want to get your news via NNTP from
792 \"flab.flab.edu\", you could say:
794 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
796 If you want to use your local spool, say:
798 \(setq gnus-select-method (list 'nnspool (system-name)))
800 If you use this variable, you must set `gnus-nntp-server' to nil.
802 There is a lot more to know about select methods and virtual servers -
803 see the manual for details."
805 :type 'gnus-select-method)
807 (defcustom gnus-message-archive-method
810 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
811 (nnfolder-active-file
812 ,(nnheader-concat message-directory "archive/active"))
813 (nnfolder-get-new-mail nil)
814 (nnfolder-inhibit-expiry t))
815 "Method used for archiving messages you've sent.
816 This should be a mail method.
818 It's probably not a very effective to change this variable once you've
819 run Gnus once. After doing that, you must edit this server from the
823 :type 'gnus-select-method)
825 (defcustom gnus-message-archive-group nil
826 "*Name of the group in which to save the messages you've written.
827 This can either be a string; a list of strings; or an alist
828 of regexps/functions/forms to be evaluated to return a string (or a list
829 of strings). The functions are called with the name of the current
830 group (or nil) as a parameter.
832 If you want to save your mail in one group and the news articles you
833 write in another group, you could say something like:
835 \(setq gnus-message-archive-group
836 '((if (message-news-p)
840 Normally the group names returned by this variable should be
841 unprefixed -- which implicitly means \"store on the archive server\".
842 However, you may wish to store the message on some other server. In
843 that case, just return a fully prefixed name of the group --
844 \"nnml+private:mail.misc\", for instance."
846 :type '(choice (const :tag "none" nil)
849 (defcustom gnus-secondary-servers nil
850 "List of NNTP servers that the user can choose between interactively.
851 To make Gnus query you for a server, you have to give `gnus' a
852 non-numeric prefix - `C-u M-x gnus', in short."
854 :type '(repeat string))
856 (defcustom gnus-nntp-server nil
857 "*The name of the host running the NNTP server.
858 This variable is semi-obsolete. Use the `gnus-select-method'
861 :type '(choice (const :tag "disable" nil)
864 (defcustom gnus-secondary-select-methods nil
865 "A list of secondary methods that will be used for reading news.
866 This is a list where each element is a complete select method (see
867 `gnus-select-method').
869 If, for instance, you want to read your mail with the nnml backend,
870 you could set this variable:
872 \(setq gnus-secondary-select-methods '((nnml \"\")))"
874 :type '(repeat gnus-select-method))
876 (defvar gnus-backup-default-subscribed-newsgroups
877 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
878 "Default default new newsgroups the first time Gnus is run.
879 Should be set in paths.el, and shouldn't be touched by the user.")
881 (defcustom gnus-local-domain nil
882 "Local domain name without a host name.
883 The DOMAINNAME environment variable is used instead if it is defined.
884 If the `system-name' function returns the full Internet name, there is
885 no need to set this variable."
887 :type '(choice (const :tag "default" nil)
890 (defvar gnus-local-organization nil
891 "String with a description of what organization (if any) the user belongs to.
892 Obsolete variable; use `message-user-organization' instead.")
894 ;; Customization variables
896 (defcustom gnus-refer-article-method nil
897 "Preferred method for fetching an article by Message-ID.
898 If you are reading news from the local spool (with nnspool), fetching
899 articles by Message-ID is painfully slow. By setting this method to an
900 nntp method, you might get acceptable results.
902 The value of this variable must be a valid select method as discussed
903 in the documentation of `gnus-select-method'."
905 :type '(choice (const :tag "default" nil)
908 (defcustom gnus-group-faq-directory
909 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
910 "/ftp@sunsite.auc.dk:/pub/usenet/"
911 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
912 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
913 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
914 "/ftp@rtfm.mit.edu:/pub/usenet/"
915 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
916 "/ftp@ftp.sunet.se:/pub/usenet/"
917 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
918 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
919 "/ftp@ftp.hk.super.net:/mirror/faqs/")
920 "Directory where the group FAQs are stored.
921 This will most commonly be on a remote machine, and the file will be
924 This variable can also be a list of directories. In that case, the
925 first element in the list will be used by default. The others can
926 be used when being prompted for a site.
928 Note that Gnus uses an aol machine as the default directory. If this
929 feels fundamentally unclean, just think of it as a way to finally get
930 something of value back from them.
932 If the default site is too slow, try one of these:
934 North America: mirrors.aol.com /pub/rtfm/usenet
935 ftp.seas.gwu.edu /pub/rtfm
936 rtfm.mit.edu /pub/usenet
937 Europe: ftp.uni-paderborn.de /pub/FAQ
938 src.doc.ic.ac.uk /usenet/news-FAQS
939 ftp.sunet.se /pub/usenet
940 sunsite.auc.dk /pub/usenet
941 Asia: nctuccca.edu.tw /USENET/FAQ
942 hwarang.postech.ac.kr /pub/usenet
943 ftp.hk.super.net /mirror/faqs"
944 :group 'gnus-group-various
945 :type '(choice directory
948 (defcustom gnus-use-cross-reference t
949 "*Non-nil means that cross referenced articles will be marked as read.
950 If nil, ignore cross references. If t, mark articles as read in
951 subscribed newsgroups. If neither t nor nil, mark as read in all
954 :type '(choice (const :tag "off" nil)
955 (const :tag "subscribed" t)
959 (defcustom gnus-process-mark ?#
961 :group 'gnus-group-visual
962 :group 'gnus-summary-marks
965 (defcustom gnus-asynchronous nil
966 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
967 :group 'gnus-asynchronous
970 (defcustom gnus-large-newsgroup 200
971 "*The number of articles which indicates a large newsgroup.
972 If the number of articles in a newsgroup is greater than this value,
973 confirmation is required for selecting the newsgroup."
974 :group 'gnus-group-select
977 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
978 "*Non-nil means that the default name of a file to save articles in is the group name.
979 If it's nil, the directory form of the group name is used instead.
981 If this variable is a list, and the list contains the element
982 `not-score', long file names will not be used for score files; if it
983 contains the element `not-save', long file names will not be used for
984 saving; and if it contains the element `not-kill', long file names
985 will not be used for kill files.
987 Note that the default for this variable varies according to what system
988 type you're using. On `usg-unix-v' and `xenix' this variable defaults
989 to nil while on all other systems it defaults to t."
993 (defcustom gnus-kill-files-directory gnus-directory
994 "*Name of the directory where kill files will be stored (default \"~/News\")."
995 :group 'gnus-score-files
996 :group 'gnus-score-kill
999 (defcustom gnus-save-score nil
1000 "*If non-nil, save group scoring info."
1001 :group 'gnus-score-various
1005 (defcustom gnus-use-undo t
1006 "*If non-nil, allow undoing in Gnus group mode buffers."
1010 (defcustom gnus-use-adaptive-scoring nil
1011 "*If non-nil, use some adaptive scoring scheme.
1012 If a list, then the values `word' and `line' are meaningful. The
1013 former will perform adaption on individual words in the subject
1014 header while `line' will perform adaption on several headers."
1016 :group 'gnus-score-adapt
1017 :type '(set (const word) (const line)))
1019 (defcustom gnus-use-cache 'passive
1020 "*If nil, Gnus will ignore the article cache.
1021 If `passive', it will allow entering (and reading) articles
1022 explicitly entered into the cache. If anything else, use the
1023 cache to the full extent of the law."
1026 :type '(choice (const :tag "off" nil)
1027 (const :tag "passive" passive)
1028 (const :tag "active" t)))
1030 (defcustom gnus-use-trees nil
1031 "*If non-nil, display a thread tree buffer."
1035 (defcustom gnus-use-grouplens nil
1036 "*If non-nil, use GroupLens ratings."
1040 (defcustom gnus-keep-backlog nil
1041 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1042 If it is a number N, then Gnus will only keep the last N articles
1043 read. If it is neither nil nor a number, Gnus will keep all read
1044 articles. This is not a good idea."
1046 :type '(choice (const :tag "off" nil)
1051 (defcustom gnus-use-nocem nil
1052 "*If non-nil, Gnus will read NoCeM cancel messages."
1056 (defcustom gnus-suppress-duplicates nil
1057 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1061 (defcustom gnus-use-demon nil
1062 "If non-nil, Gnus might use some demons."
1066 (defcustom gnus-use-scoring t
1067 "*If non-nil, enable scoring."
1071 (defcustom gnus-use-picons nil
1072 "*If non-nil, display picons."
1076 (defcustom gnus-summary-prepare-exit-hook
1077 '(gnus-summary-expire-articles)
1078 "A hook called when preparing to exit from the summary buffer.
1079 It calls `gnus-summary-expire-articles' by default."
1080 :group 'gnus-summary-exit
1083 (defcustom gnus-novice-user t
1084 "*Non-nil means that you are a usenet novice.
1085 If non-nil, verbose messages may be displayed and confirmations may be
1090 (defcustom gnus-expert-user nil
1091 "*Non-nil means that you will never be asked for confirmation about anything.
1092 And that means *anything*."
1096 (defcustom gnus-interactive-catchup t
1097 "*If non-nil, require your confirmation when catching up a group."
1098 :group 'gnus-group-select
1101 (defcustom gnus-interactive-exit t
1102 "*If non-nil, require your confirmation when exiting Gnus."
1106 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1107 "*Function for extracting address components from a From header.
1108 Two pre-defined function exist: `gnus-extract-address-components',
1109 which is the default, quite fast, and too simplistic solution, and
1110 `mail-extract-address-components', which works much better, but is
1112 :group 'gnus-summary-format
1113 :type '(radio (function-item gnus-extract-address-components)
1114 (function-item mail-extract-address-components)
1115 (function :tag "Other")))
1117 (defcustom gnus-carpal nil
1118 "*If non-nil, display clickable icons."
1122 (defcustom gnus-shell-command-separator ";"
1123 "String used to separate to shell commands."
1127 (defcustom gnus-valid-select-methods
1128 '(("nntp" post address prompt-address physical-address)
1129 ("nnspool" post address)
1130 ("nnvirtual" post-mail virtual prompt-address)
1131 ("nnmbox" mail respool address)
1132 ("nnml" mail respool address)
1133 ("nnmh" mail respool address)
1134 ("nndir" post-mail prompt-address physical-address)
1135 ("nneething" none address prompt-address physical-address)
1136 ("nndoc" none address prompt-address)
1137 ("nnbabyl" mail address respool)
1138 ("nnkiboze" post virtual)
1139 ("nnsoup" post-mail address)
1140 ("nndraft" post-mail)
1141 ("nnfolder" mail respool address)
1142 ("nngateway" none address prompt-address physical-address)
1144 "An alist of valid select methods.
1145 The first element of each list lists should be a string with the name
1146 of the select method. The other elements may be the category of
1147 this method (i. e., `post', `mail', `none' or whatever) or other
1148 properties that this method has (like being respoolable).
1149 If you implement a new select method, all you should have to change is
1150 this variable. I think."
1152 :type '(repeat (group (string :tag "Name")
1153 (radio-button-choice (const :format "%v " post)
1154 (const :format "%v " mail)
1155 (const :format "%v " none)
1157 (checklist :inline t
1158 (const :format "%v " address)
1159 (const :format "%v " prompt-address)
1160 (const :format "%v " virtual)
1163 (define-widget 'gnus-select-method 'list
1164 "Widget for entering a select method."
1165 :args `((choice :tag "Method"
1166 ,@(mapcar (lambda (entry)
1167 (list 'const :format "%v\n"
1168 (intern (car entry))))
1169 gnus-valid-select-methods))
1170 (string :tag "Address")
1171 (editable-list :inline t
1174 (sexp :tag "Value")))))
1176 (defcustom gnus-updated-mode-lines '(group article summary tree)
1177 "List of buffers that should update their mode lines.
1178 The list may contain the symbols `group', `article', `tree' and
1179 `summary'. If the corresponding symbol is present, Gnus will keep
1180 that mode line updated with information that may be pertinent.
1181 If this variable is nil, screen refresh may be quicker."
1182 :group 'gnus-various
1183 :type '(set (const group)
1188 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1189 (defcustom gnus-mode-non-string-length nil
1190 "*Max length of mode-line non-string contents.
1191 If this is nil, Gnus will take space as is needed, leaving the rest
1192 of the modeline intact. Note that the default of nil is unlikely
1193 to be desirable; see the manual for further details."
1194 :group 'gnus-various
1195 :type '(choice (const nil)
1198 (defcustom gnus-auto-expirable-newsgroups nil
1199 "*Groups in which to automatically mark read articles as expirable.
1200 If non-nil, this should be a regexp that should match all groups in
1201 which to perform auto-expiry. This only makes sense for mail groups."
1202 :group 'nnmail-expire
1203 :type '(choice (const nil)
1206 (defcustom gnus-total-expirable-newsgroups nil
1207 "*Groups in which to perform expiry of all read articles.
1208 Use with extreme caution. All groups that match this regexp will be
1209 expiring - which means that all read articles will be deleted after
1210 \(say) one week. (This only goes for mail groups and the like, of
1212 :group 'nnmail-expire
1213 :type '(choice (const nil)
1216 (defcustom gnus-group-uncollapsed-levels 1
1217 "Number of group name elements to leave alone when making a short group name."
1218 :group 'gnus-group-visual
1221 (defcustom gnus-group-use-permanent-levels nil
1222 "*If non-nil, once you set a level, Gnus will use this level."
1223 :group 'gnus-group-levels
1228 (defcustom gnus-load-hook nil
1229 "A hook run while Gnus is loaded."
1233 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1234 "A hook called to apply kill files to a group.
1235 This hook is intended to apply a kill file to the selected newsgroup.
1236 The function `gnus-apply-kill-file' is called by default.
1238 Since a general kill file is too heavy to use only for a few
1239 newsgroups, I recommend you to use a lighter hook function. For
1240 example, if you'd like to apply a kill file to articles which contains
1241 a string `rmgroup' in subject in newsgroup `control', you can use the
1244 (setq gnus-apply-kill-hook
1247 (cond ((string-match \"control\" gnus-newsgroup-name)
1248 (gnus-kill \"Subject\" \"rmgroup\")
1249 (gnus-expunge \"X\"))))))"
1250 :group 'gnus-score-kill
1251 :options '(gnus-apply-kill-file)
1254 (defcustom gnus-group-change-level-function nil
1255 "Function run when a group level is changed.
1256 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1257 :group 'gnus-group-level
1262 (defcustom gnus-visual
1263 '(summary-highlight group-highlight article-highlight
1265 summary-menu group-menu article-menu
1266 tree-highlight menu highlight
1267 browse-menu server-menu
1268 page-marker tree-menu binary-menu pick-menu
1270 "Enable visual features.
1271 If `visual' is disabled, there will be no menus and few faces. Most of
1272 the visual customization options below will be ignored. Gnus will use
1273 less space and be faster as a result.
1275 This variable can also be a list of visual elements to switch on. For
1276 instance, to switch off all visual things except menus, you can say:
1278 (setq gnus-visual '(menu))
1280 Valid elements include `summary-highlight', `group-highlight',
1281 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1282 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1283 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1284 and `grouplens-menu'."
1287 :type '(set (const summary-highlight)
1288 (const group-highlight)
1289 (const article-highlight)
1291 (const summary-menu)
1293 (const article-menu)
1294 (const tree-highlight)
1303 (const grouplens-menu)))
1305 (defcustom gnus-mouse-face
1307 (if (gnus-visual-p 'mouse-face 'highlight)
1308 (if (boundp 'gnus-mouse-face)
1309 (or gnus-mouse-face 'highlight)
1313 "Face used for group or summary buffer mouse highlighting.
1314 The line beneath the mouse pointer will be highlighted with this
1319 (defcustom gnus-article-display-hook
1320 (if (and (string-match "XEmacs" emacs-version)
1322 '(gnus-article-hide-headers-if-wanted
1323 gnus-article-hide-boring-headers
1324 gnus-article-treat-overstrike
1325 gnus-article-maybe-highlight
1326 gnus-article-display-x-face)
1327 '(gnus-article-hide-headers-if-wanted
1328 gnus-article-hide-boring-headers
1329 gnus-article-treat-overstrike
1330 gnus-article-maybe-highlight))
1331 "Controls how the article buffer will look.
1333 If you leave the list empty, the article will appear exactly as it is
1334 stored on the disk. The list entries will hide or highlight various
1335 parts of the article, making it easier to find the information you
1337 :group 'gnus-article-highlight
1340 :options '(gnus-article-add-buttons
1341 gnus-article-add-buttons-to-head
1342 gnus-article-emphasize
1343 gnus-article-fill-cited-article
1344 gnus-article-remove-cr
1345 gnus-article-de-quoted-unreadable
1346 gnus-summary-stop-page-breaking
1347 ;; gnus-summary-caesar-message
1348 ;; gnus-summary-verbose-headers
1349 gnus-summary-toggle-mime
1351 gnus-article-hide-headers
1352 gnus-article-hide-boring-headers
1353 gnus-article-hide-signature
1354 gnus-article-hide-citation
1355 gnus-article-hide-pgp
1356 gnus-article-hide-pem
1357 gnus-article-highlight
1358 gnus-article-highlight-headers
1359 gnus-article-highlight-citation
1360 gnus-article-highlight-signature
1361 gnus-article-date-ut
1362 gnus-article-date-local
1363 gnus-article-date-lapsed
1364 gnus-article-date-original
1365 gnus-article-remove-trailing-blank-lines
1366 gnus-article-strip-leading-blank-lines
1367 gnus-article-strip-multiple-blank-lines
1368 gnus-article-strip-blank-lines
1369 gnus-article-treat-overstrike
1370 gnus-article-display-x-face
1371 gnus-smiley-display))
1373 (defcustom gnus-article-save-directory gnus-directory
1374 "*Name of the directory articles will be saved in (default \"~/News\")."
1375 :group 'gnus-article-saving
1379 ;;; Internal variables
1381 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1382 (defvar gnus-original-article-buffer " *Original Article*")
1383 (defvar gnus-newsgroup-name nil)
1385 (defvar gnus-current-select-method nil
1386 "The current method for selecting a newsgroup.")
1388 (defvar gnus-tree-buffer "*Tree*"
1389 "Buffer where Gnus thread trees are displayed.")
1392 (defvar gnus-use-generic-from nil)
1394 ;; Variable holding the user answers to all method prompts.
1395 (defvar gnus-method-history nil)
1396 (defvar gnus-group-history nil)
1398 ;; Variable holding the user answers to all mail method prompts.
1399 (defvar gnus-mail-method-history nil)
1401 ;; Variable holding the user answers to all group prompts.
1402 (defvar gnus-group-history nil)
1404 (defvar gnus-server-alist nil
1405 "List of available servers.")
1407 (defvar gnus-predefined-server-alist
1410 (nnspool-spool-directory "~/News/cache/")
1411 (nnspool-nov-directory "~/News/cache/")
1412 (nnspool-active-file "~/News/cache/active"))))
1413 "List of predefined (convenience) servers.")
1415 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1417 (defconst gnus-article-mark-lists
1418 '((marked . tick) (replied . reply)
1419 (expirable . expire) (killed . killed)
1420 (bookmarks . bookmark) (dormant . dormant)
1421 (scored . score) (saved . save)
1424 (defvar gnus-headers-retrieved-by nil)
1425 (defvar gnus-article-reply nil)
1426 (defvar gnus-override-method nil)
1427 (defvar gnus-article-check-size nil)
1428 (defvar gnus-opened-servers nil)
1430 (defvar gnus-current-kill-article nil)
1432 (defvar gnus-have-read-active-file nil)
1434 (defconst gnus-maintainer
1435 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1436 "The mail address of the Gnus maintainers.")
1438 (defvar gnus-info-nodes
1439 '((gnus-group-mode "(gnus)The Group Buffer")
1440 (gnus-summary-mode "(gnus)The Summary Buffer")
1441 (gnus-article-mode "(gnus)The Article Buffer")
1442 (mime/viewer-mode "(gnus)The Article Buffer")
1443 (gnus-server-mode "(gnus)The Server Buffer")
1444 (gnus-browse-mode "(gnus)Browse Foreign Server")
1445 (gnus-tree-mode "(gnus)Tree Display"))
1446 "Alist of major modes and related Info nodes.")
1448 (defvar gnus-group-buffer "*Group*")
1449 (defvar gnus-summary-buffer "*Summary*")
1450 (defvar gnus-article-buffer "*Article*")
1451 (defvar gnus-server-buffer "*Server*")
1453 (defvar gnus-buffer-list nil
1454 "Gnus buffers that should be killed on exit.")
1456 (defvar gnus-slave nil
1457 "Whether this Gnus is a slave or not.")
1459 (defvar gnus-batch-mode nil
1460 "Whether this Gnus is running in batch mode or not.")
1462 (defvar gnus-variable-list
1463 '(gnus-newsrc-options gnus-newsrc-options-n
1464 gnus-newsrc-last-checked-date
1465 gnus-newsrc-alist gnus-server-alist
1466 gnus-killed-list gnus-zombie-list
1467 gnus-topic-topology gnus-topic-alist
1469 "Gnus variables saved in the quick startup file.")
1471 (defvar gnus-newsrc-alist nil
1472 "Assoc list of read articles.
1473 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1475 (defvar gnus-newsrc-hashtb nil
1476 "Hashtable of gnus-newsrc-alist.")
1478 (defvar gnus-killed-list nil
1479 "List of killed newsgroups.")
1481 (defvar gnus-killed-hashtb nil
1482 "Hash table equivalent of gnus-killed-list.")
1484 (defvar gnus-zombie-list nil
1485 "List of almost dead newsgroups.")
1487 (defvar gnus-description-hashtb nil
1488 "Descriptions of newsgroups.")
1490 (defvar gnus-list-of-killed-groups nil
1491 "List of newsgroups that have recently been killed by the user.")
1493 (defvar gnus-active-hashtb nil
1494 "Hashtable of active articles.")
1496 (defvar gnus-moderated-hashtb nil
1497 "Hashtable of moderated newsgroups.")
1499 ;; Save window configuration.
1500 (defvar gnus-prev-winconf nil)
1502 (defvar gnus-reffed-article-number nil)
1504 ;;; Let the byte-compiler know that we know about this variable.
1505 (defvar rmail-default-rmail-file)
1507 (defvar gnus-dead-summary nil)
1509 ;;; End of variables.
1511 ;; Define some autoload functions Gnus might use.
1514 ;; This little mapcar goes through the list below and marks the
1515 ;; symbols in question as autoloaded functions.
1518 (let ((interactive (nth 1 (memq ':interactive package))))
1522 (when (consp function)
1523 (setq keymap (car (memq 'keymap function)))
1524 (setq function (car function)))
1525 (autoload function (car package) nil interactive keymap)))
1526 (if (eq (nth 1 package) ':interactive)
1529 '(("metamail" metamail-buffer)
1530 ("info" Info-goto-node)
1531 ("hexl" hexl-hex-string-to-integer)
1532 ("pp" pp pp-to-string pp-eval-expression)
1533 ("ps-print" ps-print-preprint)
1534 ("mail-extr" mail-extract-address-components)
1535 ("message" :interactive t
1536 message-send-and-exit message-yank-original)
1537 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1538 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1539 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1540 timezone-make-sortable-date timezone-make-time-string)
1541 ("rmailout" rmail-output)
1542 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1544 ("gnus-audio" :interactive t gnus-audio-play)
1545 ("gnus-xmas" gnus-xmas-splash)
1546 ("gnus-soup" :interactive t
1547 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1548 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1549 ("nnsoup" nnsoup-pack-replies)
1550 ("score-mode" :interactive t gnus-score-mode)
1551 ("gnus-mh" gnus-summary-save-article-folder
1552 gnus-Folder-save-name gnus-folder-save-name)
1553 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1554 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1555 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1556 gnus-demon-add-disconnection gnus-demon-add-handler
1557 gnus-demon-remove-handler)
1558 ("gnus-demon" :interactive t
1559 gnus-demon-init gnus-demon-cancel)
1560 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1561 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1562 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1563 gnus-nocem-unwanted-article-p)
1564 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info)
1565 ("gnus-srvr" gnus-browse-foreign-server)
1566 ("gnus-cite" :interactive t
1567 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1568 gnus-article-hide-citation gnus-article-fill-cited-article
1569 gnus-article-hide-citation-in-followups)
1570 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1571 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1572 gnus-execute gnus-expunge)
1573 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1574 gnus-cache-possibly-remove-articles gnus-cache-request-article
1575 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1576 gnus-cache-enter-remove-article gnus-cached-article-p
1577 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1578 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1579 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1580 ("gnus-score" :interactive t
1581 gnus-summary-increase-score gnus-summary-set-score
1582 gnus-summary-raise-thread gnus-summary-raise-same-subject
1583 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1584 gnus-summary-lower-thread gnus-summary-lower-same-subject
1585 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1586 gnus-summary-current-score gnus-score-default
1587 gnus-score-flush-cache gnus-score-close
1588 gnus-possibly-score-headers gnus-score-followup-article
1589 gnus-score-followup-thread)
1591 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1592 gnus-current-score-file-nondirectory gnus-score-adaptive
1593 gnus-score-find-trace gnus-score-file-name)
1594 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1595 ("gnus-topic" :interactive t gnus-topic-mode)
1596 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1597 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1598 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1599 ("gnus-uu" :interactive t
1600 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1601 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1602 gnus-uu-mark-by-regexp gnus-uu-mark-all
1603 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1604 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1605 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1606 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1607 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1608 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1609 gnus-uu-decode-binhex-view)
1610 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1611 ("gnus-msg" (gnus-summary-send-map keymap)
1612 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1613 ("gnus-msg" :interactive t
1614 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1615 gnus-summary-followup gnus-summary-followup-with-original
1616 gnus-summary-cancel-article gnus-summary-supersede-article
1617 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1618 gnus-summary-mail-forward gnus-summary-mail-other-window
1619 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1621 ("gnus-picon" :interactive t gnus-article-display-picons
1622 gnus-group-display-picons gnus-picons-article-display-x-face
1623 gnus-picons-display-x-face)
1624 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1625 gnus-grouplens-mode)
1626 ("smiley" :interactive t gnus-smiley-display)
1627 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1628 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1629 gnus-list-of-unread-articles gnus-list-of-read-articles
1630 gnus-offer-save-summaries gnus-make-thread-indent-array
1631 gnus-summary-exit gnus-update-read-articles)
1632 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1633 gnus-group-list-groups gnus-group-first-unread-group
1634 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1635 gnus-group-setup-buffer gnus-group-get-new-news
1636 gnus-group-make-help-group gnus-group-update-group)
1637 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1638 gnus-backlog-remove-article)
1639 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1640 gnus-article-prepare gnus-article-set-window-start
1641 gnus-article-next-page gnus-article-prev-page
1642 gnus-request-article-this-buffer gnus-article-mode
1643 gnus-article-setup-buffer gnus-narrow-to-page
1644 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1645 ("gnus-art" :interactive t
1646 gnus-article-hide-headers gnus-article-hide-boring-headers
1647 gnus-article-treat-overstrike gnus-article-word-wrap
1648 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1649 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1650 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1651 gnus-article-hide-pem gnus-article-hide-signature
1652 gnus-article-strip-leading-blank-lines gnus-article-date-local
1653 gnus-article-date-original gnus-article-date-lapsed
1654 gnus-article-show-all-headers
1655 gnus-article-edit-mode gnus-article-edit-article
1656 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522)
1657 ("gnus-int" gnus-request-type)
1658 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1660 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1661 gnus-dup-enter-articles)
1662 ("gnus-range" gnus-copy-sequence)
1663 ("gnus-eform" gnus-edit-form)
1664 ("gnus-move" :interactive t
1665 gnus-group-move-group-to-server gnus-change-server)
1666 ("gnus-logic" gnus-score-advanced)
1667 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1668 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1669 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1670 gnus-async-halt-prefetch)
1671 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1672 gnus-summary-save-article-vm))))
1674 ;;; gnus-sum.el thingies
1677 (defcustom gnus-summary-line-format "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
1678 "*The format specification of the lines in the summary buffer.
1680 It works along the same lines as a normal formatting string,
1681 with some simple extensions.
1683 %N Article number, left padded with spaces (string)
1685 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1686 %n Name of the poster (string)
1687 %a Extracted name of the poster (string)
1688 %A Extracted address of the poster (string)
1689 %F Contents of the From: header (string)
1690 %x Contents of the Xref: header (string)
1691 %D Date of the article (string)
1692 %d Date of the article (string) in DD-MMM format
1693 %M Message-id of the article (string)
1694 %r References of the article (string)
1695 %c Number of characters in the article (integer)
1696 %L Number of lines in the article (integer)
1697 %I Indentation based on thread level (a string of spaces)
1698 %T A string with two possible values: 80 spaces if the article
1699 is on thread level two or larger and 0 spaces on level one
1700 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1701 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1702 %[ Opening bracket (character, \"[\" or \"<\")
1703 %] Closing bracket (character, \"]\" or \">\")
1704 %> Spaces of length thread-level (string)
1705 %< Spaces of length (- 20 thread-level) (string)
1706 %i Article score (number)
1707 %z Article zcore (character)
1708 %t Number of articles under the current thread (number).
1709 %e Whether the thread is empty or not (character).
1710 %l GroupLens score (string).
1711 %V Total thread score (number).
1712 %P The line number (number).
1713 %u User defined specifier. The next character in the format string should
1714 be a letter. Gnus will call the function gnus-user-format-function-X,
1715 where X is the letter following %u. The function will be passed the
1716 current header as argument. The function should return a string, which
1717 will be inserted into the summary just like information from any other
1720 Text between %( and %) will be highlighted with `gnus-mouse-face'
1721 when the mouse point is placed inside the area. There can only be one
1724 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1725 with care. For reasons of efficiency, Gnus will compute what column
1726 these characters will end up in, and \"hard-code\" that. This means that
1727 it is illegal to have these specs after a variable-length spec. Well,
1728 you might not be arrested, but your summary buffer will look strange,
1729 which is bad enough.
1731 The smart choice is to have these specs as for to the left as
1734 This restriction may disappear in later versions of Gnus."
1736 :group 'gnus-summary-format)
1739 ;;; Skeleton keymaps
1742 (defun gnus-suppress-keymap (keymap)
1743 (suppress-keymap keymap)
1744 (let ((keys `([delete] "\177" "\M-u"))) ;gnus-mouse-2
1746 (define-key keymap (pop keys) 'undefined))))
1748 (defvar gnus-article-mode-map
1749 (let ((keymap (make-keymap)))
1750 (gnus-suppress-keymap keymap)
1752 (defvar gnus-summary-mode-map
1753 (let ((keymap (make-keymap)))
1754 (gnus-suppress-keymap keymap)
1756 (defvar gnus-group-mode-map
1757 (let ((keymap (make-keymap)))
1758 (gnus-suppress-keymap keymap)
1763 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1764 ;; If you want the cursor to go somewhere else, set these two
1765 ;; functions in some startup hook to whatever you want.
1766 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1767 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1769 ;;; Various macros and substs.
1771 (defun gnus-header-from (header)
1772 (mail-header-from header))
1774 (defmacro gnus-gethash (string hashtable)
1775 "Get hash value of STRING in HASHTABLE."
1776 `(symbol-value (intern-soft ,string ,hashtable)))
1778 (defmacro gnus-sethash (string value hashtable)
1779 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1780 `(set (intern ,string ,hashtable) ,value))
1781 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1783 (defmacro gnus-group-unread (group)
1784 "Get the currently computed number of unread articles in GROUP."
1785 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1787 (defmacro gnus-group-entry (group)
1788 "Get the newsrc entry for GROUP."
1789 `(gnus-gethash ,group gnus-newsrc-hashtb))
1791 (defmacro gnus-active (group)
1792 "Get active info on GROUP."
1793 `(gnus-gethash ,group gnus-active-hashtb))
1795 (defmacro gnus-set-active (group active)
1796 "Set GROUP's active info."
1797 `(gnus-sethash ,group ,active gnus-active-hashtb))
1799 (defun gnus-alive-p ()
1800 "Say whether Gnus is running or not."
1801 (and gnus-group-buffer
1802 (get-buffer gnus-group-buffer)
1804 (set-buffer gnus-group-buffer)
1805 (eq major-mode 'gnus-group-mode))))
1807 ;; Info access macros.
1809 (defmacro gnus-info-group (info)
1811 (defmacro gnus-info-rank (info)
1813 (defmacro gnus-info-read (info)
1815 (defmacro gnus-info-marks (info)
1817 (defmacro gnus-info-method (info)
1819 (defmacro gnus-info-params (info)
1822 (defmacro gnus-info-level (info)
1823 `(let ((rank (gnus-info-rank ,info)))
1827 (defmacro gnus-info-score (info)
1828 `(let ((rank (gnus-info-rank ,info)))
1829 (or (and (consp rank) (cdr rank)) 0)))
1831 (defmacro gnus-info-set-group (info group)
1832 `(setcar ,info ,group))
1833 (defmacro gnus-info-set-rank (info rank)
1834 `(setcar (nthcdr 1 ,info) ,rank))
1835 (defmacro gnus-info-set-read (info read)
1836 `(setcar (nthcdr 2 ,info) ,read))
1837 (defmacro gnus-info-set-marks (info marks &optional extend)
1839 `(gnus-info-set-entry ,info ,marks 3)
1840 `(setcar (nthcdr 3 ,info) ,marks)))
1841 (defmacro gnus-info-set-method (info method &optional extend)
1843 `(gnus-info-set-entry ,info ,method 4)
1844 `(setcar (nthcdr 4 ,info) ,method)))
1845 (defmacro gnus-info-set-params (info params &optional extend)
1847 `(gnus-info-set-entry ,info ,params 5)
1848 `(setcar (nthcdr 5 ,info) ,params)))
1850 (defun gnus-info-set-entry (info entry number)
1851 ;; Extend the info until we have enough elements.
1852 (while (<= (length info) number)
1853 (nconc info (list nil)))
1855 (setcar (nthcdr number info) entry))
1857 (defmacro gnus-info-set-level (info level)
1858 `(let ((rank (cdr ,info)))
1859 (if (consp (car rank))
1860 (setcar (car rank) ,level)
1861 (setcar rank ,level))))
1862 (defmacro gnus-info-set-score (info score)
1863 `(let ((rank (cdr ,info)))
1864 (if (consp (car rank))
1865 (setcdr (car rank) ,score)
1866 (setcar rank (cons (car rank) ,score)))))
1868 (defmacro gnus-get-info (group)
1869 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1871 ;; Byte-compiler warning.
1872 (defvar gnus-visual)
1873 ;; Find out whether the gnus-visual TYPE is wanted.
1874 (defun gnus-visual-p (&optional type class)
1875 (and gnus-visual ; Has to be non-nil, at least.
1876 (if (not type) ; We don't care about type.
1878 (if (listp gnus-visual) ; It's a list, so we check it.
1879 (or (memq type gnus-visual)
1880 (memq class gnus-visual))
1883 ;;; Load the compatability functions.
1892 (defvar gnus-shutdown-alist nil)
1894 (defun gnus-add-shutdown (function &rest symbols)
1895 "Run FUNCTION whenever one of SYMBOLS is shut down."
1896 (push (cons function symbols) gnus-shutdown-alist))
1898 (defun gnus-shutdown (symbol)
1899 "Shut down everything that waits for SYMBOL."
1900 (let ((alist gnus-shutdown-alist)
1902 (while (setq entry (pop alist))
1903 (when (memq symbol (cdr entry))
1904 (funcall (car entry))))))
1908 ;;; Gnus Utility Functions
1911 (defmacro gnus-string-or (&rest strings)
1912 "Return the first element of STRINGS that is a non-blank string.
1913 STRINGS will be evaluated in normal `or' order."
1914 `(gnus-string-or-1 ',strings))
1916 (defun gnus-string-or-1 (strings)
1919 (setq string (eval (pop strings)))
1920 (if (string-match "^[ \t]*$" string)
1922 (setq strings nil)))
1925 ;; Add the current buffer to the list of buffers to be killed on exit.
1926 (defun gnus-add-current-to-buffer-list ()
1927 (or (memq (current-buffer) gnus-buffer-list)
1928 (push (current-buffer) gnus-buffer-list)))
1930 (defun gnus-version (&optional arg)
1931 "Version number of this version of Gnus.
1932 If ARG, insert string at point."
1934 (let ((methods gnus-valid-select-methods)
1937 ;; Go through all the legal select methods and add their version
1938 ;; numbers to the total version string. Only the backends that are
1939 ;; currently in use will have their message numbers taken into
1942 (setq meth (intern (concat (caar methods) "-version")))
1944 (stringp (symbol-value meth))
1945 (setq mess (concat mess "; " (symbol-value meth))))
1946 (setq methods (cdr methods)))
1948 (insert (message mess))
1951 (defun gnus-continuum-version (version)
1952 "Return VERSION as a floating point number."
1953 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1954 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1955 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1956 (number (match-string 2 version))
1958 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1959 (setq major (string-to-number (match-string 1 number)))
1960 (setq minor (string-to-number (match-string 2 number)))
1961 (setq least (if (match-beginning 3)
1962 (string-to-number (match-string 3 number))
1966 (format "%s00%02d%02d"
1968 ((member alpha '("(ding)" "d")) "4.99")
1969 ((member alpha '("September" "s")) "5.01")
1970 ((member alpha '("Red" "r")) "5.03"))
1972 (format "%d.%02d%02d" major minor least))))))
1974 (defun gnus-info-find-node ()
1975 "Find Info documentation of Gnus."
1977 ;; Enlarge info window if needed.
1978 (let (gnus-info-buffer)
1979 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1980 (setq gnus-info-buffer (current-buffer))
1981 (gnus-configure-windows 'info)))
1983 ;;; More various functions.
1985 (defun gnus-group-read-only-p (&optional group)
1986 "Check whether GROUP supports editing or not.
1987 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
1988 that that variable is buffer-local to the summary buffers."
1989 (let ((group (or group gnus-newsgroup-name)))
1990 (not (gnus-check-backend-function 'request-replace-article group))))
1992 (defun gnus-group-total-expirable-p (group)
1993 "Check whether GROUP is total-expirable or not."
1994 (let ((params (gnus-group-find-parameter group))
1997 ((memq 'total-expire params)
1999 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2001 (gnus-total-expirable-newsgroups ; Check var.
2002 (string-match gnus-total-expirable-newsgroups group)))))
2004 (defun gnus-group-auto-expirable-p (group)
2005 "Check whether GROUP is total-expirable or not."
2006 (let ((params (gnus-group-find-parameter group))
2009 ((memq 'auto-expire params)
2011 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2013 (gnus-auto-expirable-newsgroups ; Check var.
2014 (string-match gnus-auto-expirable-newsgroups group)))))
2016 (defun gnus-virtual-group-p (group)
2017 "Say whether GROUP is virtual or not."
2018 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2019 gnus-valid-select-methods)))
2021 (defun gnus-news-group-p (group &optional article)
2022 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2023 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2024 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2025 (eq (gnus-request-type group article) 'news))))
2027 ;; Returns a list of writable groups.
2028 (defun gnus-writable-groups ()
2029 (let ((alist gnus-newsrc-alist)
2031 (while (setq group (car (pop alist)))
2032 (unless (gnus-group-read-only-p group)
2033 (push group groups)))
2036 ;; Check whether to use long file names.
2037 (defun gnus-use-long-file-name (symbol)
2038 ;; The variable has to be set...
2039 (and gnus-use-long-file-name
2040 ;; If it isn't a list, then we return t.
2041 (or (not (listp gnus-use-long-file-name))
2042 ;; If it is a list, and the list contains `symbol', we
2044 (not (memq symbol gnus-use-long-file-name)))))
2046 ;; Generate a unique new group name.
2047 (defun gnus-generate-new-group-name (leaf)
2050 (while (gnus-gethash name gnus-newsrc-hashtb)
2051 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2054 (defun gnus-ephemeral-group-p (group)
2055 "Say whether GROUP is ephemeral or not."
2056 (gnus-group-get-parameter group 'quit-config))
2058 (defun gnus-group-quit-config (group)
2059 "Return the quit-config of GROUP."
2060 (gnus-group-get-parameter group 'quit-config))
2062 (defun gnus-kill-ephemeral-group (group)
2063 "Remove ephemeral GROUP from relevant structures."
2064 (gnus-sethash group nil gnus-newsrc-hashtb))
2066 (defun gnus-simplify-mode-line ()
2067 "Make mode lines a bit simpler."
2068 (setq mode-line-modified "-- ")
2069 (when (listp mode-line-format)
2070 (make-local-variable 'mode-line-format)
2071 (setq mode-line-format (copy-sequence mode-line-format))
2072 (when (equal (nth 3 mode-line-format) " ")
2073 (setcar (nthcdr 3 mode-line-format) " "))))
2075 ;;; Servers and groups.
2077 (defsubst gnus-server-add-address (method)
2078 (let ((method-name (symbol-name (car method))))
2079 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2080 (not (assq (intern (concat method-name "-address")) method))
2081 (memq 'physical-address (assq (car method)
2082 gnus-valid-select-methods)))
2083 (append method (list (list (intern (concat method-name "-address"))
2087 (defsubst gnus-server-get-method (group method)
2088 ;; Input either a server name, and extended server name, or a
2089 ;; select method, and return a select method.
2090 (cond ((stringp method)
2091 (gnus-server-to-method method))
2092 ((equal method gnus-select-method)
2094 ((and (stringp (car method)) group)
2095 (gnus-server-extend-method group method))
2096 ((and method (not group)
2097 (equal (cadr method) ""))
2100 (gnus-server-add-address method))))
2102 (defun gnus-server-to-method (server)
2103 "Map virtual server names to select methods."
2105 ;; Is this a method, perhaps?
2106 (and server (listp server) server)
2107 ;; Perhaps this is the native server?
2108 (and (equal server "native") gnus-select-method)
2109 ;; It should be in the server alist.
2110 (cdr (assoc server gnus-server-alist))
2111 ;; It could be in the predefined server alist.
2112 (cdr (assoc server gnus-predefined-server-alist))
2113 ;; If not, we look through all the opened server
2114 ;; to see whether we can find it there.
2115 (let ((opened gnus-opened-servers))
2117 (not (equal server (format "%s:%s" (caaar opened)
2122 (defmacro gnus-method-equal (ss1 ss2)
2123 "Say whether two servers are equal."
2127 (and (= (length s1) (length s2))
2129 (while (and s1 (member (car s1) s2))
2133 (defun gnus-server-equal (m1 m2)
2134 "Say whether two methods are equal."
2135 (let ((m1 (cond ((null m1) gnus-select-method)
2136 ((stringp m1) (gnus-server-to-method m1))
2138 (m2 (cond ((null m2) gnus-select-method)
2139 ((stringp m2) (gnus-server-to-method m2))
2141 (gnus-method-equal m1 m2)))
2143 (defun gnus-servers-using-backend (backend)
2144 "Return a list of known servers using BACKEND."
2145 (let ((opened gnus-opened-servers)
2148 (when (eq backend (caaar opened))
2149 (push (caar opened) out))
2153 (defun gnus-archive-server-wanted-p ()
2154 "Say whether the user wants to use the archive server."
2156 ((or (not gnus-message-archive-method)
2157 (not gnus-message-archive-group))
2159 ((and gnus-message-archive-method gnus-message-archive-group)
2162 (let ((active (cadr (assq 'nnfolder-active-file
2163 gnus-message-archive-method))))
2165 (file-exists-p active))))))
2167 (defun gnus-group-prefixed-name (group method)
2168 "Return the whole name from GROUP and METHOD."
2169 (and (stringp method) (setq method (gnus-server-to-method method)))
2172 (concat (format "%s" (car method))
2174 (or (assoc (format "%s" (car method))
2175 (gnus-methods-using 'address))
2176 (gnus-server-equal method gnus-message-archive-method))
2178 (not (string= (nth 1 method) "")))
2179 (concat "+" (nth 1 method)))
2182 (defun gnus-group-real-prefix (group)
2183 "Return the prefix of the current group name."
2184 (if (string-match "^[^:]+:" group)
2185 (substring group 0 (match-end 0))
2188 (defun gnus-group-method (group)
2189 "Return the server or method used for selecting GROUP.
2190 You should probably use `gnus-find-method-for-group' instead."
2191 (let ((prefix (gnus-group-real-prefix group)))
2192 (if (equal prefix "")
2194 (let ((servers gnus-opened-servers)
2196 backend possible found)
2197 (if (string-match "^[^\\+]+\\+" prefix)
2198 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2199 server (substring prefix (match-end 0) (1- (length prefix))))
2200 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2202 (when (eq (caaar servers) backend)
2203 (setq possible (caar servers))
2204 (when (equal (cadaar servers) server)
2205 (setq found (caar servers))))
2207 (or (car (rassoc found gnus-server-alist))
2209 (car (rassoc possible gnus-server-alist))
2211 (list backend server))))))
2213 (defsubst gnus-secondary-method-p (method)
2214 "Return whether METHOD is a secondary select method."
2215 (let ((methods gnus-secondary-select-methods)
2216 (gmethod (gnus-server-get-method nil method)))
2218 (not (equal (gnus-server-get-method nil (car methods))
2220 (setq methods (cdr methods)))
2223 (defun gnus-group-foreign-p (group)
2224 "Say whether a group is foreign or not."
2225 (and (not (gnus-group-native-p group))
2226 (not (gnus-group-secondary-p group))))
2228 (defun gnus-group-native-p (group)
2229 "Say whether the group is native or not."
2230 (not (string-match ":" group)))
2232 (defun gnus-group-secondary-p (group)
2233 "Say whether the group is secondary or not."
2234 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2236 (defun gnus-group-find-parameter (group &optional symbol)
2237 "Return the group parameters for GROUP.
2238 If SYMBOL, return the value of that symbol in the group parameters."
2240 (set-buffer gnus-group-buffer)
2241 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2243 (gnus-group-parameter-value parameters symbol)
2246 (defun gnus-group-get-parameter (group &optional symbol)
2247 "Return the group parameters for GROUP.
2248 If SYMBOL, return the value of that symbol in the group parameters."
2249 (let ((params (gnus-info-params (gnus-get-info group))))
2251 (gnus-group-parameter-value params symbol)
2254 (defun gnus-group-parameter-value (params symbol)
2255 "Return the value of SYMBOL in group PARAMS."
2256 (or (car (memq symbol params)) ; It's either a simple symbol
2257 (cdr (assq symbol params)))) ; or a cons.
2259 (defun gnus-group-add-parameter (group param)
2260 "Add parameter PARAM to GROUP."
2261 (let ((info (gnus-get-info group)))
2263 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2264 ;; Cons the new param to the old one and update.
2265 (gnus-group-set-info (cons param (gnus-info-params info))
2268 (defun gnus-group-set-parameter (group name value)
2269 "Set parameter NAME to VALUE in GROUP."
2270 (let ((info (gnus-get-info group)))
2272 (gnus-group-remove-parameter group name)
2273 (let ((old-params (gnus-info-params info))
2274 (new-params (list (cons name value))))
2276 (when (or (not (listp (car old-params)))
2277 (not (eq (caar old-params) name)))
2278 (setq new-params (append new-params (list (car old-params)))))
2279 (setq old-params (cdr old-params)))
2280 (gnus-group-set-info new-params group 'params)))))
2282 (defun gnus-group-remove-parameter (group name)
2283 "Remove parameter NAME from GROUP."
2284 (let ((info (gnus-get-info group)))
2286 (let ((params (gnus-info-params info)))
2288 (setq params (delq name params))
2289 (while (assq name params)
2290 (setq params (delq (assq name params) params)))
2291 (gnus-info-set-params info params))))))
2293 (defun gnus-group-add-score (group &optional score)
2294 "Add SCORE to the GROUP score.
2295 If SCORE is nil, add 1 to the score of GROUP."
2296 (let ((info (gnus-get-info group)))
2298 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2300 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2301 (defun gnus-short-group-name (group &optional levels)
2302 "Collapse GROUP name LEVELS.
2303 Select methods are stripped and any remote host name is stripped down to
2304 just the host name."
2305 (let* ((name "") (foreign "") (depth -1) (skip 1)
2308 (while (string-match "\\." group skip)
2309 (setq skip (match-end 0)
2312 ;; separate foreign select method from group name and collapse.
2313 ;; if method contains a server, collapse to non-domain server name,
2314 ;; otherwise collapse to select method
2315 (when (string-match ":" group)
2316 (cond ((string-match "+" group)
2317 (let* ((plus (string-match "+" group))
2318 (colon (string-match ":" group (or plus 0)))
2319 (dot (string-match "\\." group)))
2320 (setq foreign (concat
2321 (substring group (+ 1 plus)
2322 (cond ((null dot) colon)
2323 ((< colon dot) colon)
2324 ((< dot colon) dot)))
2326 group (substring group (+ 1 colon)))))
2328 (let* ((colon (string-match ":" group)))
2329 (setq foreign (concat (substring group 0 (+ 1 colon)))
2330 group (substring group (+ 1 colon)))))))
2331 ;; collapse group name leaving LEVELS uncollapsed elements
2333 (if (and (string-match "\\." group) (> levels 0))
2334 (setq name (concat name (substring group 0 1))
2335 group (substring group (match-end 0))
2337 name (concat name "."))
2338 (setq name (concat foreign name group)
2342 (defun gnus-narrow-to-body ()
2343 "Narrow to the body of an article."
2346 (goto-char (point-min))
2347 (or (search-forward "\n\n" nil t)
2353 ;;; Kill file handling.
2356 (defun gnus-apply-kill-file ()
2357 "Apply a kill file to the current newsgroup.
2358 Returns the number of articles marked as read."
2359 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2360 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2361 (gnus-apply-kill-file-internal)
2364 (defun gnus-kill-save-kill-buffer ()
2365 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2366 (when (get-file-buffer file)
2368 (set-buffer (get-file-buffer file))
2369 (when (buffer-modified-p)
2371 (kill-buffer (current-buffer))))))
2373 (defcustom gnus-kill-file-name "KILL"
2374 "Suffix of the kill files."
2375 :group 'gnus-score-kill
2376 :group 'gnus-score-files
2379 (defun gnus-newsgroup-kill-file (newsgroup)
2380 "Return the name of a kill file name for NEWSGROUP.
2381 If NEWSGROUP is nil, return the global kill file name instead."
2383 ;; The global KILL file is placed at top of the directory.
2384 ((or (null newsgroup)
2385 (string-equal newsgroup ""))
2386 (expand-file-name gnus-kill-file-name
2387 gnus-kill-files-directory))
2388 ;; Append ".KILL" to newsgroup name.
2389 ((gnus-use-long-file-name 'not-kill)
2390 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2391 "." gnus-kill-file-name)
2392 gnus-kill-files-directory))
2393 ;; Place "KILL" under the hierarchical directory.
2395 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2396 "/" gnus-kill-file-name)
2397 gnus-kill-files-directory))))
2401 (defun gnus-member-of-valid (symbol group)
2402 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2404 (symbol-name (car (gnus-find-method-for-group group)))
2405 gnus-valid-select-methods)))
2407 (defun gnus-method-option-p (method option)
2408 "Return non-nil if select METHOD has OPTION as a parameter."
2409 (when (stringp method)
2410 (setq method (gnus-server-to-method method)))
2411 (memq option (assoc (format "%s" (car method))
2412 gnus-valid-select-methods)))
2414 (defun gnus-similar-server-opened (method)
2415 (let ((opened gnus-opened-servers))
2416 (while (and method opened)
2417 (when (and (equal (cadr method) (cadaar opened))
2418 (not (equal method (caar opened))))
2423 (defun gnus-server-extend-method (group method)
2424 ;; This function "extends" a virtual server. If the server is
2425 ;; "hello", and the select method is ("hello" (my-var "something"))
2426 ;; in the group "alt.alt", this will result in a new virtual server
2427 ;; called "hello+alt.alt".
2428 (if (or (not (inline (gnus-similar-server-opened method)))
2429 (not (cddr method)))
2431 `(,(car method) ,(concat (cadr method) "+" group)
2432 (,(intern (format "%s-address" (car method))) ,(cadr method))
2435 (defun gnus-server-status (method)
2436 "Return the status of METHOD."
2437 (nth 1 (assoc method gnus-opened-servers)))
2439 (defun gnus-group-name-to-method (group)
2440 "Guess a select method based on GROUP."
2441 (if (string-match ":" group)
2442 (let ((server (substring group 0 (match-beginning 0))))
2443 (if (string-match "\\+" server)
2444 (list (intern (substring server 0 (match-beginning 0)))
2445 (substring server (match-end 0)))
2446 (list (intern server) "")))
2447 gnus-select-method))
2449 (defun gnus-find-method-for-group (group &optional info)
2450 "Find the select method that GROUP uses."
2451 (or gnus-override-method
2454 (let ((info (or info (gnus-get-info group)))
2457 (not (setq method (gnus-info-method info)))
2458 (equal method "native"))
2461 (cond ((stringp method)
2462 (inline (gnus-server-to-method method)))
2463 ((stringp (cadr method))
2464 (inline (gnus-server-extend-method group method)))
2467 (cond ((equal (cadr method) "")
2469 ((null (cadr method))
2470 (list (car method) ""))
2472 (gnus-server-add-address method)))))))
2474 (defsubst gnus-check-backend-function (func group)
2475 "Check whether GROUP supports function FUNC.
2476 GROUP can either be a string (a group name) or a select method."
2478 (let ((method (if (stringp group)
2479 (car (gnus-find-method-for-group group))
2481 (unless (featurep method)
2483 (fboundp (intern (format "%s-%s" method func))))))
2485 (defun gnus-methods-using (feature)
2486 "Find all methods that have FEATURE."
2487 (let ((valids gnus-valid-select-methods)
2490 (when (memq feature (car valids))
2491 (push (car valids) outs))
2492 (setq valids (cdr valids)))
2495 (defun gnus-read-group (prompt &optional default)
2496 "Prompt the user for a group name.
2497 Disallow illegal group names."
2503 (setq group (read-string (concat prefix prompt)
2504 (cons (or default "") 0)
2505 'gnus-group-history)))
2506 (setq prefix (format "Illegal group name: \"%s\". " group)
2510 (defun gnus-read-method (prompt)
2511 "Prompt the user for a method.
2512 Allow completion over sensible values."
2515 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2517 nil t nil 'gnus-method-history)))
2520 (setq method gnus-select-method))
2521 ((assoc method gnus-valid-select-methods)
2522 (list (intern method)
2523 (if (memq 'prompt-address
2524 (assoc method gnus-valid-select-methods))
2525 (read-string "Address: ")
2527 ((assoc method gnus-server-alist)
2530 (list (intern method) "")))))
2532 ;;; User-level commands.
2535 (defun gnus-slave-no-server (&optional arg)
2536 "Read network news as a slave, without connecting to local server"
2538 (gnus-no-server arg t))
2541 (defun gnus-no-server (&optional arg slave)
2543 If ARG is a positive number, Gnus will use that as the
2544 startup level. If ARG is nil, Gnus will be started at level 2.
2545 If ARG is non-nil and not a positive number, Gnus will
2546 prompt the user for the name of an NNTP server to use.
2547 As opposed to `gnus', this command will not connect to the local server."
2549 (gnus-no-server-1 arg slave))
2552 (defun gnus-slave (&optional arg)
2553 "Read news as a slave."
2555 (gnus arg nil 'slave))
2558 (defun gnus-other-frame (&optional arg)
2559 "Pop up a frame to read news."
2561 (let ((window (get-buffer-window gnus-group-buffer)))
2563 (select-frame (window-frame window)))
2564 ((= (length (frame-list)) 1)
2565 (select-frame (make-frame)))
2571 (defun gnus (&optional arg dont-connect slave)
2573 If ARG is non-nil and a positive number, Gnus will use that as the
2574 startup level. If ARG is non-nil and not a positive number, Gnus will
2575 prompt the user for the name of an NNTP server to use."
2577 (gnus-1 arg dont-connect slave))
2579 ;; Allow redefinition of Gnus functions.
2585 ;;; gnus.el ends here