1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97,98 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval '(run-hooks 'gnus-load-hook))
31 (eval-when-compile (require 'cl))
35 (if (< emacs-major-version 20)
36 (require 'gnus-load)))
40 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
44 (defgroup gnus-cache nil
48 (defgroup gnus-start nil
49 "Starting your favorite newsreader."
52 (defgroup gnus-start-server nil
53 "Server options at startup."
56 ;; These belong to gnus-group.el.
57 (defgroup gnus-group nil
59 :link '(custom-manual "(gnus)The Group Buffer")
62 (defgroup gnus-group-foreign nil
64 :link '(custom-manual "(gnus)Foreign Groups")
67 (defgroup gnus-group-new nil
68 "Automatic subscription of new groups."
71 (defgroup gnus-group-levels nil
73 :link '(custom-manual "(gnus)Group Levels")
76 (defgroup gnus-group-select nil
78 :link '(custom-manual "(gnus)Selecting a Group")
81 (defgroup gnus-group-listing nil
82 "Showing slices of the group list."
83 :link '(custom-manual "(gnus)Listing Groups")
86 (defgroup gnus-group-visual nil
87 "Sorting the group buffer."
88 :link '(custom-manual "(gnus)Group Buffer Format")
92 (defgroup gnus-group-various nil
93 "Various group options."
94 :link '(custom-manual "(gnus)Scanning New Messages")
97 ;; These belong to gnus-sum.el.
98 (defgroup gnus-summary nil
100 :link '(custom-manual "(gnus)The Summary Buffer")
103 (defgroup gnus-summary-exit nil
104 "Leaving summary buffers."
105 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
106 :group 'gnus-summary)
108 (defgroup gnus-summary-marks nil
109 "Marks used in summary buffers."
110 :link '(custom-manual "(gnus)Marking Articles")
111 :group 'gnus-summary)
113 (defgroup gnus-thread nil
114 "Ordering articles according to replies."
115 :link '(custom-manual "(gnus)Threading")
116 :group 'gnus-summary)
118 (defgroup gnus-summary-format nil
119 "Formatting of the summary buffer."
120 :link '(custom-manual "(gnus)Summary Buffer Format")
121 :group 'gnus-summary)
123 (defgroup gnus-summary-choose nil
125 :link '(custom-manual "(gnus)Choosing Articles")
126 :group 'gnus-summary)
128 (defgroup gnus-summary-maneuvering nil
129 "Summary movement commands."
130 :link '(custom-manual "(gnus)Summary Maneuvering")
131 :group 'gnus-summary)
133 (defgroup gnus-summary-mail nil
134 "Mail group commands."
135 :link '(custom-manual "(gnus)Mail Group Commands")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-sort nil
139 "Sorting the summary buffer."
140 :link '(custom-manual "(gnus)Sorting")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-visual nil
144 "Highlighting and menus in the summary buffer."
145 :link '(custom-manual "(gnus)Summary Highlighting")
147 :group 'gnus-summary)
149 (defgroup gnus-summary-various nil
150 "Various summary buffer options."
151 :link '(custom-manual "(gnus)Various Summary Stuff")
152 :group 'gnus-summary)
154 (defgroup gnus-summary-pick nil
155 "Pick mode in the summary buffer."
156 :link '(custom-manual "(gnus)Pick and Read")
158 :group 'gnus-summary)
160 (defgroup gnus-summary-tree nil
161 "Tree display of threads in the summary buffer."
162 :link '(custom-manual "(gnus)Tree Display")
164 :group 'gnus-summary)
166 ;; Belongs to gnus-uu.el
167 (defgroup gnus-extract-view nil
168 "Viewing extracted files."
169 :link '(custom-manual "(gnus)Viewing Files")
170 :group 'gnus-extract)
172 ;; Belongs to gnus-score.el
173 (defgroup gnus-score nil
174 "Score and kill file handling."
177 (defgroup gnus-score-kill nil
181 (defgroup gnus-score-adapt nil
182 "Adaptive score files."
185 (defgroup gnus-score-default nil
186 "Default values for score files."
189 (defgroup gnus-score-expire nil
190 "Expiring score rules."
193 (defgroup gnus-score-decay nil
194 "Decaying score rules."
197 (defgroup gnus-score-files nil
198 "Score and kill file names."
202 (defgroup gnus-score-various nil
203 "Various scoring and killing options."
207 (defgroup gnus-visual nil
208 "Options controling the visual fluff."
212 (defgroup gnus-agent nil
213 "Offline support for Gnus."
216 (defgroup gnus-files nil
217 "Files used by Gnus."
220 (defgroup gnus-dribble-file nil
222 :link '(custom-manual "(gnus)Auto Save")
225 (defgroup gnus-newsrc nil
226 "Storing Gnus state."
229 (defgroup gnus-server nil
230 "Options related to newsservers and other servers used by Gnus."
233 (defgroup gnus-message '((message custom-group))
234 "Composing replies and followups in Gnus."
237 (defgroup gnus-meta nil
238 "Meta variables controling major portions of Gnus.
239 In general, modifying these variables does not take affect until Gnus
240 is restarted, and sometimes reloaded."
243 (defgroup gnus-various nil
244 "Other Gnus options."
245 :link '(custom-manual "(gnus)Various Various")
248 (defgroup gnus-exit nil
250 :link '(custom-manual "(gnus)Exiting Gnus")
253 (defconst gnus-product-name "Nana-gnus"
254 "Product name of this version of gnus.")
256 (defconst gnus-version-number "6.9.2"
257 "Version number for this version of gnus.")
259 (defconst gnus-version
260 (format "%s %s (based on Gnus 5.6.44; for SEMI 1.10, FLIM 1.11)"
261 gnus-product-name gnus-version-number)
262 "Version string for this version of gnus.")
264 (defcustom gnus-inhibit-startup-message nil
265 "If non-nil, the startup message will not be displayed.
266 This variable is used before `.gnus.el' is loaded, so it should
267 be set in `.emacs' instead."
271 (defcustom gnus-play-startup-jingle nil
272 "If non-nil, play the Gnus jingle at startup."
276 ;;; Kludges to help the transition from the old `custom.el'.
278 (unless (featurep 'gnus-xmas)
279 (defalias 'gnus-make-overlay 'make-overlay)
280 (defalias 'gnus-delete-overlay 'delete-overlay)
281 (defalias 'gnus-overlay-put 'overlay-put)
282 (defalias 'gnus-move-overlay 'move-overlay)
283 (defalias 'gnus-overlay-end 'overlay-end)
284 (defalias 'gnus-extent-detached-p 'ignore)
285 (defalias 'gnus-extent-start-open 'ignore)
286 (defalias 'gnus-set-text-properties 'set-text-properties)
287 (defalias 'gnus-group-remove-excess-properties 'ignore)
288 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
289 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
290 (defalias 'gnus-character-to-event 'identity)
291 (defalias 'gnus-add-text-properties 'add-text-properties)
292 (defalias 'gnus-put-text-property 'put-text-property)
293 (defalias 'gnus-mode-line-buffer-identification 'identity)
294 (defalias 'gnus-characterp 'numberp)
295 (defalias 'gnus-deactivate-mark 'deactivate-mark)
296 (defalias 'gnus-window-edges 'window-edges)
297 (defalias 'gnus-key-press-event-p 'numberp))
299 ;; We define these group faces here to avoid the display
300 ;; update forced when creating new faces.
302 (defface gnus-group-news-1-face
305 (:foreground "PaleTurquoise" :bold t))
308 (:foreground "ForestGreen" :bold t))
311 "Level 1 newsgroup face.")
313 (defface gnus-group-news-1-empty-face
316 (:foreground "PaleTurquoise"))
319 (:foreground "ForestGreen"))
322 "Level 1 empty newsgroup face.")
324 (defface gnus-group-news-2-face
327 (:foreground "turquoise" :bold t))
330 (:foreground "CadetBlue4" :bold t))
333 "Level 2 newsgroup face.")
335 (defface gnus-group-news-2-empty-face
338 (:foreground "turquoise"))
341 (:foreground "CadetBlue4"))
344 "Level 2 empty newsgroup face.")
346 (defface gnus-group-news-3-face
355 "Level 3 newsgroup face.")
357 (defface gnus-group-news-3-empty-face
366 "Level 3 empty newsgroup face.")
368 (defface gnus-group-news-low-face
371 (:foreground "DarkTurquoise" :bold t))
374 (:foreground "DarkGreen" :bold t))
377 "Low level newsgroup face.")
379 (defface gnus-group-news-low-empty-face
382 (:foreground "DarkTurquoise"))
385 (:foreground "DarkGreen"))
388 "Low level empty newsgroup face.")
390 (defface gnus-group-mail-1-face
393 (:foreground "aquamarine1" :bold t))
396 (:foreground "DeepPink3" :bold t))
399 "Level 1 mailgroup face.")
401 (defface gnus-group-mail-1-empty-face
404 (:foreground "aquamarine1"))
407 (:foreground "DeepPink3"))
409 (:italic t :bold t)))
410 "Level 1 empty mailgroup face.")
412 (defface gnus-group-mail-2-face
415 (:foreground "aquamarine2" :bold t))
418 (:foreground "HotPink3" :bold t))
421 "Level 2 mailgroup face.")
423 (defface gnus-group-mail-2-empty-face
426 (:foreground "aquamarine2"))
429 (:foreground "HotPink3"))
432 "Level 2 empty mailgroup face.")
434 (defface gnus-group-mail-3-face
437 (:foreground "aquamarine3" :bold t))
440 (:foreground "magenta4" :bold t))
443 "Level 3 mailgroup face.")
445 (defface gnus-group-mail-3-empty-face
448 (:foreground "aquamarine3"))
451 (:foreground "magenta4"))
454 "Level 3 empty mailgroup face.")
456 (defface gnus-group-mail-low-face
459 (:foreground "aquamarine4" :bold t))
462 (:foreground "DeepPink4" :bold t))
465 "Low level mailgroup face.")
467 (defface gnus-group-mail-low-empty-face
470 (:foreground "aquamarine4"))
473 (:foreground "DeepPink4"))
476 "Low level empty mailgroup face.")
478 ;; Summary mode faces.
480 (defface gnus-summary-selected-face '((t
482 "Face used for selected articles.")
484 (defface gnus-summary-cancelled-face
486 (:foreground "yellow" :background "black")))
487 "Face used for cancelled articles.")
489 (defface gnus-summary-high-ticked-face
492 (:foreground "pink" :bold t))
495 (:foreground "firebrick" :bold t))
498 "Face used for high interest ticked articles.")
500 (defface gnus-summary-low-ticked-face
503 (:foreground "pink" :italic t))
506 (:foreground "firebrick" :italic t))
509 "Face used for low interest ticked articles.")
511 (defface gnus-summary-normal-ticked-face
514 (:foreground "pink"))
517 (:foreground "firebrick"))
520 "Face used for normal interest ticked articles.")
522 (defface gnus-summary-high-ancient-face
525 (:foreground "SkyBlue" :bold t))
528 (:foreground "RoyalBlue" :bold t))
531 "Face used for high interest ancient articles.")
533 (defface gnus-summary-low-ancient-face
536 (:foreground "SkyBlue" :italic t))
539 (:foreground "RoyalBlue" :italic t))
542 "Face used for low interest ancient articles.")
544 (defface gnus-summary-normal-ancient-face
547 (:foreground "SkyBlue"))
550 (:foreground "RoyalBlue"))
553 "Face used for normal interest ancient articles.")
555 (defface gnus-summary-high-unread-face
558 "Face used for high interest unread articles.")
560 (defface gnus-summary-low-unread-face
563 "Face used for low interest unread articles.")
565 (defface gnus-summary-normal-unread-face
568 "Face used for normal interest unread articles.")
570 (defface gnus-summary-high-read-face
573 (:foreground "PaleGreen"
577 (:foreground "DarkGreen"
581 "Face used for high interest read articles.")
583 (defface gnus-summary-low-read-face
586 (:foreground "PaleGreen"
590 (:foreground "DarkGreen"
594 "Face used for low interest read articles.")
596 (defface gnus-summary-normal-read-face
599 (:foreground "PaleGreen"))
602 (:foreground "DarkGreen"))
605 "Face used for normal interest read articles.")
612 (defvar gnus-buffers nil)
614 (defun gnus-get-buffer-create (name)
615 "Do the same as `get-buffer-create', but store the created buffer."
616 (or (get-buffer name)
617 (car (push (get-buffer-create name) gnus-buffers))))
619 (defun gnus-add-buffer ()
620 "Add the current buffer to the list of Gnus buffers."
621 (push (current-buffer) gnus-buffers))
623 (defun gnus-buffers ()
624 "Return a list of live Gnus buffers."
625 (while (and gnus-buffers
626 (not (buffer-name (car gnus-buffers))))
628 (let ((buffers gnus-buffers))
630 (if (buffer-name (cadr buffers))
632 (setcdr buffers (cddr buffers)))))
637 (defvar gnus-group-buffer "*Group*")
640 (autoload 'gnus-play-jingle "gnus-audio"))
642 (defface gnus-splash-face
645 (:foreground "ForestGreen"))
648 (:foreground "ForestGreen"))
651 "Level 1 newsgroup face.")
653 (defun gnus-splash ()
655 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
656 (let ((buffer-read-only nil))
658 (unless gnus-inhibit-startup-message
659 (gnus-group-startup-message)
661 (when gnus-play-startup-jingle
662 (gnus-play-jingle))))))
664 (defun gnus-indent-rigidly (start end arg)
665 "Indent rigidly using only spaces and no tabs."
668 (narrow-to-region start end)
670 (indent-rigidly start end arg)
671 ;; We translate tabs into spaces -- not everybody uses
672 ;; an 8-character tab.
673 (goto-char (point-min))
674 (while (search-forward "\t" nil t)
675 (replace-match " " t t))))))
677 (defvar gnus-simple-splash nil)
679 (defun gnus-group-startup-message (&optional x y)
680 "Insert startup message in current buffer."
681 ;; Insert the message.
686 _ ___ __ ___ __ _ ___
706 (gnus-indent-rigidly (point-min) (point-max)
707 (/ (max (- (window-width) (or x 46)) 0) 2))
708 (goto-char (point-min))
710 (let* ((pheight (count-lines (point-min) (point-max)))
711 (wheight (window-height))
712 (rest (- wheight pheight)))
713 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
715 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
716 (goto-char (point-min))
717 (setq mode-line-buffer-identification (concat " " gnus-version))
718 (setq gnus-simple-splash t)
719 (set-buffer-modified-p t))
722 (let ((command (format "%s" this-command)))
723 (if (and (string-match "gnus" command)
724 (not (string-match "gnus-other-frame" command)))
726 (gnus-get-buffer-create gnus-group-buffer))))
734 (defcustom gnus-home-directory "~/"
735 "Directory variable that specifies the \"home\" directory.
736 All other Gnus path variables are initialized from this variable."
740 (defcustom gnus-directory (or (getenv "SAVEDIR")
741 (nnheader-concat gnus-home-directory "News/"))
742 "*Directory variable from which all other Gnus file variables are derived.
744 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
745 This means that other directory variables that are initialized from
746 this variable won't be set properly if you set this variable in `.gnus.el'.
747 Set this variable in `.emacs' instead."
751 (defcustom gnus-default-directory nil
752 "*Default directory for all Gnus buffers."
754 :type '(choice (const :tag "current" nil)
757 ;; Site dependent variables. These variables should be defined in
760 (defvar gnus-default-nntp-server nil
761 "Specify a default NNTP server.
762 This variable should be defined in paths.el, and should never be set
764 If you want to change servers, you should use `gnus-select-method'.
765 See the documentation to that variable.")
767 ;; Don't touch this variable.
768 (defvar gnus-nntp-service "nntp"
769 "NNTP service name (\"nntp\" or 119).
770 This is an obsolete variable, which is scarcely used. If you use an
771 nntp server for your newsgroup and want to change the port number
772 used to 899, you would say something along these lines:
774 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
776 (defcustom gnus-nntpserver-file "/etc/nntpserver"
777 "A file with only the name of the nntp server in it."
782 ;; This function is used to check both the environment variable
783 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
784 ;; an nntp server name default.
785 (defun gnus-getenv-nntpserver ()
786 (or (getenv "NNTPSERVER")
787 (and (file-readable-p gnus-nntpserver-file)
789 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
790 (buffer-disable-undo (current-buffer))
791 (insert-file-contents gnus-nntpserver-file)
792 (let ((name (buffer-string)))
794 (if (string-match "^[ \t\n]*$" name)
797 (kill-buffer (current-buffer))))))))
799 (defcustom gnus-select-method
802 (list 'nntp (or (condition-case nil
803 (gnus-getenv-nntpserver)
805 (when (and gnus-default-nntp-server
806 (not (string= gnus-default-nntp-server "")))
807 gnus-default-nntp-server)
809 (if (or (null gnus-nntp-service)
810 (equal gnus-nntp-service "nntp"))
812 (list gnus-nntp-service)))
814 "*Default method for selecting a newsgroup.
815 This variable should be a list, where the first element is how the
816 news is to be fetched, the second is the address.
818 For instance, if you want to get your news via NNTP from
819 \"flab.flab.edu\", you could say:
821 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
823 If you want to use your local spool, say:
825 \(setq gnus-select-method (list 'nnspool (system-name)))
827 If you use this variable, you must set `gnus-nntp-server' to nil.
829 There is a lot more to know about select methods and virtual servers -
830 see the manual for details."
832 :type 'gnus-select-method)
834 (defcustom gnus-message-archive-method
837 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
838 (nnfolder-active-file
839 ,(nnheader-concat message-directory "archive/active"))
840 (nnfolder-get-new-mail nil)
841 (nnfolder-inhibit-expiry t))
842 "*Method used for archiving messages you've sent.
843 This should be a mail method.
845 It's probably not a very effective to change this variable once you've
846 run Gnus once. After doing that, you must edit this server from the
850 :type 'gnus-select-method)
852 (defcustom gnus-message-archive-group nil
853 "*Name of the group in which to save the messages you've written.
854 This can either be a string; a list of strings; or an alist
855 of regexps/functions/forms to be evaluated to return a string (or a list
856 of strings). The functions are called with the name of the current
857 group (or nil) as a parameter.
859 If you want to save your mail in one group and the news articles you
860 write in another group, you could say something like:
862 \(setq gnus-message-archive-group
863 '((if (message-news-p)
867 Normally the group names returned by this variable should be
868 unprefixed -- which implicitly means \"store on the archive server\".
869 However, you may wish to store the message on some other server. In
870 that case, just return a fully prefixed name of the group --
871 \"nnml+private:mail.misc\", for instance."
873 :type '(choice (const :tag "none" nil)
877 (defcustom gnus-secondary-servers nil
878 "List of NNTP servers that the user can choose between interactively.
879 To make Gnus query you for a server, you have to give `gnus' a
880 non-numeric prefix - `C-u M-x gnus', in short."
882 :type '(repeat string))
884 (defcustom gnus-nntp-server nil
885 "*The name of the host running the NNTP server.
886 This variable is semi-obsolete. Use the `gnus-select-method'
889 :type '(choice (const :tag "disable" nil)
892 (defcustom gnus-secondary-select-methods nil
893 "A list of secondary methods that will be used for reading news.
894 This is a list where each element is a complete select method (see
895 `gnus-select-method').
897 If, for instance, you want to read your mail with the nnml backend,
898 you could set this variable:
900 \(setq gnus-secondary-select-methods '((nnml \"\")))"
902 :type '(repeat gnus-select-method))
904 (defvar gnus-backup-default-subscribed-newsgroups
905 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
906 "Default default new newsgroups the first time Gnus is run.
907 Should be set in paths.el, and shouldn't be touched by the user.")
909 (defcustom gnus-local-domain nil
910 "Local domain name without a host name.
911 The DOMAINNAME environment variable is used instead if it is defined.
912 If the `system-name' function returns the full Internet name, there is
913 no need to set this variable."
915 :type '(choice (const :tag "default" nil)
918 (defvar gnus-local-organization nil
919 "String with a description of what organization (if any) the user belongs to.
920 Obsolete variable; use `message-user-organization' instead.")
922 ;; Customization variables
924 (defcustom gnus-refer-article-method nil
925 "Preferred method for fetching an article by Message-ID.
926 If you are reading news from the local spool (with nnspool), fetching
927 articles by Message-ID is painfully slow. By setting this method to an
928 nntp method, you might get acceptable results.
930 The value of this variable must be a valid select method as discussed
931 in the documentation of `gnus-select-method'."
933 :type '(choice (const :tag "default" nil)
936 (defcustom gnus-group-faq-directory
937 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
938 "/ftp@sunsite.auc.dk:/pub/usenet/"
939 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
940 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
941 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
942 "/ftp@rtfm.mit.edu:/pub/usenet/"
943 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
944 "/ftp@ftp.sunet.se:/pub/usenet/"
945 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
946 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
947 "/ftp@ftp.hk.super.net:/mirror/faqs/")
948 "*Directory where the group FAQs are stored.
949 This will most commonly be on a remote machine, and the file will be
952 This variable can also be a list of directories. In that case, the
953 first element in the list will be used by default. The others can
954 be used when being prompted for a site.
956 Note that Gnus uses an aol machine as the default directory. If this
957 feels fundamentally unclean, just think of it as a way to finally get
958 something of value back from them.
960 If the default site is too slow, try one of these:
962 North America: mirrors.aol.com /pub/rtfm/usenet
963 ftp.seas.gwu.edu /pub/rtfm
964 rtfm.mit.edu /pub/usenet
965 Europe: ftp.uni-paderborn.de /pub/FAQ
966 src.doc.ic.ac.uk /usenet/news-FAQS
967 ftp.sunet.se /pub/usenet
968 sunsite.auc.dk /pub/usenet
969 Asia: nctuccca.edu.tw /USENET/FAQ
970 hwarang.postech.ac.kr /pub/usenet
971 ftp.hk.super.net /mirror/faqs"
972 :group 'gnus-group-various
973 :type '(choice directory
976 (defcustom gnus-use-cross-reference t
977 "*Non-nil means that cross referenced articles will be marked as read.
978 If nil, ignore cross references. If t, mark articles as read in
979 subscribed newsgroups. If neither t nor nil, mark as read in all
982 :type '(choice (const :tag "off" nil)
983 (const :tag "subscribed" t)
987 (defcustom gnus-process-mark ?#
989 :group 'gnus-group-visual
990 :group 'gnus-summary-marks
993 (defcustom gnus-asynchronous nil
994 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
995 :group 'gnus-asynchronous
998 (defcustom gnus-large-newsgroup 200
999 "*The number of articles which indicates a large newsgroup.
1000 If the number of articles in a newsgroup is greater than this value,
1001 confirmation is required for selecting the newsgroup."
1002 :group 'gnus-group-select
1005 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1006 "*Non-nil means that the default name of a file to save articles in is the group name.
1007 If it's nil, the directory form of the group name is used instead.
1009 If this variable is a list, and the list contains the element
1010 `not-score', long file names will not be used for score files; if it
1011 contains the element `not-save', long file names will not be used for
1012 saving; and if it contains the element `not-kill', long file names
1013 will not be used for kill files.
1015 Note that the default for this variable varies according to what system
1016 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1017 to nil while on all other systems it defaults to t."
1021 (defcustom gnus-kill-files-directory gnus-directory
1022 "*Name of the directory where kill files will be stored (default \"~/News\")."
1023 :group 'gnus-score-files
1024 :group 'gnus-score-kill
1027 (defcustom gnus-save-score nil
1028 "*If non-nil, save group scoring info."
1029 :group 'gnus-score-various
1033 (defcustom gnus-use-undo t
1034 "*If non-nil, allow undoing in Gnus group mode buffers."
1038 (defcustom gnus-use-adaptive-scoring nil
1039 "*If non-nil, use some adaptive scoring scheme.
1040 If a list, then the values `word' and `line' are meaningful. The
1041 former will perform adaption on individual words in the subject
1042 header while `line' will perform adaption on several headers."
1044 :group 'gnus-score-adapt
1045 :type '(set (const word) (const line)))
1047 (defcustom gnus-use-cache 'passive
1048 "*If nil, Gnus will ignore the article cache.
1049 If `passive', it will allow entering (and reading) articles
1050 explicitly entered into the cache. If anything else, use the
1051 cache to the full extent of the law."
1054 :type '(choice (const :tag "off" nil)
1055 (const :tag "passive" passive)
1056 (const :tag "active" t)))
1058 (defcustom gnus-use-trees nil
1059 "*If non-nil, display a thread tree buffer."
1063 (defcustom gnus-use-grouplens nil
1064 "*If non-nil, use GroupLens ratings."
1068 (defcustom gnus-keep-backlog nil
1069 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1070 If it is a number N, then Gnus will only keep the last N articles
1071 read. If it is neither nil nor a number, Gnus will keep all read
1072 articles. This is not a good idea."
1074 :type '(choice (const :tag "off" nil)
1079 (defcustom gnus-use-nocem nil
1080 "*If non-nil, Gnus will read NoCeM cancel messages."
1084 (defcustom gnus-suppress-duplicates nil
1085 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1089 (defcustom gnus-use-demon nil
1090 "If non-nil, Gnus might use some demons."
1094 (defcustom gnus-use-scoring t
1095 "*If non-nil, enable scoring."
1099 (defcustom gnus-use-picons nil
1100 "*If non-nil, display picons."
1104 (defcustom gnus-summary-prepare-exit-hook
1105 '(gnus-summary-expire-articles)
1106 "*A hook called when preparing to exit from the summary buffer.
1107 It calls `gnus-summary-expire-articles' by default."
1108 :group 'gnus-summary-exit
1111 (defcustom gnus-novice-user t
1112 "*Non-nil means that you are a usenet novice.
1113 If non-nil, verbose messages may be displayed and confirmations may be
1118 (defcustom gnus-expert-user nil
1119 "*Non-nil means that you will never be asked for confirmation about anything.
1120 That doesn't mean *anything* anything; particularly destructive
1121 commands will still require prompting."
1125 (defcustom gnus-interactive-catchup t
1126 "*If non-nil, require your confirmation when catching up a group."
1127 :group 'gnus-group-select
1130 (defcustom gnus-interactive-exit t
1131 "*If non-nil, require your confirmation when exiting Gnus."
1135 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1136 "*Function for extracting address components from a From header.
1137 Two pre-defined function exist: `gnus-extract-address-components',
1138 which is the default, quite fast, and too simplistic solution, and
1139 `mail-extract-address-components', which works much better, but is
1141 :group 'gnus-summary-format
1142 :type '(radio (function-item gnus-extract-address-components)
1143 (function-item mail-extract-address-components)
1144 (function-item std11-extract-address-components)
1145 (function :tag "Other")))
1147 (defcustom gnus-carpal nil
1148 "*If non-nil, display clickable icons."
1152 (defcustom gnus-shell-command-separator ";"
1153 "String used to separate to shell commands."
1157 (defcustom gnus-valid-select-methods
1158 '(("nntp" post address prompt-address physical-address)
1159 ("nnspool" post address)
1160 ("nnvirtual" post-mail virtual prompt-address)
1161 ("nnmbox" mail respool address)
1162 ("nnml" mail respool address)
1163 ("nnmh" mail respool address)
1164 ("nndir" post-mail prompt-address physical-address)
1165 ("nneething" none address prompt-address physical-address)
1166 ("nndoc" none address prompt-address)
1167 ("nnbabyl" mail address respool)
1168 ("nnkiboze" post virtual)
1169 ("nnsoup" post-mail address)
1170 ("nndraft" post-mail)
1171 ("nnfolder" mail respool address)
1172 ("nngateway" post-mail address prompt-address physical-address)
1175 ("nnagent" post-mail))
1176 "*An alist of valid select methods.
1177 The first element of each list lists should be a string with the name
1178 of the select method. The other elements may be the category of
1179 this method (i. e., `post', `mail', `none' or whatever) or other
1180 properties that this method has (like being respoolable).
1181 If you implement a new select method, all you should have to change is
1182 this variable. I think."
1184 :type '(repeat (group (string :tag "Name")
1185 (radio-button-choice (const :format "%v " post)
1186 (const :format "%v " mail)
1187 (const :format "%v " none)
1189 (checklist :inline t
1190 (const :format "%v " address)
1191 (const :format "%v " prompt-address)
1192 (const :format "%v " physical-address)
1193 (const :format "%v " virtual)
1196 (define-widget 'gnus-select-method 'list
1197 "Widget for entering a select method."
1198 :args `((choice :tag "Method"
1199 ,@(mapcar (lambda (entry)
1200 (list 'const :format "%v\n"
1201 (intern (car entry))))
1202 gnus-valid-select-methods))
1203 (string :tag "Address")
1204 (editable-list :inline t
1207 (sexp :tag "Value")))))
1209 (defcustom gnus-updated-mode-lines '(group article summary tree)
1210 "List of buffers that should update their mode lines.
1211 The list may contain the symbols `group', `article', `tree' and
1212 `summary'. If the corresponding symbol is present, Gnus will keep
1213 that mode line updated with information that may be pertinent.
1214 If this variable is nil, screen refresh may be quicker."
1215 :group 'gnus-various
1216 :type '(set (const group)
1221 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1222 (defcustom gnus-mode-non-string-length nil
1223 "*Max length of mode-line non-string contents.
1224 If this is nil, Gnus will take space as is needed, leaving the rest
1225 of the modeline intact. Note that the default of nil is unlikely
1226 to be desirable; see the manual for further details."
1227 :group 'gnus-various
1228 :type '(choice (const nil)
1231 (defcustom gnus-auto-expirable-newsgroups nil
1232 "*Groups in which to automatically mark read articles as expirable.
1233 If non-nil, this should be a regexp that should match all groups in
1234 which to perform auto-expiry. This only makes sense for mail groups."
1235 :group 'nnmail-expire
1236 :type '(choice (const nil)
1239 (defcustom gnus-total-expirable-newsgroups nil
1240 "*Groups in which to perform expiry of all read articles.
1241 Use with extreme caution. All groups that match this regexp will be
1242 expiring - which means that all read articles will be deleted after
1243 \(say) one week. (This only goes for mail groups and the like, of
1245 :group 'nnmail-expire
1246 :type '(choice (const nil)
1249 (defcustom gnus-group-uncollapsed-levels 1
1250 "Number of group name elements to leave alone when making a short group name."
1251 :group 'gnus-group-visual
1254 (defcustom gnus-group-use-permanent-levels nil
1255 "*If non-nil, once you set a level, Gnus will use this level."
1256 :group 'gnus-group-levels
1261 (defcustom gnus-load-hook nil
1262 "A hook run while Gnus is loaded."
1266 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1267 "A hook called to apply kill files to a group.
1268 This hook is intended to apply a kill file to the selected newsgroup.
1269 The function `gnus-apply-kill-file' is called by default.
1271 Since a general kill file is too heavy to use only for a few
1272 newsgroups, I recommend you to use a lighter hook function. For
1273 example, if you'd like to apply a kill file to articles which contains
1274 a string `rmgroup' in subject in newsgroup `control', you can use the
1277 (setq gnus-apply-kill-hook
1280 (cond ((string-match \"control\" gnus-newsgroup-name)
1281 (gnus-kill \"Subject\" \"rmgroup\")
1282 (gnus-expunge \"X\"))))))"
1283 :group 'gnus-score-kill
1284 :options '(gnus-apply-kill-file)
1287 (defcustom gnus-group-change-level-function nil
1288 "Function run when a group level is changed.
1289 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1290 :group 'gnus-group-level
1295 (defcustom gnus-visual
1296 '(summary-highlight group-highlight article-highlight
1298 summary-menu group-menu article-menu
1299 tree-highlight menu highlight
1300 browse-menu server-menu
1301 page-marker tree-menu binary-menu pick-menu
1303 "*Enable visual features.
1304 If `visual' is disabled, there will be no menus and few faces. Most of
1305 the visual customization options below will be ignored. Gnus will use
1306 less space and be faster as a result.
1308 This variable can also be a list of visual elements to switch on. For
1309 instance, to switch off all visual things except menus, you can say:
1311 (setq gnus-visual '(menu))
1313 Valid elements include `summary-highlight', `group-highlight',
1314 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1315 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1316 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1317 and `grouplens-menu'."
1320 :type '(set (const summary-highlight)
1321 (const group-highlight)
1322 (const article-highlight)
1324 (const summary-menu)
1326 (const article-menu)
1327 (const tree-highlight)
1336 (const grouplens-menu)))
1338 (defcustom gnus-mouse-face
1340 (if (gnus-visual-p 'mouse-face 'highlight)
1341 (if (boundp 'gnus-mouse-face)
1342 (or gnus-mouse-face 'highlight)
1346 "*Face used for group or summary buffer mouse highlighting.
1347 The line beneath the mouse pointer will be highlighted with this
1352 (defcustom gnus-article-display-hook
1353 (if (and (string-match "XEmacs" emacs-version)
1355 '(gnus-article-hide-headers-if-wanted
1356 gnus-article-hide-boring-headers
1357 gnus-article-treat-overstrike
1358 gnus-article-maybe-highlight
1359 gnus-article-display-x-face)
1360 '(gnus-article-hide-headers-if-wanted
1361 gnus-article-hide-boring-headers
1362 gnus-article-treat-overstrike
1363 gnus-article-maybe-highlight))
1364 "*Controls how the article buffer will look.
1366 If you leave the list empty, the article will appear exactly as it is
1367 stored on the disk. The list entries will hide or highlight various
1368 parts of the article, making it easier to find the information you
1370 :group 'gnus-article-highlight
1373 :options '(gnus-article-add-buttons
1374 gnus-article-add-buttons-to-head
1375 gnus-article-emphasize
1376 gnus-article-fill-cited-article
1377 gnus-article-remove-cr
1378 gnus-summary-stop-page-breaking
1379 ;; gnus-summary-caesar-message
1380 ;; gnus-summary-verbose-headers
1381 gnus-summary-toggle-mime
1383 gnus-article-hide-headers
1384 gnus-article-hide-boring-headers
1385 gnus-article-hide-signature
1386 gnus-article-hide-citation
1387 gnus-article-hide-pgp
1388 gnus-article-hide-pem
1389 gnus-article-highlight
1390 gnus-article-highlight-headers
1391 gnus-article-highlight-citation
1392 gnus-article-highlight-signature
1393 gnus-article-date-ut
1394 gnus-article-date-local
1395 gnus-article-date-lapsed
1396 gnus-article-date-original
1397 gnus-article-remove-trailing-blank-lines
1398 gnus-article-strip-leading-blank-lines
1399 gnus-article-strip-multiple-blank-lines
1400 gnus-article-strip-blank-lines
1401 gnus-article-treat-overstrike
1402 gnus-article-display-x-face
1403 gnus-smiley-display))
1405 (defcustom gnus-article-save-directory gnus-directory
1406 "*Name of the directory articles will be saved in (default \"~/News\")."
1407 :group 'gnus-article-saving
1410 (defvar gnus-plugged t
1411 "Whether Gnus is plugged or not.")
1414 ;;; Internal variables
1416 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1417 (defvar gnus-original-article-buffer " *Original Article*")
1418 (defvar gnus-newsgroup-name nil)
1419 (defvar gnus-ephemeral-servers nil)
1421 (defvar gnus-agent nil
1422 "Whether we want to use the Gnus agent or not.")
1424 (defvar gnus-command-method nil
1425 "Dynamically bound variable that says what the current backend is.")
1427 (defvar gnus-current-select-method nil
1428 "The current method for selecting a newsgroup.")
1430 (defvar gnus-tree-buffer "*Tree*"
1431 "Buffer where Gnus thread trees are displayed.")
1434 (defvar gnus-use-generic-from nil)
1436 ;; Variable holding the user answers to all method prompts.
1437 (defvar gnus-method-history nil)
1439 ;; Variable holding the user answers to all mail method prompts.
1440 (defvar gnus-mail-method-history nil)
1442 ;; Variable holding the user answers to all group prompts.
1443 (defvar gnus-group-history nil)
1445 (defvar gnus-server-alist nil
1446 "List of available servers.")
1448 (defcustom gnus-cache-directory
1449 (nnheader-concat gnus-directory "cache/")
1450 "*The directory where cached articles will be stored."
1454 (defvar gnus-predefined-server-alist
1457 (nnspool-spool-directory ,gnus-cache-directory)
1458 (nnspool-nov-directory ,gnus-cache-directory)
1459 (nnspool-active-file
1460 ,(nnheader-concat gnus-cache-directory "active"))))
1461 "List of predefined (convenience) servers.")
1463 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1465 (defconst gnus-article-mark-lists
1466 '((marked . tick) (replied . reply)
1467 (expirable . expire) (killed . killed)
1468 (bookmarks . bookmark) (dormant . dormant)
1469 (scored . score) (saved . save)
1470 (cached . cache) (downloadable . download)
1471 (unsendable . unsend)))
1473 (defvar gnus-headers-retrieved-by nil)
1474 (defvar gnus-article-reply nil)
1475 (defvar gnus-override-method nil)
1476 (defvar gnus-article-check-size nil)
1477 (defvar gnus-opened-servers nil)
1479 (defvar gnus-current-kill-article nil)
1481 (defvar gnus-have-read-active-file nil)
1483 (defconst gnus-maintainer
1484 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1485 "The mail address of the Gnus maintainers.")
1487 (defconst semi-gnus-developers
1488 "Semi-gnus Developers:
1489 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1490 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1491 "The mail address of the Semi-gnus developers.")
1493 (defcustom gnus-info-filename nil
1494 "*Controls language of gnus Info.
1495 If nil and current-language-environment is Japanese, go to gnus-ja.
1496 Otherwise go to corresponding Info.
1497 This variable can be nil, gnus or gnus-ja."
1499 :type '(choice (const nil)
1500 (const :tag "English" gnus)
1501 (const :tag "Japanese" gnus-ja)))
1503 (defvar gnus-info-nodes
1504 '((gnus-group-mode "The Group Buffer")
1505 (gnus-summary-mode "The Summary Buffer")
1506 (gnus-article-mode "The Article Buffer")
1507 (mime/viewer-mode "The Article Buffer")
1508 (gnus-server-mode "The Server Buffer")
1509 (gnus-browse-mode "Browse Foreign Server")
1510 (gnus-tree-mode "Tree Display"))
1511 "Alist of major modes and related Info nodes.")
1513 (defvar gnus-group-buffer "*Group*")
1514 (defvar gnus-summary-buffer "*Summary*")
1515 (defvar gnus-article-buffer "*Article*")
1516 (defvar gnus-server-buffer "*Server*")
1518 (defvar gnus-slave nil
1519 "Whether this Gnus is a slave or not.")
1521 (defvar gnus-batch-mode nil
1522 "Whether this Gnus is running in batch mode or not.")
1524 (defvar gnus-variable-list
1525 '(gnus-newsrc-options gnus-newsrc-options-n
1526 gnus-newsrc-last-checked-date
1527 gnus-newsrc-alist gnus-server-alist
1528 gnus-killed-list gnus-zombie-list
1529 gnus-topic-topology gnus-topic-alist
1531 "Gnus variables saved in the quick startup file.")
1533 (defvar gnus-newsrc-alist nil
1534 "Assoc list of read articles.
1535 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1537 (defvar gnus-newsrc-hashtb nil
1538 "Hashtable of gnus-newsrc-alist.")
1540 (defvar gnus-killed-list nil
1541 "List of killed newsgroups.")
1543 (defvar gnus-killed-hashtb nil
1544 "Hash table equivalent of gnus-killed-list.")
1546 (defvar gnus-zombie-list nil
1547 "List of almost dead newsgroups.")
1549 (defvar gnus-description-hashtb nil
1550 "Descriptions of newsgroups.")
1552 (defvar gnus-list-of-killed-groups nil
1553 "List of newsgroups that have recently been killed by the user.")
1555 (defvar gnus-active-hashtb nil
1556 "Hashtable of active articles.")
1558 (defvar gnus-moderated-hashtb nil
1559 "Hashtable of moderated newsgroups.")
1561 ;; Save window configuration.
1562 (defvar gnus-prev-winconf nil)
1564 (defvar gnus-reffed-article-number nil)
1566 ;;; Let the byte-compiler know that we know about this variable.
1567 (defvar rmail-default-rmail-file)
1569 (defvar gnus-dead-summary nil)
1571 ;;; End of variables.
1573 ;; Define some autoload functions Gnus might use.
1576 ;; This little mapcar goes through the list below and marks the
1577 ;; symbols in question as autoloaded functions.
1580 (let ((interactive (nth 1 (memq ':interactive package))))
1584 (when (consp function)
1585 (setq keymap (car (memq 'keymap function)))
1586 (setq function (car function)))
1587 (autoload function (car package) nil interactive keymap)))
1588 (if (eq (nth 1 package) ':interactive)
1591 '(("info" Info-goto-node)
1592 ("hexl" hexl-hex-string-to-integer)
1593 ("pp" pp pp-to-string pp-eval-expression)
1594 ("ps-print" ps-print-preprint)
1595 ("mail-extr" mail-extract-address-components)
1596 ("browse-url" browse-url)
1597 ("message" :interactive t
1598 message-send-and-exit message-yank-original)
1599 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1600 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1601 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1602 timezone-make-sortable-date timezone-make-time-string)
1603 ("rmailout" rmail-output)
1604 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1606 ("gnus-audio" :interactive t gnus-audio-play)
1607 ("gnus-xmas" gnus-xmas-splash)
1608 ("gnus-soup" :interactive t
1609 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1610 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1611 ("nnsoup" nnsoup-pack-replies)
1612 ("score-mode" :interactive t gnus-score-mode)
1613 ("gnus-mh" gnus-summary-save-article-folder
1614 gnus-Folder-save-name gnus-folder-save-name)
1615 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1616 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1617 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1618 gnus-demon-add-disconnection gnus-demon-add-handler
1619 gnus-demon-remove-handler)
1620 ("gnus-demon" :interactive t
1621 gnus-demon-init gnus-demon-cancel)
1622 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1623 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1624 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1625 gnus-nocem-unwanted-article-p)
1626 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1627 gnus-server-server-name)
1628 ("gnus-srvr" gnus-browse-foreign-server)
1629 ("gnus-cite" :interactive t
1630 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1631 gnus-article-hide-citation gnus-article-fill-cited-article
1632 gnus-article-hide-citation-in-followups)
1633 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1634 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1635 gnus-execute gnus-expunge)
1636 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1637 gnus-cache-possibly-remove-articles gnus-cache-request-article
1638 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1639 gnus-cache-enter-remove-article gnus-cached-article-p
1640 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1641 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1642 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1643 ("gnus-score" :interactive t
1644 gnus-summary-increase-score gnus-summary-set-score
1645 gnus-summary-raise-thread gnus-summary-raise-same-subject
1646 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1647 gnus-summary-lower-thread gnus-summary-lower-same-subject
1648 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1649 gnus-summary-current-score gnus-score-default
1650 gnus-score-flush-cache gnus-score-close
1651 gnus-possibly-score-headers gnus-score-followup-article
1652 gnus-score-followup-thread)
1654 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1655 gnus-current-score-file-nondirectory gnus-score-adaptive
1656 gnus-score-find-trace gnus-score-file-name)
1657 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1658 ("gnus-topic" :interactive t gnus-topic-mode)
1659 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1660 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1661 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1662 ("gnus-uu" :interactive t
1663 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1664 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1665 gnus-uu-mark-by-regexp gnus-uu-mark-all
1666 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1667 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1668 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1669 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1670 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1671 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1672 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1673 gnus-uu-mark-over gnus-uu-post-news gnus-uu-post-news)
1674 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1675 gnus-uu-unmark-thread)
1676 ("gnus-msg" (gnus-summary-send-map keymap)
1677 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1678 ("gnus-msg" :interactive t
1679 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1680 gnus-summary-followup gnus-summary-followup-with-original
1681 gnus-summary-cancel-article gnus-summary-supersede-article
1682 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1683 gnus-summary-mail-forward gnus-summary-mail-other-window
1684 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1685 gnus-summary-wide-reply gnus-summary-followup-to-mail
1686 gnus-summary-followup-to-mail-with-original gnus-bug
1687 gnus-summary-wide-reply-with-original
1688 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1689 gnus-summary-post-forward)
1690 ("gnus-picon" :interactive t gnus-article-display-picons
1691 gnus-group-display-picons gnus-picons-article-display-x-face
1692 gnus-picons-display-x-face)
1693 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1694 gnus-grouplens-mode)
1695 ("smiley" :interactive t gnus-smiley-display)
1696 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1697 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1698 gnus-list-of-unread-articles gnus-list-of-read-articles
1699 gnus-offer-save-summaries gnus-make-thread-indent-array
1700 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1701 gnus-summary-skip-intangible gnus-summary-article-number
1702 gnus-data-header gnus-data-find)
1703 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1704 gnus-group-list-groups gnus-group-first-unread-group
1705 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1706 gnus-group-setup-buffer gnus-group-get-new-news
1707 gnus-group-make-help-group gnus-group-update-group
1708 gnus-clear-inboxes-moved gnus-group-iterate
1709 gnus-group-group-name)
1710 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1711 gnus-backlog-remove-article)
1712 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1713 gnus-article-prepare gnus-article-set-window-start
1714 gnus-article-next-page gnus-article-prev-page
1715 gnus-request-article-this-buffer gnus-article-mode
1716 gnus-article-setup-buffer gnus-narrow-to-page
1717 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1718 ("gnus-art" :interactive t
1719 gnus-article-hide-headers gnus-article-hide-boring-headers
1720 gnus-article-treat-overstrike gnus-article-word-wrap
1721 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1722 gnus-article-display-x-face
1723 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1724 gnus-article-hide-pem gnus-article-hide-signature
1725 gnus-article-strip-leading-blank-lines gnus-article-date-local
1726 gnus-article-date-original gnus-article-date-lapsed
1727 gnus-article-show-all-headers
1728 gnus-article-edit-mode gnus-article-edit-article
1729 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522
1730 gnus-start-date-timer gnus-stop-date-timer)
1731 ("gnus-int" gnus-request-type)
1732 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1733 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1734 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1735 gnus-dup-enter-articles)
1736 ("gnus-range" gnus-copy-sequence)
1737 ("gnus-eform" gnus-edit-form)
1738 ("gnus-move" :interactive t
1739 gnus-group-move-group-to-server gnus-change-server)
1740 ("gnus-logic" gnus-score-advanced)
1741 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1742 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1743 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1744 gnus-async-halt-prefetch)
1745 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1746 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1747 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1748 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1749 ("gnus-agent" :interactive t
1750 gnus-unplugged gnus-agentize gnus-agent-batch)
1751 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1752 gnus-summary-save-article-vm)
1753 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1755 ;;; gnus-sum.el thingies
1758 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1759 "*The format specification of the lines in the summary buffer.
1761 It works along the same lines as a normal formatting string,
1762 with some simple extensions.
1764 %N Article number, left padded with spaces (string)
1766 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1767 %n Name of the poster (string)
1768 %a Extracted name of the poster (string)
1769 %A Extracted address of the poster (string)
1770 %F Contents of the From: header (string)
1771 %x Contents of the Xref: header (string)
1772 %D Date of the article (string)
1773 %d Date of the article (string) in DD-MMM format
1774 %M Message-id of the article (string)
1775 %r References of the article (string)
1776 %c Number of characters in the article (integer)
1777 %L Number of lines in the article (integer)
1778 %I Indentation based on thread level (a string of spaces)
1779 %T A string with two possible values: 80 spaces if the article
1780 is on thread level two or larger and 0 spaces on level one
1781 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1782 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1783 %[ Opening bracket (character, \"[\" or \"<\")
1784 %] Closing bracket (character, \"]\" or \">\")
1785 %> Spaces of length thread-level (string)
1786 %< Spaces of length (- 20 thread-level) (string)
1787 %i Article score (number)
1788 %z Article zcore (character)
1789 %t Number of articles under the current thread (number).
1790 %e Whether the thread is empty or not (character).
1791 %l GroupLens score (string).
1792 %V Total thread score (number).
1793 %P The line number (number).
1794 %O Download mark (character).
1795 %u User defined specifier. The next character in the format string should
1796 be a letter. Gnus will call the function gnus-user-format-function-X,
1797 where X is the letter following %u. The function will be passed the
1798 current header as argument. The function should return a string, which
1799 will be inserted into the summary just like information from any other
1802 Text between %( and %) will be highlighted with `gnus-mouse-face'
1803 when the mouse point is placed inside the area. There can only be one
1806 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1807 with care. For reasons of efficiency, Gnus will compute what column
1808 these characters will end up in, and \"hard-code\" that. This means that
1809 it is illegal to have these specs after a variable-length spec. Well,
1810 you might not be arrested, but your summary buffer will look strange,
1811 which is bad enough.
1813 The smart choice is to have these specs as for to the left as
1816 This restriction may disappear in later versions of Gnus."
1818 :group 'gnus-summary-format)
1821 ;;; Skeleton keymaps
1824 (defun gnus-suppress-keymap (keymap)
1825 (suppress-keymap keymap)
1826 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1828 (define-key keymap (pop keys) 'undefined))))
1830 (defvar gnus-article-mode-map
1831 (let ((keymap (make-keymap)))
1832 (gnus-suppress-keymap keymap)
1834 (defvar gnus-summary-mode-map
1835 (let ((keymap (make-keymap)))
1836 (gnus-suppress-keymap keymap)
1838 (defvar gnus-group-mode-map
1839 (let ((keymap (make-keymap)))
1840 (gnus-suppress-keymap keymap)
1845 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1846 ;; If you want the cursor to go somewhere else, set these two
1847 ;; functions in some startup hook to whatever you want.
1848 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1849 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1851 ;;; Various macros and substs.
1853 (defun gnus-header-from (header)
1854 (mail-header-from header))
1856 (defmacro gnus-gethash (string hashtable)
1857 "Get hash value of STRING in HASHTABLE."
1858 `(symbol-value (intern-soft ,string ,hashtable)))
1860 (defmacro gnus-sethash (string value hashtable)
1861 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1862 `(set (intern ,string ,hashtable) ,value))
1863 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1865 (defmacro gnus-group-unread (group)
1866 "Get the currently computed number of unread articles in GROUP."
1867 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1869 (defmacro gnus-group-entry (group)
1870 "Get the newsrc entry for GROUP."
1871 `(gnus-gethash ,group gnus-newsrc-hashtb))
1873 (defmacro gnus-active (group)
1874 "Get active info on GROUP."
1875 `(gnus-gethash ,group gnus-active-hashtb))
1877 (defmacro gnus-set-active (group active)
1878 "Set GROUP's active info."
1879 `(gnus-sethash ,group ,active gnus-active-hashtb))
1881 ;; Info access macros.
1883 (defmacro gnus-info-group (info)
1885 (defmacro gnus-info-rank (info)
1887 (defmacro gnus-info-read (info)
1889 (defmacro gnus-info-marks (info)
1891 (defmacro gnus-info-method (info)
1893 (defmacro gnus-info-params (info)
1896 (defmacro gnus-info-level (info)
1897 `(let ((rank (gnus-info-rank ,info)))
1901 (defmacro gnus-info-score (info)
1902 `(let ((rank (gnus-info-rank ,info)))
1903 (or (and (consp rank) (cdr rank)) 0)))
1905 (defmacro gnus-info-set-group (info group)
1906 `(setcar ,info ,group))
1907 (defmacro gnus-info-set-rank (info rank)
1908 `(setcar (nthcdr 1 ,info) ,rank))
1909 (defmacro gnus-info-set-read (info read)
1910 `(setcar (nthcdr 2 ,info) ,read))
1911 (defmacro gnus-info-set-marks (info marks &optional extend)
1913 `(gnus-info-set-entry ,info ,marks 3)
1914 `(setcar (nthcdr 3 ,info) ,marks)))
1915 (defmacro gnus-info-set-method (info method &optional extend)
1917 `(gnus-info-set-entry ,info ,method 4)
1918 `(setcar (nthcdr 4 ,info) ,method)))
1919 (defmacro gnus-info-set-params (info params &optional extend)
1921 `(gnus-info-set-entry ,info ,params 5)
1922 `(setcar (nthcdr 5 ,info) ,params)))
1924 (defun gnus-info-set-entry (info entry number)
1925 ;; Extend the info until we have enough elements.
1926 (while (<= (length info) number)
1927 (nconc info (list nil)))
1929 (setcar (nthcdr number info) entry))
1931 (defmacro gnus-info-set-level (info level)
1932 `(let ((rank (cdr ,info)))
1933 (if (consp (car rank))
1934 (setcar (car rank) ,level)
1935 (setcar rank ,level))))
1936 (defmacro gnus-info-set-score (info score)
1937 `(let ((rank (cdr ,info)))
1938 (if (consp (car rank))
1939 (setcdr (car rank) ,score)
1940 (setcar rank (cons (car rank) ,score)))))
1942 (defmacro gnus-get-info (group)
1943 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1945 ;; Byte-compiler warning.
1946 (defvar gnus-visual)
1947 ;; Find out whether the gnus-visual TYPE is wanted.
1948 (defun gnus-visual-p (&optional type class)
1949 (and gnus-visual ; Has to be non-nil, at least.
1950 (if (not type) ; We don't care about type.
1952 (if (listp gnus-visual) ; It's a list, so we check it.
1953 (or (memq type gnus-visual)
1954 (memq class gnus-visual))
1957 ;;; Load the compatability functions.
1966 (defvar gnus-shutdown-alist nil)
1968 (defun gnus-add-shutdown (function &rest symbols)
1969 "Run FUNCTION whenever one of SYMBOLS is shut down."
1970 (push (cons function symbols) gnus-shutdown-alist))
1972 (defun gnus-shutdown (symbol)
1973 "Shut down everything that waits for SYMBOL."
1974 (let ((alist gnus-shutdown-alist)
1976 (while (setq entry (pop alist))
1977 (when (memq symbol (cdr entry))
1978 (funcall (car entry))))))
1982 ;;; Gnus Utility Functions
1986 (defmacro gnus-string-or (&rest strings)
1987 "Return the first element of STRINGS that is a non-blank string.
1988 STRINGS will be evaluated in normal `or' order."
1989 `(gnus-string-or-1 ',strings))
1991 (defun gnus-string-or-1 (strings)
1994 (setq string (eval (pop strings)))
1995 (if (string-match "^[ \t]*$" string)
1997 (setq strings nil)))
2000 (defun gnus-version (&optional arg)
2001 "Version number of this version of Gnus.
2002 If ARG, insert string at point."
2005 (insert (message gnus-version))
2006 (message gnus-version)))
2008 (defun gnus-continuum-version (version)
2009 "Return VERSION as a floating point number."
2010 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2011 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2012 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2013 (number (match-string 2 version))
2015 (unless (string-match
2016 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2017 (error "Invalid version string: %s" version))
2018 (setq major (string-to-number (match-string 1 number))
2019 minor (string-to-number (match-string 2 number))
2020 least (if (match-beginning 3)
2021 (string-to-number (match-string 3 number))
2025 (format "%s00%02d%02d"
2027 ((member alpha '("(ding)" "d")) "4.99")
2028 ((member alpha '("September" "s")) "5.01")
2029 ((member alpha '("Red" "r")) "5.03")
2030 ((member alpha '("Quassia" "q")) "5.05")
2031 ((member alpha '("p")) "5.07")
2032 ((member alpha '("o")) "5.09")
2033 ((member alpha '("n")) "5.11"))
2035 (format "%d.%02d%02d" major minor least))))))
2037 (defun gnus-info-find-node ()
2038 "Find Info documentation of Gnus."
2040 ;; Enlarge info window if needed.
2041 (let (gnus-info-buffer)
2042 (Info-goto-node (format "(%s)%s"
2043 (or gnus-info-filename
2044 (get-language-info current-language-environment 'gnus-info)
2046 (cadr (assq major-mode gnus-info-nodes))))
2047 (setq gnus-info-buffer (current-buffer))
2048 (gnus-configure-windows 'info)))
2051 ;;; gnus-interactive
2054 (defvar gnus-current-prefix-symbol nil
2055 "Current prefix symbol.")
2057 (defvar gnus-current-prefix-symbols nil
2058 "List of current prefix symbols.")
2060 (defun gnus-interactive (string &optional params)
2061 "Return a list that can be fed to `interactive'.
2062 See `interactive' for full documentation.
2064 Adds the following specs:
2066 y -- The current symbolic prefix.
2067 Y -- A list of the current symbolic prefix(es).
2068 A -- Article number.
2069 H -- Article header.
2073 (while (< i (length string))
2074 (string-match ".\\([^\n]*\\)\n?" string i)
2075 (setq c (aref string i))
2077 (setq prompt (match-string 1 string)))
2078 (setq i (match-end 0))
2079 ;; We basically emulate just about everything that
2080 ;; `interactive' does, but add the specs listed above.
2084 (completing-read prompt obarray 'fboundp t))
2086 (read-buffer prompt (current-buffer) t))
2088 (read-buffer prompt (other-buffer (current-buffer))))
2092 (completing-read prompt obarray 'commandp t))
2096 (read-file-name prompt nil default-directory 'lambda))
2098 (read-file-name prompt nil nil 'lambda))
2100 (read-file-name prompt))
2102 (read-key-sequence prompt))
2104 (error "Not implemented spec"))
2106 (error "Not implemented spec"))
2110 (error "Not implemented spec"))
2112 (string-to-number (read-from-minibuffer prompt)))
2114 (prefix-numeric-value current-prefix-arg))
2120 (read-string prompt))
2122 (intern (read-string prompt)))
2124 (read-variable prompt))
2126 (read-minibuffer prompt))
2128 (eval-minibuffer prompt))
2129 ;; And here the new specs come.
2131 gnus-current-prefix-symbol)
2133 gnus-current-prefix-symbols)
2135 (gnus-group-group-name))
2137 (gnus-summary-skip-intangible)
2138 (or (get-text-property (point) 'gnus-number)
2139 (gnus-summary-last-subject)))
2141 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2143 (error "Non-implemented spec")))
2147 (push (if (< (point) (mark) (point) (mark))) out)
2148 (push (if (> (point) (mark) (point) (mark))) out))))
2149 (setq out (delq 'gnus-prefix-nil out))
2152 (defun gnus-symbolic-argument (&optional arg)
2153 "Read a symbolic argument and a command, and then execute command."
2155 (let* ((in-command (this-command-keys))
2156 (command in-command)
2157 gnus-current-prefix-symbols
2158 gnus-current-prefix-symbol
2160 (while (equal in-command command)
2161 (message "%s-" (key-description (this-command-keys)))
2162 (push (intern (char-to-string (read-char))) syms)
2163 (setq command (read-key-sequence nil t)))
2164 (setq gnus-current-prefix-symbols (nreverse syms)
2165 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2166 (call-interactively (key-binding command t))))
2168 ;;; More various functions.
2170 (defsubst gnus-check-backend-function (func group)
2171 "Check whether GROUP supports function FUNC.
2172 GROUP can either be a string (a group name) or a select method."
2174 (let ((method (if (stringp group)
2175 (car (gnus-find-method-for-group group))
2177 (unless (featurep method)
2179 (fboundp (intern (format "%s-%s" method func))))))
2181 (defun gnus-group-read-only-p (&optional group)
2182 "Check whether GROUP supports editing or not.
2183 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2184 that that variable is buffer-local to the summary buffers."
2185 (let ((group (or group gnus-newsgroup-name)))
2186 (not (gnus-check-backend-function 'request-replace-article group))))
2188 (defun gnus-group-total-expirable-p (group)
2189 "Check whether GROUP is total-expirable or not."
2190 (let ((params (gnus-group-find-parameter group))
2193 ((memq 'total-expire params)
2195 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2197 (gnus-total-expirable-newsgroups ; Check var.
2198 (string-match gnus-total-expirable-newsgroups group)))))
2200 (defun gnus-group-auto-expirable-p (group)
2201 "Check whether GROUP is auto-expirable or not."
2202 (let ((params (gnus-group-find-parameter group))
2205 ((memq 'auto-expire params)
2207 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2209 (gnus-auto-expirable-newsgroups ; Check var.
2210 (string-match gnus-auto-expirable-newsgroups group)))))
2212 (defun gnus-virtual-group-p (group)
2213 "Say whether GROUP is virtual or not."
2214 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2215 gnus-valid-select-methods)))
2217 (defun gnus-news-group-p (group &optional article)
2218 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2219 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2220 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2221 (if (or (null article)
2222 (not (< article 0)))
2223 (eq (gnus-request-type group article) 'news)
2224 (if (not (vectorp article))
2226 ;; It's a real article.
2227 (eq (gnus-request-type group (mail-header-id article))
2230 ;; Returns a list of writable groups.
2231 (defun gnus-writable-groups ()
2232 (let ((alist gnus-newsrc-alist)
2234 (while (setq group (car (pop alist)))
2235 (unless (gnus-group-read-only-p group)
2236 (push group groups)))
2239 ;; Check whether to use long file names.
2240 (defun gnus-use-long-file-name (symbol)
2241 ;; The variable has to be set...
2242 (and gnus-use-long-file-name
2243 ;; If it isn't a list, then we return t.
2244 (or (not (listp gnus-use-long-file-name))
2245 ;; If it is a list, and the list contains `symbol', we
2247 (not (memq symbol gnus-use-long-file-name)))))
2249 ;; Generate a unique new group name.
2250 (defun gnus-generate-new-group-name (leaf)
2253 (while (gnus-gethash name gnus-newsrc-hashtb)
2254 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2257 (defun gnus-ephemeral-group-p (group)
2258 "Say whether GROUP is ephemeral or not."
2259 (gnus-group-get-parameter group 'quit-config t))
2261 (defun gnus-group-quit-config (group)
2262 "Return the quit-config of GROUP."
2263 (gnus-group-get-parameter group 'quit-config t))
2265 (defun gnus-kill-ephemeral-group (group)
2266 "Remove ephemeral GROUP from relevant structures."
2267 (gnus-sethash group nil gnus-newsrc-hashtb))
2269 (defun gnus-simplify-mode-line ()
2270 "Make mode lines a bit simpler."
2271 (setq mode-line-modified (cdr gnus-mode-line-modified))
2272 (when (listp mode-line-format)
2273 (make-local-variable 'mode-line-format)
2274 (setq mode-line-format (copy-sequence mode-line-format))
2275 (when (equal (nth 3 mode-line-format) " ")
2276 (setcar (nthcdr 3 mode-line-format) " "))))
2278 ;;; Servers and groups.
2280 (defsubst gnus-server-add-address (method)
2281 (let ((method-name (symbol-name (car method))))
2282 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2283 (not (assq (intern (concat method-name "-address")) method))
2284 (memq 'physical-address (assq (car method)
2285 gnus-valid-select-methods)))
2286 (append method (list (list (intern (concat method-name "-address"))
2290 (defsubst gnus-server-get-method (group method)
2291 ;; Input either a server name, and extended server name, or a
2292 ;; select method, and return a select method.
2293 (cond ((stringp method)
2294 (gnus-server-to-method method))
2295 ((equal method gnus-select-method)
2297 ((and (stringp (car method))
2299 (gnus-server-extend-method group method))
2302 (equal (cadr method) ""))
2305 (gnus-server-add-address method))))
2307 (defun gnus-server-to-method (server)
2308 "Map virtual server names to select methods."
2310 ;; Is this a method, perhaps?
2311 (and server (listp server) server)
2312 ;; Perhaps this is the native server?
2313 (and (equal server "native") gnus-select-method)
2314 ;; It should be in the server alist.
2315 (cdr (assoc server gnus-server-alist))
2316 ;; It could be in the predefined server alist.
2317 (cdr (assoc server gnus-predefined-server-alist))
2318 ;; If not, we look through all the opened server
2319 ;; to see whether we can find it there.
2320 (let ((opened gnus-opened-servers))
2322 (not (equal server (format "%s:%s" (caaar opened)
2327 (defmacro gnus-method-equal (ss1 ss2)
2328 "Say whether two servers are equal."
2332 (and (= (length s1) (length s2))
2334 (while (and s1 (member (car s1) s2))
2338 (defun gnus-server-equal (m1 m2)
2339 "Say whether two methods are equal."
2340 (let ((m1 (cond ((null m1) gnus-select-method)
2341 ((stringp m1) (gnus-server-to-method m1))
2343 (m2 (cond ((null m2) gnus-select-method)
2344 ((stringp m2) (gnus-server-to-method m2))
2346 (gnus-method-equal m1 m2)))
2348 (defun gnus-servers-using-backend (backend)
2349 "Return a list of known servers using BACKEND."
2350 (let ((opened gnus-opened-servers)
2353 (when (eq backend (caaar opened))
2354 (push (caar opened) out))
2358 (defun gnus-archive-server-wanted-p ()
2359 "Say whether the user wants to use the archive server."
2361 ((or (not gnus-message-archive-method)
2362 (not gnus-message-archive-group))
2364 ((and gnus-message-archive-method gnus-message-archive-group)
2367 (let ((active (cadr (assq 'nnfolder-active-file
2368 gnus-message-archive-method))))
2370 (file-exists-p active))))))
2372 (defun gnus-group-prefixed-name (group method)
2373 "Return the whole name from GROUP and METHOD."
2374 (and (stringp method) (setq method (gnus-server-to-method method)))
2375 (if (or (not method)
2376 (gnus-server-equal method "native"))
2378 (concat (format "%s" (car method))
2380 (or (assoc (format "%s" (car method))
2381 (gnus-methods-using 'address))
2382 (gnus-server-equal method gnus-message-archive-method))
2384 (not (string= (nth 1 method) "")))
2385 (concat "+" (nth 1 method)))
2388 (defun gnus-group-real-prefix (group)
2389 "Return the prefix of the current group name."
2390 (if (string-match "^[^:]+:" group)
2391 (substring group 0 (match-end 0))
2394 (defun gnus-group-method (group)
2395 "Return the server or method used for selecting GROUP.
2396 You should probably use `gnus-find-method-for-group' instead."
2397 (let ((prefix (gnus-group-real-prefix group)))
2398 (if (equal prefix "")
2400 (let ((servers gnus-opened-servers)
2402 backend possible found)
2403 (if (string-match "^[^\\+]+\\+" prefix)
2404 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2405 server (substring prefix (match-end 0) (1- (length prefix))))
2406 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2408 (when (eq (caaar servers) backend)
2409 (setq possible (caar servers))
2410 (when (equal (cadaar servers) server)
2411 (setq found (caar servers))))
2413 (or (car (rassoc found gnus-server-alist))
2415 (car (rassoc possible gnus-server-alist))
2417 (list backend server))))))
2419 (defsubst gnus-secondary-method-p (method)
2420 "Return whether METHOD is a secondary select method."
2421 (let ((methods gnus-secondary-select-methods)
2422 (gmethod (gnus-server-get-method nil method)))
2424 (not (equal (gnus-server-get-method nil (car methods))
2426 (setq methods (cdr methods)))
2429 (defun gnus-groups-from-server (server)
2430 "Return a list of all groups that are fetched from SERVER."
2431 (let ((alist (cdr gnus-newsrc-alist))
2433 (while (setq info (pop alist))
2434 (when (gnus-server-equal (gnus-info-method info) server)
2435 (push (gnus-info-group info) groups)))
2436 (sort groups 'string<)))
2438 (defun gnus-group-foreign-p (group)
2439 "Say whether a group is foreign or not."
2440 (and (not (gnus-group-native-p group))
2441 (not (gnus-group-secondary-p group))))
2443 (defun gnus-group-native-p (group)
2444 "Say whether the group is native or not."
2445 (not (string-match ":" group)))
2447 (defun gnus-group-secondary-p (group)
2448 "Say whether the group is secondary or not."
2449 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2451 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2452 "Return the group parameters for GROUP.
2453 If SYMBOL, return the value of that symbol in the group parameters."
2455 (set-buffer gnus-group-buffer)
2456 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2458 (gnus-group-parameter-value parameters symbol allow-list)
2461 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2462 "Return the group parameters for GROUP.
2463 If SYMBOL, return the value of that symbol in the group parameters.
2464 Most functions should use `gnus-group-find-parameter', which
2465 also examines the topic parameters."
2466 (let ((params (gnus-info-params (gnus-get-info group))))
2468 (gnus-group-parameter-value params symbol allow-list)
2471 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2472 "Return the value of SYMBOL in group PARAMS."
2473 ;; We only wish to return group parameters (dotted lists) and
2474 ;; not local variables, which may have the same names.
2475 ;; But first we handle single elements...
2476 (or (car (memq symbol params))
2480 (while (setq elem (pop params))
2481 (when (and (consp elem)
2482 (eq (car elem) symbol)
2485 (throw 'found (cdr elem))))))))
2487 (defun gnus-group-add-parameter (group param)
2488 "Add parameter PARAM to GROUP."
2489 (let ((info (gnus-get-info group)))
2491 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2492 ;; Cons the new param to the old one and update.
2493 (gnus-group-set-info (cons param (gnus-info-params info))
2496 (defun gnus-group-set-parameter (group name value)
2497 "Set parameter NAME to VALUE in GROUP."
2498 (let ((info (gnus-get-info group)))
2500 (gnus-group-remove-parameter group name)
2501 (let ((old-params (gnus-info-params info))
2502 (new-params (list (cons name value))))
2504 (when (or (not (listp (car old-params)))
2505 (not (eq (caar old-params) name)))
2506 (setq new-params (append new-params (list (car old-params)))))
2507 (setq old-params (cdr old-params)))
2508 (gnus-group-set-info new-params group 'params)))))
2510 (defun gnus-group-remove-parameter (group name)
2511 "Remove parameter NAME from GROUP."
2512 (let ((info (gnus-get-info group)))
2514 (let ((params (gnus-info-params info)))
2516 (setq params (delq name params))
2517 (while (assq name params)
2518 (gnus-pull name params))
2519 (gnus-info-set-params info params))))))
2521 (defun gnus-group-add-score (group &optional score)
2522 "Add SCORE to the GROUP score.
2523 If SCORE is nil, add 1 to the score of GROUP."
2524 (let ((info (gnus-get-info group)))
2526 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2528 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2529 (defun gnus-short-group-name (group &optional levels)
2530 "Collapse GROUP name LEVELS.
2531 Select methods are stripped and any remote host name is stripped down to
2532 just the host name."
2539 (while (string-match "\\." group skip)
2540 (setq skip (match-end 0)
2543 ;; separate foreign select method from group name and collapse.
2544 ;; if method contains a server, collapse to non-domain server name,
2545 ;; otherwise collapse to select method
2546 (when (string-match ":" group)
2547 (cond ((string-match "+" group)
2548 (let* ((plus (string-match "+" group))
2549 (colon (string-match ":" group (or plus 0)))
2550 (dot (string-match "\\." group)))
2551 (setq foreign (concat
2552 (substring group (+ 1 plus)
2553 (cond ((null dot) colon)
2554 ((< colon dot) colon)
2555 ((< dot colon) dot)))
2557 group (substring group (+ 1 colon)))))
2559 (let* ((colon (string-match ":" group)))
2560 (setq foreign (concat (substring group 0 (+ 1 colon)))
2561 group (substring group (+ 1 colon)))))))
2562 ;; collapse group name leaving LEVELS uncollapsed elements
2564 (if (and (string-match "\\." group) (> levels 0))
2565 (setq name (concat name (substring group 0 1))
2566 group (substring group (match-end 0))
2568 name (concat name "."))
2569 (setq name (concat foreign name group)
2573 (defun gnus-narrow-to-body ()
2574 "Narrow to the body of an article."
2577 (goto-char (point-min))
2578 (or (search-forward "\n\n" nil t)
2584 ;;; Kill file handling.
2587 (defun gnus-apply-kill-file ()
2588 "Apply a kill file to the current newsgroup.
2589 Returns the number of articles marked as read."
2590 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2591 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2592 (gnus-apply-kill-file-internal)
2595 (defun gnus-kill-save-kill-buffer ()
2596 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2597 (when (get-file-buffer file)
2599 (set-buffer (get-file-buffer file))
2600 (when (buffer-modified-p)
2602 (kill-buffer (current-buffer))))))
2604 (defcustom gnus-kill-file-name "KILL"
2605 "Suffix of the kill files."
2606 :group 'gnus-score-kill
2607 :group 'gnus-score-files
2610 (defun gnus-newsgroup-kill-file (newsgroup)
2611 "Return the name of a kill file name for NEWSGROUP.
2612 If NEWSGROUP is nil, return the global kill file name instead."
2614 ;; The global KILL file is placed at top of the directory.
2615 ((or (null newsgroup)
2616 (string-equal newsgroup ""))
2617 (expand-file-name gnus-kill-file-name
2618 gnus-kill-files-directory))
2619 ;; Append ".KILL" to newsgroup name.
2620 ((gnus-use-long-file-name 'not-kill)
2621 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2622 "." gnus-kill-file-name)
2623 gnus-kill-files-directory))
2624 ;; Place "KILL" under the hierarchical directory.
2626 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2627 "/" gnus-kill-file-name)
2628 gnus-kill-files-directory))))
2632 (defun gnus-member-of-valid (symbol group)
2633 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2635 (symbol-name (car (gnus-find-method-for-group group)))
2636 gnus-valid-select-methods)))
2638 (defun gnus-method-option-p (method option)
2639 "Return non-nil if select METHOD has OPTION as a parameter."
2640 (when (stringp method)
2641 (setq method (gnus-server-to-method method)))
2642 (memq option (assoc (format "%s" (car method))
2643 gnus-valid-select-methods)))
2645 (defun gnus-similar-server-opened (method)
2646 (let ((opened gnus-opened-servers))
2647 (while (and method opened)
2648 (when (and (equal (cadr method) (cadaar opened))
2649 (not (equal method (caar opened))))
2654 (defun gnus-server-extend-method (group method)
2655 ;; This function "extends" a virtual server. If the server is
2656 ;; "hello", and the select method is ("hello" (my-var "something"))
2657 ;; in the group "alt.alt", this will result in a new virtual server
2658 ;; called "hello+alt.alt".
2659 (if (or (not (inline (gnus-similar-server-opened method)))
2660 (not (cddr method)))
2662 `(,(car method) ,(concat (cadr method) "+" group)
2663 (,(intern (format "%s-address" (car method))) ,(cadr method))
2666 (defun gnus-server-status (method)
2667 "Return the status of METHOD."
2668 (nth 1 (assoc method gnus-opened-servers)))
2670 (defun gnus-group-name-to-method (group)
2671 "Guess a select method based on GROUP."
2672 (if (string-match ":" group)
2673 (let ((server (substring group 0 (match-beginning 0))))
2674 (if (string-match "\\+" server)
2675 (list (intern (substring server 0 (match-beginning 0)))
2676 (substring server (match-end 0)))
2677 (list (intern server) "")))
2678 gnus-select-method))
2680 (defun gnus-find-method-for-group (group &optional info)
2681 "Find the select method that GROUP uses."
2682 (or gnus-override-method
2685 (let ((info (or info (gnus-get-info group)))
2688 (not (setq method (gnus-info-method info)))
2689 (equal method "native"))
2692 (cond ((stringp method)
2693 (inline (gnus-server-to-method method)))
2694 ((stringp (cadr method))
2695 (inline (gnus-server-extend-method group method)))
2698 (cond ((equal (cadr method) "")
2700 ((null (cadr method))
2701 (list (car method) ""))
2703 (gnus-server-add-address method)))))))
2705 (defun gnus-methods-using (feature)
2706 "Find all methods that have FEATURE."
2707 (let ((valids gnus-valid-select-methods)
2710 (when (memq feature (car valids))
2711 (push (car valids) outs))
2712 (setq valids (cdr valids)))
2715 (defun gnus-read-group (prompt &optional default)
2716 "Prompt the user for a group name.
2717 Disallow illegal group names."
2723 (setq group (read-string (concat prefix prompt)
2724 (cons (or default "") 0)
2725 'gnus-group-history)))
2726 (setq prefix (format "Illegal group name: \"%s\". " group)
2730 (defun gnus-read-method (prompt)
2731 "Prompt the user for a method.
2732 Allow completion over sensible values."
2734 (append gnus-valid-select-methods
2735 gnus-predefined-server-alist
2740 nil t nil 'gnus-method-history)))
2743 (setq method gnus-select-method))
2744 ((assoc method gnus-valid-select-methods)
2745 (list (intern method)
2746 (if (memq 'prompt-address
2747 (assoc method gnus-valid-select-methods))
2748 (read-string "Address: ")
2750 ((assoc method servers)
2753 (list (intern method) "")))))
2755 ;;; User-level commands.
2758 (defun gnus-slave-no-server (&optional arg)
2759 "Read network news as a slave, without connecting to local server."
2761 (gnus-no-server arg t))
2764 (defun gnus-no-server (&optional arg slave)
2766 If ARG is a positive number, Gnus will use that as the
2767 startup level. If ARG is nil, Gnus will be started at level 2.
2768 If ARG is non-nil and not a positive number, Gnus will
2769 prompt the user for the name of an NNTP server to use.
2770 As opposed to `gnus', this command will not connect to the local server."
2772 (gnus-no-server-1 arg slave))
2775 (defun gnus-slave (&optional arg)
2776 "Read news as a slave."
2778 (gnus arg nil 'slave))
2781 (defun gnus-other-frame (&optional arg)
2782 "Pop up a frame to read news."
2784 (let ((window (get-buffer-window gnus-group-buffer)))
2786 (select-frame (window-frame window)))
2787 ((= (length (frame-list)) 1)
2788 (select-frame (make-frame)))
2794 (defun gnus (&optional arg dont-connect slave)
2796 If ARG is non-nil and a positive number, Gnus will use that as the
2797 startup level. If ARG is non-nil and not a positive number, Gnus will
2798 prompt the user for the name of an NNTP server to use."
2800 (gnus-1 arg dont-connect slave))
2802 ;; Allow redefinition of Gnus functions.
2808 ;;; gnus.el ends here