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))
31 (eval-when-compile (require 'cl))
38 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42 (defgroup gnus-start nil
43 "Starting your favorite newsreader."
46 (defgroup gnus-start-server nil
47 "Server options at startup."
50 ;; These belong to gnus-group.el.
51 (defgroup gnus-group nil
53 :link '(custom-manual "(gnus)The Group Buffer")
56 (defgroup gnus-group-foreign nil
58 :link '(custom-manual "(gnus)Foreign Groups")
61 (defgroup gnus-group-new nil
62 "Automatic subscription of new groups."
65 (defgroup gnus-group-levels nil
67 :link '(custom-manual "(gnus)Group Levels")
70 (defgroup gnus-group-select nil
72 :link '(custom-manual "(gnus)Selecting a Group")
75 (defgroup gnus-group-listing nil
76 "Showing slices of the group list."
77 :link '(custom-manual "(gnus)Listing Groups")
80 (defgroup gnus-group-visual nil
81 "Sorting the group buffer."
82 :link '(custom-manual "(gnus)Group Buffer Format")
86 (defgroup gnus-group-various nil
87 "Various group options."
88 :link '(custom-manual "(gnus)Scanning New Messages")
91 ;; These belong to gnus-sum.el.
92 (defgroup gnus-summary nil
94 :link '(custom-manual "(gnus)The Summary Buffer")
97 (defgroup gnus-summary-exit nil
98 "Leaving summary buffers."
99 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
100 :group 'gnus-summary)
102 (defgroup gnus-summary-marks nil
103 "Marks used in summary buffers."
104 :link '(custom-manual "(gnus)Marking Articles")
105 :group 'gnus-summary)
107 (defgroup gnus-thread nil
108 "Ordering articles according to replies."
109 :link '(custom-manual "(gnus)Threading")
110 :group 'gnus-summary)
112 (defgroup gnus-summary-format nil
113 "Formatting of the summary buffer."
114 :link '(custom-manual "(gnus)Summary Buffer Format")
115 :group 'gnus-summary)
117 (defgroup gnus-summary-choose nil
119 :link '(custom-manual "(gnus)Choosing Articles")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-maneuvering nil
123 "Summary movement commands."
124 :link '(custom-manual "(gnus)Summary Maneuvering")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-mail nil
128 "Mail group commands."
129 :link '(custom-manual "(gnus)Mail Group Commands")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-sort nil
133 "Sorting the summary buffer."
134 :link '(custom-manual "(gnus)Sorting")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-visual nil
138 "Highlighting and menus in the summary buffer."
139 :link '(custom-manual "(gnus)Summary Highlighting")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-various nil
144 "Various summary buffer options."
145 :link '(custom-manual "(gnus)Various Summary Stuff")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-pick nil
149 "Pick mode in the summary buffer."
150 :link '(custom-manual "(gnus)Pick and Read")
152 :group 'gnus-summary)
154 (defgroup gnus-summary-tree nil
155 "Tree display of threads in the summary buffer."
156 :link '(custom-manual "(gnus)Tree Display")
158 :group 'gnus-summary)
160 ;; Belongs to gnus-uu.el
161 (defgroup gnus-extract-view nil
162 "Viewing extracted files."
163 :link '(custom-manual "(gnus)Viewing Files")
164 :group 'gnus-extract)
166 ;; Belongs to gnus-score.el
167 (defgroup gnus-score nil
168 "Score and kill file handling."
171 (defgroup gnus-score-kill nil
175 (defgroup gnus-score-adapt nil
176 "Adaptive score files."
179 (defgroup gnus-score-default nil
180 "Default values for score files."
183 (defgroup gnus-score-expire nil
184 "Expiring score rules."
187 (defgroup gnus-score-decay nil
188 "Decaying score rules."
191 (defgroup gnus-score-files nil
192 "Score and kill file names."
196 (defgroup gnus-score-various nil
197 "Various scoring and killing options."
201 (defgroup gnus-visual nil
202 "Options controling the visual fluff."
206 (defgroup gnus-files nil
207 "Files used by Gnus."
210 (defgroup gnus-dribble-file nil
212 :link '(custom-manual "(gnus)Auto Save")
215 (defgroup gnus-newsrc nil
216 "Storing Gnus state."
219 (defgroup gnus-server nil
220 "Options related to newsservers and other servers used by Gnus."
223 (defgroup gnus-message '((message custom-group))
224 "Composing replies and followups in Gnus."
227 (defgroup gnus-meta nil
228 "Meta variables controling major portions of Gnus.
229 In general, modifying these variables does not take affect until Gnus
230 is restarted, and sometimes reloaded."
233 (defgroup gnus-various nil
234 "Other Gnus options."
235 :link '(custom-manual "(gnus)Various Various")
238 (defgroup gnus-exit nil
240 :link '(custom-manual "(gnus)Exiting Gnus")
243 (defconst gnus-version-number "5.4.67"
244 "Version number for this version of Gnus.")
246 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
247 "Version string for this version of Gnus.")
249 (defcustom gnus-inhibit-startup-message nil
250 "If non-nil, the startup message will not be displayed.
251 This variable is used before `.gnus.el' is loaded, so it should
252 be set in `.emacs' instead."
256 (defcustom gnus-play-startup-jingle nil
257 "If non-nil, play the Gnus jingle at startup."
261 ;;; Kludges to help the transition from the old `custom.el'.
263 (unless (featurep 'gnus-xmas)
264 (defalias 'gnus-make-overlay 'make-overlay)
265 (defalias 'gnus-overlay-put 'overlay-put)
266 (defalias 'gnus-move-overlay 'move-overlay)
267 (defalias 'gnus-overlay-end 'overlay-end)
268 (defalias 'gnus-extent-detached-p 'ignore)
269 (defalias 'gnus-extent-start-open 'ignore)
270 (defalias 'gnus-set-text-properties 'set-text-properties)
271 (defalias 'gnus-group-remove-excess-properties 'ignore)
272 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
273 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
274 (defalias 'gnus-character-to-event 'identity)
275 (defalias 'gnus-add-text-properties 'add-text-properties)
276 (defalias 'gnus-put-text-property 'put-text-property)
277 (defalias 'gnus-mode-line-buffer-identification 'identity)
278 (defalias 'gnus-characterp 'numberp)
279 (defalias 'gnus-key-press-event-p 'numberp))
281 ;; The XEmacs people think this is evil, so it must go.
282 (defun custom-face-lookup (&optional fg bg stipple bold italic underline)
283 "Lookup or create a face with specified attributes."
284 (let ((name (intern (format "custom-face-%s-%s-%s-%S-%S-%S"
287 (or stipple "default")
288 bold italic underline))))
289 (if (and (custom-facep name)
290 (fboundp 'make-face))
292 (copy-face 'default name)
294 (not (string-equal fg "default")))
296 (set-face-foreground name fg)))
298 (not (string-equal bg "default")))
300 (set-face-background name bg)))
302 (not (string-equal stipple "default"))
303 (not (eq stipple 'custom:asis))
304 (fboundp 'set-face-stipple))
305 (set-face-stipple name stipple))
307 (not (eq bold 'custom:asis)))
309 (make-face-bold name)))
311 (not (eq italic 'custom:asis)))
313 (make-face-italic name)))
315 (not (eq underline 'custom:asis)))
317 (set-face-underline-p name t))))
320 ;; We define these group faces here to avoid the display
321 ;; update forced when creating new faces.
323 (defface gnus-group-news-1-face
326 (:foreground "PaleTurquoise" :bold t))
329 (:foreground "ForestGreen" :bold t))
332 "Level 1 newsgroup face.")
334 (defface gnus-group-news-1-empty-face
337 (:foreground "PaleTurquoise"))
340 (:foreground "ForestGreen"))
343 "Level 1 empty newsgroup face.")
345 (defface gnus-group-news-2-face
348 (:foreground "turquoise" :bold t))
351 (:foreground "CadetBlue4" :bold t))
354 "Level 2 newsgroup face.")
356 (defface gnus-group-news-2-empty-face
359 (:foreground "turquoise"))
362 (:foreground "CadetBlue4"))
365 "Level 2 empty newsgroup face.")
367 (defface gnus-group-news-3-face
376 "Level 3 newsgroup face.")
378 (defface gnus-group-news-3-empty-face
387 "Level 3 empty newsgroup face.")
389 (defface gnus-group-news-low-face
392 (:foreground "DarkTurquoise" :bold t))
395 (:foreground "DarkGreen" :bold t))
398 "Low level newsgroup face.")
400 (defface gnus-group-news-low-empty-face
403 (:foreground "DarkTurquoise"))
406 (:foreground "DarkGreen"))
409 "Low level empty newsgroup face.")
411 (defface gnus-group-mail-1-face
414 (:foreground "aquamarine1" :bold t))
417 (:foreground "DeepPink3" :bold t))
420 "Level 1 mailgroup face.")
422 (defface gnus-group-mail-1-empty-face
425 (:foreground "aquamarine1"))
428 (:foreground "DeepPink3"))
430 (:italic t :bold t)))
431 "Level 1 empty mailgroup face.")
433 (defface gnus-group-mail-2-face
436 (:foreground "aquamarine2" :bold t))
439 (:foreground "HotPink3" :bold t))
442 "Level 2 mailgroup face.")
444 (defface gnus-group-mail-2-empty-face
447 (:foreground "aquamarine2"))
450 (:foreground "HotPink3"))
453 "Level 2 empty mailgroup face.")
455 (defface gnus-group-mail-3-face
458 (:foreground "aquamarine3" :bold t))
461 (:foreground "magenta4" :bold t))
464 "Level 3 mailgroup face.")
466 (defface gnus-group-mail-3-empty-face
469 (:foreground "aquamarine3"))
472 (:foreground "magenta4"))
475 "Level 3 empty mailgroup face.")
477 (defface gnus-group-mail-low-face
480 (:foreground "aquamarine4" :bold t))
483 (:foreground "DeepPink4" :bold t))
486 "Low level mailgroup face.")
488 (defface gnus-group-mail-low-empty-face
491 (:foreground "aquamarine4"))
494 (:foreground "DeepPink4"))
497 "Low level empty mailgroup face.")
499 ;; Summary mode faces.
501 (defface gnus-summary-selected-face '((t
503 "Face used for selected articles.")
505 (defface gnus-summary-cancelled-face
507 (:foreground "yellow" :background "black")))
508 "Face used for cancelled articles.")
510 (defface gnus-summary-high-ticked-face
513 (:foreground "pink" :bold t))
516 (:foreground "firebrick" :bold t))
519 "Face used for high interest ticked articles.")
521 (defface gnus-summary-low-ticked-face
524 (:foreground "pink" :italic t))
527 (:foreground "firebrick" :italic t))
530 "Face used for low interest ticked articles.")
532 (defface gnus-summary-normal-ticked-face
535 (:foreground "pink"))
538 (:foreground "firebrick"))
541 "Face used for normal interest ticked articles.")
543 (defface gnus-summary-high-ancient-face
546 (:foreground "SkyBlue" :bold t))
549 (:foreground "RoyalBlue" :bold t))
552 "Face used for high interest ancient articles.")
554 (defface gnus-summary-low-ancient-face
557 (:foreground "SkyBlue" :italic t))
560 (:foreground "RoyalBlue" :italic t))
563 "Face used for low interest ancient articles.")
565 (defface gnus-summary-normal-ancient-face
568 (:foreground "SkyBlue"))
571 (:foreground "RoyalBlue"))
574 "Face used for normal interest ancient articles.")
576 (defface gnus-summary-high-unread-face
579 "Face used for high interest unread articles.")
581 (defface gnus-summary-low-unread-face
584 "Face used for low interest unread articles.")
586 (defface gnus-summary-normal-unread-face
589 "Face used for normal interest unread articles.")
591 (defface gnus-summary-high-read-face
594 (:foreground "PaleGreen"
598 (:foreground "DarkGreen"
602 "Face used for high interest read articles.")
604 (defface gnus-summary-low-read-face
607 (:foreground "PaleGreen"
611 (:foreground "DarkGreen"
615 "Face used for low interest read articles.")
617 (defface gnus-summary-normal-read-face
620 (:foreground "PaleGreen"))
623 (:foreground "DarkGreen"))
626 "Face used for normal interest read articles.")
631 (defvar gnus-group-buffer "*Group*")
634 (autoload 'gnus-play-jingle "gnus-audio"))
636 (defface gnus-splash-face
645 "Level 1 newsgroup face.")
647 (defun gnus-splash ()
649 (switch-to-buffer gnus-group-buffer)
650 (let ((buffer-read-only nil))
652 (unless gnus-inhibit-startup-message
653 (gnus-group-startup-message)
655 (when gnus-play-startup-jingle
656 (gnus-play-jingle))))))
658 (defun gnus-indent-rigidly (start end arg)
659 "Indent rigidly using only spaces and no tabs."
662 (narrow-to-region start end)
664 (indent-rigidly start end arg)
665 ;; We translate tabs into spaces -- not everybody uses
666 ;; an 8-character tab.
667 (goto-char (point-min))
668 (while (search-forward "\t" nil t)
669 (replace-match " " t t))))))
671 (defvar gnus-simple-splash nil)
673 (defun gnus-group-startup-message (&optional x y)
674 "Insert startup message in current buffer."
675 ;; Insert the message.
680 _ ___ __ ___ __ _ ___
700 (gnus-indent-rigidly (point-min) (point-max)
701 (/ (max (- (window-width) (or x 46)) 0) 2))
702 (goto-char (point-min))
704 (let* ((pheight (count-lines (point-min) (point-max)))
705 (wheight (window-height))
706 (rest (- wheight pheight)))
707 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
709 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
710 (goto-char (point-min))
711 (setq mode-line-buffer-identification (concat " " gnus-version))
712 (setq gnus-simple-splash t)
713 (set-buffer-modified-p t))
716 (let ((command (format "%s" this-command)))
717 (when (and (string-match "gnus" command)
718 (not (string-match "gnus-other-frame" command)))
727 (defcustom gnus-home-directory "~/"
728 "Directory variable that specifies the \"home\" directory.
729 All other Gnus path variables are initialized from this variable."
733 (defcustom gnus-directory (or (getenv "SAVEDIR")
734 (nnheader-concat gnus-home-directory "News/"))
735 "Directory variable from which all other Gnus file variables are derived."
739 (defcustom gnus-default-directory nil
740 "*Default directory for all Gnus buffers."
742 :type '(choice (const :tag "current" nil)
745 ;; Site dependent variables. These variables should be defined in
748 (defvar gnus-default-nntp-server nil
749 "Specify a default NNTP server.
750 This variable should be defined in paths.el, and should never be set
752 If you want to change servers, you should use `gnus-select-method'.
753 See the documentation to that variable.")
755 ;; Don't touch this variable.
756 (defvar gnus-nntp-service "nntp"
757 "NNTP service name (\"nntp\" or 119).
758 This is an obsolete variable, which is scarcely used. If you use an
759 nntp server for your newsgroup and want to change the port number
760 used to 899, you would say something along these lines:
762 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
764 (defcustom gnus-nntpserver-file "/etc/nntpserver"
765 "A file with only the name of the nntp server in it."
770 ;; This function is used to check both the environment variable
771 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
772 ;; an nntp server name default.
773 (defun gnus-getenv-nntpserver ()
774 (or (getenv "NNTPSERVER")
775 (and (file-readable-p gnus-nntpserver-file)
777 (set-buffer (get-buffer-create " *gnus nntp*"))
778 (buffer-disable-undo (current-buffer))
779 (insert-file-contents gnus-nntpserver-file)
780 (let ((name (buffer-string)))
782 (if (string-match "^[ \t\n]*$" name)
785 (kill-buffer (current-buffer))))))))
787 (defcustom gnus-select-method
790 (list 'nntp (or (condition-case nil
791 (gnus-getenv-nntpserver)
793 (when (and gnus-default-nntp-server
794 (not (string= gnus-default-nntp-server "")))
795 gnus-default-nntp-server)
797 (if (or (null gnus-nntp-service)
798 (equal gnus-nntp-service "nntp"))
800 (list gnus-nntp-service)))
802 "Default method for selecting a newsgroup.
803 This variable should be a list, where the first element is how the
804 news is to be fetched, the second is the address.
806 For instance, if you want to get your news via NNTP from
807 \"flab.flab.edu\", you could say:
809 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
811 If you want to use your local spool, say:
813 \(setq gnus-select-method (list 'nnspool (system-name)))
815 If you use this variable, you must set `gnus-nntp-server' to nil.
817 There is a lot more to know about select methods and virtual servers -
818 see the manual for details."
820 :type 'gnus-select-method)
822 (defcustom gnus-message-archive-method
825 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
826 (nnfolder-active-file
827 ,(nnheader-concat message-directory "archive/active"))
828 (nnfolder-get-new-mail nil)
829 (nnfolder-inhibit-expiry t))
830 "Method used for archiving messages you've sent.
831 This should be a mail method.
833 It's probably not a very effective to change this variable once you've
834 run Gnus once. After doing that, you must edit this server from the
838 :type 'gnus-select-method)
840 (defcustom gnus-message-archive-group nil
841 "*Name of the group in which to save the messages you've written.
842 This can either be a string; a list of strings; or an alist
843 of regexps/functions/forms to be evaluated to return a string (or a list
844 of strings). The functions are called with the name of the current
845 group (or nil) as a parameter.
847 If you want to save your mail in one group and the news articles you
848 write in another group, you could say something like:
850 \(setq gnus-message-archive-group
851 '((if (message-news-p)
855 Normally the group names returned by this variable should be
856 unprefixed -- which implicitly means \"store on the archive server\".
857 However, you may wish to store the message on some other server. In
858 that case, just return a fully prefixed name of the group --
859 \"nnml+private:mail.misc\", for instance."
861 :type '(choice (const :tag "none" nil)
864 (defcustom gnus-secondary-servers nil
865 "List of NNTP servers that the user can choose between interactively.
866 To make Gnus query you for a server, you have to give `gnus' a
867 non-numeric prefix - `C-u M-x gnus', in short."
869 :type '(repeat string))
871 (defcustom gnus-nntp-server nil
872 "*The name of the host running the NNTP server.
873 This variable is semi-obsolete. Use the `gnus-select-method'
876 :type '(choice (const :tag "disable" nil)
879 (defcustom gnus-secondary-select-methods nil
880 "A list of secondary methods that will be used for reading news.
881 This is a list where each element is a complete select method (see
882 `gnus-select-method').
884 If, for instance, you want to read your mail with the nnml backend,
885 you could set this variable:
887 \(setq gnus-secondary-select-methods '((nnml \"\")))"
889 :type '(repeat gnus-select-method))
891 (defvar gnus-backup-default-subscribed-newsgroups
892 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
893 "Default default new newsgroups the first time Gnus is run.
894 Should be set in paths.el, and shouldn't be touched by the user.")
896 (defcustom gnus-local-domain nil
897 "Local domain name without a host name.
898 The DOMAINNAME environment variable is used instead if it is defined.
899 If the `system-name' function returns the full Internet name, there is
900 no need to set this variable."
902 :type '(choice (const :tag "default" nil)
905 (defvar gnus-local-organization nil
906 "String with a description of what organization (if any) the user belongs to.
907 Obsolete variable; use `message-user-organization' instead.")
909 ;; Customization variables
911 (defcustom gnus-refer-article-method nil
912 "Preferred method for fetching an article by Message-ID.
913 If you are reading news from the local spool (with nnspool), fetching
914 articles by Message-ID is painfully slow. By setting this method to an
915 nntp method, you might get acceptable results.
917 The value of this variable must be a valid select method as discussed
918 in the documentation of `gnus-select-method'."
920 :type '(choice (const :tag "default" nil)
923 (defcustom gnus-group-faq-directory
924 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
925 "/ftp@sunsite.auc.dk:/pub/usenet/"
926 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
927 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
928 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
929 "/ftp@rtfm.mit.edu:/pub/usenet/"
930 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
931 "/ftp@ftp.sunet.se:/pub/usenet/"
932 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
933 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
934 "/ftp@ftp.hk.super.net:/mirror/faqs/")
935 "Directory where the group FAQs are stored.
936 This will most commonly be on a remote machine, and the file will be
939 This variable can also be a list of directories. In that case, the
940 first element in the list will be used by default. The others can
941 be used when being prompted for a site.
943 Note that Gnus uses an aol machine as the default directory. If this
944 feels fundamentally unclean, just think of it as a way to finally get
945 something of value back from them.
947 If the default site is too slow, try one of these:
949 North America: mirrors.aol.com /pub/rtfm/usenet
950 ftp.seas.gwu.edu /pub/rtfm
951 rtfm.mit.edu /pub/usenet
952 Europe: ftp.uni-paderborn.de /pub/FAQ
953 src.doc.ic.ac.uk /usenet/news-FAQS
954 ftp.sunet.se /pub/usenet
955 sunsite.auc.dk /pub/usenet
956 Asia: nctuccca.edu.tw /USENET/FAQ
957 hwarang.postech.ac.kr /pub/usenet
958 ftp.hk.super.net /mirror/faqs"
959 :group 'gnus-group-various
960 :type '(choice directory
963 (defcustom gnus-use-cross-reference t
964 "*Non-nil means that cross referenced articles will be marked as read.
965 If nil, ignore cross references. If t, mark articles as read in
966 subscribed newsgroups. If neither t nor nil, mark as read in all
969 :type '(choice (const :tag "off" nil)
970 (const :tag "subscribed" t)
974 (defcustom gnus-process-mark ?#
976 :group 'gnus-group-visual
977 :group 'gnus-summary-marks
980 (defcustom gnus-asynchronous nil
981 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
982 :group 'gnus-asynchronous
985 (defcustom gnus-large-newsgroup 200
986 "*The number of articles which indicates a large newsgroup.
987 If the number of articles in a newsgroup is greater than this value,
988 confirmation is required for selecting the newsgroup."
989 :group 'gnus-group-select
992 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
993 "*Non-nil means that the default name of a file to save articles in is the group name.
994 If it's nil, the directory form of the group name is used instead.
996 If this variable is a list, and the list contains the element
997 `not-score', long file names will not be used for score files; if it
998 contains the element `not-save', long file names will not be used for
999 saving; and if it contains the element `not-kill', long file names
1000 will not be used for kill files.
1002 Note that the default for this variable varies according to what system
1003 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1004 to nil while on all other systems it defaults to t."
1008 (defcustom gnus-kill-files-directory gnus-directory
1009 "*Name of the directory where kill files will be stored (default \"~/News\")."
1010 :group 'gnus-score-files
1011 :group 'gnus-score-kill
1014 (defcustom gnus-save-score nil
1015 "*If non-nil, save group scoring info."
1016 :group 'gnus-score-various
1020 (defcustom gnus-use-undo t
1021 "*If non-nil, allow undoing in Gnus group mode buffers."
1025 (defcustom gnus-use-adaptive-scoring nil
1026 "*If non-nil, use some adaptive scoring scheme.
1027 If a list, then the values `word' and `line' are meaningful. The
1028 former will perform adaption on individual words in the subject
1029 header while `line' will perform adaption on several headers."
1031 :group 'gnus-score-adapt
1032 :type '(set (const word) (const line)))
1034 (defcustom gnus-use-cache 'passive
1035 "*If nil, Gnus will ignore the article cache.
1036 If `passive', it will allow entering (and reading) articles
1037 explicitly entered into the cache. If anything else, use the
1038 cache to the full extent of the law."
1041 :type '(choice (const :tag "off" nil)
1042 (const :tag "passive" passive)
1043 (const :tag "active" t)))
1045 (defcustom gnus-use-trees nil
1046 "*If non-nil, display a thread tree buffer."
1050 (defcustom gnus-use-grouplens nil
1051 "*If non-nil, use GroupLens ratings."
1055 (defcustom gnus-keep-backlog nil
1056 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1057 If it is a number N, then Gnus will only keep the last N articles
1058 read. If it is neither nil nor a number, Gnus will keep all read
1059 articles. This is not a good idea."
1061 :type '(choice (const :tag "off" nil)
1066 (defcustom gnus-use-nocem nil
1067 "*If non-nil, Gnus will read NoCeM cancel messages."
1071 (defcustom gnus-suppress-duplicates nil
1072 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1076 (defcustom gnus-use-demon nil
1077 "If non-nil, Gnus might use some demons."
1081 (defcustom gnus-use-scoring t
1082 "*If non-nil, enable scoring."
1086 (defcustom gnus-use-picons nil
1087 "*If non-nil, display picons."
1091 (defcustom gnus-summary-prepare-exit-hook
1092 '(gnus-summary-expire-articles)
1093 "A hook called when preparing to exit from the summary buffer.
1094 It calls `gnus-summary-expire-articles' by default."
1095 :group 'gnus-summary-exit
1098 (defcustom gnus-novice-user t
1099 "*Non-nil means that you are a usenet novice.
1100 If non-nil, verbose messages may be displayed and confirmations may be
1105 (defcustom gnus-expert-user nil
1106 "*Non-nil means that you will never be asked for confirmation about anything.
1107 And that means *anything*."
1111 (defcustom gnus-interactive-catchup t
1112 "*If non-nil, require your confirmation when catching up a group."
1113 :group 'gnus-group-select
1116 (defcustom gnus-interactive-exit t
1117 "*If non-nil, require your confirmation when exiting Gnus."
1121 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1122 "*Function for extracting address components from a From header.
1123 Two pre-defined function exist: `gnus-extract-address-components',
1124 which is the default, quite fast, and too simplistic solution, and
1125 `mail-extract-address-components', which works much better, but is
1127 :group 'gnus-summary-format
1128 :type '(radio (function-item gnus-extract-address-components)
1129 (function-item mail-extract-address-components)
1130 (function :tag "Other")))
1132 (defcustom gnus-carpal nil
1133 "*If non-nil, display clickable icons."
1137 (defcustom gnus-shell-command-separator ";"
1138 "String used to separate to shell commands."
1142 (defcustom gnus-valid-select-methods
1143 '(("nntp" post address prompt-address physical-address)
1144 ("nnspool" post address)
1145 ("nnvirtual" post-mail virtual prompt-address)
1146 ("nnmbox" mail respool address)
1147 ("nnml" mail respool address)
1148 ("nnmh" mail respool address)
1149 ("nndir" post-mail prompt-address physical-address)
1150 ("nneething" none address prompt-address physical-address)
1151 ("nndoc" none address prompt-address)
1152 ("nnbabyl" mail address respool)
1153 ("nnkiboze" post virtual)
1154 ("nnsoup" post-mail address)
1155 ("nndraft" post-mail)
1156 ("nnfolder" mail respool address)
1157 ("nngateway" none address prompt-address physical-address)
1159 "An alist of valid select methods.
1160 The first element of each list lists should be a string with the name
1161 of the select method. The other elements may be the category of
1162 this method (i. e., `post', `mail', `none' or whatever) or other
1163 properties that this method has (like being respoolable).
1164 If you implement a new select method, all you should have to change is
1165 this variable. I think."
1167 :type '(repeat (group (string :tag "Name")
1168 (radio-button-choice (const :format "%v " post)
1169 (const :format "%v " mail)
1170 (const :format "%v " none)
1172 (checklist :inline t
1173 (const :format "%v " address)
1174 (const :format "%v " prompt-address)
1175 (const :format "%v " virtual)
1178 (define-widget 'gnus-select-method 'list
1179 "Widget for entering a select method."
1180 :args `((choice :tag "Method"
1181 ,@(mapcar (lambda (entry)
1182 (list 'const :format "%v\n"
1183 (intern (car entry))))
1184 gnus-valid-select-methods))
1185 (string :tag "Address")
1186 (editable-list :inline t
1189 (sexp :tag "Value")))))
1191 (defcustom gnus-updated-mode-lines '(group article summary tree)
1192 "List of buffers that should update their mode lines.
1193 The list may contain the symbols `group', `article', `tree' and
1194 `summary'. If the corresponding symbol is present, Gnus will keep
1195 that mode line updated with information that may be pertinent.
1196 If this variable is nil, screen refresh may be quicker."
1197 :group 'gnus-various
1198 :type '(set (const group)
1203 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1204 (defcustom gnus-mode-non-string-length nil
1205 "*Max length of mode-line non-string contents.
1206 If this is nil, Gnus will take space as is needed, leaving the rest
1207 of the modeline intact. Note that the default of nil is unlikely
1208 to be desirable; see the manual for further details."
1209 :group 'gnus-various
1210 :type '(choice (const nil)
1213 (defcustom gnus-auto-expirable-newsgroups nil
1214 "*Groups in which to automatically mark read articles as expirable.
1215 If non-nil, this should be a regexp that should match all groups in
1216 which to perform auto-expiry. This only makes sense for mail groups."
1217 :group 'nnmail-expire
1218 :type '(choice (const nil)
1221 (defcustom gnus-total-expirable-newsgroups nil
1222 "*Groups in which to perform expiry of all read articles.
1223 Use with extreme caution. All groups that match this regexp will be
1224 expiring - which means that all read articles will be deleted after
1225 \(say) one week. (This only goes for mail groups and the like, of
1227 :group 'nnmail-expire
1228 :type '(choice (const nil)
1231 (defcustom gnus-group-uncollapsed-levels 1
1232 "Number of group name elements to leave alone when making a short group name."
1233 :group 'gnus-group-visual
1236 (defcustom gnus-group-use-permanent-levels nil
1237 "*If non-nil, once you set a level, Gnus will use this level."
1238 :group 'gnus-group-levels
1243 (defcustom gnus-load-hook nil
1244 "A hook run while Gnus is loaded."
1248 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1249 "A hook called to apply kill files to a group.
1250 This hook is intended to apply a kill file to the selected newsgroup.
1251 The function `gnus-apply-kill-file' is called by default.
1253 Since a general kill file is too heavy to use only for a few
1254 newsgroups, I recommend you to use a lighter hook function. For
1255 example, if you'd like to apply a kill file to articles which contains
1256 a string `rmgroup' in subject in newsgroup `control', you can use the
1259 (setq gnus-apply-kill-hook
1262 (cond ((string-match \"control\" gnus-newsgroup-name)
1263 (gnus-kill \"Subject\" \"rmgroup\")
1264 (gnus-expunge \"X\"))))))"
1265 :group 'gnus-score-kill
1266 :options '(gnus-apply-kill-file)
1269 (defcustom gnus-group-change-level-function nil
1270 "Function run when a group level is changed.
1271 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1272 :group 'gnus-group-level
1277 (defcustom gnus-visual
1278 '(summary-highlight group-highlight article-highlight
1280 summary-menu group-menu article-menu
1281 tree-highlight menu highlight
1282 browse-menu server-menu
1283 page-marker tree-menu binary-menu pick-menu
1285 "Enable visual features.
1286 If `visual' is disabled, there will be no menus and few faces. Most of
1287 the visual customization options below will be ignored. Gnus will use
1288 less space and be faster as a result.
1290 This variable can also be a list of visual elements to switch on. For
1291 instance, to switch off all visual things except menus, you can say:
1293 (setq gnus-visual '(menu))
1295 Valid elements include `summary-highlight', `group-highlight',
1296 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1297 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1298 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1299 and `grouplens-menu'."
1302 :type '(set (const summary-highlight)
1303 (const group-highlight)
1304 (const article-highlight)
1306 (const summary-menu)
1308 (const article-menu)
1309 (const tree-highlight)
1318 (const grouplens-menu)))
1320 (defcustom gnus-mouse-face
1322 (if (gnus-visual-p 'mouse-face 'highlight)
1323 (if (boundp 'gnus-mouse-face)
1324 (or gnus-mouse-face 'highlight)
1328 "Face used for group or summary buffer mouse highlighting.
1329 The line beneath the mouse pointer will be highlighted with this
1334 (defcustom gnus-article-display-hook
1335 (if (and (string-match "XEmacs" emacs-version)
1337 '(gnus-article-hide-headers-if-wanted
1338 gnus-article-hide-boring-headers
1339 gnus-article-treat-overstrike
1340 gnus-article-maybe-highlight
1341 gnus-article-display-x-face)
1342 '(gnus-article-hide-headers-if-wanted
1343 gnus-article-hide-boring-headers
1344 gnus-article-treat-overstrike
1345 gnus-article-maybe-highlight))
1346 "Controls how the article buffer will look.
1348 If you leave the list empty, the article will appear exactly as it is
1349 stored on the disk. The list entries will hide or highlight various
1350 parts of the article, making it easier to find the information you
1352 :group 'gnus-article-highlight
1355 :options '(gnus-article-add-buttons
1356 gnus-article-add-buttons-to-head
1357 gnus-article-emphasize
1358 gnus-article-fill-cited-article
1359 gnus-article-remove-cr
1360 gnus-article-de-quoted-unreadable
1361 gnus-summary-stop-page-breaking
1362 ;; gnus-summary-caesar-message
1363 ;; gnus-summary-verbose-headers
1364 gnus-summary-toggle-mime
1366 gnus-article-hide-headers
1367 gnus-article-hide-boring-headers
1368 gnus-article-hide-signature
1369 gnus-article-hide-citation
1370 gnus-article-hide-pgp
1371 gnus-article-hide-pem
1372 gnus-article-highlight
1373 gnus-article-highlight-headers
1374 gnus-article-highlight-citation
1375 gnus-article-highlight-signature
1376 gnus-article-date-ut
1377 gnus-article-date-local
1378 gnus-article-date-lapsed
1379 gnus-article-date-original
1380 gnus-article-remove-trailing-blank-lines
1381 gnus-article-strip-leading-blank-lines
1382 gnus-article-strip-multiple-blank-lines
1383 gnus-article-strip-blank-lines
1384 gnus-article-treat-overstrike
1385 gnus-article-display-x-face
1386 gnus-smiley-display))
1388 (defcustom gnus-article-save-directory gnus-directory
1389 "*Name of the directory articles will be saved in (default \"~/News\")."
1390 :group 'gnus-article-saving
1394 ;;; Internal variables
1396 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1397 (defvar gnus-original-article-buffer " *Original Article*")
1398 (defvar gnus-newsgroup-name nil)
1400 (defvar gnus-current-select-method nil
1401 "The current method for selecting a newsgroup.")
1403 (defvar gnus-tree-buffer "*Tree*"
1404 "Buffer where Gnus thread trees are displayed.")
1407 (defvar gnus-use-generic-from nil)
1409 ;; Variable holding the user answers to all method prompts.
1410 (defvar gnus-method-history nil)
1411 (defvar gnus-group-history nil)
1413 ;; Variable holding the user answers to all mail method prompts.
1414 (defvar gnus-mail-method-history nil)
1416 ;; Variable holding the user answers to all group prompts.
1417 (defvar gnus-group-history nil)
1419 (defvar gnus-server-alist nil
1420 "List of available servers.")
1422 (defvar gnus-predefined-server-alist
1425 (nnspool-spool-directory "~/News/cache/")
1426 (nnspool-nov-directory "~/News/cache/")
1427 (nnspool-active-file "~/News/cache/active"))))
1428 "List of predefined (convenience) servers.")
1430 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1432 (defconst gnus-article-mark-lists
1433 '((marked . tick) (replied . reply)
1434 (expirable . expire) (killed . killed)
1435 (bookmarks . bookmark) (dormant . dormant)
1436 (scored . score) (saved . save)
1439 (defvar gnus-headers-retrieved-by nil)
1440 (defvar gnus-article-reply nil)
1441 (defvar gnus-override-method nil)
1442 (defvar gnus-article-check-size nil)
1443 (defvar gnus-opened-servers nil)
1445 (defvar gnus-current-kill-article nil)
1447 (defvar gnus-have-read-active-file nil)
1449 (defconst gnus-maintainer
1450 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1451 "The mail address of the Gnus maintainers.")
1453 (defvar gnus-info-nodes
1454 '((gnus-group-mode "(gnus)The Group Buffer")
1455 (gnus-summary-mode "(gnus)The Summary Buffer")
1456 (gnus-article-mode "(gnus)The Article Buffer")
1457 (mime/viewer-mode "(gnus)The Article Buffer")
1458 (gnus-server-mode "(gnus)The Server Buffer")
1459 (gnus-browse-mode "(gnus)Browse Foreign Server")
1460 (gnus-tree-mode "(gnus)Tree Display"))
1461 "Alist of major modes and related Info nodes.")
1463 (defvar gnus-group-buffer "*Group*")
1464 (defvar gnus-summary-buffer "*Summary*")
1465 (defvar gnus-article-buffer "*Article*")
1466 (defvar gnus-server-buffer "*Server*")
1468 (defvar gnus-buffer-list nil
1469 "Gnus buffers that should be killed on exit.")
1471 (defvar gnus-slave nil
1472 "Whether this Gnus is a slave or not.")
1474 (defvar gnus-batch-mode nil
1475 "Whether this Gnus is running in batch mode or not.")
1477 (defvar gnus-variable-list
1478 '(gnus-newsrc-options gnus-newsrc-options-n
1479 gnus-newsrc-last-checked-date
1480 gnus-newsrc-alist gnus-server-alist
1481 gnus-killed-list gnus-zombie-list
1482 gnus-topic-topology gnus-topic-alist
1484 "Gnus variables saved in the quick startup file.")
1486 (defvar gnus-newsrc-alist nil
1487 "Assoc list of read articles.
1488 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1490 (defvar gnus-newsrc-hashtb nil
1491 "Hashtable of gnus-newsrc-alist.")
1493 (defvar gnus-killed-list nil
1494 "List of killed newsgroups.")
1496 (defvar gnus-killed-hashtb nil
1497 "Hash table equivalent of gnus-killed-list.")
1499 (defvar gnus-zombie-list nil
1500 "List of almost dead newsgroups.")
1502 (defvar gnus-description-hashtb nil
1503 "Descriptions of newsgroups.")
1505 (defvar gnus-list-of-killed-groups nil
1506 "List of newsgroups that have recently been killed by the user.")
1508 (defvar gnus-active-hashtb nil
1509 "Hashtable of active articles.")
1511 (defvar gnus-moderated-hashtb nil
1512 "Hashtable of moderated newsgroups.")
1514 ;; Save window configuration.
1515 (defvar gnus-prev-winconf nil)
1517 (defvar gnus-reffed-article-number nil)
1519 ;;; Let the byte-compiler know that we know about this variable.
1520 (defvar rmail-default-rmail-file)
1522 (defvar gnus-dead-summary nil)
1524 ;;; End of variables.
1526 ;; Define some autoload functions Gnus might use.
1529 ;; This little mapcar goes through the list below and marks the
1530 ;; symbols in question as autoloaded functions.
1533 (let ((interactive (nth 1 (memq ':interactive package))))
1537 (when (consp function)
1538 (setq keymap (car (memq 'keymap function)))
1539 (setq function (car function)))
1540 (autoload function (car package) nil interactive keymap)))
1541 (if (eq (nth 1 package) ':interactive)
1544 '(("metamail" metamail-buffer)
1545 ("info" Info-goto-node)
1546 ("hexl" hexl-hex-string-to-integer)
1547 ("pp" pp pp-to-string pp-eval-expression)
1548 ("ps-print" ps-print-preprint)
1549 ("mail-extr" mail-extract-address-components)
1550 ("message" :interactive t
1551 message-send-and-exit message-yank-original)
1552 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1553 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1554 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1555 timezone-make-sortable-date timezone-make-time-string)
1556 ("rmailout" rmail-output)
1557 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1559 ("gnus-audio" :interactive t gnus-audio-play)
1560 ("gnus-xmas" gnus-xmas-splash)
1561 ("gnus-soup" :interactive t
1562 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1563 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1564 ("nnsoup" nnsoup-pack-replies)
1565 ("score-mode" :interactive t gnus-score-mode)
1566 ("gnus-mh" gnus-summary-save-article-folder
1567 gnus-Folder-save-name gnus-folder-save-name)
1568 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1569 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1570 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1571 gnus-demon-add-disconnection gnus-demon-add-handler
1572 gnus-demon-remove-handler)
1573 ("gnus-demon" :interactive t
1574 gnus-demon-init gnus-demon-cancel)
1575 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1576 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1577 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1578 gnus-nocem-unwanted-article-p)
1579 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info)
1580 ("gnus-srvr" gnus-browse-foreign-server)
1581 ("gnus-cite" :interactive t
1582 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1583 gnus-article-hide-citation gnus-article-fill-cited-article
1584 gnus-article-hide-citation-in-followups)
1585 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1586 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1587 gnus-execute gnus-expunge)
1588 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1589 gnus-cache-possibly-remove-articles gnus-cache-request-article
1590 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1591 gnus-cache-enter-remove-article gnus-cached-article-p
1592 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1593 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1594 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1595 ("gnus-score" :interactive t
1596 gnus-summary-increase-score gnus-summary-set-score
1597 gnus-summary-raise-thread gnus-summary-raise-same-subject
1598 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1599 gnus-summary-lower-thread gnus-summary-lower-same-subject
1600 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1601 gnus-summary-current-score gnus-score-default
1602 gnus-score-flush-cache gnus-score-close
1603 gnus-possibly-score-headers gnus-score-followup-article
1604 gnus-score-followup-thread)
1606 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1607 gnus-current-score-file-nondirectory gnus-score-adaptive
1608 gnus-score-find-trace gnus-score-file-name)
1609 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1610 ("gnus-topic" :interactive t gnus-topic-mode)
1611 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1612 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1613 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1614 ("gnus-uu" :interactive t
1615 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1616 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1617 gnus-uu-mark-by-regexp gnus-uu-mark-all
1618 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1619 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1620 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1621 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1622 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1623 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1624 gnus-uu-decode-binhex-view)
1625 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1626 ("gnus-msg" (gnus-summary-send-map keymap)
1627 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1628 ("gnus-msg" :interactive t
1629 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1630 gnus-summary-followup gnus-summary-followup-with-original
1631 gnus-summary-cancel-article gnus-summary-supersede-article
1632 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1633 gnus-summary-mail-forward gnus-summary-mail-other-window
1634 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1636 ("gnus-picon" :interactive t gnus-article-display-picons
1637 gnus-group-display-picons gnus-picons-article-display-x-face
1638 gnus-picons-display-x-face)
1639 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1640 gnus-grouplens-mode)
1641 ("smiley" :interactive t gnus-smiley-display)
1642 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1643 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1644 gnus-list-of-unread-articles gnus-list-of-read-articles
1645 gnus-offer-save-summaries gnus-make-thread-indent-array
1646 gnus-summary-exit gnus-update-read-articles)
1647 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1648 gnus-group-list-groups gnus-group-first-unread-group
1649 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1650 gnus-group-setup-buffer gnus-group-get-new-news
1651 gnus-group-make-help-group gnus-group-update-group)
1652 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1653 gnus-backlog-remove-article)
1654 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1655 gnus-article-prepare gnus-article-set-window-start
1656 gnus-article-next-page gnus-article-prev-page
1657 gnus-request-article-this-buffer gnus-article-mode
1658 gnus-article-setup-buffer gnus-narrow-to-page
1659 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1660 ("gnus-art" :interactive t
1661 gnus-article-hide-headers gnus-article-hide-boring-headers
1662 gnus-article-treat-overstrike gnus-article-word-wrap
1663 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1664 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1665 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1666 gnus-article-hide-pem gnus-article-hide-signature
1667 gnus-article-strip-leading-blank-lines gnus-article-date-local
1668 gnus-article-date-original gnus-article-date-lapsed
1669 gnus-article-show-all-headers
1670 gnus-article-edit-mode gnus-article-edit-article
1671 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522)
1672 ("gnus-int" gnus-request-type)
1673 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1675 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1676 gnus-dup-enter-articles)
1677 ("gnus-range" gnus-copy-sequence)
1678 ("gnus-eform" gnus-edit-form)
1679 ("gnus-move" :interactive t
1680 gnus-group-move-group-to-server gnus-change-server)
1681 ("gnus-logic" gnus-score-advanced)
1682 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1683 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1684 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1685 gnus-async-halt-prefetch)
1686 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1687 gnus-summary-save-article-vm))))
1689 ;;; gnus-sum.el thingies
1692 (defcustom gnus-summary-line-format "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
1693 "*The format specification of the lines in the summary buffer.
1695 It works along the same lines as a normal formatting string,
1696 with some simple extensions.
1698 %N Article number, left padded with spaces (string)
1700 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1701 %n Name of the poster (string)
1702 %a Extracted name of the poster (string)
1703 %A Extracted address of the poster (string)
1704 %F Contents of the From: header (string)
1705 %x Contents of the Xref: header (string)
1706 %D Date of the article (string)
1707 %d Date of the article (string) in DD-MMM format
1708 %M Message-id of the article (string)
1709 %r References of the article (string)
1710 %c Number of characters in the article (integer)
1711 %L Number of lines in the article (integer)
1712 %I Indentation based on thread level (a string of spaces)
1713 %T A string with two possible values: 80 spaces if the article
1714 is on thread level two or larger and 0 spaces on level one
1715 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1716 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1717 %[ Opening bracket (character, \"[\" or \"<\")
1718 %] Closing bracket (character, \"]\" or \">\")
1719 %> Spaces of length thread-level (string)
1720 %< Spaces of length (- 20 thread-level) (string)
1721 %i Article score (number)
1722 %z Article zcore (character)
1723 %t Number of articles under the current thread (number).
1724 %e Whether the thread is empty or not (character).
1725 %l GroupLens score (string).
1726 %V Total thread score (number).
1727 %P The line number (number).
1728 %u User defined specifier. The next character in the format string should
1729 be a letter. Gnus will call the function gnus-user-format-function-X,
1730 where X is the letter following %u. The function will be passed the
1731 current header as argument. The function should return a string, which
1732 will be inserted into the summary just like information from any other
1735 Text between %( and %) will be highlighted with `gnus-mouse-face'
1736 when the mouse point is placed inside the area. There can only be one
1739 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1740 with care. For reasons of efficiency, Gnus will compute what column
1741 these characters will end up in, and \"hard-code\" that. This means that
1742 it is illegal to have these specs after a variable-length spec. Well,
1743 you might not be arrested, but your summary buffer will look strange,
1744 which is bad enough.
1746 The smart choice is to have these specs as for to the left as
1749 This restriction may disappear in later versions of Gnus."
1751 :group 'gnus-summary-format)
1754 ;;; Skeleton keymaps
1757 (defun gnus-suppress-keymap (keymap)
1758 (suppress-keymap keymap)
1759 (let ((keys `([delete] "\177" "\M-u"))) ;gnus-mouse-2
1761 (define-key keymap (pop keys) 'undefined))))
1763 (defvar gnus-article-mode-map
1764 (let ((keymap (make-keymap)))
1765 (gnus-suppress-keymap keymap)
1767 (defvar gnus-summary-mode-map
1768 (let ((keymap (make-keymap)))
1769 (gnus-suppress-keymap keymap)
1771 (defvar gnus-group-mode-map
1772 (let ((keymap (make-keymap)))
1773 (gnus-suppress-keymap keymap)
1778 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1779 ;; If you want the cursor to go somewhere else, set these two
1780 ;; functions in some startup hook to whatever you want.
1781 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1782 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1784 ;;; Various macros and substs.
1786 (defun gnus-header-from (header)
1787 (mail-header-from header))
1789 (defmacro gnus-gethash (string hashtable)
1790 "Get hash value of STRING in HASHTABLE."
1791 `(symbol-value (intern-soft ,string ,hashtable)))
1793 (defmacro gnus-sethash (string value hashtable)
1794 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1795 `(set (intern ,string ,hashtable) ,value))
1796 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1798 (defmacro gnus-group-unread (group)
1799 "Get the currently computed number of unread articles in GROUP."
1800 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1802 (defmacro gnus-group-entry (group)
1803 "Get the newsrc entry for GROUP."
1804 `(gnus-gethash ,group gnus-newsrc-hashtb))
1806 (defmacro gnus-active (group)
1807 "Get active info on GROUP."
1808 `(gnus-gethash ,group gnus-active-hashtb))
1810 (defmacro gnus-set-active (group active)
1811 "Set GROUP's active info."
1812 `(gnus-sethash ,group ,active gnus-active-hashtb))
1814 (defun gnus-alive-p ()
1815 "Say whether Gnus is running or not."
1816 (and gnus-group-buffer
1817 (get-buffer gnus-group-buffer)
1819 (set-buffer gnus-group-buffer)
1820 (eq major-mode 'gnus-group-mode))))
1822 ;; Info access macros.
1824 (defmacro gnus-info-group (info)
1826 (defmacro gnus-info-rank (info)
1828 (defmacro gnus-info-read (info)
1830 (defmacro gnus-info-marks (info)
1832 (defmacro gnus-info-method (info)
1834 (defmacro gnus-info-params (info)
1837 (defmacro gnus-info-level (info)
1838 `(let ((rank (gnus-info-rank ,info)))
1842 (defmacro gnus-info-score (info)
1843 `(let ((rank (gnus-info-rank ,info)))
1844 (or (and (consp rank) (cdr rank)) 0)))
1846 (defmacro gnus-info-set-group (info group)
1847 `(setcar ,info ,group))
1848 (defmacro gnus-info-set-rank (info rank)
1849 `(setcar (nthcdr 1 ,info) ,rank))
1850 (defmacro gnus-info-set-read (info read)
1851 `(setcar (nthcdr 2 ,info) ,read))
1852 (defmacro gnus-info-set-marks (info marks &optional extend)
1854 `(gnus-info-set-entry ,info ,marks 3)
1855 `(setcar (nthcdr 3 ,info) ,marks)))
1856 (defmacro gnus-info-set-method (info method &optional extend)
1858 `(gnus-info-set-entry ,info ,method 4)
1859 `(setcar (nthcdr 4 ,info) ,method)))
1860 (defmacro gnus-info-set-params (info params &optional extend)
1862 `(gnus-info-set-entry ,info ,params 5)
1863 `(setcar (nthcdr 5 ,info) ,params)))
1865 (defun gnus-info-set-entry (info entry number)
1866 ;; Extend the info until we have enough elements.
1867 (while (<= (length info) number)
1868 (nconc info (list nil)))
1870 (setcar (nthcdr number info) entry))
1872 (defmacro gnus-info-set-level (info level)
1873 `(let ((rank (cdr ,info)))
1874 (if (consp (car rank))
1875 (setcar (car rank) ,level)
1876 (setcar rank ,level))))
1877 (defmacro gnus-info-set-score (info score)
1878 `(let ((rank (cdr ,info)))
1879 (if (consp (car rank))
1880 (setcdr (car rank) ,score)
1881 (setcar rank (cons (car rank) ,score)))))
1883 (defmacro gnus-get-info (group)
1884 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1886 ;; Byte-compiler warning.
1887 (defvar gnus-visual)
1888 ;; Find out whether the gnus-visual TYPE is wanted.
1889 (defun gnus-visual-p (&optional type class)
1890 (and gnus-visual ; Has to be non-nil, at least.
1891 (if (not type) ; We don't care about type.
1893 (if (listp gnus-visual) ; It's a list, so we check it.
1894 (or (memq type gnus-visual)
1895 (memq class gnus-visual))
1898 ;;; Load the compatability functions.
1907 (defvar gnus-shutdown-alist nil)
1909 (defun gnus-add-shutdown (function &rest symbols)
1910 "Run FUNCTION whenever one of SYMBOLS is shut down."
1911 (push (cons function symbols) gnus-shutdown-alist))
1913 (defun gnus-shutdown (symbol)
1914 "Shut down everything that waits for SYMBOL."
1915 (let ((alist gnus-shutdown-alist)
1917 (while (setq entry (pop alist))
1918 (when (memq symbol (cdr entry))
1919 (funcall (car entry))))))
1923 ;;; Gnus Utility Functions
1926 (defmacro gnus-string-or (&rest strings)
1927 "Return the first element of STRINGS that is a non-blank string.
1928 STRINGS will be evaluated in normal `or' order."
1929 `(gnus-string-or-1 ',strings))
1931 (defun gnus-string-or-1 (strings)
1934 (setq string (eval (pop strings)))
1935 (if (string-match "^[ \t]*$" string)
1937 (setq strings nil)))
1940 ;; Add the current buffer to the list of buffers to be killed on exit.
1941 (defun gnus-add-current-to-buffer-list ()
1942 (or (memq (current-buffer) gnus-buffer-list)
1943 (push (current-buffer) gnus-buffer-list)))
1945 (defun gnus-version (&optional arg)
1946 "Version number of this version of Gnus.
1947 If ARG, insert string at point."
1949 (let ((methods gnus-valid-select-methods)
1952 ;; Go through all the legal select methods and add their version
1953 ;; numbers to the total version string. Only the backends that are
1954 ;; currently in use will have their message numbers taken into
1957 (setq meth (intern (concat (caar methods) "-version")))
1959 (stringp (symbol-value meth))
1960 (setq mess (concat mess "; " (symbol-value meth))))
1961 (setq methods (cdr methods)))
1963 (insert (message mess))
1966 (defun gnus-continuum-version (version)
1967 "Return VERSION as a floating point number."
1968 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1969 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1970 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1971 (number (match-string 2 version))
1973 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1974 (setq major (string-to-number (match-string 1 number)))
1975 (setq minor (string-to-number (match-string 2 number)))
1976 (setq least (if (match-beginning 3)
1977 (string-to-number (match-string 3 number))
1981 (format "%s00%02d%02d"
1983 ((member alpha '("(ding)" "d")) "4.99")
1984 ((member alpha '("September" "s")) "5.01")
1985 ((member alpha '("Red" "r")) "5.03"))
1987 (format "%d.%02d%02d" major minor least))))))
1989 (defun gnus-info-find-node ()
1990 "Find Info documentation of Gnus."
1992 ;; Enlarge info window if needed.
1993 (let (gnus-info-buffer)
1994 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1995 (setq gnus-info-buffer (current-buffer))
1996 (gnus-configure-windows 'info)))
1998 ;;; More various functions.
2000 (defsubst gnus-check-backend-function (func group)
2001 "Check whether GROUP supports function FUNC.
2002 GROUP can either be a string (a group name) or a select method."
2004 (let ((method (if (stringp group)
2005 (car (gnus-find-method-for-group group))
2007 (unless (featurep method)
2009 (fboundp (intern (format "%s-%s" method func))))))
2011 (defun gnus-group-read-only-p (&optional group)
2012 "Check whether GROUP supports editing or not.
2013 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2014 that that variable is buffer-local to the summary buffers."
2015 (let ((group (or group gnus-newsgroup-name)))
2016 (not (gnus-check-backend-function 'request-replace-article group))))
2018 (defun gnus-group-total-expirable-p (group)
2019 "Check whether GROUP is total-expirable or not."
2020 (let ((params (gnus-group-find-parameter group))
2023 ((memq 'total-expire params)
2025 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2027 (gnus-total-expirable-newsgroups ; Check var.
2028 (string-match gnus-total-expirable-newsgroups group)))))
2030 (defun gnus-group-auto-expirable-p (group)
2031 "Check whether GROUP is auto-expirable or not."
2032 (let ((params (gnus-group-find-parameter group))
2035 ((memq 'auto-expire params)
2037 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2039 (gnus-auto-expirable-newsgroups ; Check var.
2040 (string-match gnus-auto-expirable-newsgroups group)))))
2042 (defun gnus-virtual-group-p (group)
2043 "Say whether GROUP is virtual or not."
2044 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2045 gnus-valid-select-methods)))
2047 (defun gnus-news-group-p (group &optional article)
2048 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2049 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2050 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2051 (eq (gnus-request-type group article) 'news))))
2053 ;; Returns a list of writable groups.
2054 (defun gnus-writable-groups ()
2055 (let ((alist gnus-newsrc-alist)
2057 (while (setq group (car (pop alist)))
2058 (unless (gnus-group-read-only-p group)
2059 (push group groups)))
2062 ;; Check whether to use long file names.
2063 (defun gnus-use-long-file-name (symbol)
2064 ;; The variable has to be set...
2065 (and gnus-use-long-file-name
2066 ;; If it isn't a list, then we return t.
2067 (or (not (listp gnus-use-long-file-name))
2068 ;; If it is a list, and the list contains `symbol', we
2070 (not (memq symbol gnus-use-long-file-name)))))
2072 ;; Generate a unique new group name.
2073 (defun gnus-generate-new-group-name (leaf)
2076 (while (gnus-gethash name gnus-newsrc-hashtb)
2077 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2080 (defun gnus-ephemeral-group-p (group)
2081 "Say whether GROUP is ephemeral or not."
2082 (gnus-group-get-parameter group 'quit-config))
2084 (defun gnus-group-quit-config (group)
2085 "Return the quit-config of GROUP."
2086 (gnus-group-get-parameter group 'quit-config))
2088 (defun gnus-kill-ephemeral-group (group)
2089 "Remove ephemeral GROUP from relevant structures."
2090 (gnus-sethash group nil gnus-newsrc-hashtb))
2092 (defun gnus-simplify-mode-line ()
2093 "Make mode lines a bit simpler."
2094 (setq mode-line-modified (cdr gnus-mode-line-modified))
2095 (when (listp mode-line-format)
2096 (make-local-variable 'mode-line-format)
2097 (setq mode-line-format (copy-sequence mode-line-format))
2098 (when (equal (nth 3 mode-line-format) " ")
2099 (setcar (nthcdr 3 mode-line-format) " "))))
2101 ;;; Servers and groups.
2103 (defsubst gnus-server-add-address (method)
2104 (let ((method-name (symbol-name (car method))))
2105 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2106 (not (assq (intern (concat method-name "-address")) method))
2107 (memq 'physical-address (assq (car method)
2108 gnus-valid-select-methods)))
2109 (append method (list (list (intern (concat method-name "-address"))
2113 (defsubst gnus-server-get-method (group method)
2114 ;; Input either a server name, and extended server name, or a
2115 ;; select method, and return a select method.
2116 (cond ((stringp method)
2117 (gnus-server-to-method method))
2118 ((equal method gnus-select-method)
2120 ((and (stringp (car method)) group)
2121 (gnus-server-extend-method group method))
2122 ((and method (not group)
2123 (equal (cadr method) ""))
2126 (gnus-server-add-address method))))
2128 (defun gnus-server-to-method (server)
2129 "Map virtual server names to select methods."
2131 ;; Is this a method, perhaps?
2132 (and server (listp server) server)
2133 ;; Perhaps this is the native server?
2134 (and (equal server "native") gnus-select-method)
2135 ;; It should be in the server alist.
2136 (cdr (assoc server gnus-server-alist))
2137 ;; It could be in the predefined server alist.
2138 (cdr (assoc server gnus-predefined-server-alist))
2139 ;; If not, we look through all the opened server
2140 ;; to see whether we can find it there.
2141 (let ((opened gnus-opened-servers))
2143 (not (equal server (format "%s:%s" (caaar opened)
2148 (defmacro gnus-method-equal (ss1 ss2)
2149 "Say whether two servers are equal."
2153 (and (= (length s1) (length s2))
2155 (while (and s1 (member (car s1) s2))
2159 (defun gnus-server-equal (m1 m2)
2160 "Say whether two methods are equal."
2161 (let ((m1 (cond ((null m1) gnus-select-method)
2162 ((stringp m1) (gnus-server-to-method m1))
2164 (m2 (cond ((null m2) gnus-select-method)
2165 ((stringp m2) (gnus-server-to-method m2))
2167 (gnus-method-equal m1 m2)))
2169 (defun gnus-servers-using-backend (backend)
2170 "Return a list of known servers using BACKEND."
2171 (let ((opened gnus-opened-servers)
2174 (when (eq backend (caaar opened))
2175 (push (caar opened) out))
2179 (defun gnus-archive-server-wanted-p ()
2180 "Say whether the user wants to use the archive server."
2182 ((or (not gnus-message-archive-method)
2183 (not gnus-message-archive-group))
2185 ((and gnus-message-archive-method gnus-message-archive-group)
2188 (let ((active (cadr (assq 'nnfolder-active-file
2189 gnus-message-archive-method))))
2191 (file-exists-p active))))))
2193 (defun gnus-group-prefixed-name (group method)
2194 "Return the whole name from GROUP and METHOD."
2195 (and (stringp method) (setq method (gnus-server-to-method method)))
2198 (concat (format "%s" (car method))
2200 (or (assoc (format "%s" (car method))
2201 (gnus-methods-using 'address))
2202 (gnus-server-equal method gnus-message-archive-method))
2204 (not (string= (nth 1 method) "")))
2205 (concat "+" (nth 1 method)))
2208 (defun gnus-group-real-prefix (group)
2209 "Return the prefix of the current group name."
2210 (if (string-match "^[^:]+:" group)
2211 (substring group 0 (match-end 0))
2214 (defun gnus-group-method (group)
2215 "Return the server or method used for selecting GROUP.
2216 You should probably use `gnus-find-method-for-group' instead."
2217 (let ((prefix (gnus-group-real-prefix group)))
2218 (if (equal prefix "")
2220 (let ((servers gnus-opened-servers)
2222 backend possible found)
2223 (if (string-match "^[^\\+]+\\+" prefix)
2224 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2225 server (substring prefix (match-end 0) (1- (length prefix))))
2226 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2228 (when (eq (caaar servers) backend)
2229 (setq possible (caar servers))
2230 (when (equal (cadaar servers) server)
2231 (setq found (caar servers))))
2233 (or (car (rassoc found gnus-server-alist))
2235 (car (rassoc possible gnus-server-alist))
2237 (list backend server))))))
2239 (defsubst gnus-secondary-method-p (method)
2240 "Return whether METHOD is a secondary select method."
2241 (let ((methods gnus-secondary-select-methods)
2242 (gmethod (gnus-server-get-method nil method)))
2244 (not (equal (gnus-server-get-method nil (car methods))
2246 (setq methods (cdr methods)))
2249 (defun gnus-group-foreign-p (group)
2250 "Say whether a group is foreign or not."
2251 (and (not (gnus-group-native-p group))
2252 (not (gnus-group-secondary-p group))))
2254 (defun gnus-group-native-p (group)
2255 "Say whether the group is native or not."
2256 (not (string-match ":" group)))
2258 (defun gnus-group-secondary-p (group)
2259 "Say whether the group is secondary or not."
2260 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2262 (defun gnus-group-find-parameter (group &optional symbol)
2263 "Return the group parameters for GROUP.
2264 If SYMBOL, return the value of that symbol in the group parameters."
2266 (set-buffer gnus-group-buffer)
2267 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2269 (gnus-group-parameter-value parameters symbol)
2272 (defun gnus-group-get-parameter (group &optional symbol)
2273 "Return the group parameters for GROUP.
2274 If SYMBOL, return the value of that symbol in the group parameters."
2275 (let ((params (gnus-info-params (gnus-get-info group))))
2277 (gnus-group-parameter-value params symbol)
2280 (defun gnus-group-parameter-value (params symbol)
2281 "Return the value of SYMBOL in group PARAMS."
2282 (or (car (memq symbol params)) ; It's either a simple symbol
2283 (cdr (assq symbol params)))) ; or a cons.
2285 (defun gnus-group-add-parameter (group param)
2286 "Add parameter PARAM to GROUP."
2287 (let ((info (gnus-get-info group)))
2289 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2290 ;; Cons the new param to the old one and update.
2291 (gnus-group-set-info (cons param (gnus-info-params info))
2294 (defun gnus-group-set-parameter (group name value)
2295 "Set parameter NAME to VALUE in GROUP."
2296 (let ((info (gnus-get-info group)))
2298 (gnus-group-remove-parameter group name)
2299 (let ((old-params (gnus-info-params info))
2300 (new-params (list (cons name value))))
2302 (when (or (not (listp (car old-params)))
2303 (not (eq (caar old-params) name)))
2304 (setq new-params (append new-params (list (car old-params)))))
2305 (setq old-params (cdr old-params)))
2306 (gnus-group-set-info new-params group 'params)))))
2308 (defun gnus-group-remove-parameter (group name)
2309 "Remove parameter NAME from GROUP."
2310 (let ((info (gnus-get-info group)))
2312 (let ((params (gnus-info-params info)))
2314 (setq params (delq name params))
2315 (while (assq name params)
2316 (setq params (delq (assq name params) params)))
2317 (gnus-info-set-params info params))))))
2319 (defun gnus-group-add-score (group &optional score)
2320 "Add SCORE to the GROUP score.
2321 If SCORE is nil, add 1 to the score of GROUP."
2322 (let ((info (gnus-get-info group)))
2324 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2326 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2327 (defun gnus-short-group-name (group &optional levels)
2328 "Collapse GROUP name LEVELS.
2329 Select methods are stripped and any remote host name is stripped down to
2330 just the host name."
2331 (let* ((name "") (foreign "") (depth -1) (skip 1)
2334 (while (string-match "\\." group skip)
2335 (setq skip (match-end 0)
2338 ;; separate foreign select method from group name and collapse.
2339 ;; if method contains a server, collapse to non-domain server name,
2340 ;; otherwise collapse to select method
2341 (when (string-match ":" group)
2342 (cond ((string-match "+" group)
2343 (let* ((plus (string-match "+" group))
2344 (colon (string-match ":" group (or plus 0)))
2345 (dot (string-match "\\." group)))
2346 (setq foreign (concat
2347 (substring group (+ 1 plus)
2348 (cond ((null dot) colon)
2349 ((< colon dot) colon)
2350 ((< dot colon) dot)))
2352 group (substring group (+ 1 colon)))))
2354 (let* ((colon (string-match ":" group)))
2355 (setq foreign (concat (substring group 0 (+ 1 colon)))
2356 group (substring group (+ 1 colon)))))))
2357 ;; collapse group name leaving LEVELS uncollapsed elements
2359 (if (and (string-match "\\." group) (> levels 0))
2360 (setq name (concat name (substring group 0 1))
2361 group (substring group (match-end 0))
2363 name (concat name "."))
2364 (setq name (concat foreign name group)
2368 (defun gnus-narrow-to-body ()
2369 "Narrow to the body of an article."
2372 (goto-char (point-min))
2373 (or (search-forward "\n\n" nil t)
2379 ;;; Kill file handling.
2382 (defun gnus-apply-kill-file ()
2383 "Apply a kill file to the current newsgroup.
2384 Returns the number of articles marked as read."
2385 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2386 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2387 (gnus-apply-kill-file-internal)
2390 (defun gnus-kill-save-kill-buffer ()
2391 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2392 (when (get-file-buffer file)
2394 (set-buffer (get-file-buffer file))
2395 (when (buffer-modified-p)
2397 (kill-buffer (current-buffer))))))
2399 (defcustom gnus-kill-file-name "KILL"
2400 "Suffix of the kill files."
2401 :group 'gnus-score-kill
2402 :group 'gnus-score-files
2405 (defun gnus-newsgroup-kill-file (newsgroup)
2406 "Return the name of a kill file name for NEWSGROUP.
2407 If NEWSGROUP is nil, return the global kill file name instead."
2409 ;; The global KILL file is placed at top of the directory.
2410 ((or (null newsgroup)
2411 (string-equal newsgroup ""))
2412 (expand-file-name gnus-kill-file-name
2413 gnus-kill-files-directory))
2414 ;; Append ".KILL" to newsgroup name.
2415 ((gnus-use-long-file-name 'not-kill)
2416 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2417 "." gnus-kill-file-name)
2418 gnus-kill-files-directory))
2419 ;; Place "KILL" under the hierarchical directory.
2421 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2422 "/" gnus-kill-file-name)
2423 gnus-kill-files-directory))))
2427 (defun gnus-member-of-valid (symbol group)
2428 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2430 (symbol-name (car (gnus-find-method-for-group group)))
2431 gnus-valid-select-methods)))
2433 (defun gnus-method-option-p (method option)
2434 "Return non-nil if select METHOD has OPTION as a parameter."
2435 (when (stringp method)
2436 (setq method (gnus-server-to-method method)))
2437 (memq option (assoc (format "%s" (car method))
2438 gnus-valid-select-methods)))
2440 (defun gnus-similar-server-opened (method)
2441 (let ((opened gnus-opened-servers))
2442 (while (and method opened)
2443 (when (and (equal (cadr method) (cadaar opened))
2444 (not (equal method (caar opened))))
2449 (defun gnus-server-extend-method (group method)
2450 ;; This function "extends" a virtual server. If the server is
2451 ;; "hello", and the select method is ("hello" (my-var "something"))
2452 ;; in the group "alt.alt", this will result in a new virtual server
2453 ;; called "hello+alt.alt".
2454 (if (or (not (inline (gnus-similar-server-opened method)))
2455 (not (cddr method)))
2457 `(,(car method) ,(concat (cadr method) "+" group)
2458 (,(intern (format "%s-address" (car method))) ,(cadr method))
2461 (defun gnus-server-status (method)
2462 "Return the status of METHOD."
2463 (nth 1 (assoc method gnus-opened-servers)))
2465 (defun gnus-group-name-to-method (group)
2466 "Guess a select method based on GROUP."
2467 (if (string-match ":" group)
2468 (let ((server (substring group 0 (match-beginning 0))))
2469 (if (string-match "\\+" server)
2470 (list (intern (substring server 0 (match-beginning 0)))
2471 (substring server (match-end 0)))
2472 (list (intern server) "")))
2473 gnus-select-method))
2475 (defun gnus-find-method-for-group (group &optional info)
2476 "Find the select method that GROUP uses."
2477 (or gnus-override-method
2480 (let ((info (or info (gnus-get-info group)))
2483 (not (setq method (gnus-info-method info)))
2484 (equal method "native"))
2487 (cond ((stringp method)
2488 (inline (gnus-server-to-method method)))
2489 ((stringp (cadr method))
2490 (inline (gnus-server-extend-method group method)))
2493 (cond ((equal (cadr method) "")
2495 ((null (cadr method))
2496 (list (car method) ""))
2498 (gnus-server-add-address method)))))))
2500 (defun gnus-methods-using (feature)
2501 "Find all methods that have FEATURE."
2502 (let ((valids gnus-valid-select-methods)
2505 (when (memq feature (car valids))
2506 (push (car valids) outs))
2507 (setq valids (cdr valids)))
2510 (defun gnus-read-group (prompt &optional default)
2511 "Prompt the user for a group name.
2512 Disallow illegal group names."
2518 (setq group (read-string (concat prefix prompt)
2519 (cons (or default "") 0)
2520 'gnus-group-history)))
2521 (setq prefix (format "Illegal group name: \"%s\". " group)
2525 (defun gnus-read-method (prompt)
2526 "Prompt the user for a method.
2527 Allow completion over sensible values."
2530 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2532 nil t nil 'gnus-method-history)))
2535 (setq method gnus-select-method))
2536 ((assoc method gnus-valid-select-methods)
2537 (list (intern method)
2538 (if (memq 'prompt-address
2539 (assoc method gnus-valid-select-methods))
2540 (read-string "Address: ")
2542 ((assoc method gnus-server-alist)
2545 (list (intern method) "")))))
2547 ;;; User-level commands.
2550 (defun gnus-slave-no-server (&optional arg)
2551 "Read network news as a slave, without connecting to local server"
2553 (gnus-no-server arg t))
2556 (defun gnus-no-server (&optional arg slave)
2558 If ARG is a positive number, Gnus will use that as the
2559 startup level. If ARG is nil, Gnus will be started at level 2.
2560 If ARG is non-nil and not a positive number, Gnus will
2561 prompt the user for the name of an NNTP server to use.
2562 As opposed to `gnus', this command will not connect to the local server."
2564 (gnus-no-server-1 arg slave))
2567 (defun gnus-slave (&optional arg)
2568 "Read news as a slave."
2570 (gnus arg nil 'slave))
2573 (defun gnus-other-frame (&optional arg)
2574 "Pop up a frame to read news."
2576 (let ((window (get-buffer-window gnus-group-buffer)))
2578 (select-frame (window-frame window)))
2579 ((= (length (frame-list)) 1)
2580 (select-frame (make-frame)))
2586 (defun gnus (&optional arg dont-connect slave)
2588 If ARG is non-nil and a positive number, Gnus will use that as the
2589 startup level. If ARG is non-nil and not a positive number, Gnus will
2590 prompt the user for the name of an NNTP server to use."
2592 (gnus-1 arg dont-connect slave))
2594 ;; Allow redefinition of Gnus functions.
2600 ;;; gnus.el ends here