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-version-number "0.30"
254 "Version number for this version of Gnus.")
256 (defconst gnus-version (format "Pterodactyl Gnus v%s" gnus-version-number)
257 "Version string for this version of Gnus.")
259 (defcustom gnus-inhibit-startup-message nil
260 "If non-nil, the startup message will not be displayed.
261 This variable is used before `.gnus.el' is loaded, so it should
262 be set in `.emacs' instead."
266 (defcustom gnus-play-startup-jingle nil
267 "If non-nil, play the Gnus jingle at startup."
271 (unless (featurep 'gnus-xmas)
272 (defalias 'gnus-make-overlay 'make-overlay)
273 (defalias 'gnus-delete-overlay 'delete-overlay)
274 (defalias 'gnus-overlay-put 'overlay-put)
275 (defalias 'gnus-move-overlay 'move-overlay)
276 (defalias 'gnus-overlay-end 'overlay-end)
277 (defalias 'gnus-extent-detached-p 'ignore)
278 (defalias 'gnus-extent-start-open 'ignore)
279 (defalias 'gnus-set-text-properties 'set-text-properties)
280 (defalias 'gnus-group-remove-excess-properties 'ignore)
281 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
282 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
283 (defalias 'gnus-character-to-event 'identity)
284 (defalias 'gnus-add-text-properties 'add-text-properties)
285 (defalias 'gnus-put-text-property 'put-text-property)
286 (defalias 'gnus-mode-line-buffer-identification 'identity)
287 (defalias 'gnus-characterp 'numberp)
288 (defalias 'gnus-deactivate-mark 'deactivate-mark)
289 (defalias 'gnus-window-edges 'window-edges)
290 (defalias 'gnus-key-press-event-p 'numberp)
291 (defalias 'gnus-annotation-in-region-p 'ignore))
293 ;; We define these group faces here to avoid the display
294 ;; update forced when creating new faces.
296 (defface gnus-group-news-1-face
299 (:foreground "PaleTurquoise" :bold t))
302 (:foreground "ForestGreen" :bold t))
305 "Level 1 newsgroup face.")
307 (defface gnus-group-news-1-empty-face
310 (:foreground "PaleTurquoise"))
313 (:foreground "ForestGreen"))
316 "Level 1 empty newsgroup face.")
318 (defface gnus-group-news-2-face
321 (:foreground "turquoise" :bold t))
324 (:foreground "CadetBlue4" :bold t))
327 "Level 2 newsgroup face.")
329 (defface gnus-group-news-2-empty-face
332 (:foreground "turquoise"))
335 (:foreground "CadetBlue4"))
338 "Level 2 empty newsgroup face.")
340 (defface gnus-group-news-3-face
349 "Level 3 newsgroup face.")
351 (defface gnus-group-news-3-empty-face
360 "Level 3 empty newsgroup face.")
362 (defface gnus-group-news-low-face
365 (:foreground "DarkTurquoise" :bold t))
368 (:foreground "DarkGreen" :bold t))
371 "Low level newsgroup face.")
373 (defface gnus-group-news-low-empty-face
376 (:foreground "DarkTurquoise"))
379 (:foreground "DarkGreen"))
382 "Low level empty newsgroup face.")
384 (defface gnus-group-mail-1-face
387 (:foreground "aquamarine1" :bold t))
390 (:foreground "DeepPink3" :bold t))
393 "Level 1 mailgroup face.")
395 (defface gnus-group-mail-1-empty-face
398 (:foreground "aquamarine1"))
401 (:foreground "DeepPink3"))
403 (:italic t :bold t)))
404 "Level 1 empty mailgroup face.")
406 (defface gnus-group-mail-2-face
409 (:foreground "aquamarine2" :bold t))
412 (:foreground "HotPink3" :bold t))
415 "Level 2 mailgroup face.")
417 (defface gnus-group-mail-2-empty-face
420 (:foreground "aquamarine2"))
423 (:foreground "HotPink3"))
426 "Level 2 empty mailgroup face.")
428 (defface gnus-group-mail-3-face
431 (:foreground "aquamarine3" :bold t))
434 (:foreground "magenta4" :bold t))
437 "Level 3 mailgroup face.")
439 (defface gnus-group-mail-3-empty-face
442 (:foreground "aquamarine3"))
445 (:foreground "magenta4"))
448 "Level 3 empty mailgroup face.")
450 (defface gnus-group-mail-low-face
453 (:foreground "aquamarine4" :bold t))
456 (:foreground "DeepPink4" :bold t))
459 "Low level mailgroup face.")
461 (defface gnus-group-mail-low-empty-face
464 (:foreground "aquamarine4"))
467 (:foreground "DeepPink4"))
470 "Low level empty mailgroup face.")
472 ;; Summary mode faces.
474 (defface gnus-summary-selected-face '((t
476 "Face used for selected articles.")
478 (defface gnus-summary-cancelled-face
480 (:foreground "yellow" :background "black")))
481 "Face used for cancelled articles.")
483 (defface gnus-summary-high-ticked-face
486 (:foreground "pink" :bold t))
489 (:foreground "firebrick" :bold t))
492 "Face used for high interest ticked articles.")
494 (defface gnus-summary-low-ticked-face
497 (:foreground "pink" :italic t))
500 (:foreground "firebrick" :italic t))
503 "Face used for low interest ticked articles.")
505 (defface gnus-summary-normal-ticked-face
508 (:foreground "pink"))
511 (:foreground "firebrick"))
514 "Face used for normal interest ticked articles.")
516 (defface gnus-summary-high-ancient-face
519 (:foreground "SkyBlue" :bold t))
522 (:foreground "RoyalBlue" :bold t))
525 "Face used for high interest ancient articles.")
527 (defface gnus-summary-low-ancient-face
530 (:foreground "SkyBlue" :italic t))
533 (:foreground "RoyalBlue" :italic t))
536 "Face used for low interest ancient articles.")
538 (defface gnus-summary-normal-ancient-face
541 (:foreground "SkyBlue"))
544 (:foreground "RoyalBlue"))
547 "Face used for normal interest ancient articles.")
549 (defface gnus-summary-high-unread-face
552 "Face used for high interest unread articles.")
554 (defface gnus-summary-low-unread-face
557 "Face used for low interest unread articles.")
559 (defface gnus-summary-normal-unread-face
562 "Face used for normal interest unread articles.")
564 (defface gnus-summary-high-read-face
567 (:foreground "PaleGreen"
571 (:foreground "DarkGreen"
575 "Face used for high interest read articles.")
577 (defface gnus-summary-low-read-face
580 (:foreground "PaleGreen"
584 (:foreground "DarkGreen"
588 "Face used for low interest read articles.")
590 (defface gnus-summary-normal-read-face
593 (:foreground "PaleGreen"))
596 (:foreground "DarkGreen"))
599 "Face used for normal interest read articles.")
606 (defvar gnus-buffers nil)
608 (defun gnus-get-buffer-create (name)
609 "Do the same as `get-buffer-create', but store the created buffer."
610 (or (get-buffer name)
611 (car (push (get-buffer-create name) gnus-buffers))))
613 (defun gnus-add-buffer ()
614 "Add the current buffer to the list of Gnus buffers."
615 (push (current-buffer) gnus-buffers))
617 (defun gnus-buffers ()
618 "Return a list of live Gnus buffers."
619 (while (and gnus-buffers
620 (not (buffer-name (car gnus-buffers))))
622 (let ((buffers gnus-buffers))
624 (if (buffer-name (cadr buffers))
626 (setcdr buffers (cddr buffers)))))
631 (defvar gnus-group-buffer "*Group*")
634 (autoload 'gnus-play-jingle "gnus-audio"))
636 (defface gnus-splash-face
639 (:foreground "Brown"))
642 (:foreground "Brown"))
645 "Face of the splash screen.")
647 (defun gnus-splash ()
649 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
650 (let ((buffer-read-only nil))
652 (unless gnus-inhibit-startup-message
653 (gnus-group-startup-message)
655 (when gnus-play-startup-jingle
656 (gnus-play-jingle))))))
658 (defun gnus-indent-rigidly (start end arg)
659 "Indent rigidly using only spaces and no tabs."
662 (narrow-to-region start end)
664 (indent-rigidly start end arg)
665 ;; We translate tabs into spaces -- not everybody uses
666 ;; an 8-character tab.
667 (goto-char (point-min))
668 (while (search-forward "\t" nil t)
669 (replace-match " " t t))))))
671 (defvar gnus-simple-splash nil)
673 (defun gnus-group-startup-message (&optional x y)
674 "Insert startup message in current buffer."
675 ;; Insert the message.
680 _ ___ __ ___ __ _ ___
700 (gnus-indent-rigidly (point-min) (point-max)
701 (/ (max (- (window-width) (or x 46)) 0) 2))
702 (goto-char (point-min))
704 (let* ((pheight (count-lines (point-min) (point-max)))
705 (wheight (window-height))
706 (rest (- wheight pheight)))
707 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
709 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
710 (goto-char (point-min))
711 (setq mode-line-buffer-identification (concat " " gnus-version))
712 (setq gnus-simple-splash t)
713 (set-buffer-modified-p t))
716 (let ((command (format "%s" this-command)))
717 (if (and (string-match "gnus" command)
718 (not (string-match "gnus-other-frame" command)))
720 (gnus-get-buffer-create gnus-group-buffer))))
728 (defcustom gnus-home-directory "~/"
729 "Directory variable that specifies the \"home\" directory.
730 All other Gnus path variables are initialized from this variable."
734 (defcustom gnus-directory (or (getenv "SAVEDIR")
735 (nnheader-concat gnus-home-directory "News/"))
736 "*Directory variable from which all other Gnus file variables are derived.
738 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
739 This means that other directory variables that are initialized from
740 this variable won't be set properly if you set this variable in `.gnus.el'.
741 Set this variable in `.emacs' instead."
745 (defcustom gnus-default-directory nil
746 "*Default directory for all Gnus buffers."
748 :type '(choice (const :tag "current" nil)
751 ;; Site dependent variables. These variables should be defined in
754 (defvar gnus-default-nntp-server nil
755 "Specify a default NNTP server.
756 This variable should be defined in paths.el, and should never be set
758 If you want to change servers, you should use `gnus-select-method'.
759 See the documentation to that variable.")
761 ;; Don't touch this variable.
762 (defvar gnus-nntp-service "nntp"
763 "NNTP service name (\"nntp\" or 119).
764 This is an obsolete variable, which is scarcely used. If you use an
765 nntp server for your newsgroup and want to change the port number
766 used to 899, you would say something along these lines:
768 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
770 (defcustom gnus-nntpserver-file "/etc/nntpserver"
771 "A file with only the name of the nntp server in it."
776 ;; This function is used to check both the environment variable
777 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
778 ;; an nntp server name default.
779 (defun gnus-getenv-nntpserver ()
780 (or (getenv "NNTPSERVER")
781 (and (file-readable-p gnus-nntpserver-file)
783 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
784 (insert-file-contents gnus-nntpserver-file)
785 (let ((name (buffer-string)))
787 (if (string-match "^[ \t\n]*$" name)
790 (kill-buffer (current-buffer))))))))
792 (defcustom gnus-select-method
795 (list 'nntp (or (condition-case nil
796 (gnus-getenv-nntpserver)
798 (when (and gnus-default-nntp-server
799 (not (string= gnus-default-nntp-server "")))
800 gnus-default-nntp-server)
802 (if (or (null gnus-nntp-service)
803 (equal gnus-nntp-service "nntp"))
805 (list gnus-nntp-service)))
807 "*Default method for selecting a newsgroup.
808 This variable should be a list, where the first element is how the
809 news is to be fetched, the second is the address.
811 For instance, if you want to get your news via NNTP from
812 \"flab.flab.edu\", you could say:
814 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
816 If you want to use your local spool, say:
818 \(setq gnus-select-method (list 'nnspool (system-name)))
820 If you use this variable, you must set `gnus-nntp-server' to nil.
822 There is a lot more to know about select methods and virtual servers -
823 see the manual for details."
825 :type 'gnus-select-method)
827 (defcustom gnus-message-archive-method
830 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
831 (nnfolder-active-file
832 ,(nnheader-concat message-directory "archive/active"))
833 (nnfolder-get-new-mail nil)
834 (nnfolder-inhibit-expiry t))
835 "*Method used for archiving messages you've sent.
836 This should be a mail method.
838 It's probably not a very effective to change this variable once you've
839 run Gnus once. After doing that, you must edit this server from the
843 :type 'gnus-select-method)
845 (defcustom gnus-message-archive-group nil
846 "*Name of the group in which to save the messages you've written.
847 This can either be a string; a list of strings; or an alist
848 of regexps/functions/forms to be evaluated to return a string (or a list
849 of strings). The functions are called with the name of the current
850 group (or nil) as a parameter.
852 If you want to save your mail in one group and the news articles you
853 write in another group, you could say something like:
855 \(setq gnus-message-archive-group
856 '((if (message-news-p)
860 Normally the group names returned by this variable should be
861 unprefixed -- which implicitly means \"store on the archive server\".
862 However, you may wish to store the message on some other server. In
863 that case, just return a fully prefixed name of the group --
864 \"nnml+private:mail.misc\", for instance."
866 :type '(choice (const :tag "none" nil)
870 (defcustom gnus-secondary-servers nil
871 "List of NNTP servers that the user can choose between interactively.
872 To make Gnus query you for a server, you have to give `gnus' a
873 non-numeric prefix - `C-u M-x gnus', in short."
875 :type '(repeat string))
877 (defcustom gnus-nntp-server nil
878 "*The name of the host running the NNTP server.
879 This variable is semi-obsolete. Use the `gnus-select-method'
882 :type '(choice (const :tag "disable" nil)
885 (defcustom gnus-secondary-select-methods nil
886 "A list of secondary methods that will be used for reading news.
887 This is a list where each element is a complete select method (see
888 `gnus-select-method').
890 If, for instance, you want to read your mail with the nnml backend,
891 you could set this variable:
893 \(setq gnus-secondary-select-methods '((nnml \"\")))"
895 :type '(repeat gnus-select-method))
897 (defvar gnus-backup-default-subscribed-newsgroups
898 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
899 "Default default new newsgroups the first time Gnus is run.
900 Should be set in paths.el, and shouldn't be touched by the user.")
902 (defcustom gnus-local-domain nil
903 "Local domain name without a host name.
904 The DOMAINNAME environment variable is used instead if it is defined.
905 If the `system-name' function returns the full Internet name, there is
906 no need to set this variable."
908 :type '(choice (const :tag "default" nil)
911 (defvar gnus-local-organization nil
912 "String with a description of what organization (if any) the user belongs to.
913 Obsolete variable; use `message-user-organization' instead.")
915 ;; Customization variables
917 (defcustom gnus-refer-article-method nil
918 "Preferred method for fetching an article by Message-ID.
919 If you are reading news from the local spool (with nnspool), fetching
920 articles by Message-ID is painfully slow. By setting this method to an
921 nntp method, you might get acceptable results.
923 The value of this variable must be a valid select method as discussed
924 in the documentation of `gnus-select-method'."
926 :type '(choice (const :tag "default" nil)
929 (defcustom gnus-group-faq-directory
930 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
931 "/ftp@sunsite.auc.dk:/pub/usenet/"
932 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
933 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
934 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
935 "/ftp@rtfm.mit.edu:/pub/usenet/"
936 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
937 "/ftp@ftp.sunet.se:/pub/usenet/"
938 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
939 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
940 "/ftp@ftp.hk.super.net:/mirror/faqs/")
941 "*Directory where the group FAQs are stored.
942 This will most commonly be on a remote machine, and the file will be
945 This variable can also be a list of directories. In that case, the
946 first element in the list will be used by default. The others can
947 be used when being prompted for a site.
949 Note that Gnus uses an aol machine as the default directory. If this
950 feels fundamentally unclean, just think of it as a way to finally get
951 something of value back from them.
953 If the default site is too slow, try one of these:
955 North America: mirrors.aol.com /pub/rtfm/usenet
956 ftp.seas.gwu.edu /pub/rtfm
957 rtfm.mit.edu /pub/usenet
958 Europe: ftp.uni-paderborn.de /pub/FAQ
959 src.doc.ic.ac.uk /usenet/news-FAQS
960 ftp.sunet.se /pub/usenet
961 sunsite.auc.dk /pub/usenet
962 Asia: nctuccca.edu.tw /USENET/FAQ
963 hwarang.postech.ac.kr /pub/usenet
964 ftp.hk.super.net /mirror/faqs"
965 :group 'gnus-group-various
966 :type '(choice directory
969 (defcustom gnus-use-cross-reference t
970 "*Non-nil means that cross referenced articles will be marked as read.
971 If nil, ignore cross references. If t, mark articles as read in
972 subscribed newsgroups. If neither t nor nil, mark as read in all
975 :type '(choice (const :tag "off" nil)
976 (const :tag "subscribed" t)
980 (defcustom gnus-process-mark ?#
982 :group 'gnus-group-visual
983 :group 'gnus-summary-marks
986 (defcustom gnus-asynchronous nil
987 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
988 :group 'gnus-asynchronous
991 (defcustom gnus-large-newsgroup 200
992 "*The number of articles which indicates a large newsgroup.
993 If the number of articles in a newsgroup is greater than this value,
994 confirmation is required for selecting the newsgroup."
995 :group 'gnus-group-select
998 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
999 "*Non-nil means that the default name of a file to save articles in is the group name.
1000 If it's nil, the directory form of the group name is used instead.
1002 If this variable is a list, and the list contains the element
1003 `not-score', long file names will not be used for score files; if it
1004 contains the element `not-save', long file names will not be used for
1005 saving; and if it contains the element `not-kill', long file names
1006 will not be used for kill files.
1008 Note that the default for this variable varies according to what system
1009 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1010 to nil while on all other systems it defaults to t."
1014 (defcustom gnus-kill-files-directory gnus-directory
1015 "*Name of the directory where kill files will be stored (default \"~/News\")."
1016 :group 'gnus-score-files
1017 :group 'gnus-score-kill
1020 (defcustom gnus-save-score nil
1021 "*If non-nil, save group scoring info."
1022 :group 'gnus-score-various
1026 (defcustom gnus-use-undo t
1027 "*If non-nil, allow undoing in Gnus group mode buffers."
1031 (defcustom gnus-use-adaptive-scoring nil
1032 "*If non-nil, use some adaptive scoring scheme.
1033 If a list, then the values `word' and `line' are meaningful. The
1034 former will perform adaption on individual words in the subject
1035 header while `line' will perform adaption on several headers."
1037 :group 'gnus-score-adapt
1038 :type '(set (const word) (const line)))
1040 (defcustom gnus-use-cache 'passive
1041 "*If nil, Gnus will ignore the article cache.
1042 If `passive', it will allow entering (and reading) articles
1043 explicitly entered into the cache. If anything else, use the
1044 cache to the full extent of the law."
1047 :type '(choice (const :tag "off" nil)
1048 (const :tag "passive" passive)
1049 (const :tag "active" t)))
1051 (defcustom gnus-use-trees nil
1052 "*If non-nil, display a thread tree buffer."
1056 (defcustom gnus-use-grouplens nil
1057 "*If non-nil, use GroupLens ratings."
1061 (defcustom gnus-keep-backlog nil
1062 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1063 If it is a number N, then Gnus will only keep the last N articles
1064 read. If it is neither nil nor a number, Gnus will keep all read
1065 articles. This is not a good idea."
1067 :type '(choice (const :tag "off" nil)
1072 (defcustom gnus-use-nocem nil
1073 "*If non-nil, Gnus will read NoCeM cancel messages."
1077 (defcustom gnus-suppress-duplicates nil
1078 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1082 (defcustom gnus-use-demon nil
1083 "If non-nil, Gnus might use some demons."
1087 (defcustom gnus-use-scoring t
1088 "*If non-nil, enable scoring."
1092 (defcustom gnus-use-picons nil
1093 "*If non-nil, display picons."
1097 (defcustom gnus-summary-prepare-exit-hook
1098 '(gnus-summary-expire-articles)
1099 "*A hook called when preparing to exit from the summary buffer.
1100 It calls `gnus-summary-expire-articles' by default."
1101 :group 'gnus-summary-exit
1104 (defcustom gnus-novice-user t
1105 "*Non-nil means that you are a usenet novice.
1106 If non-nil, verbose messages may be displayed and confirmations may be
1111 (defcustom gnus-expert-user nil
1112 "*Non-nil means that you will never be asked for confirmation about anything.
1113 That doesn't mean *anything* anything; particularly destructive
1114 commands will still require prompting."
1118 (defcustom gnus-interactive-catchup t
1119 "*If non-nil, require your confirmation when catching up a group."
1120 :group 'gnus-group-select
1123 (defcustom gnus-interactive-exit t
1124 "*If non-nil, require your confirmation when exiting Gnus."
1128 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1129 "*Function for extracting address components from a From header.
1130 Two pre-defined function exist: `gnus-extract-address-components',
1131 which is the default, quite fast, and too simplistic solution, and
1132 `mail-extract-address-components', which works much better, but is
1134 :group 'gnus-summary-format
1135 :type '(radio (function-item gnus-extract-address-components)
1136 (function-item mail-extract-address-components)
1137 (function :tag "Other")))
1139 (defcustom gnus-carpal nil
1140 "*If non-nil, display clickable icons."
1144 (defcustom gnus-shell-command-separator ";"
1145 "String used to separate to shell commands."
1149 (defcustom gnus-valid-select-methods
1150 '(("nntp" post address prompt-address physical-address)
1151 ("nnspool" post address)
1152 ("nnvirtual" post-mail virtual prompt-address)
1153 ("nnmbox" mail respool address)
1154 ("nnml" mail respool address)
1155 ("nnmh" mail respool address)
1156 ("nndir" post-mail prompt-address physical-address)
1157 ("nneething" none address prompt-address physical-address)
1158 ("nndoc" none address prompt-address)
1159 ("nnbabyl" mail address respool)
1160 ("nnkiboze" post virtual)
1161 ("nnsoup" post-mail address)
1162 ("nndraft" post-mail)
1163 ("nnfolder" mail respool address)
1164 ("nngateway" post-mail address prompt-address physical-address)
1167 ("nnagent" post-mail))
1168 "*An alist of valid select methods.
1169 The first element of each list lists should be a string with the name
1170 of the select method. The other elements may be the category of
1171 this method (i. e., `post', `mail', `none' or whatever) or other
1172 properties that this method has (like being respoolable).
1173 If you implement a new select method, all you should have to change is
1174 this variable. I think."
1176 :type '(repeat (group (string :tag "Name")
1177 (radio-button-choice (const :format "%v " post)
1178 (const :format "%v " mail)
1179 (const :format "%v " none)
1181 (checklist :inline t
1182 (const :format "%v " address)
1183 (const :format "%v " prompt-address)
1184 (const :format "%v " physical-address)
1185 (const :format "%v " virtual)
1188 (define-widget 'gnus-select-method 'list
1189 "Widget for entering a select method."
1190 :args `((choice :tag "Method"
1191 ,@(mapcar (lambda (entry)
1192 (list 'const :format "%v\n"
1193 (intern (car entry))))
1194 gnus-valid-select-methods))
1195 (string :tag "Address")
1196 (editable-list :inline t
1199 (sexp :tag "Value")))))
1201 (defcustom gnus-updated-mode-lines '(group article summary tree)
1202 "List of buffers that should update their mode lines.
1203 The list may contain the symbols `group', `article', `tree' and
1204 `summary'. If the corresponding symbol is present, Gnus will keep
1205 that mode line updated with information that may be pertinent.
1206 If this variable is nil, screen refresh may be quicker."
1207 :group 'gnus-various
1208 :type '(set (const group)
1213 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1214 (defcustom gnus-mode-non-string-length nil
1215 "*Max length of mode-line non-string contents.
1216 If this is nil, Gnus will take space as is needed, leaving the rest
1217 of the modeline intact. Note that the default of nil is unlikely
1218 to be desirable; see the manual for further details."
1219 :group 'gnus-various
1220 :type '(choice (const nil)
1223 (defcustom gnus-auto-expirable-newsgroups nil
1224 "*Groups in which to automatically mark read articles as expirable.
1225 If non-nil, this should be a regexp that should match all groups in
1226 which to perform auto-expiry. This only makes sense for mail groups."
1227 :group 'nnmail-expire
1228 :type '(choice (const nil)
1231 (defcustom gnus-total-expirable-newsgroups nil
1232 "*Groups in which to perform expiry of all read articles.
1233 Use with extreme caution. All groups that match this regexp will be
1234 expiring - which means that all read articles will be deleted after
1235 \(say) one week. (This only goes for mail groups and the like, of
1237 :group 'nnmail-expire
1238 :type '(choice (const nil)
1241 (defcustom gnus-group-uncollapsed-levels 1
1242 "Number of group name elements to leave alone when making a short group name."
1243 :group 'gnus-group-visual
1246 (defcustom gnus-group-use-permanent-levels nil
1247 "*If non-nil, once you set a level, Gnus will use this level."
1248 :group 'gnus-group-levels
1253 (defcustom gnus-load-hook nil
1254 "A hook run while Gnus is loaded."
1258 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1259 "A hook called to apply kill files to a group.
1260 This hook is intended to apply a kill file to the selected newsgroup.
1261 The function `gnus-apply-kill-file' is called by default.
1263 Since a general kill file is too heavy to use only for a few
1264 newsgroups, I recommend you to use a lighter hook function. For
1265 example, if you'd like to apply a kill file to articles which contains
1266 a string `rmgroup' in subject in newsgroup `control', you can use the
1269 (setq gnus-apply-kill-hook
1272 (cond ((string-match \"control\" gnus-newsgroup-name)
1273 (gnus-kill \"Subject\" \"rmgroup\")
1274 (gnus-expunge \"X\"))))))"
1275 :group 'gnus-score-kill
1276 :options '(gnus-apply-kill-file)
1279 (defcustom gnus-group-change-level-function nil
1280 "Function run when a group level is changed.
1281 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1282 :group 'gnus-group-level
1287 (defcustom gnus-visual
1288 '(summary-highlight group-highlight article-highlight
1290 summary-menu group-menu article-menu
1291 tree-highlight menu highlight
1292 browse-menu server-menu
1293 page-marker tree-menu binary-menu pick-menu
1295 "*Enable visual features.
1296 If `visual' is disabled, there will be no menus and few faces. Most of
1297 the visual customization options below will be ignored. Gnus will use
1298 less space and be faster as a result.
1300 This variable can also be a list of visual elements to switch on. For
1301 instance, to switch off all visual things except menus, you can say:
1303 (setq gnus-visual '(menu))
1305 Valid elements include `summary-highlight', `group-highlight',
1306 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1307 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1308 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1309 and `grouplens-menu'."
1312 :type '(set (const summary-highlight)
1313 (const group-highlight)
1314 (const article-highlight)
1316 (const summary-menu)
1318 (const article-menu)
1319 (const tree-highlight)
1328 (const grouplens-menu)))
1330 (defcustom gnus-mouse-face
1332 (if (gnus-visual-p 'mouse-face 'highlight)
1333 (if (boundp 'gnus-mouse-face)
1334 (or gnus-mouse-face 'highlight)
1338 "*Face used for group or summary buffer mouse highlighting.
1339 The line beneath the mouse pointer will be highlighted with this
1344 (defcustom gnus-article-display-hook
1345 (if (and (string-match "XEmacs" emacs-version)
1347 '(gnus-article-hide-headers-if-wanted
1348 gnus-article-hide-boring-headers
1349 gnus-article-treat-overstrike
1350 gnus-article-maybe-highlight
1351 gnus-article-display-x-face)
1352 '(gnus-article-hide-headers-if-wanted
1353 gnus-article-hide-boring-headers
1354 gnus-article-treat-overstrike
1355 gnus-article-maybe-highlight))
1356 "*Controls how the article buffer will look.
1358 If you leave the list empty, the article will appear exactly as it is
1359 stored on the disk. The list entries will hide or highlight various
1360 parts of the article, making it easier to find the information you
1362 :group 'gnus-article-highlight
1365 :options '(gnus-article-add-buttons
1366 gnus-article-add-buttons-to-head
1367 gnus-article-emphasize
1368 gnus-article-fill-cited-article
1369 gnus-article-remove-cr
1370 gnus-article-de-quoted-unreadable
1371 gnus-summary-stop-page-breaking
1372 ;; gnus-summary-caesar-message
1373 ;; gnus-summary-verbose-headers
1375 gnus-article-hide-headers
1376 gnus-article-hide-boring-headers
1377 gnus-article-hide-signature
1378 gnus-article-hide-citation
1379 gnus-article-hide-pgp
1380 gnus-article-hide-pem
1381 gnus-article-highlight
1382 gnus-article-highlight-headers
1383 gnus-article-highlight-citation
1384 gnus-article-highlight-signature
1385 gnus-article-date-ut
1386 gnus-article-date-local
1387 gnus-article-date-lapsed
1388 gnus-article-date-original
1389 gnus-article-remove-trailing-blank-lines
1390 gnus-article-strip-leading-blank-lines
1391 gnus-article-strip-multiple-blank-lines
1392 gnus-article-strip-blank-lines
1393 gnus-article-treat-overstrike
1394 gnus-article-display-x-face
1395 gnus-smiley-display))
1397 (defcustom gnus-article-save-directory gnus-directory
1398 "*Name of the directory articles will be saved in (default \"~/News\")."
1399 :group 'gnus-article-saving
1402 (defvar gnus-plugged t
1403 "Whether Gnus is plugged or not.")
1406 ;;; Internal variables
1408 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1409 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1410 (defvar gnus-original-article-buffer " *Original Article*")
1411 (defvar gnus-newsgroup-name nil)
1412 (defvar gnus-ephemeral-servers nil)
1414 (defvar gnus-agent nil
1415 "Whether we want to use the Gnus agent or not.")
1417 (defvar gnus-command-method nil
1418 "Dynamically bound variable that says what the current backend is.")
1420 (defvar gnus-current-select-method nil
1421 "The current method for selecting a newsgroup.")
1423 (defvar gnus-tree-buffer "*Tree*"
1424 "Buffer where Gnus thread trees are displayed.")
1427 (defvar gnus-use-generic-from nil)
1429 ;; Variable holding the user answers to all method prompts.
1430 (defvar gnus-method-history nil)
1432 ;; Variable holding the user answers to all mail method prompts.
1433 (defvar gnus-mail-method-history nil)
1435 ;; Variable holding the user answers to all group prompts.
1436 (defvar gnus-group-history nil)
1438 (defvar gnus-server-alist nil
1439 "List of available servers.")
1441 (defcustom gnus-cache-directory
1442 (nnheader-concat gnus-directory "cache/")
1443 "*The directory where cached articles will be stored."
1447 (defvar gnus-predefined-server-alist
1450 (nnspool-spool-directory ,gnus-cache-directory)
1451 (nnspool-nov-directory ,gnus-cache-directory)
1452 (nnspool-active-file
1453 ,(nnheader-concat gnus-cache-directory "active"))))
1454 "List of predefined (convenience) servers.")
1456 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1458 (defconst gnus-article-mark-lists
1459 '((marked . tick) (replied . reply)
1460 (expirable . expire) (killed . killed)
1461 (bookmarks . bookmark) (dormant . dormant)
1462 (scored . score) (saved . save)
1463 (cached . cache) (downloadable . download)
1464 (unsendable . unsend)))
1466 (defvar gnus-headers-retrieved-by nil)
1467 (defvar gnus-article-reply nil)
1468 (defvar gnus-override-method nil)
1469 (defvar gnus-article-check-size nil)
1470 (defvar gnus-opened-servers nil)
1472 (defvar gnus-current-kill-article nil)
1474 (defvar gnus-have-read-active-file nil)
1476 (defconst gnus-maintainer
1477 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1478 "The mail address of the Gnus maintainers.")
1480 (defvar gnus-info-nodes
1481 '((gnus-group-mode "(gnus)The Group Buffer")
1482 (gnus-summary-mode "(gnus)The Summary Buffer")
1483 (gnus-article-mode "(gnus)The Article Buffer")
1484 (mime/viewer-mode "(gnus)The Article Buffer")
1485 (gnus-server-mode "(gnus)The Server Buffer")
1486 (gnus-browse-mode "(gnus)Browse Foreign Server")
1487 (gnus-tree-mode "(gnus)Tree Display"))
1488 "Alist of major modes and related Info nodes.")
1490 (defvar gnus-group-buffer "*Group*")
1491 (defvar gnus-summary-buffer "*Summary*")
1492 (defvar gnus-article-buffer "*Article*")
1493 (defvar gnus-server-buffer "*Server*")
1495 (defvar gnus-slave nil
1496 "Whether this Gnus is a slave or not.")
1498 (defvar gnus-batch-mode nil
1499 "Whether this Gnus is running in batch mode or not.")
1501 (defvar gnus-variable-list
1502 '(gnus-newsrc-options gnus-newsrc-options-n
1503 gnus-newsrc-last-checked-date
1504 gnus-newsrc-alist gnus-server-alist
1505 gnus-killed-list gnus-zombie-list
1506 gnus-topic-topology gnus-topic-alist
1508 "Gnus variables saved in the quick startup file.")
1510 (defvar gnus-newsrc-alist nil
1511 "Assoc list of read articles.
1512 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1514 (defvar gnus-newsrc-hashtb nil
1515 "Hashtable of gnus-newsrc-alist.")
1517 (defvar gnus-killed-list nil
1518 "List of killed newsgroups.")
1520 (defvar gnus-killed-hashtb nil
1521 "Hash table equivalent of gnus-killed-list.")
1523 (defvar gnus-zombie-list nil
1524 "List of almost dead newsgroups.")
1526 (defvar gnus-description-hashtb nil
1527 "Descriptions of newsgroups.")
1529 (defvar gnus-list-of-killed-groups nil
1530 "List of newsgroups that have recently been killed by the user.")
1532 (defvar gnus-active-hashtb nil
1533 "Hashtable of active articles.")
1535 (defvar gnus-moderated-hashtb nil
1536 "Hashtable of moderated newsgroups.")
1538 ;; Save window configuration.
1539 (defvar gnus-prev-winconf nil)
1541 (defvar gnus-reffed-article-number nil)
1543 ;;; Let the byte-compiler know that we know about this variable.
1544 (defvar rmail-default-rmail-file)
1546 (defvar gnus-dead-summary nil)
1548 ;;; End of variables.
1550 ;; Define some autoload functions Gnus might use.
1553 ;; This little mapcar goes through the list below and marks the
1554 ;; symbols in question as autoloaded functions.
1557 (let ((interactive (nth 1 (memq ':interactive package))))
1561 (when (consp function)
1562 (setq keymap (car (memq 'keymap function)))
1563 (setq function (car function)))
1564 (autoload function (car package) nil interactive keymap)))
1565 (if (eq (nth 1 package) ':interactive)
1568 '(("metamail" metamail-buffer)
1569 ("info" Info-goto-node)
1570 ("pp" pp pp-to-string pp-eval-expression)
1571 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1572 ("ps-print" ps-print-preprint)
1573 ("mail-extr" mail-extract-address-components)
1574 ("browse-url" browse-url)
1575 ("message" :interactive t
1576 message-send-and-exit message-yank-original)
1577 ("nnmail" nnmail-split-fancy nnmail-article-group)
1578 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1579 ("rmailout" rmail-output)
1580 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1581 rmail-show-message rmail-output-to-rmail-file)
1582 ("gnus-audio" :interactive t gnus-audio-play)
1583 ("gnus-xmas" gnus-xmas-splash)
1584 ("gnus-soup" :interactive t
1585 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1586 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1587 ("nnsoup" nnsoup-pack-replies)
1588 ("score-mode" :interactive t gnus-score-mode)
1589 ("gnus-mh" gnus-summary-save-article-folder
1590 gnus-Folder-save-name gnus-folder-save-name)
1591 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1592 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1593 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1594 gnus-demon-add-disconnection gnus-demon-add-handler
1595 gnus-demon-remove-handler)
1596 ("gnus-demon" :interactive t
1597 gnus-demon-init gnus-demon-cancel)
1598 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1599 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1600 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1601 gnus-nocem-unwanted-article-p)
1602 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1603 gnus-server-server-name)
1604 ("gnus-srvr" gnus-browse-foreign-server)
1605 ("gnus-cite" :interactive t
1606 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1607 gnus-article-hide-citation gnus-article-fill-cited-article
1608 gnus-article-hide-citation-in-followups)
1609 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1610 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1611 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1612 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1613 gnus-cache-possibly-remove-articles gnus-cache-request-article
1614 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1615 gnus-cache-enter-remove-article gnus-cached-article-p
1616 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1617 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1618 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1619 ("gnus-score" :interactive t
1620 gnus-summary-increase-score gnus-summary-set-score
1621 gnus-summary-raise-thread gnus-summary-raise-same-subject
1622 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1623 gnus-summary-lower-thread gnus-summary-lower-same-subject
1624 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1625 gnus-summary-current-score gnus-score-default
1626 gnus-score-flush-cache gnus-score-close
1627 gnus-possibly-score-headers gnus-score-followup-article
1628 gnus-score-followup-thread)
1630 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1631 gnus-current-score-file-nondirectory gnus-score-adaptive
1632 gnus-score-find-trace gnus-score-file-name)
1633 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1634 ("gnus-topic" :interactive t gnus-topic-mode)
1635 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1636 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1637 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1638 ("gnus-uu" :interactive t
1639 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1640 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1641 gnus-uu-mark-by-regexp gnus-uu-mark-all
1642 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1643 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1644 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1645 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1646 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1647 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1648 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1650 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1651 gnus-uu-unmark-thread)
1652 ("gnus-msg" (gnus-summary-send-map keymap)
1653 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1654 ("gnus-msg" :interactive t
1655 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1656 gnus-summary-followup gnus-summary-followup-with-original
1657 gnus-summary-cancel-article gnus-summary-supersede-article
1658 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1659 gnus-summary-mail-forward gnus-summary-mail-other-window
1660 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1661 gnus-summary-wide-reply gnus-summary-followup-to-mail
1662 gnus-summary-followup-to-mail-with-original gnus-bug)
1663 ("gnus-picon" :interactive t gnus-article-display-picons
1664 gnus-group-display-picons gnus-picons-article-display-x-face
1665 gnus-picons-display-x-face)
1666 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1667 gnus-grouplens-mode)
1668 ("smiley" :interactive t gnus-smiley-display)
1669 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1670 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1671 gnus-list-of-unread-articles gnus-list-of-read-articles
1672 gnus-offer-save-summaries gnus-make-thread-indent-array
1673 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1674 gnus-summary-skip-intangible gnus-summary-article-number
1675 gnus-data-header gnus-data-find)
1676 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1677 gnus-group-list-groups gnus-group-first-unread-group
1678 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1679 gnus-group-setup-buffer gnus-group-get-new-news
1680 gnus-group-make-help-group gnus-group-update-group
1681 gnus-clear-inboxes-moved gnus-group-iterate
1682 gnus-group-group-name)
1683 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1684 gnus-backlog-remove-article)
1685 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1686 gnus-article-prepare gnus-article-set-window-start
1687 gnus-article-next-page gnus-article-prev-page
1688 gnus-request-article-this-buffer gnus-article-mode
1689 gnus-article-setup-buffer gnus-narrow-to-page
1690 gnus-article-delete-invisible-text)
1691 ("gnus-art" :interactive t
1692 gnus-article-hide-headers gnus-article-hide-boring-headers
1693 gnus-article-treat-overstrike gnus-article-word-wrap
1694 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1695 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1696 gnus-article-hide-pgp
1697 gnus-article-hide-pem gnus-article-hide-signature
1698 gnus-article-strip-leading-blank-lines gnus-article-date-local
1699 gnus-article-date-original gnus-article-date-lapsed
1700 gnus-article-show-all-headers
1701 gnus-article-edit-mode gnus-article-edit-article
1702 gnus-article-edit-done gnus-article-decode-encoded-words
1703 gnus-start-date-timer gnus-stop-date-timer)
1704 ("gnus-int" gnus-request-type)
1705 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1706 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1707 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1708 gnus-dup-enter-articles)
1709 ("gnus-range" gnus-copy-sequence)
1710 ("gnus-eform" gnus-edit-form)
1711 ("gnus-move" :interactive t
1712 gnus-group-move-group-to-server gnus-change-server)
1713 ("gnus-logic" gnus-score-advanced)
1714 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1715 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1716 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1717 gnus-async-halt-prefetch)
1718 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1719 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1720 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1721 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1722 ("gnus-agent" :interactive t
1723 gnus-unplugged gnus-agentize gnus-agent-batch)
1724 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1725 gnus-summary-save-article-vm)
1726 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1728 ;;; gnus-sum.el thingies
1731 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1732 "*The format specification of the lines in the summary buffer.
1734 It works along the same lines as a normal formatting string,
1735 with some simple extensions.
1737 %N Article number, left padded with spaces (string)
1739 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1740 %n Name of the poster (string)
1741 %a Extracted name of the poster (string)
1742 %A Extracted address of the poster (string)
1743 %F Contents of the From: header (string)
1744 %x Contents of the Xref: header (string)
1745 %D Date of the article (string)
1746 %d Date of the article (string) in DD-MMM format
1747 %M Message-id of the article (string)
1748 %r References of the article (string)
1749 %c Number of characters in the article (integer)
1750 %L Number of lines in the article (integer)
1751 %I Indentation based on thread level (a string of spaces)
1752 %T A string with two possible values: 80 spaces if the article
1753 is on thread level two or larger and 0 spaces on level one
1754 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1755 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1756 %[ Opening bracket (character, \"[\" or \"<\")
1757 %] Closing bracket (character, \"]\" or \">\")
1758 %> Spaces of length thread-level (string)
1759 %< Spaces of length (- 20 thread-level) (string)
1760 %i Article score (number)
1761 %z Article zcore (character)
1762 %t Number of articles under the current thread (number).
1763 %e Whether the thread is empty or not (character).
1764 %l GroupLens score (string).
1765 %V Total thread score (number).
1766 %P The line number (number).
1767 %O Download mark (character).
1768 %u User defined specifier. The next character in the format string should
1769 be a letter. Gnus will call the function gnus-user-format-function-X,
1770 where X is the letter following %u. The function will be passed the
1771 current header as argument. The function should return a string, which
1772 will be inserted into the summary just like information from any other
1775 Text between %( and %) will be highlighted with `gnus-mouse-face'
1776 when the mouse point is placed inside the area. There can only be one
1779 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1780 with care. For reasons of efficiency, Gnus will compute what column
1781 these characters will end up in, and \"hard-code\" that. This means that
1782 it is illegal to have these specs after a variable-length spec. Well,
1783 you might not be arrested, but your summary buffer will look strange,
1784 which is bad enough.
1786 The smart choice is to have these specs as for to the left as
1789 This restriction may disappear in later versions of Gnus."
1791 :group 'gnus-summary-format)
1794 ;;; Skeleton keymaps
1797 (defun gnus-suppress-keymap (keymap)
1798 (suppress-keymap keymap)
1799 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1801 (define-key keymap (pop keys) 'undefined))))
1803 (defvar gnus-article-mode-map
1804 (let ((keymap (make-keymap)))
1805 (gnus-suppress-keymap keymap)
1807 (defvar gnus-summary-mode-map
1808 (let ((keymap (make-keymap)))
1809 (gnus-suppress-keymap keymap)
1811 (defvar gnus-group-mode-map
1812 (let ((keymap (make-keymap)))
1813 (gnus-suppress-keymap keymap)
1818 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1819 ;; If you want the cursor to go somewhere else, set these two
1820 ;; functions in some startup hook to whatever you want.
1821 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1822 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1824 ;;; Various macros and substs.
1826 (defun gnus-header-from (header)
1827 (mail-header-from header))
1829 (defmacro gnus-gethash (string hashtable)
1830 "Get hash value of STRING in HASHTABLE."
1831 `(symbol-value (intern-soft ,string ,hashtable)))
1833 (defmacro gnus-sethash (string value hashtable)
1834 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1835 `(set (intern ,string ,hashtable) ,value))
1836 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1838 (defmacro gnus-group-unread (group)
1839 "Get the currently computed number of unread articles in GROUP."
1840 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1842 (defmacro gnus-group-entry (group)
1843 "Get the newsrc entry for GROUP."
1844 `(gnus-gethash ,group gnus-newsrc-hashtb))
1846 (defmacro gnus-active (group)
1847 "Get active info on GROUP."
1848 `(gnus-gethash ,group gnus-active-hashtb))
1850 (defmacro gnus-set-active (group active)
1851 "Set GROUP's active info."
1852 `(gnus-sethash ,group ,active gnus-active-hashtb))
1854 ;; Info access macros.
1856 (defmacro gnus-info-group (info)
1858 (defmacro gnus-info-rank (info)
1860 (defmacro gnus-info-read (info)
1862 (defmacro gnus-info-marks (info)
1864 (defmacro gnus-info-method (info)
1866 (defmacro gnus-info-params (info)
1869 (defmacro gnus-info-level (info)
1870 `(let ((rank (gnus-info-rank ,info)))
1874 (defmacro gnus-info-score (info)
1875 `(let ((rank (gnus-info-rank ,info)))
1876 (or (and (consp rank) (cdr rank)) 0)))
1878 (defmacro gnus-info-set-group (info group)
1879 `(setcar ,info ,group))
1880 (defmacro gnus-info-set-rank (info rank)
1881 `(setcar (nthcdr 1 ,info) ,rank))
1882 (defmacro gnus-info-set-read (info read)
1883 `(setcar (nthcdr 2 ,info) ,read))
1884 (defmacro gnus-info-set-marks (info marks &optional extend)
1886 `(gnus-info-set-entry ,info ,marks 3)
1887 `(setcar (nthcdr 3 ,info) ,marks)))
1888 (defmacro gnus-info-set-method (info method &optional extend)
1890 `(gnus-info-set-entry ,info ,method 4)
1891 `(setcar (nthcdr 4 ,info) ,method)))
1892 (defmacro gnus-info-set-params (info params &optional extend)
1894 `(gnus-info-set-entry ,info ,params 5)
1895 `(setcar (nthcdr 5 ,info) ,params)))
1897 (defun gnus-info-set-entry (info entry number)
1898 ;; Extend the info until we have enough elements.
1899 (while (<= (length info) number)
1900 (nconc info (list nil)))
1902 (setcar (nthcdr number info) entry))
1904 (defmacro gnus-info-set-level (info level)
1905 `(let ((rank (cdr ,info)))
1906 (if (consp (car rank))
1907 (setcar (car rank) ,level)
1908 (setcar rank ,level))))
1909 (defmacro gnus-info-set-score (info score)
1910 `(let ((rank (cdr ,info)))
1911 (if (consp (car rank))
1912 (setcdr (car rank) ,score)
1913 (setcar rank (cons (car rank) ,score)))))
1915 (defmacro gnus-get-info (group)
1916 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1918 ;; Byte-compiler warning.
1919 (defvar gnus-visual)
1920 ;; Find out whether the gnus-visual TYPE is wanted.
1921 (defun gnus-visual-p (&optional type class)
1922 (and gnus-visual ; Has to be non-nil, at least.
1923 (if (not type) ; We don't care about type.
1925 (if (listp gnus-visual) ; It's a list, so we check it.
1926 (or (memq type gnus-visual)
1927 (memq class gnus-visual))
1930 ;;; Load the compatability functions.
1939 (defvar gnus-shutdown-alist nil)
1941 (defun gnus-add-shutdown (function &rest symbols)
1942 "Run FUNCTION whenever one of SYMBOLS is shut down."
1943 (push (cons function symbols) gnus-shutdown-alist))
1945 (defun gnus-shutdown (symbol)
1946 "Shut down everything that waits for SYMBOL."
1947 (let ((alist gnus-shutdown-alist)
1949 (while (setq entry (pop alist))
1950 (when (memq symbol (cdr entry))
1951 (funcall (car entry))))))
1955 ;;; Gnus Utility Functions
1959 (defmacro gnus-string-or (&rest strings)
1960 "Return the first element of STRINGS that is a non-blank string.
1961 STRINGS will be evaluated in normal `or' order."
1962 `(gnus-string-or-1 ',strings))
1964 (defun gnus-string-or-1 (strings)
1967 (setq string (eval (pop strings)))
1968 (if (string-match "^[ \t]*$" string)
1970 (setq strings nil)))
1973 (defun gnus-version (&optional arg)
1974 "Version number of this version of Gnus.
1975 If ARG, insert string at point."
1978 (insert (message gnus-version))
1979 (message gnus-version)))
1981 (defun gnus-continuum-version (version)
1982 "Return VERSION as a floating point number."
1983 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1984 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1985 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
1986 (number (match-string 2 version))
1988 (unless (string-match
1989 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1990 (error "Invalid version string: %s" version))
1991 (setq major (string-to-number (match-string 1 number))
1992 minor (string-to-number (match-string 2 number))
1993 least (if (match-beginning 3)
1994 (string-to-number (match-string 3 number))
1998 (format "%s00%02d%02d"
1999 (if (member alpha '("(ding)" "d"))
2003 (- (mm-char-int (aref (downcase alpha) 0))
2007 (format "%d.%02d%02d" major minor least))))))
2009 (defun gnus-info-find-node ()
2010 "Find Info documentation of Gnus."
2012 ;; Enlarge info window if needed.
2013 (let (gnus-info-buffer)
2014 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2015 (setq gnus-info-buffer (current-buffer))
2016 (gnus-configure-windows 'info)))
2019 ;;; gnus-interactive
2022 (defvar gnus-current-prefix-symbol nil
2023 "Current prefix symbol.")
2025 (defvar gnus-current-prefix-symbols nil
2026 "List of current prefix symbols.")
2028 (defun gnus-interactive (string &optional params)
2029 "Return a list that can be fed to `interactive'.
2030 See `interactive' for full documentation.
2032 Adds the following specs:
2034 y -- The current symbolic prefix.
2035 Y -- A list of the current symbolic prefix(es).
2036 A -- Article number.
2037 H -- Article header.
2041 (while (< i (length string))
2042 (string-match ".\\([^\n]*\\)\n?" string i)
2043 (setq c (aref string i))
2045 (setq prompt (match-string 1 string)))
2046 (setq i (match-end 0))
2047 ;; We basically emulate just about everything that
2048 ;; `interactive' does, but add the specs listed above.
2052 (completing-read prompt obarray 'fboundp t))
2054 (read-buffer prompt (current-buffer) t))
2056 (read-buffer prompt (other-buffer (current-buffer))))
2060 (completing-read prompt obarray 'commandp t))
2064 (read-file-name prompt nil default-directory 'lambda))
2066 (read-file-name prompt nil nil 'lambda))
2068 (read-file-name prompt))
2070 (read-key-sequence prompt))
2072 (error "Not implemented spec"))
2074 (error "Not implemented spec"))
2078 (error "Not implemented spec"))
2080 (string-to-number (read-from-minibuffer prompt)))
2082 (prefix-numeric-value current-prefix-arg))
2088 (read-string prompt))
2090 (intern (read-string prompt)))
2092 (read-variable prompt))
2094 (read-minibuffer prompt))
2096 (eval-minibuffer prompt))
2097 ;; And here the new specs come.
2099 gnus-current-prefix-symbol)
2101 gnus-current-prefix-symbols)
2103 (gnus-group-group-name))
2105 (gnus-summary-skip-intangible)
2106 (or (get-text-property (point) 'gnus-number)
2107 (gnus-summary-last-subject)))
2109 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2111 (error "Non-implemented spec")))
2115 (push (if (< (point) (mark) (point) (mark))) out)
2116 (push (if (> (point) (mark) (point) (mark))) out))))
2117 (setq out (delq 'gnus-prefix-nil out))
2120 (defun gnus-symbolic-argument (&optional arg)
2121 "Read a symbolic argument and a command, and then execute command."
2123 (let* ((in-command (this-command-keys))
2124 (command in-command)
2125 gnus-current-prefix-symbols
2126 gnus-current-prefix-symbol
2128 (while (equal in-command command)
2129 (message "%s-" (key-description (this-command-keys)))
2130 (push (intern (char-to-string (read-char))) syms)
2131 (setq command (read-key-sequence nil t)))
2132 (setq gnus-current-prefix-symbols (nreverse syms)
2133 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2134 (call-interactively (key-binding command t))))
2136 ;;; More various functions.
2138 (defsubst gnus-check-backend-function (func group)
2139 "Check whether GROUP supports function FUNC.
2140 GROUP can either be a string (a group name) or a select method."
2142 (let ((method (if (stringp group)
2143 (car (gnus-find-method-for-group group))
2145 (unless (featurep method)
2147 (fboundp (intern (format "%s-%s" method func))))))
2149 (defun gnus-group-read-only-p (&optional group)
2150 "Check whether GROUP supports editing or not.
2151 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2152 that that variable is buffer-local to the summary buffers."
2153 (let ((group (or group gnus-newsgroup-name)))
2154 (not (gnus-check-backend-function 'request-replace-article group))))
2156 (defun gnus-group-total-expirable-p (group)
2157 "Check whether GROUP is total-expirable or not."
2158 (let ((params (gnus-group-find-parameter group))
2161 ((memq 'total-expire params)
2163 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2165 (gnus-total-expirable-newsgroups ; Check var.
2166 (string-match gnus-total-expirable-newsgroups group)))))
2168 (defun gnus-group-auto-expirable-p (group)
2169 "Check whether GROUP is auto-expirable or not."
2170 (let ((params (gnus-group-find-parameter group))
2173 ((memq 'auto-expire params)
2175 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2177 (gnus-auto-expirable-newsgroups ; Check var.
2178 (string-match gnus-auto-expirable-newsgroups group)))))
2180 (defun gnus-virtual-group-p (group)
2181 "Say whether GROUP is virtual or not."
2182 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2183 gnus-valid-select-methods)))
2185 (defun gnus-news-group-p (group &optional article)
2186 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2187 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2188 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2189 (if (or (null article)
2190 (not (< article 0)))
2191 (eq (gnus-request-type group article) 'news)
2192 (if (not (vectorp article))
2194 ;; It's a real article.
2195 (eq (gnus-request-type group (mail-header-id article))
2198 ;; Returns a list of writable groups.
2199 (defun gnus-writable-groups ()
2200 (let ((alist gnus-newsrc-alist)
2202 (while (setq group (car (pop alist)))
2203 (unless (gnus-group-read-only-p group)
2204 (push group groups)))
2207 ;; Check whether to use long file names.
2208 (defun gnus-use-long-file-name (symbol)
2209 ;; The variable has to be set...
2210 (and gnus-use-long-file-name
2211 ;; If it isn't a list, then we return t.
2212 (or (not (listp gnus-use-long-file-name))
2213 ;; If it is a list, and the list contains `symbol', we
2215 (not (memq symbol gnus-use-long-file-name)))))
2217 ;; Generate a unique new group name.
2218 (defun gnus-generate-new-group-name (leaf)
2221 (while (gnus-gethash name gnus-newsrc-hashtb)
2222 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2225 (defun gnus-ephemeral-group-p (group)
2226 "Say whether GROUP is ephemeral or not."
2227 (gnus-group-get-parameter group 'quit-config t))
2229 (defun gnus-group-quit-config (group)
2230 "Return the quit-config of GROUP."
2231 (gnus-group-get-parameter group 'quit-config t))
2233 (defun gnus-kill-ephemeral-group (group)
2234 "Remove ephemeral GROUP from relevant structures."
2235 (gnus-sethash group nil gnus-newsrc-hashtb))
2237 (defun gnus-simplify-mode-line ()
2238 "Make mode lines a bit simpler."
2239 (setq mode-line-modified (cdr gnus-mode-line-modified))
2240 (when (listp mode-line-format)
2241 (make-local-variable 'mode-line-format)
2242 (setq mode-line-format (copy-sequence mode-line-format))
2243 (when (equal (nth 3 mode-line-format) " ")
2244 (setcar (nthcdr 3 mode-line-format) " "))))
2246 ;;; Servers and groups.
2248 (defsubst gnus-server-add-address (method)
2249 (let ((method-name (symbol-name (car method))))
2250 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2251 (not (assq (intern (concat method-name "-address")) method))
2252 (memq 'physical-address (assq (car method)
2253 gnus-valid-select-methods)))
2254 (append method (list (list (intern (concat method-name "-address"))
2258 (defsubst gnus-server-get-method (group method)
2259 ;; Input either a server name, and extended server name, or a
2260 ;; select method, and return a select method.
2261 (cond ((stringp method)
2262 (gnus-server-to-method method))
2263 ((equal method gnus-select-method)
2265 ((and (stringp (car method))
2267 (gnus-server-extend-method group method))
2270 (equal (cadr method) ""))
2273 (gnus-server-add-address method))))
2275 (defun gnus-server-to-method (server)
2276 "Map virtual server names to select methods."
2278 ;; Is this a method, perhaps?
2279 (and server (listp server) server)
2280 ;; Perhaps this is the native server?
2281 (and (equal server "native") gnus-select-method)
2282 ;; It should be in the server alist.
2283 (cdr (assoc server gnus-server-alist))
2284 ;; It could be in the predefined server alist.
2285 (cdr (assoc server gnus-predefined-server-alist))
2286 ;; If not, we look through all the opened server
2287 ;; to see whether we can find it there.
2288 (let ((opened gnus-opened-servers))
2290 (not (equal server (format "%s:%s" (caaar opened)
2295 (defmacro gnus-method-equal (ss1 ss2)
2296 "Say whether two servers are equal."
2300 (and (= (length s1) (length s2))
2302 (while (and s1 (member (car s1) s2))
2306 (defun gnus-server-equal (m1 m2)
2307 "Say whether two methods are equal."
2308 (let ((m1 (cond ((null m1) gnus-select-method)
2309 ((stringp m1) (gnus-server-to-method m1))
2311 (m2 (cond ((null m2) gnus-select-method)
2312 ((stringp m2) (gnus-server-to-method m2))
2314 (gnus-method-equal m1 m2)))
2316 (defun gnus-servers-using-backend (backend)
2317 "Return a list of known servers using BACKEND."
2318 (let ((opened gnus-opened-servers)
2321 (when (eq backend (caaar opened))
2322 (push (caar opened) out))
2326 (defun gnus-archive-server-wanted-p ()
2327 "Say whether the user wants to use the archive server."
2329 ((or (not gnus-message-archive-method)
2330 (not gnus-message-archive-group))
2332 ((and gnus-message-archive-method gnus-message-archive-group)
2335 (let ((active (cadr (assq 'nnfolder-active-file
2336 gnus-message-archive-method))))
2338 (file-exists-p active))))))
2340 (defun gnus-group-prefixed-name (group method)
2341 "Return the whole name from GROUP and METHOD."
2342 (and (stringp method) (setq method (gnus-server-to-method method)))
2343 (if (or (not method)
2344 (gnus-server-equal method "native"))
2346 (concat (format "%s" (car method))
2348 (or (assoc (format "%s" (car method))
2349 (gnus-methods-using 'address))
2350 (gnus-server-equal method gnus-message-archive-method))
2352 (not (string= (nth 1 method) "")))
2353 (concat "+" (nth 1 method)))
2356 (defun gnus-group-real-prefix (group)
2357 "Return the prefix of the current group name."
2358 (if (string-match "^[^:]+:" group)
2359 (substring group 0 (match-end 0))
2362 (defun gnus-group-method (group)
2363 "Return the server or method used for selecting GROUP.
2364 You should probably use `gnus-find-method-for-group' instead."
2365 (let ((prefix (gnus-group-real-prefix group)))
2366 (if (equal prefix "")
2368 (let ((servers gnus-opened-servers)
2370 backend possible found)
2371 (if (string-match "^[^\\+]+\\+" prefix)
2372 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2373 server (substring prefix (match-end 0) (1- (length prefix))))
2374 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2376 (when (eq (caaar servers) backend)
2377 (setq possible (caar servers))
2378 (when (equal (cadaar servers) server)
2379 (setq found (caar servers))))
2381 (or (car (rassoc found gnus-server-alist))
2383 (car (rassoc possible gnus-server-alist))
2385 (list backend server))))))
2387 (defsubst gnus-secondary-method-p (method)
2388 "Return whether METHOD is a secondary select method."
2389 (let ((methods gnus-secondary-select-methods)
2390 (gmethod (gnus-server-get-method nil method)))
2392 (not (equal (gnus-server-get-method nil (car methods))
2394 (setq methods (cdr methods)))
2397 (defun gnus-groups-from-server (server)
2398 "Return a list of all groups that are fetched from SERVER."
2399 (let ((alist (cdr gnus-newsrc-alist))
2401 (while (setq info (pop alist))
2402 (when (gnus-server-equal (gnus-info-method info) server)
2403 (push (gnus-info-group info) groups)))
2404 (sort groups 'string<)))
2406 (defun gnus-group-foreign-p (group)
2407 "Say whether a group is foreign or not."
2408 (and (not (gnus-group-native-p group))
2409 (not (gnus-group-secondary-p group))))
2411 (defun gnus-group-native-p (group)
2412 "Say whether the group is native or not."
2413 (not (string-match ":" group)))
2415 (defun gnus-group-secondary-p (group)
2416 "Say whether the group is secondary or not."
2417 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2419 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2420 "Return the group parameters for GROUP.
2421 If SYMBOL, return the value of that symbol in the group parameters."
2423 (set-buffer gnus-group-buffer)
2424 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2426 (gnus-group-parameter-value parameters symbol allow-list)
2429 (defun gnus-group-get-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.
2432 Most functions should use `gnus-group-find-parameter', which
2433 also examines the topic parameters."
2434 (let ((params (gnus-info-params (gnus-get-info group))))
2436 (gnus-group-parameter-value params symbol allow-list)
2439 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2440 "Return the value of SYMBOL in group PARAMS."
2441 ;; We only wish to return group parameters (dotted lists) and
2442 ;; not local variables, which may have the same names.
2443 ;; But first we handle single elements...
2444 (or (car (memq symbol params))
2448 (while (setq elem (pop params))
2449 (when (and (consp elem)
2450 (eq (car elem) symbol)
2453 (throw 'found (cdr elem))))))))
2455 (defun gnus-group-add-parameter (group param)
2456 "Add parameter PARAM to GROUP."
2457 (let ((info (gnus-get-info group)))
2459 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2460 ;; Cons the new param to the old one and update.
2461 (gnus-group-set-info (cons param (gnus-info-params info))
2464 (defun gnus-group-set-parameter (group name value)
2465 "Set parameter NAME to VALUE in GROUP."
2466 (let ((info (gnus-get-info group)))
2468 (gnus-group-remove-parameter group name)
2469 (let ((old-params (gnus-info-params info))
2470 (new-params (list (cons name value))))
2472 (when (or (not (listp (car old-params)))
2473 (not (eq (caar old-params) name)))
2474 (setq new-params (append new-params (list (car old-params)))))
2475 (setq old-params (cdr old-params)))
2476 (gnus-group-set-info new-params group 'params)))))
2478 (defun gnus-group-remove-parameter (group name)
2479 "Remove parameter NAME from GROUP."
2480 (let ((info (gnus-get-info group)))
2482 (let ((params (gnus-info-params info)))
2484 (setq params (delq name params))
2485 (while (assq name params)
2486 (gnus-pull name params))
2487 (gnus-info-set-params info params))))))
2489 (defun gnus-group-add-score (group &optional score)
2490 "Add SCORE to the GROUP score.
2491 If SCORE is nil, add 1 to the score of GROUP."
2492 (let ((info (gnus-get-info group)))
2494 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2496 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2497 (defun gnus-short-group-name (group &optional levels)
2498 "Collapse GROUP name LEVELS.
2499 Select methods are stripped and any remote host name is stripped down to
2500 just the host name."
2507 (while (string-match "\\." group skip)
2508 (setq skip (match-end 0)
2511 ;; separate foreign select method from group name and collapse.
2512 ;; if method contains a server, collapse to non-domain server name,
2513 ;; otherwise collapse to select method
2514 (when (string-match ":" group)
2515 (cond ((string-match "+" group)
2516 (let* ((plus (string-match "+" group))
2517 (colon (string-match ":" group (or plus 0)))
2518 (dot (string-match "\\." group)))
2519 (setq foreign (concat
2520 (substring group (+ 1 plus)
2521 (cond ((null dot) colon)
2522 ((< colon dot) colon)
2523 ((< dot colon) dot)))
2525 group (substring group (+ 1 colon)))))
2527 (let* ((colon (string-match ":" group)))
2528 (setq foreign (concat (substring group 0 (+ 1 colon)))
2529 group (substring group (+ 1 colon)))))))
2530 ;; collapse group name leaving LEVELS uncollapsed elements
2532 (if (and (string-match "\\." group) (> levels 0))
2533 (setq name (concat name (substring group 0 1))
2534 group (substring group (match-end 0))
2536 name (concat name "."))
2537 (setq name (concat foreign name group)
2541 (defun gnus-narrow-to-body ()
2542 "Narrow to the body of an article."
2545 (goto-char (point-min))
2546 (or (search-forward "\n\n" nil t)
2552 ;;; Kill file handling.
2555 (defun gnus-apply-kill-file ()
2556 "Apply a kill file to the current newsgroup.
2557 Returns the number of articles marked as read."
2558 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2559 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2560 (gnus-apply-kill-file-internal)
2563 (defun gnus-kill-save-kill-buffer ()
2564 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2565 (when (get-file-buffer file)
2567 (set-buffer (get-file-buffer file))
2568 (when (buffer-modified-p)
2570 (kill-buffer (current-buffer))))))
2572 (defcustom gnus-kill-file-name "KILL"
2573 "Suffix of the kill files."
2574 :group 'gnus-score-kill
2575 :group 'gnus-score-files
2578 (defun gnus-newsgroup-kill-file (newsgroup)
2579 "Return the name of a kill file name for NEWSGROUP.
2580 If NEWSGROUP is nil, return the global kill file name instead."
2582 ;; The global KILL file is placed at top of the directory.
2583 ((or (null newsgroup)
2584 (string-equal newsgroup ""))
2585 (expand-file-name gnus-kill-file-name
2586 gnus-kill-files-directory))
2587 ;; Append ".KILL" to newsgroup name.
2588 ((gnus-use-long-file-name 'not-kill)
2589 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2590 "." gnus-kill-file-name)
2591 gnus-kill-files-directory))
2592 ;; Place "KILL" under the hierarchical directory.
2594 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2595 "/" gnus-kill-file-name)
2596 gnus-kill-files-directory))))
2600 (defun gnus-member-of-valid (symbol group)
2601 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2603 (symbol-name (car (gnus-find-method-for-group group)))
2604 gnus-valid-select-methods)))
2606 (defun gnus-method-option-p (method option)
2607 "Return non-nil if select METHOD has OPTION as a parameter."
2608 (when (stringp method)
2609 (setq method (gnus-server-to-method method)))
2610 (memq option (assoc (format "%s" (car method))
2611 gnus-valid-select-methods)))
2613 (defun gnus-similar-server-opened (method)
2614 (let ((opened gnus-opened-servers))
2615 (while (and method opened)
2616 (when (and (equal (cadr method) (cadaar opened))
2617 (not (equal method (caar opened))))
2622 (defun gnus-server-extend-method (group method)
2623 ;; This function "extends" a virtual server. If the server is
2624 ;; "hello", and the select method is ("hello" (my-var "something"))
2625 ;; in the group "alt.alt", this will result in a new virtual server
2626 ;; called "hello+alt.alt".
2627 (if (or (not (inline (gnus-similar-server-opened method)))
2628 (not (cddr method)))
2630 `(,(car method) ,(concat (cadr method) "+" group)
2631 (,(intern (format "%s-address" (car method))) ,(cadr method))
2634 (defun gnus-server-status (method)
2635 "Return the status of METHOD."
2636 (nth 1 (assoc method gnus-opened-servers)))
2638 (defun gnus-group-name-to-method (group)
2639 "Guess a select method based on GROUP."
2640 (if (string-match ":" group)
2641 (let ((server (substring group 0 (match-beginning 0))))
2642 (if (string-match "\\+" server)
2643 (list (intern (substring server 0 (match-beginning 0)))
2644 (substring server (match-end 0)))
2645 (list (intern server) "")))
2646 gnus-select-method))
2648 (defun gnus-find-method-for-group (group &optional info)
2649 "Find the select method that GROUP uses."
2650 (or gnus-override-method
2653 (let ((info (or info (gnus-get-info group)))
2656 (not (setq method (gnus-info-method info)))
2657 (equal method "native"))
2660 (cond ((stringp method)
2661 (inline (gnus-server-to-method method)))
2662 ((stringp (cadr method))
2663 (inline (gnus-server-extend-method group method)))
2666 (cond ((equal (cadr method) "")
2668 ((null (cadr method))
2669 (list (car method) ""))
2671 (gnus-server-add-address method)))))))
2673 (defun gnus-methods-using (feature)
2674 "Find all methods that have FEATURE."
2675 (let ((valids gnus-valid-select-methods)
2678 (when (memq feature (car valids))
2679 (push (car valids) outs))
2680 (setq valids (cdr valids)))
2683 (defun gnus-read-group (prompt &optional default)
2684 "Prompt the user for a group name.
2685 Disallow illegal group names."
2691 (setq group (read-string (concat prefix prompt)
2692 (cons (or default "") 0)
2693 'gnus-group-history)))
2694 (setq prefix (format "Illegal group name: \"%s\". " group)
2698 (defun gnus-read-method (prompt)
2699 "Prompt the user for a method.
2700 Allow completion over sensible values."
2702 (append gnus-valid-select-methods
2703 gnus-predefined-server-alist
2708 nil t nil 'gnus-method-history)))
2711 (setq method gnus-select-method))
2712 ((assoc method gnus-valid-select-methods)
2713 (list (intern method)
2714 (if (memq 'prompt-address
2715 (assoc method gnus-valid-select-methods))
2716 (read-string "Address: ")
2718 ((assoc method servers)
2721 (list (intern method) "")))))
2723 ;;; User-level commands.
2726 (defun gnus-slave-no-server (&optional arg)
2727 "Read network news as a slave, without connecting to local server."
2729 (gnus-no-server arg t))
2732 (defun gnus-no-server (&optional arg slave)
2734 If ARG is a positive number, Gnus will use that as the
2735 startup level. If ARG is nil, Gnus will be started at level 2.
2736 If ARG is non-nil and not a positive number, Gnus will
2737 prompt the user for the name of an NNTP server to use.
2738 As opposed to `gnus', this command will not connect to the local server."
2740 (gnus-no-server-1 arg slave))
2743 (defun gnus-slave (&optional arg)
2744 "Read news as a slave."
2746 (gnus arg nil 'slave))
2749 (defun gnus-other-frame (&optional arg)
2750 "Pop up a frame to read news."
2752 (let ((window (get-buffer-window gnus-group-buffer)))
2754 (select-frame (window-frame window)))
2755 ((= (length (frame-list)) 1)
2756 (select-frame (make-frame)))
2762 (defun gnus (&optional arg dont-connect slave)
2764 If ARG is non-nil and a positive number, Gnus will use that as the
2765 startup level. If ARG is non-nil and not a positive number, Gnus will
2766 prompt the user for the name of an NNTP server to use."
2768 (gnus-1 arg dont-connect slave))
2770 ;; Allow redefinition of Gnus functions.
2776 ;;; gnus.el ends here
projects / gnus / blob