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 "T-gnus"
254 "Product name of this version of gnus.")
256 (defconst gnus-version-number "6.10.020"
257 "Version number for this version of gnus.")
259 (defconst gnus-original-version-number "0.31"
260 "Version number for this version of Gnus.")
262 (defconst gnus-original-product-name "Pterodactyl Gnus"
263 "Version number for this version of Gnus.")
265 (defconst gnus-version
266 (format "%s %s (based on %s %s ; for SEMI 1.8, FLIM 1.8/1.9)"
267 gnus-product-name gnus-version-number
268 gnus-original-product-name gnus-original-version-number)
269 "Version string for this version of gnus.")
271 (defcustom gnus-inhibit-startup-message nil
272 "If non-nil, the startup message will not be displayed.
273 This variable is used before `.gnus.el' is loaded, so it should
274 be set in `.emacs' instead."
278 (defcustom gnus-play-startup-jingle nil
279 "If non-nil, play the Gnus jingle at startup."
283 (unless (featurep 'gnus-xmas)
284 (defalias 'gnus-make-overlay 'make-overlay)
285 (defalias 'gnus-delete-overlay 'delete-overlay)
286 (defalias 'gnus-overlay-put 'overlay-put)
287 (defalias 'gnus-move-overlay 'move-overlay)
288 (defalias 'gnus-overlay-end 'overlay-end)
289 (defalias 'gnus-extent-detached-p 'ignore)
290 (defalias 'gnus-extent-start-open 'ignore)
291 (defalias 'gnus-set-text-properties 'set-text-properties)
292 (defalias 'gnus-group-remove-excess-properties 'ignore)
293 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
294 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
295 (defalias 'gnus-character-to-event 'identity)
296 (defalias 'gnus-add-text-properties 'add-text-properties)
297 (defalias 'gnus-put-text-property 'put-text-property)
298 (defalias 'gnus-mode-line-buffer-identification 'identity)
299 (defalias 'gnus-characterp 'numberp)
300 (defalias 'gnus-deactivate-mark 'deactivate-mark)
301 (defalias 'gnus-window-edges 'window-edges)
302 (defalias 'gnus-key-press-event-p 'numberp)
303 (defalias 'gnus-annotation-in-region-p 'ignore)
304 (defalias 'gnus-decode-rfc1522 'ignore))
306 ;; We define these group faces here to avoid the display
307 ;; update forced when creating new faces.
309 (defface gnus-group-news-1-face
312 (:foreground "PaleTurquoise" :bold t))
315 (:foreground "ForestGreen" :bold t))
318 "Level 1 newsgroup face.")
320 (defface gnus-group-news-1-empty-face
323 (:foreground "PaleTurquoise"))
326 (:foreground "ForestGreen"))
329 "Level 1 empty newsgroup face.")
331 (defface gnus-group-news-2-face
334 (:foreground "turquoise" :bold t))
337 (:foreground "CadetBlue4" :bold t))
340 "Level 2 newsgroup face.")
342 (defface gnus-group-news-2-empty-face
345 (:foreground "turquoise"))
348 (:foreground "CadetBlue4"))
351 "Level 2 empty newsgroup face.")
353 (defface gnus-group-news-3-face
362 "Level 3 newsgroup face.")
364 (defface gnus-group-news-3-empty-face
373 "Level 3 empty newsgroup face.")
375 (defface gnus-group-news-low-face
378 (:foreground "DarkTurquoise" :bold t))
381 (:foreground "DarkGreen" :bold t))
384 "Low level newsgroup face.")
386 (defface gnus-group-news-low-empty-face
389 (:foreground "DarkTurquoise"))
392 (:foreground "DarkGreen"))
395 "Low level empty newsgroup face.")
397 (defface gnus-group-mail-1-face
400 (:foreground "aquamarine1" :bold t))
403 (:foreground "DeepPink3" :bold t))
406 "Level 1 mailgroup face.")
408 (defface gnus-group-mail-1-empty-face
411 (:foreground "aquamarine1"))
414 (:foreground "DeepPink3"))
416 (:italic t :bold t)))
417 "Level 1 empty mailgroup face.")
419 (defface gnus-group-mail-2-face
422 (:foreground "aquamarine2" :bold t))
425 (:foreground "HotPink3" :bold t))
428 "Level 2 mailgroup face.")
430 (defface gnus-group-mail-2-empty-face
433 (:foreground "aquamarine2"))
436 (:foreground "HotPink3"))
439 "Level 2 empty mailgroup face.")
441 (defface gnus-group-mail-3-face
444 (:foreground "aquamarine3" :bold t))
447 (:foreground "magenta4" :bold t))
450 "Level 3 mailgroup face.")
452 (defface gnus-group-mail-3-empty-face
455 (:foreground "aquamarine3"))
458 (:foreground "magenta4"))
461 "Level 3 empty mailgroup face.")
463 (defface gnus-group-mail-low-face
466 (:foreground "aquamarine4" :bold t))
469 (:foreground "DeepPink4" :bold t))
472 "Low level mailgroup face.")
474 (defface gnus-group-mail-low-empty-face
477 (:foreground "aquamarine4"))
480 (:foreground "DeepPink4"))
483 "Low level empty mailgroup face.")
485 ;; Summary mode faces.
487 (defface gnus-summary-selected-face '((t
489 "Face used for selected articles.")
491 (defface gnus-summary-cancelled-face
493 (:foreground "yellow" :background "black")))
494 "Face used for cancelled articles.")
496 (defface gnus-summary-high-ticked-face
499 (:foreground "pink" :bold t))
502 (:foreground "firebrick" :bold t))
505 "Face used for high interest ticked articles.")
507 (defface gnus-summary-low-ticked-face
510 (:foreground "pink" :italic t))
513 (:foreground "firebrick" :italic t))
516 "Face used for low interest ticked articles.")
518 (defface gnus-summary-normal-ticked-face
521 (:foreground "pink"))
524 (:foreground "firebrick"))
527 "Face used for normal interest ticked articles.")
529 (defface gnus-summary-high-ancient-face
532 (:foreground "SkyBlue" :bold t))
535 (:foreground "RoyalBlue" :bold t))
538 "Face used for high interest ancient articles.")
540 (defface gnus-summary-low-ancient-face
543 (:foreground "SkyBlue" :italic t))
546 (:foreground "RoyalBlue" :italic t))
549 "Face used for low interest ancient articles.")
551 (defface gnus-summary-normal-ancient-face
554 (:foreground "SkyBlue"))
557 (:foreground "RoyalBlue"))
560 "Face used for normal interest ancient articles.")
562 (defface gnus-summary-high-unread-face
565 "Face used for high interest unread articles.")
567 (defface gnus-summary-low-unread-face
570 "Face used for low interest unread articles.")
572 (defface gnus-summary-normal-unread-face
575 "Face used for normal interest unread articles.")
577 (defface gnus-summary-high-read-face
580 (:foreground "PaleGreen"
584 (:foreground "DarkGreen"
588 "Face used for high interest read articles.")
590 (defface gnus-summary-low-read-face
593 (:foreground "PaleGreen"
597 (:foreground "DarkGreen"
601 "Face used for low interest read articles.")
603 (defface gnus-summary-normal-read-face
606 (:foreground "PaleGreen"))
609 (:foreground "DarkGreen"))
612 "Face used for normal interest read articles.")
619 (defvar gnus-buffers nil)
621 (defun gnus-get-buffer-create (name)
622 "Do the same as `get-buffer-create', but store the created buffer."
623 (or (get-buffer name)
624 (car (push (get-buffer-create name) gnus-buffers))))
626 (defun gnus-add-buffer ()
627 "Add the current buffer to the list of Gnus buffers."
628 (push (current-buffer) gnus-buffers))
630 (defun gnus-buffers ()
631 "Return a list of live Gnus buffers."
632 (while (and gnus-buffers
633 (not (buffer-name (car gnus-buffers))))
635 (let ((buffers gnus-buffers))
637 (if (buffer-name (cadr buffers))
639 (setcdr buffers (cddr buffers)))))
644 (defvar gnus-group-buffer "*Group*")
647 (autoload 'gnus-play-jingle "gnus-audio"))
649 (defface gnus-splash-face
652 (:foreground "Brown"))
655 (:foreground "Brown"))
658 "Face of the splash screen.")
660 (defun gnus-splash ()
662 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
663 (let ((buffer-read-only nil))
665 (unless gnus-inhibit-startup-message
666 (gnus-group-startup-message)
668 (when gnus-play-startup-jingle
669 (gnus-play-jingle))))))
671 (defun gnus-indent-rigidly (start end arg)
672 "Indent rigidly using only spaces and no tabs."
675 (narrow-to-region start end)
677 (indent-rigidly start end arg)
678 ;; We translate tabs into spaces -- not everybody uses
679 ;; an 8-character tab.
680 (goto-char (point-min))
681 (while (search-forward "\t" nil t)
682 (replace-match " " t t))))))
684 (defvar gnus-simple-splash nil)
686 (defun gnus-group-startup-message (&optional x y)
687 "Insert startup message in current buffer."
688 ;; Insert the message.
693 _ ___ __ ___ __ _ ___
713 (gnus-indent-rigidly (point-min) (point-max)
714 (/ (max (- (window-width) (or x 46)) 0) 2))
715 (goto-char (point-min))
717 (let* ((pheight (count-lines (point-min) (point-max)))
718 (wheight (window-height))
719 (rest (- wheight pheight)))
720 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
722 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
723 (goto-char (point-min))
724 (setq mode-line-buffer-identification (concat " " gnus-version))
725 (setq gnus-simple-splash t)
726 (set-buffer-modified-p t))
729 (let ((command (format "%s" this-command)))
730 (if (and (string-match "gnus" command)
731 (not (string-match "gnus-other-frame" command)))
733 (gnus-get-buffer-create gnus-group-buffer))))
741 (defcustom gnus-home-directory "~/"
742 "Directory variable that specifies the \"home\" directory.
743 All other Gnus path variables are initialized from this variable."
747 (defcustom gnus-directory (or (getenv "SAVEDIR")
748 (nnheader-concat gnus-home-directory "News/"))
749 "*Directory variable from which all other Gnus file variables are derived.
751 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
752 This means that other directory variables that are initialized from
753 this variable won't be set properly if you set this variable in `.gnus.el'.
754 Set this variable in `.emacs' instead."
758 (defcustom gnus-default-directory nil
759 "*Default directory for all Gnus buffers."
761 :type '(choice (const :tag "current" nil)
764 ;; Site dependent variables. These variables should be defined in
767 (defvar gnus-default-nntp-server nil
768 "Specify a default NNTP server.
769 This variable should be defined in paths.el, and should never be set
771 If you want to change servers, you should use `gnus-select-method'.
772 See the documentation to that variable.")
774 ;; Don't touch this variable.
775 (defvar gnus-nntp-service "nntp"
776 "NNTP service name (\"nntp\" or 119).
777 This is an obsolete variable, which is scarcely used. If you use an
778 nntp server for your newsgroup and want to change the port number
779 used to 899, you would say something along these lines:
781 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
783 (defcustom gnus-nntpserver-file "/etc/nntpserver"
784 "A file with only the name of the nntp server in it."
789 ;; This function is used to check both the environment variable
790 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
791 ;; an nntp server name default.
792 (defun gnus-getenv-nntpserver ()
793 (or (getenv "NNTPSERVER")
794 (and (file-readable-p gnus-nntpserver-file)
796 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
797 (insert-file-contents gnus-nntpserver-file)
798 (let ((name (buffer-string)))
800 (if (string-match "^[ \t\n]*$" name)
803 (kill-buffer (current-buffer))))))))
805 (defcustom gnus-select-method
808 (list 'nntp (or (condition-case nil
809 (gnus-getenv-nntpserver)
811 (when (and gnus-default-nntp-server
812 (not (string= gnus-default-nntp-server "")))
813 gnus-default-nntp-server)
815 (if (or (null gnus-nntp-service)
816 (equal gnus-nntp-service "nntp"))
818 (list gnus-nntp-service)))
820 "*Default method for selecting a newsgroup.
821 This variable should be a list, where the first element is how the
822 news is to be fetched, the second is the address.
824 For instance, if you want to get your news via NNTP from
825 \"flab.flab.edu\", you could say:
827 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
829 If you want to use your local spool, say:
831 \(setq gnus-select-method (list 'nnspool (system-name)))
833 If you use this variable, you must set `gnus-nntp-server' to nil.
835 There is a lot more to know about select methods and virtual servers -
836 see the manual for details."
838 :type 'gnus-select-method)
840 (defcustom gnus-message-archive-method
843 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
844 (nnfolder-active-file
845 ,(nnheader-concat message-directory "archive/active"))
846 (nnfolder-get-new-mail nil)
847 (nnfolder-inhibit-expiry t))
848 "*Method used for archiving messages you've sent.
849 This should be a mail method.
851 It's probably not a very effective to change this variable once you've
852 run Gnus once. After doing that, you must edit this server from the
856 :type 'gnus-select-method)
858 (defcustom gnus-message-archive-group nil
859 "*Name of the group in which to save the messages you've written.
860 This can either be a string; a list of strings; or an alist
861 of regexps/functions/forms to be evaluated to return a string (or a list
862 of strings). The functions are called with the name of the current
863 group (or nil) as a parameter.
865 If you want to save your mail in one group and the news articles you
866 write in another group, you could say something like:
868 \(setq gnus-message-archive-group
869 '((if (message-news-p)
873 Normally the group names returned by this variable should be
874 unprefixed -- which implicitly means \"store on the archive server\".
875 However, you may wish to store the message on some other server. In
876 that case, just return a fully prefixed name of the group --
877 \"nnml+private:mail.misc\", for instance."
879 :type '(choice (const :tag "none" nil)
882 (defcustom gnus-secondary-servers nil
883 "List of NNTP servers that the user can choose between interactively.
884 To make Gnus query you for a server, you have to give `gnus' a
885 non-numeric prefix - `C-u M-x gnus', in short."
887 :type '(repeat string))
889 (defcustom gnus-nntp-server nil
890 "*The name of the host running the NNTP server.
891 This variable is semi-obsolete. Use the `gnus-select-method'
894 :type '(choice (const :tag "disable" nil)
897 (defcustom gnus-secondary-select-methods nil
898 "A list of secondary methods that will be used for reading news.
899 This is a list where each element is a complete select method (see
900 `gnus-select-method').
902 If, for instance, you want to read your mail with the nnml backend,
903 you could set this variable:
905 \(setq gnus-secondary-select-methods '((nnml \"\")))"
907 :type '(repeat gnus-select-method))
909 (defvar gnus-backup-default-subscribed-newsgroups
910 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
911 "Default default new newsgroups the first time Gnus is run.
912 Should be set in paths.el, and shouldn't be touched by the user.")
914 (defcustom gnus-local-domain nil
915 "Local domain name without a host name.
916 The DOMAINNAME environment variable is used instead if it is defined.
917 If the `system-name' function returns the full Internet name, there is
918 no need to set this variable."
920 :type '(choice (const :tag "default" nil)
923 (defvar gnus-local-organization nil
924 "String with a description of what organization (if any) the user belongs to.
925 Obsolete variable; use `message-user-organization' instead.")
927 ;; Customization variables
929 (defcustom gnus-refer-article-method nil
930 "Preferred method for fetching an article by Message-ID.
931 If you are reading news from the local spool (with nnspool), fetching
932 articles by Message-ID is painfully slow. By setting this method to an
933 nntp method, you might get acceptable results.
935 The value of this variable must be a valid select method as discussed
936 in the documentation of `gnus-select-method'."
938 :type '(choice (const :tag "default" nil)
941 (defcustom gnus-group-faq-directory
942 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
943 "/ftp@sunsite.auc.dk:/pub/usenet/"
944 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
945 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
946 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
947 "/ftp@rtfm.mit.edu:/pub/usenet/"
948 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
949 "/ftp@ftp.sunet.se:/pub/usenet/"
950 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
951 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
952 "/ftp@ftp.hk.super.net:/mirror/faqs/")
953 "*Directory where the group FAQs are stored.
954 This will most commonly be on a remote machine, and the file will be
957 This variable can also be a list of directories. In that case, the
958 first element in the list will be used by default. The others can
959 be used when being prompted for a site.
961 Note that Gnus uses an aol machine as the default directory. If this
962 feels fundamentally unclean, just think of it as a way to finally get
963 something of value back from them.
965 If the default site is too slow, try one of these:
967 North America: mirrors.aol.com /pub/rtfm/usenet
968 ftp.seas.gwu.edu /pub/rtfm
969 rtfm.mit.edu /pub/usenet
970 Europe: ftp.uni-paderborn.de /pub/FAQ
971 src.doc.ic.ac.uk /usenet/news-FAQS
972 ftp.sunet.se /pub/usenet
973 sunsite.auc.dk /pub/usenet
974 Asia: nctuccca.edu.tw /USENET/FAQ
975 hwarang.postech.ac.kr /pub/usenet
976 ftp.hk.super.net /mirror/faqs"
977 :group 'gnus-group-various
978 :type '(choice directory
981 (defcustom gnus-use-cross-reference t
982 "*Non-nil means that cross referenced articles will be marked as read.
983 If nil, ignore cross references. If t, mark articles as read in
984 subscribed newsgroups. If neither t nor nil, mark as read in all
987 :type '(choice (const :tag "off" nil)
988 (const :tag "subscribed" t)
992 (defcustom gnus-process-mark ?#
994 :group 'gnus-group-visual
995 :group 'gnus-summary-marks
998 (defcustom gnus-asynchronous nil
999 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1000 :group 'gnus-asynchronous
1003 (defcustom gnus-large-newsgroup 200
1004 "*The number of articles which indicates a large newsgroup.
1005 If the number of articles in a newsgroup is greater than this value,
1006 confirmation is required for selecting the newsgroup."
1007 :group 'gnus-group-select
1010 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1011 "*Non-nil means that the default name of a file to save articles in is the group name.
1012 If it's nil, the directory form of the group name is used instead.
1014 If this variable is a list, and the list contains the element
1015 `not-score', long file names will not be used for score files; if it
1016 contains the element `not-save', long file names will not be used for
1017 saving; and if it contains the element `not-kill', long file names
1018 will not be used for kill files.
1020 Note that the default for this variable varies according to what system
1021 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1022 to nil while on all other systems it defaults to t."
1026 (defcustom gnus-kill-files-directory gnus-directory
1027 "*Name of the directory where kill files will be stored (default \"~/News\")."
1028 :group 'gnus-score-files
1029 :group 'gnus-score-kill
1032 (defcustom gnus-save-score nil
1033 "*If non-nil, save group scoring info."
1034 :group 'gnus-score-various
1038 (defcustom gnus-use-undo t
1039 "*If non-nil, allow undoing in Gnus group mode buffers."
1043 (defcustom gnus-use-adaptive-scoring nil
1044 "*If non-nil, use some adaptive scoring scheme.
1045 If a list, then the values `word' and `line' are meaningful. The
1046 former will perform adaption on individual words in the subject
1047 header while `line' will perform adaption on several headers."
1049 :group 'gnus-score-adapt
1050 :type '(set (const word) (const line)))
1052 (defcustom gnus-use-cache 'passive
1053 "*If nil, Gnus will ignore the article cache.
1054 If `passive', it will allow entering (and reading) articles
1055 explicitly entered into the cache. If anything else, use the
1056 cache to the full extent of the law."
1059 :type '(choice (const :tag "off" nil)
1060 (const :tag "passive" passive)
1061 (const :tag "active" t)))
1063 (defcustom gnus-use-trees nil
1064 "*If non-nil, display a thread tree buffer."
1068 (defcustom gnus-use-grouplens nil
1069 "*If non-nil, use GroupLens ratings."
1073 (defcustom gnus-keep-backlog nil
1074 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1075 If it is a number N, then Gnus will only keep the last N articles
1076 read. If it is neither nil nor a number, Gnus will keep all read
1077 articles. This is not a good idea."
1079 :type '(choice (const :tag "off" nil)
1084 (defcustom gnus-use-nocem nil
1085 "*If non-nil, Gnus will read NoCeM cancel messages."
1089 (defcustom gnus-suppress-duplicates nil
1090 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1094 (defcustom gnus-use-demon nil
1095 "If non-nil, Gnus might use some demons."
1099 (defcustom gnus-use-scoring t
1100 "*If non-nil, enable scoring."
1104 (defcustom gnus-use-picons nil
1105 "*If non-nil, display picons."
1109 (defcustom gnus-summary-prepare-exit-hook
1110 '(gnus-summary-expire-articles)
1111 "*A hook called when preparing to exit from the summary buffer.
1112 It calls `gnus-summary-expire-articles' by default."
1113 :group 'gnus-summary-exit
1116 (defcustom gnus-novice-user t
1117 "*Non-nil means that you are a usenet novice.
1118 If non-nil, verbose messages may be displayed and confirmations may be
1123 (defcustom gnus-expert-user nil
1124 "*Non-nil means that you will never be asked for confirmation about anything.
1125 That doesn't mean *anything* anything; particularly destructive
1126 commands will still require prompting."
1130 (defcustom gnus-interactive-catchup t
1131 "*If non-nil, require your confirmation when catching up a group."
1132 :group 'gnus-group-select
1135 (defcustom gnus-interactive-exit t
1136 "*If non-nil, require your confirmation when exiting Gnus."
1140 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1141 "*Function for extracting address components from a From header.
1143 `gnus-extract-address-components' is a quite fast, and too simplistic.
1144 `mail-extract-address-components' works much better, but is slower.
1145 `std11-extract-address-components' also works better, and less slower."
1146 :group 'gnus-summary-format
1147 :type '(radio (function-item gnus-extract-address-components)
1148 (function-item mail-extract-address-components)
1149 (function-item std11-extract-address-components)
1150 (function :tag "Other")))
1152 (defcustom gnus-carpal nil
1153 "*If non-nil, display clickable icons."
1157 (defcustom gnus-shell-command-separator ";"
1158 "String used to separate to shell commands."
1162 (defcustom gnus-valid-select-methods
1163 '(("nntp" post address prompt-address physical-address)
1164 ("nnspool" post address)
1165 ("nnvirtual" post-mail virtual prompt-address)
1166 ("nnmbox" mail respool address)
1167 ("nnml" mail respool address)
1168 ("nnmh" mail respool address)
1169 ("nndir" post-mail prompt-address physical-address)
1170 ("nneething" none address prompt-address physical-address)
1171 ("nndoc" none address prompt-address)
1172 ("nnbabyl" mail address respool)
1173 ("nnkiboze" post virtual)
1174 ("nnsoup" post-mail address)
1175 ("nndraft" post-mail)
1176 ("nnfolder" mail respool address)
1177 ("nngateway" post-mail address prompt-address physical-address)
1180 ("nnagent" post-mail))
1181 "*An alist of valid select methods.
1182 The first element of each list lists should be a string with the name
1183 of the select method. The other elements may be the category of
1184 this method (i. e., `post', `mail', `none' or whatever) or other
1185 properties that this method has (like being respoolable).
1186 If you implement a new select method, all you should have to change is
1187 this variable. I think."
1189 :type '(repeat (group (string :tag "Name")
1190 (radio-button-choice (const :format "%v " post)
1191 (const :format "%v " mail)
1192 (const :format "%v " none)
1194 (checklist :inline t
1195 (const :format "%v " address)
1196 (const :format "%v " prompt-address)
1197 (const :format "%v " physical-address)
1198 (const :format "%v " virtual)
1201 (define-widget 'gnus-select-method 'list
1202 "Widget for entering a select method."
1203 :args `((choice :tag "Method"
1204 ,@(mapcar (lambda (entry)
1205 (list 'const :format "%v\n"
1206 (intern (car entry))))
1207 gnus-valid-select-methods))
1208 (string :tag "Address")
1209 (editable-list :inline t
1212 (sexp :tag "Value")))))
1214 (defcustom gnus-updated-mode-lines '(group article summary tree)
1215 "List of buffers that should update their mode lines.
1216 The list may contain the symbols `group', `article', `tree' and
1217 `summary'. If the corresponding symbol is present, Gnus will keep
1218 that mode line updated with information that may be pertinent.
1219 If this variable is nil, screen refresh may be quicker."
1220 :group 'gnus-various
1221 :type '(set (const group)
1226 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1227 (defcustom gnus-mode-non-string-length nil
1228 "*Max length of mode-line non-string contents.
1229 If this is nil, Gnus will take space as is needed, leaving the rest
1230 of the modeline intact. Note that the default of nil is unlikely
1231 to be desirable; see the manual for further details."
1232 :group 'gnus-various
1233 :type '(choice (const nil)
1236 (defcustom gnus-auto-expirable-newsgroups nil
1237 "*Groups in which to automatically mark read articles as expirable.
1238 If non-nil, this should be a regexp that should match all groups in
1239 which to perform auto-expiry. This only makes sense for mail groups."
1240 :group 'nnmail-expire
1241 :type '(choice (const nil)
1244 (defcustom gnus-total-expirable-newsgroups nil
1245 "*Groups in which to perform expiry of all read articles.
1246 Use with extreme caution. All groups that match this regexp will be
1247 expiring - which means that all read articles will be deleted after
1248 \(say) one week. (This only goes for mail groups and the like, of
1250 :group 'nnmail-expire
1251 :type '(choice (const nil)
1254 (defcustom gnus-group-uncollapsed-levels 1
1255 "Number of group name elements to leave alone when making a short group name."
1256 :group 'gnus-group-visual
1259 (defcustom gnus-group-use-permanent-levels nil
1260 "*If non-nil, once you set a level, Gnus will use this level."
1261 :group 'gnus-group-levels
1266 (defcustom gnus-load-hook nil
1267 "A hook run while Gnus is loaded."
1271 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1272 "A hook called to apply kill files to a group.
1273 This hook is intended to apply a kill file to the selected newsgroup.
1274 The function `gnus-apply-kill-file' is called by default.
1276 Since a general kill file is too heavy to use only for a few
1277 newsgroups, I recommend you to use a lighter hook function. For
1278 example, if you'd like to apply a kill file to articles which contains
1279 a string `rmgroup' in subject in newsgroup `control', you can use the
1282 (setq gnus-apply-kill-hook
1285 (cond ((string-match \"control\" gnus-newsgroup-name)
1286 (gnus-kill \"Subject\" \"rmgroup\")
1287 (gnus-expunge \"X\"))))))"
1288 :group 'gnus-score-kill
1289 :options '(gnus-apply-kill-file)
1292 (defcustom gnus-group-change-level-function nil
1293 "Function run when a group level is changed.
1294 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1295 :group 'gnus-group-level
1300 (defcustom gnus-visual
1301 '(summary-highlight group-highlight article-highlight
1303 summary-menu group-menu article-menu
1304 tree-highlight menu highlight
1305 browse-menu server-menu
1306 page-marker tree-menu binary-menu pick-menu
1308 "*Enable visual features.
1309 If `visual' is disabled, there will be no menus and few faces. Most of
1310 the visual customization options below will be ignored. Gnus will use
1311 less space and be faster as a result.
1313 This variable can also be a list of visual elements to switch on. For
1314 instance, to switch off all visual things except menus, you can say:
1316 (setq gnus-visual '(menu))
1318 Valid elements include `summary-highlight', `group-highlight',
1319 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1320 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1321 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1322 and `grouplens-menu'."
1325 :type '(set (const summary-highlight)
1326 (const group-highlight)
1327 (const article-highlight)
1329 (const summary-menu)
1331 (const article-menu)
1332 (const tree-highlight)
1341 (const grouplens-menu)))
1343 (defcustom gnus-mouse-face
1345 (if (gnus-visual-p 'mouse-face 'highlight)
1346 (if (boundp 'gnus-mouse-face)
1347 (or gnus-mouse-face 'highlight)
1351 "*Face used for group or summary buffer mouse highlighting.
1352 The line beneath the mouse pointer will be highlighted with this
1357 (defcustom gnus-article-display-hook
1358 (if (and (string-match "XEmacs" emacs-version)
1360 '(gnus-article-hide-headers-if-wanted
1361 gnus-article-hide-boring-headers
1362 gnus-article-treat-overstrike
1363 gnus-article-maybe-highlight
1364 gnus-article-display-x-face)
1365 '(gnus-article-hide-headers-if-wanted
1366 gnus-article-hide-boring-headers
1367 gnus-article-treat-overstrike
1368 gnus-article-maybe-highlight))
1369 "*Controls how the article buffer will look.
1371 If you leave the list empty, the article will appear exactly as it is
1372 stored on the disk. The list entries will hide or highlight various
1373 parts of the article, making it easier to find the information you
1375 :group 'gnus-article-highlight
1378 :options '(gnus-article-add-buttons
1379 gnus-article-add-buttons-to-head
1380 gnus-article-emphasize
1381 gnus-article-fill-cited-article
1382 gnus-article-remove-cr
1383 gnus-summary-stop-page-breaking
1384 ;; gnus-summary-caesar-message
1385 ;; gnus-summary-verbose-headers
1386 gnus-summary-toggle-mime
1388 gnus-article-hide-headers
1389 gnus-article-hide-boring-headers
1390 gnus-article-hide-signature
1391 gnus-article-hide-citation
1392 gnus-article-hide-pgp
1393 gnus-article-hide-pem
1394 gnus-article-highlight
1395 gnus-article-highlight-headers
1396 gnus-article-highlight-citation
1397 gnus-article-highlight-signature
1398 gnus-article-date-ut
1399 gnus-article-date-local
1400 gnus-article-date-lapsed
1401 gnus-article-date-original
1402 gnus-article-remove-trailing-blank-lines
1403 gnus-article-strip-leading-blank-lines
1404 gnus-article-strip-multiple-blank-lines
1405 gnus-article-strip-blank-lines
1406 gnus-article-treat-overstrike
1407 gnus-article-display-x-face
1408 gnus-smiley-display))
1410 (defcustom gnus-article-save-directory gnus-directory
1411 "*Name of the directory articles will be saved in (default \"~/News\")."
1412 :group 'gnus-article-saving
1415 (defvar gnus-plugged t
1416 "Whether Gnus is plugged or not.")
1419 ;;; Internal variables
1421 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1422 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1423 (defvar gnus-original-article-buffer " *Original Article*")
1424 (defvar gnus-newsgroup-name nil)
1425 (defvar gnus-ephemeral-servers nil)
1427 (defvar gnus-agent nil
1428 "Whether we want to use the Gnus agent or not.")
1430 (defvar gnus-command-method nil
1431 "Dynamically bound variable that says what the current backend is.")
1433 (defvar gnus-current-select-method nil
1434 "The current method for selecting a newsgroup.")
1436 (defvar gnus-tree-buffer "*Tree*"
1437 "Buffer where Gnus thread trees are displayed.")
1440 (defvar gnus-use-generic-from nil)
1442 ;; Variable holding the user answers to all method prompts.
1443 (defvar gnus-method-history nil)
1445 ;; Variable holding the user answers to all mail method prompts.
1446 (defvar gnus-mail-method-history nil)
1448 ;; Variable holding the user answers to all group prompts.
1449 (defvar gnus-group-history nil)
1451 (defvar gnus-server-alist nil
1452 "List of available servers.")
1454 (defcustom gnus-cache-directory
1455 (nnheader-concat gnus-directory "cache/")
1456 "*The directory where cached articles will be stored."
1460 (defvar gnus-predefined-server-alist
1463 (nnspool-spool-directory ,gnus-cache-directory)
1464 (nnspool-nov-directory ,gnus-cache-directory)
1465 (nnspool-active-file
1466 ,(nnheader-concat gnus-cache-directory "active"))))
1467 "List of predefined (convenience) servers.")
1469 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1471 (defconst gnus-article-mark-lists
1472 '((marked . tick) (replied . reply)
1473 (expirable . expire) (killed . killed)
1474 (bookmarks . bookmark) (dormant . dormant)
1475 (scored . score) (saved . save)
1476 (cached . cache) (downloadable . download)
1477 (unsendable . unsend)))
1479 (defvar gnus-headers-retrieved-by nil)
1480 (defvar gnus-article-reply nil)
1481 (defvar gnus-override-method nil)
1482 (defvar gnus-article-check-size nil)
1483 (defvar gnus-opened-servers nil)
1485 (defvar gnus-current-kill-article nil)
1487 (defvar gnus-have-read-active-file nil)
1489 (defconst gnus-maintainer
1490 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1491 "The mail address of the Gnus maintainers.")
1493 (defconst semi-gnus-developers
1494 "Semi-gnus Developers:
1495 semi-gnus-en@meadow.scphys.kyoto-u.ac.jp (In English),\
1496 semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (In Japanese);"
1497 "The mail address of the Semi-gnus developers.")
1499 (defvar gnus-info-nodes
1500 '((gnus-group-mode "(gnus)The Group Buffer")
1501 (gnus-summary-mode "(gnus)The Summary Buffer")
1502 (gnus-article-mode "(gnus)The Article Buffer")
1503 (mime/viewer-mode "(gnus)The Article Buffer")
1504 (gnus-server-mode "(gnus)The Server Buffer")
1505 (gnus-browse-mode "(gnus)Browse Foreign Server")
1506 (gnus-tree-mode "(gnus)Tree Display"))
1507 "Alist of major modes and related Info nodes.")
1509 (defvar gnus-group-buffer "*Group*")
1510 (defvar gnus-summary-buffer "*Summary*")
1511 (defvar gnus-article-buffer "*Article*")
1512 (defvar gnus-server-buffer "*Server*")
1514 (defvar gnus-slave nil
1515 "Whether this Gnus is a slave or not.")
1517 (defvar gnus-batch-mode nil
1518 "Whether this Gnus is running in batch mode or not.")
1520 (defvar gnus-variable-list
1521 '(gnus-newsrc-options gnus-newsrc-options-n
1522 gnus-newsrc-last-checked-date
1523 gnus-newsrc-alist gnus-server-alist
1524 gnus-killed-list gnus-zombie-list
1525 gnus-topic-topology gnus-topic-alist
1527 "Gnus variables saved in the quick startup file.")
1529 (defvar gnus-newsrc-alist nil
1530 "Assoc list of read articles.
1531 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1533 (defvar gnus-newsrc-hashtb nil
1534 "Hashtable of gnus-newsrc-alist.")
1536 (defvar gnus-killed-list nil
1537 "List of killed newsgroups.")
1539 (defvar gnus-killed-hashtb nil
1540 "Hash table equivalent of gnus-killed-list.")
1542 (defvar gnus-zombie-list nil
1543 "List of almost dead newsgroups.")
1545 (defvar gnus-description-hashtb nil
1546 "Descriptions of newsgroups.")
1548 (defvar gnus-list-of-killed-groups nil
1549 "List of newsgroups that have recently been killed by the user.")
1551 (defvar gnus-active-hashtb nil
1552 "Hashtable of active articles.")
1554 (defvar gnus-moderated-hashtb nil
1555 "Hashtable of moderated newsgroups.")
1557 ;; Save window configuration.
1558 (defvar gnus-prev-winconf nil)
1560 (defvar gnus-reffed-article-number nil)
1562 ;;; Let the byte-compiler know that we know about this variable.
1563 (defvar rmail-default-rmail-file)
1565 (defvar gnus-dead-summary nil)
1567 ;;; End of variables.
1569 ;; Define some autoload functions Gnus might use.
1572 ;; This little mapcar goes through the list below and marks the
1573 ;; symbols in question as autoloaded functions.
1576 (let ((interactive (nth 1 (memq ':interactive package))))
1580 (when (consp function)
1581 (setq keymap (car (memq 'keymap function)))
1582 (setq function (car function)))
1583 (autoload function (car package) nil interactive keymap)))
1584 (if (eq (nth 1 package) ':interactive)
1587 '(("info" Info-goto-node)
1588 ("pp" pp pp-to-string pp-eval-expression)
1589 ("ps-print" ps-print-preprint)
1590 ("mail-extr" mail-extract-address-components)
1591 ("browse-url" browse-url)
1592 ("message" :interactive t
1593 message-send-and-exit message-yank-original)
1594 ("nnmail" nnmail-split-fancy nnmail-article-group)
1595 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1596 ("rmailout" rmail-output)
1597 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1598 rmail-show-message rmail-output-to-rmail-file)
1599 ("gnus-audio" :interactive t gnus-audio-play)
1600 ("gnus-xmas" gnus-xmas-splash)
1601 ("gnus-soup" :interactive t
1602 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1603 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1604 ("nnsoup" nnsoup-pack-replies)
1605 ("score-mode" :interactive t gnus-score-mode)
1606 ("gnus-mh" gnus-summary-save-article-folder
1607 gnus-Folder-save-name gnus-folder-save-name)
1608 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1609 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1610 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1611 gnus-demon-add-disconnection gnus-demon-add-handler
1612 gnus-demon-remove-handler)
1613 ("gnus-demon" :interactive t
1614 gnus-demon-init gnus-demon-cancel)
1615 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1616 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1617 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1618 gnus-nocem-unwanted-article-p)
1619 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1620 gnus-server-server-name)
1621 ("gnus-srvr" gnus-browse-foreign-server)
1622 ("gnus-cite" :interactive t
1623 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1624 gnus-article-hide-citation gnus-article-fill-cited-article
1625 gnus-article-hide-citation-in-followups)
1626 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1627 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1628 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1629 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1630 gnus-cache-possibly-remove-articles gnus-cache-request-article
1631 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1632 gnus-cache-enter-remove-article gnus-cached-article-p
1633 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1634 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1635 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1636 ("gnus-score" :interactive t
1637 gnus-summary-increase-score gnus-summary-set-score
1638 gnus-summary-raise-thread gnus-summary-raise-same-subject
1639 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1640 gnus-summary-lower-thread gnus-summary-lower-same-subject
1641 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1642 gnus-summary-current-score gnus-score-default
1643 gnus-score-flush-cache gnus-score-close
1644 gnus-possibly-score-headers gnus-score-followup-article
1645 gnus-score-followup-thread)
1647 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1648 gnus-current-score-file-nondirectory gnus-score-adaptive
1649 gnus-score-find-trace gnus-score-file-name)
1650 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1651 ("gnus-topic" :interactive t gnus-topic-mode)
1652 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1653 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1654 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1655 ("gnus-uu" :interactive t
1656 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1657 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1658 gnus-uu-mark-by-regexp gnus-uu-mark-all
1659 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1660 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1661 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1662 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1663 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1664 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1665 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1667 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1668 gnus-uu-unmark-thread)
1669 ("gnus-msg" (gnus-summary-send-map keymap)
1670 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1671 ("gnus-msg" :interactive t
1672 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1673 gnus-summary-followup gnus-summary-followup-with-original
1674 gnus-summary-cancel-article gnus-summary-supersede-article
1675 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1676 gnus-summary-mail-forward gnus-summary-mail-other-window
1677 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1678 gnus-summary-wide-reply gnus-summary-followup-to-mail
1679 gnus-summary-followup-to-mail-with-original gnus-bug)
1680 ("gnus-picon" :interactive t gnus-article-display-picons
1681 gnus-group-display-picons gnus-picons-article-display-x-face
1682 gnus-picons-display-x-face)
1683 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1684 gnus-grouplens-mode)
1685 ("smiley" :interactive t gnus-smiley-display)
1686 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1687 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1688 gnus-list-of-unread-articles gnus-list-of-read-articles
1689 gnus-offer-save-summaries gnus-make-thread-indent-array
1690 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1691 gnus-summary-skip-intangible gnus-summary-article-number
1692 gnus-data-header gnus-data-find)
1693 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1694 gnus-group-list-groups gnus-group-first-unread-group
1695 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1696 gnus-group-setup-buffer gnus-group-get-new-news
1697 gnus-group-make-help-group gnus-group-update-group
1698 gnus-clear-inboxes-moved gnus-group-iterate
1699 gnus-group-group-name)
1700 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1701 gnus-backlog-remove-article)
1702 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1703 gnus-article-prepare gnus-article-set-window-start
1704 gnus-article-next-page gnus-article-prev-page
1705 gnus-request-article-this-buffer gnus-article-mode
1706 gnus-article-setup-buffer gnus-narrow-to-page
1707 gnus-article-delete-invisible-text)
1708 ("gnus-art" :interactive t
1709 gnus-article-hide-headers gnus-article-hide-boring-headers
1710 gnus-article-treat-overstrike gnus-article-word-wrap
1711 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1712 gnus-article-display-x-face
1713 gnus-article-hide-pgp
1714 gnus-article-hide-pem gnus-article-hide-signature
1715 gnus-article-strip-leading-blank-lines gnus-article-date-local
1716 gnus-article-date-original gnus-article-date-lapsed
1717 gnus-article-show-all-headers
1718 gnus-article-edit-mode gnus-article-edit-article
1719 gnus-article-edit-done article-decode-encoded-words
1720 gnus-start-date-timer gnus-stop-date-timer)
1721 ("gnus-int" gnus-request-type)
1722 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1723 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1724 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1725 gnus-dup-enter-articles)
1726 ("gnus-range" gnus-copy-sequence)
1727 ("gnus-eform" gnus-edit-form)
1728 ("gnus-move" :interactive t
1729 gnus-group-move-group-to-server gnus-change-server)
1730 ("gnus-logic" gnus-score-advanced)
1731 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1732 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1733 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1734 gnus-async-halt-prefetch)
1735 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1736 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1737 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1738 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1739 ("gnus-agent" :interactive t
1740 gnus-unplugged gnus-agentize gnus-agent-batch)
1741 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1742 gnus-summary-save-article-vm)
1743 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1745 ;;; gnus-sum.el thingies
1748 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1749 "*The format specification of the lines in the summary buffer.
1751 It works along the same lines as a normal formatting string,
1752 with some simple extensions.
1754 %N Article number, left padded with spaces (string)
1756 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1757 %n Name of the poster (string)
1758 %a Extracted name of the poster (string)
1759 %A Extracted address of the poster (string)
1760 %F Contents of the From: header (string)
1761 %x Contents of the Xref: header (string)
1762 %D Date of the article (string)
1763 %d Date of the article (string) in DD-MMM format
1764 %M Message-id of the article (string)
1765 %r References of the article (string)
1766 %c Number of characters in the article (integer)
1767 %L Number of lines in the article (integer)
1768 %I Indentation based on thread level (a string of spaces)
1769 %T A string with two possible values: 80 spaces if the article
1770 is on thread level two or larger and 0 spaces on level one
1771 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1772 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1773 %[ Opening bracket (character, \"[\" or \"<\")
1774 %] Closing bracket (character, \"]\" or \">\")
1775 %> Spaces of length thread-level (string)
1776 %< Spaces of length (- 20 thread-level) (string)
1777 %i Article score (number)
1778 %z Article zcore (character)
1779 %t Number of articles under the current thread (number).
1780 %e Whether the thread is empty or not (character).
1781 %l GroupLens score (string).
1782 %V Total thread score (number).
1783 %P The line number (number).
1784 %O Download mark (character).
1785 %u User defined specifier. The next character in the format string should
1786 be a letter. Gnus will call the function gnus-user-format-function-X,
1787 where X is the letter following %u. The function will be passed the
1788 current header as argument. The function should return a string, which
1789 will be inserted into the summary just like information from any other
1792 Text between %( and %) will be highlighted with `gnus-mouse-face'
1793 when the mouse point is placed inside the area. There can only be one
1796 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1797 with care. For reasons of efficiency, Gnus will compute what column
1798 these characters will end up in, and \"hard-code\" that. This means that
1799 it is illegal to have these specs after a variable-length spec. Well,
1800 you might not be arrested, but your summary buffer will look strange,
1801 which is bad enough.
1803 The smart choice is to have these specs as for to the left as
1806 This restriction may disappear in later versions of Gnus."
1808 :group 'gnus-summary-format)
1811 ;;; Skeleton keymaps
1814 (defun gnus-suppress-keymap (keymap)
1815 (suppress-keymap keymap)
1816 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1818 (define-key keymap (pop keys) 'undefined))))
1820 (defvar gnus-article-mode-map
1821 (let ((keymap (make-sparse-keymap)))
1822 (gnus-suppress-keymap keymap)
1824 (defvar gnus-summary-mode-map
1825 (let ((keymap (make-keymap)))
1826 (gnus-suppress-keymap keymap)
1828 (defvar gnus-group-mode-map
1829 (let ((keymap (make-keymap)))
1830 (gnus-suppress-keymap keymap)
1835 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1836 ;; If you want the cursor to go somewhere else, set these two
1837 ;; functions in some startup hook to whatever you want.
1838 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1839 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1841 ;;; Various macros and substs.
1843 (defun gnus-header-from (header)
1844 (mail-header-from header))
1846 (defmacro gnus-gethash (string hashtable)
1847 "Get hash value of STRING in HASHTABLE."
1848 `(symbol-value (intern-soft ,string ,hashtable)))
1850 (defmacro gnus-sethash (string value hashtable)
1851 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1852 `(set (intern ,string ,hashtable) ,value))
1853 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1855 (defmacro gnus-group-unread (group)
1856 "Get the currently computed number of unread articles in GROUP."
1857 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1859 (defmacro gnus-group-entry (group)
1860 "Get the newsrc entry for GROUP."
1861 `(gnus-gethash ,group gnus-newsrc-hashtb))
1863 (defmacro gnus-active (group)
1864 "Get active info on GROUP."
1865 `(gnus-gethash ,group gnus-active-hashtb))
1867 (defmacro gnus-set-active (group active)
1868 "Set GROUP's active info."
1869 `(gnus-sethash ,group ,active gnus-active-hashtb))
1871 ;; Info access macros.
1873 (defmacro gnus-info-group (info)
1875 (defmacro gnus-info-rank (info)
1877 (defmacro gnus-info-read (info)
1879 (defmacro gnus-info-marks (info)
1881 (defmacro gnus-info-method (info)
1883 (defmacro gnus-info-params (info)
1886 (defmacro gnus-info-level (info)
1887 `(let ((rank (gnus-info-rank ,info)))
1891 (defmacro gnus-info-score (info)
1892 `(let ((rank (gnus-info-rank ,info)))
1893 (or (and (consp rank) (cdr rank)) 0)))
1895 (defmacro gnus-info-set-group (info group)
1896 `(setcar ,info ,group))
1897 (defmacro gnus-info-set-rank (info rank)
1898 `(setcar (nthcdr 1 ,info) ,rank))
1899 (defmacro gnus-info-set-read (info read)
1900 `(setcar (nthcdr 2 ,info) ,read))
1901 (defmacro gnus-info-set-marks (info marks &optional extend)
1903 `(gnus-info-set-entry ,info ,marks 3)
1904 `(setcar (nthcdr 3 ,info) ,marks)))
1905 (defmacro gnus-info-set-method (info method &optional extend)
1907 `(gnus-info-set-entry ,info ,method 4)
1908 `(setcar (nthcdr 4 ,info) ,method)))
1909 (defmacro gnus-info-set-params (info params &optional extend)
1911 `(gnus-info-set-entry ,info ,params 5)
1912 `(setcar (nthcdr 5 ,info) ,params)))
1914 (defun gnus-info-set-entry (info entry number)
1915 ;; Extend the info until we have enough elements.
1916 (while (<= (length info) number)
1917 (nconc info (list nil)))
1919 (setcar (nthcdr number info) entry))
1921 (defmacro gnus-info-set-level (info level)
1922 `(let ((rank (cdr ,info)))
1923 (if (consp (car rank))
1924 (setcar (car rank) ,level)
1925 (setcar rank ,level))))
1926 (defmacro gnus-info-set-score (info score)
1927 `(let ((rank (cdr ,info)))
1928 (if (consp (car rank))
1929 (setcdr (car rank) ,score)
1930 (setcar rank (cons (car rank) ,score)))))
1932 (defmacro gnus-get-info (group)
1933 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1935 ;; Byte-compiler warning.
1936 (defvar gnus-visual)
1937 ;; Find out whether the gnus-visual TYPE is wanted.
1938 (defun gnus-visual-p (&optional type class)
1939 (and gnus-visual ; Has to be non-nil, at least.
1940 (if (not type) ; We don't care about type.
1942 (if (listp gnus-visual) ; It's a list, so we check it.
1943 (or (memq type gnus-visual)
1944 (memq class gnus-visual))
1947 ;;; Load the compatability functions.
1956 (defvar gnus-shutdown-alist nil)
1958 (defun gnus-add-shutdown (function &rest symbols)
1959 "Run FUNCTION whenever one of SYMBOLS is shut down."
1960 (push (cons function symbols) gnus-shutdown-alist))
1962 (defun gnus-shutdown (symbol)
1963 "Shut down everything that waits for SYMBOL."
1964 (let ((alist gnus-shutdown-alist)
1966 (while (setq entry (pop alist))
1967 (when (memq symbol (cdr entry))
1968 (funcall (car entry))))))
1972 ;;; Gnus Utility Functions
1976 (defmacro gnus-string-or (&rest strings)
1977 "Return the first element of STRINGS that is a non-blank string.
1978 STRINGS will be evaluated in normal `or' order."
1979 `(gnus-string-or-1 ',strings))
1981 (defun gnus-string-or-1 (strings)
1984 (setq string (eval (pop strings)))
1985 (if (string-match "^[ \t]*$" string)
1987 (setq strings nil)))
1990 (defun gnus-version (&optional arg)
1991 "Version number of this version of Gnus.
1992 If ARG, insert string at point."
1995 (insert (message gnus-version))
1996 (message gnus-version)))
1998 (defun gnus-continuum-version (version)
1999 "Return VERSION as a floating point number."
2000 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2001 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2002 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2003 (number (match-string 2 version))
2005 (unless (string-match
2006 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2007 (error "Invalid version string: %s" version))
2008 (setq major (string-to-number (match-string 1 number))
2009 minor (string-to-number (match-string 2 number))
2010 least (if (match-beginning 3)
2011 (string-to-number (match-string 3 number))
2015 (format "%s00%02d%02d"
2016 (if (member alpha '("(ding)" "d"))
2020 (- (char-int (aref (downcase alpha) 0))
2024 (format "%d.%02d%02d" major minor least))))))
2026 (defun gnus-info-find-node ()
2027 "Find Info documentation of Gnus."
2029 ;; Enlarge info window if needed.
2030 (let (gnus-info-buffer)
2031 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2032 (setq gnus-info-buffer (current-buffer))
2033 (gnus-configure-windows 'info)))
2036 ;;; gnus-interactive
2039 (defvar gnus-current-prefix-symbol nil
2040 "Current prefix symbol.")
2042 (defvar gnus-current-prefix-symbols nil
2043 "List of current prefix symbols.")
2045 (defun gnus-interactive (string &optional params)
2046 "Return a list that can be fed to `interactive'.
2047 See `interactive' for full documentation.
2049 Adds the following specs:
2051 y -- The current symbolic prefix.
2052 Y -- A list of the current symbolic prefix(es).
2053 A -- Article number.
2054 H -- Article header.
2058 (while (< i (length string))
2059 (string-match ".\\([^\n]*\\)\n?" string i)
2060 (setq c (aref string i))
2062 (setq prompt (match-string 1 string)))
2063 (setq i (match-end 0))
2064 ;; We basically emulate just about everything that
2065 ;; `interactive' does, but add the specs listed above.
2069 (completing-read prompt obarray 'fboundp t))
2071 (read-buffer prompt (current-buffer) t))
2073 (read-buffer prompt (other-buffer (current-buffer))))
2077 (completing-read prompt obarray 'commandp t))
2081 (read-file-name prompt nil default-directory 'lambda))
2083 (read-file-name prompt nil nil 'lambda))
2085 (read-file-name prompt))
2087 (read-key-sequence prompt))
2089 (error "Not implemented spec"))
2091 (error "Not implemented spec"))
2095 (error "Not implemented spec"))
2097 (string-to-number (read-from-minibuffer prompt)))
2099 (prefix-numeric-value current-prefix-arg))
2105 (read-string prompt))
2107 (intern (read-string prompt)))
2109 (read-variable prompt))
2111 (read-minibuffer prompt))
2113 (eval-minibuffer prompt))
2114 ;; And here the new specs come.
2116 gnus-current-prefix-symbol)
2118 gnus-current-prefix-symbols)
2120 (gnus-group-group-name))
2122 (gnus-summary-skip-intangible)
2123 (or (get-text-property (point) 'gnus-number)
2124 (gnus-summary-last-subject)))
2126 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2128 (error "Non-implemented spec")))
2132 (push (if (< (point) (mark) (point) (mark))) out)
2133 (push (if (> (point) (mark) (point) (mark))) out))))
2134 (setq out (delq 'gnus-prefix-nil out))
2137 (defun gnus-symbolic-argument (&optional arg)
2138 "Read a symbolic argument and a command, and then execute command."
2140 (let* ((in-command (this-command-keys))
2141 (command in-command)
2142 gnus-current-prefix-symbols
2143 gnus-current-prefix-symbol
2145 (while (equal in-command command)
2146 (message "%s-" (key-description (this-command-keys)))
2147 (push (intern (char-to-string (read-char))) syms)
2148 (setq command (read-key-sequence nil t)))
2149 (setq gnus-current-prefix-symbols (nreverse syms)
2150 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2151 (call-interactively (key-binding command t))))
2153 ;;; More various functions.
2155 (defsubst gnus-check-backend-function (func group)
2156 "Check whether GROUP supports function FUNC.
2157 GROUP can either be a string (a group name) or a select method."
2159 (let ((method (if (stringp group)
2160 (car (gnus-find-method-for-group group))
2162 (unless (featurep method)
2164 (fboundp (intern (format "%s-%s" method func))))))
2166 (defun gnus-group-read-only-p (&optional group)
2167 "Check whether GROUP supports editing or not.
2168 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2169 that that variable is buffer-local to the summary buffers."
2170 (let ((group (or group gnus-newsgroup-name)))
2171 (not (gnus-check-backend-function 'request-replace-article group))))
2173 (defun gnus-group-total-expirable-p (group)
2174 "Check whether GROUP is total-expirable or not."
2175 (let ((params (gnus-group-find-parameter group))
2178 ((memq 'total-expire params)
2180 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2182 (gnus-total-expirable-newsgroups ; Check var.
2183 (string-match gnus-total-expirable-newsgroups group)))))
2185 (defun gnus-group-auto-expirable-p (group)
2186 "Check whether GROUP is auto-expirable or not."
2187 (let ((params (gnus-group-find-parameter group))
2190 ((memq 'auto-expire params)
2192 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2194 (gnus-auto-expirable-newsgroups ; Check var.
2195 (string-match gnus-auto-expirable-newsgroups group)))))
2197 (defun gnus-virtual-group-p (group)
2198 "Say whether GROUP is virtual or not."
2199 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2200 gnus-valid-select-methods)))
2202 (defun gnus-news-group-p (group &optional article)
2203 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2204 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2205 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2206 (eq (gnus-request-type group article) 'news))))
2208 ;; Returns a list of writable groups.
2209 (defun gnus-writable-groups ()
2210 (let ((alist gnus-newsrc-alist)
2212 (while (setq group (car (pop alist)))
2213 (unless (gnus-group-read-only-p group)
2214 (push group groups)))
2217 ;; Check whether to use long file names.
2218 (defun gnus-use-long-file-name (symbol)
2219 ;; The variable has to be set...
2220 (and gnus-use-long-file-name
2221 ;; If it isn't a list, then we return t.
2222 (or (not (listp gnus-use-long-file-name))
2223 ;; If it is a list, and the list contains `symbol', we
2225 (not (memq symbol gnus-use-long-file-name)))))
2227 ;; Generate a unique new group name.
2228 (defun gnus-generate-new-group-name (leaf)
2231 (while (gnus-gethash name gnus-newsrc-hashtb)
2232 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2235 (defun gnus-ephemeral-group-p (group)
2236 "Say whether GROUP is ephemeral or not."
2237 (gnus-group-get-parameter group 'quit-config t))
2239 (defun gnus-group-quit-config (group)
2240 "Return the quit-config of GROUP."
2241 (gnus-group-get-parameter group 'quit-config t))
2243 (defun gnus-kill-ephemeral-group (group)
2244 "Remove ephemeral GROUP from relevant structures."
2245 (gnus-sethash group nil gnus-newsrc-hashtb))
2247 (defun gnus-simplify-mode-line ()
2248 "Make mode lines a bit simpler."
2249 (setq mode-line-modified (cdr gnus-mode-line-modified))
2250 (when (listp mode-line-format)
2251 (make-local-variable 'mode-line-format)
2252 (setq mode-line-format (copy-sequence mode-line-format))
2253 (when (equal (nth 3 mode-line-format) " ")
2254 (setcar (nthcdr 3 mode-line-format) " "))))
2256 ;;; Servers and groups.
2258 (defsubst gnus-server-add-address (method)
2259 (let ((method-name (symbol-name (car method))))
2260 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2261 (not (assq (intern (concat method-name "-address")) method))
2262 (memq 'physical-address (assq (car method)
2263 gnus-valid-select-methods)))
2264 (append method (list (list (intern (concat method-name "-address"))
2268 (defsubst gnus-server-get-method (group method)
2269 ;; Input either a server name, and extended server name, or a
2270 ;; select method, and return a select method.
2271 (cond ((stringp method)
2272 (gnus-server-to-method method))
2273 ((equal method gnus-select-method)
2275 ((and (stringp (car method))
2277 (gnus-server-extend-method group method))
2280 (equal (cadr method) ""))
2283 (gnus-server-add-address method))))
2285 (defun gnus-server-to-method (server)
2286 "Map virtual server names to select methods."
2288 ;; Is this a method, perhaps?
2289 (and server (listp server) server)
2290 ;; Perhaps this is the native server?
2291 (and (equal server "native") gnus-select-method)
2292 ;; It should be in the server alist.
2293 (cdr (assoc server gnus-server-alist))
2294 ;; It could be in the predefined server alist.
2295 (cdr (assoc server gnus-predefined-server-alist))
2296 ;; If not, we look through all the opened server
2297 ;; to see whether we can find it there.
2298 (let ((opened gnus-opened-servers))
2300 (not (equal server (format "%s:%s" (caaar opened)
2305 (defmacro gnus-method-equal (ss1 ss2)
2306 "Say whether two servers are equal."
2310 (and (= (length s1) (length s2))
2312 (while (and s1 (member (car s1) s2))
2316 (defun gnus-server-equal (m1 m2)
2317 "Say whether two methods are equal."
2318 (let ((m1 (cond ((null m1) gnus-select-method)
2319 ((stringp m1) (gnus-server-to-method m1))
2321 (m2 (cond ((null m2) gnus-select-method)
2322 ((stringp m2) (gnus-server-to-method m2))
2324 (gnus-method-equal m1 m2)))
2326 (defun gnus-servers-using-backend (backend)
2327 "Return a list of known servers using BACKEND."
2328 (let ((opened gnus-opened-servers)
2331 (when (eq backend (caaar opened))
2332 (push (caar opened) out))
2336 (defun gnus-archive-server-wanted-p ()
2337 "Say whether the user wants to use the archive server."
2339 ((or (not gnus-message-archive-method)
2340 (not gnus-message-archive-group))
2342 ((and gnus-message-archive-method gnus-message-archive-group)
2345 (let ((active (cadr (assq 'nnfolder-active-file
2346 gnus-message-archive-method))))
2348 (file-exists-p active))))))
2350 (defun gnus-group-prefixed-name (group method)
2351 "Return the whole name from GROUP and METHOD."
2352 (and (stringp method) (setq method (gnus-server-to-method method)))
2353 (if (or (not method)
2354 (gnus-server-equal method "native"))
2356 (concat (format "%s" (car method))
2358 (or (assoc (format "%s" (car method))
2359 (gnus-methods-using 'address))
2360 (gnus-server-equal method gnus-message-archive-method))
2362 (not (string= (nth 1 method) "")))
2363 (concat "+" (nth 1 method)))
2366 (defun gnus-group-real-prefix (group)
2367 "Return the prefix of the current group name."
2368 (if (string-match "^[^:]+:" group)
2369 (substring group 0 (match-end 0))
2372 (defun gnus-group-method (group)
2373 "Return the server or method used for selecting GROUP.
2374 You should probably use `gnus-find-method-for-group' instead."
2375 (let ((prefix (gnus-group-real-prefix group)))
2376 (if (equal prefix "")
2378 (let ((servers gnus-opened-servers)
2380 backend possible found)
2381 (if (string-match "^[^\\+]+\\+" prefix)
2382 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2383 server (substring prefix (match-end 0) (1- (length prefix))))
2384 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2386 (when (eq (caaar servers) backend)
2387 (setq possible (caar servers))
2388 (when (equal (cadaar servers) server)
2389 (setq found (caar servers))))
2391 (or (car (rassoc found gnus-server-alist))
2393 (car (rassoc possible gnus-server-alist))
2395 (list backend server))))))
2397 (defsubst gnus-secondary-method-p (method)
2398 "Return whether METHOD is a secondary select method."
2399 (let ((methods gnus-secondary-select-methods)
2400 (gmethod (gnus-server-get-method nil method)))
2402 (not (equal (gnus-server-get-method nil (car methods))
2404 (setq methods (cdr methods)))
2407 (defun gnus-groups-from-server (server)
2408 "Return a list of all groups that are fetched from SERVER."
2409 (let ((alist (cdr gnus-newsrc-alist))
2411 (while (setq info (pop alist))
2412 (when (gnus-server-equal (gnus-info-method info) server)
2413 (push (gnus-info-group info) groups)))
2414 (sort groups 'string<)))
2416 (defun gnus-group-foreign-p (group)
2417 "Say whether a group is foreign or not."
2418 (and (not (gnus-group-native-p group))
2419 (not (gnus-group-secondary-p group))))
2421 (defun gnus-group-native-p (group)
2422 "Say whether the group is native or not."
2423 (not (string-match ":" group)))
2425 (defun gnus-group-secondary-p (group)
2426 "Say whether the group is secondary or not."
2427 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2429 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2430 "Return the group parameters for GROUP.
2431 If SYMBOL, return the value of that symbol in the group parameters."
2433 (set-buffer gnus-group-buffer)
2434 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2436 (gnus-group-parameter-value parameters symbol allow-list)
2439 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2440 "Return the group parameters for GROUP.
2441 If SYMBOL, return the value of that symbol in the group parameters.
2442 Most functions should use `gnus-group-find-parameter', which
2443 also examines the topic parameters."
2444 (let ((params (gnus-info-params (gnus-get-info group))))
2446 (gnus-group-parameter-value params symbol allow-list)
2449 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2450 "Return the value of SYMBOL in group PARAMS."
2451 ;; We only wish to return group parameters (dotted lists) and
2452 ;; not local variables, which may have the same names.
2453 ;; But first we handle single elements...
2454 (or (car (memq symbol params))
2458 (while (setq elem (pop params))
2459 (when (and (consp elem)
2460 (eq (car elem) symbol)
2463 (throw 'found (cdr elem))))))))
2465 (defun gnus-group-add-parameter (group param)
2466 "Add parameter PARAM to GROUP."
2467 (let ((info (gnus-get-info group)))
2469 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2470 ;; Cons the new param to the old one and update.
2471 (gnus-group-set-info (cons param (gnus-info-params info))
2474 (defun gnus-group-set-parameter (group name value)
2475 "Set parameter NAME to VALUE in GROUP."
2476 (let ((info (gnus-get-info group)))
2478 (gnus-group-remove-parameter group name)
2479 (let ((old-params (gnus-info-params info))
2480 (new-params (list (cons name value))))
2482 (when (or (not (listp (car old-params)))
2483 (not (eq (caar old-params) name)))
2484 (setq new-params (append new-params (list (car old-params)))))
2485 (setq old-params (cdr old-params)))
2486 (gnus-group-set-info new-params group 'params)))))
2488 (defun gnus-group-remove-parameter (group name)
2489 "Remove parameter NAME from GROUP."
2490 (let ((info (gnus-get-info group)))
2492 (let ((params (gnus-info-params info)))
2494 (setq params (delq name params))
2495 (while (assq name params)
2496 (gnus-pull name params))
2497 (gnus-info-set-params info params))))))
2499 (defun gnus-group-add-score (group &optional score)
2500 "Add SCORE to the GROUP score.
2501 If SCORE is nil, add 1 to the score of GROUP."
2502 (let ((info (gnus-get-info group)))
2504 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2506 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2507 (defun gnus-short-group-name (group &optional levels)
2508 "Collapse GROUP name LEVELS.
2509 Select methods are stripped and any remote host name is stripped down to
2510 just the host name."
2517 (while (string-match "\\." group skip)
2518 (setq skip (match-end 0)
2521 ;; separate foreign select method from group name and collapse.
2522 ;; if method contains a server, collapse to non-domain server name,
2523 ;; otherwise collapse to select method
2524 (when (string-match ":" group)
2525 (cond ((string-match "+" group)
2526 (let* ((plus (string-match "+" group))
2527 (colon (string-match ":" group (or plus 0)))
2528 (dot (string-match "\\." group)))
2529 (setq foreign (concat
2530 (substring group (+ 1 plus)
2531 (cond ((null dot) colon)
2532 ((< colon dot) colon)
2533 ((< dot colon) dot)))
2535 group (substring group (+ 1 colon)))))
2537 (let* ((colon (string-match ":" group)))
2538 (setq foreign (concat (substring group 0 (+ 1 colon)))
2539 group (substring group (+ 1 colon)))))))
2540 ;; collapse group name leaving LEVELS uncollapsed elements
2542 (if (and (string-match "\\." group) (> levels 0))
2543 (setq name (concat name (substring group 0 1))
2544 group (substring group (match-end 0))
2546 name (concat name "."))
2547 (setq name (concat foreign name group)
2551 (defun gnus-narrow-to-body ()
2552 "Narrow to the body of an article."
2555 (goto-char (point-min))
2556 (or (search-forward "\n\n" nil t)
2562 ;;; Kill file handling.
2565 (defun gnus-apply-kill-file ()
2566 "Apply a kill file to the current newsgroup.
2567 Returns the number of articles marked as read."
2568 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2569 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2570 (gnus-apply-kill-file-internal)
2573 (defun gnus-kill-save-kill-buffer ()
2574 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2575 (when (get-file-buffer file)
2577 (set-buffer (get-file-buffer file))
2578 (when (buffer-modified-p)
2580 (kill-buffer (current-buffer))))))
2582 (defcustom gnus-kill-file-name "KILL"
2583 "Suffix of the kill files."
2584 :group 'gnus-score-kill
2585 :group 'gnus-score-files
2588 (defun gnus-newsgroup-kill-file (newsgroup)
2589 "Return the name of a kill file name for NEWSGROUP.
2590 If NEWSGROUP is nil, return the global kill file name instead."
2592 ;; The global KILL file is placed at top of the directory.
2593 ((or (null newsgroup)
2594 (string-equal newsgroup ""))
2595 (expand-file-name gnus-kill-file-name
2596 gnus-kill-files-directory))
2597 ;; Append ".KILL" to newsgroup name.
2598 ((gnus-use-long-file-name 'not-kill)
2599 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2600 "." gnus-kill-file-name)
2601 gnus-kill-files-directory))
2602 ;; Place "KILL" under the hierarchical directory.
2604 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2605 "/" gnus-kill-file-name)
2606 gnus-kill-files-directory))))
2610 (defun gnus-member-of-valid (symbol group)
2611 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2613 (symbol-name (car (gnus-find-method-for-group group)))
2614 gnus-valid-select-methods)))
2616 (defun gnus-method-option-p (method option)
2617 "Return non-nil if select METHOD has OPTION as a parameter."
2618 (when (stringp method)
2619 (setq method (gnus-server-to-method method)))
2620 (memq option (assoc (format "%s" (car method))
2621 gnus-valid-select-methods)))
2623 (defun gnus-similar-server-opened (method)
2624 (let ((opened gnus-opened-servers))
2625 (while (and method opened)
2626 (when (and (equal (cadr method) (cadaar opened))
2627 (not (equal method (caar opened))))
2632 (defun gnus-server-extend-method (group method)
2633 ;; This function "extends" a virtual server. If the server is
2634 ;; "hello", and the select method is ("hello" (my-var "something"))
2635 ;; in the group "alt.alt", this will result in a new virtual server
2636 ;; called "hello+alt.alt".
2637 (if (or (not (inline (gnus-similar-server-opened method)))
2638 (not (cddr method)))
2640 `(,(car method) ,(concat (cadr method) "+" group)
2641 (,(intern (format "%s-address" (car method))) ,(cadr method))
2644 (defun gnus-server-status (method)
2645 "Return the status of METHOD."
2646 (nth 1 (assoc method gnus-opened-servers)))
2648 (defun gnus-group-name-to-method (group)
2649 "Guess a select method based on GROUP."
2650 (if (string-match ":" group)
2651 (let ((server (substring group 0 (match-beginning 0))))
2652 (if (string-match "\\+" server)
2653 (list (intern (substring server 0 (match-beginning 0)))
2654 (substring server (match-end 0)))
2655 (list (intern server) "")))
2656 gnus-select-method))
2658 (defun gnus-find-method-for-group (group &optional info)
2659 "Find the select method that GROUP uses."
2660 (or gnus-override-method
2663 (let ((info (or info (gnus-get-info group)))
2666 (not (setq method (gnus-info-method info)))
2667 (equal method "native"))
2670 (cond ((stringp method)
2671 (inline (gnus-server-to-method method)))
2672 ((stringp (cadr method))
2673 (inline (gnus-server-extend-method group method)))
2676 (cond ((equal (cadr method) "")
2678 ((null (cadr method))
2679 (list (car method) ""))
2681 (gnus-server-add-address method)))))))
2683 (defun gnus-methods-using (feature)
2684 "Find all methods that have FEATURE."
2685 (let ((valids gnus-valid-select-methods)
2688 (when (memq feature (car valids))
2689 (push (car valids) outs))
2690 (setq valids (cdr valids)))
2693 (defun gnus-read-group (prompt &optional default)
2694 "Prompt the user for a group name.
2695 Disallow illegal group names."
2701 (setq group (read-string (concat prefix prompt)
2702 (cons (or default "") 0)
2703 'gnus-group-history)))
2704 (setq prefix (format "Illegal group name: \"%s\". " group)
2708 (defun gnus-read-method (prompt)
2709 "Prompt the user for a method.
2710 Allow completion over sensible values."
2712 (append gnus-valid-select-methods
2713 gnus-predefined-server-alist
2718 nil t nil 'gnus-method-history)))
2721 (setq method gnus-select-method))
2722 ((assoc method gnus-valid-select-methods)
2723 (list (intern method)
2724 (if (memq 'prompt-address
2725 (assoc method gnus-valid-select-methods))
2726 (read-string "Address: ")
2728 ((assoc method servers)
2731 (list (intern method) "")))))
2733 ;;; User-level commands.
2736 (defun gnus-slave-no-server (&optional arg)
2737 "Read network news as a slave, without connecting to local server."
2739 (gnus-no-server arg t))
2742 (defun gnus-no-server (&optional arg slave)
2744 If ARG is a positive number, Gnus will use that as the
2745 startup level. If ARG is nil, Gnus will be started at level 2.
2746 If ARG is non-nil and not a positive number, Gnus will
2747 prompt the user for the name of an NNTP server to use.
2748 As opposed to `gnus', this command will not connect to the local server."
2750 (gnus-no-server-1 arg slave))
2753 (defun gnus-slave (&optional arg)
2754 "Read news as a slave."
2756 (gnus arg nil 'slave))
2759 (defun gnus-other-frame (&optional arg)
2760 "Pop up a frame to read news."
2762 (let ((window (get-buffer-window gnus-group-buffer)))
2764 (select-frame (window-frame window)))
2765 ((= (length (frame-list)) 1)
2766 (select-frame (make-frame)))
2772 (defun gnus (&optional arg dont-connect slave)
2774 If ARG is non-nil and a positive number, Gnus will use that as the
2775 startup level. If ARG is non-nil and not a positive number, Gnus will
2776 prompt the user for the name of an NNTP server to use."
2778 (gnus-1 arg dont-connect slave))
2780 ;; Allow redefinition of Gnus functions.
2786 ;;; gnus.el ends here