1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987,88,89,90,93,94,95,96,97 Free Software Foundation, Inc.
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;; Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
6 ;; Keywords: news, mail
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
29 (eval '(run-hooks 'gnus-load-hook))
31 (eval-when-compile (require 'cl))
38 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
42 (defgroup gnus-start nil
43 "Starting your favorite newsreader."
46 (defgroup gnus-start-server nil
47 "Server options at startup."
50 ;; These belong to gnus-group.el.
51 (defgroup gnus-group nil
53 :link '(custom-manual "(gnus)The Group Buffer")
56 (defgroup gnus-group-foreign nil
58 :link '(custom-manual "(gnus)Foreign Groups")
61 (defgroup gnus-group-new nil
62 "Automatic subscription of new groups."
65 (defgroup gnus-group-levels nil
67 :link '(custom-manual "(gnus)Group Levels")
70 (defgroup gnus-group-select nil
72 :link '(custom-manual "(gnus)Selecting a Group")
75 (defgroup gnus-group-listing nil
76 "Showing slices of the group list."
77 :link '(custom-manual "(gnus)Listing Groups")
80 (defgroup gnus-group-visual nil
81 "Sorting the group buffer."
82 :link '(custom-manual "(gnus)Group Buffer Format")
86 (defgroup gnus-group-various nil
87 "Various group options."
88 :link '(custom-manual "(gnus)Scanning New Messages")
91 ;; These belong to gnus-sum.el.
92 (defgroup gnus-summary nil
94 :link '(custom-manual "(gnus)The Summary Buffer")
97 (defgroup gnus-summary-exit nil
98 "Leaving summary buffers."
99 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
100 :group 'gnus-summary)
102 (defgroup gnus-summary-marks nil
103 "Marks used in summary buffers."
104 :link '(custom-manual "(gnus)Marking Articles")
105 :group 'gnus-summary)
107 (defgroup gnus-thread nil
108 "Ordering articles according to replies."
109 :link '(custom-manual "(gnus)Threading")
110 :group 'gnus-summary)
112 (defgroup gnus-summary-format nil
113 "Formatting of the summary buffer."
114 :link '(custom-manual "(gnus)Summary Buffer Format")
115 :group 'gnus-summary)
117 (defgroup gnus-summary-choose nil
119 :link '(custom-manual "(gnus)Choosing Articles")
120 :group 'gnus-summary)
122 (defgroup gnus-summary-maneuvering nil
123 "Summary movement commands."
124 :link '(custom-manual "(gnus)Summary Maneuvering")
125 :group 'gnus-summary)
127 (defgroup gnus-summary-mail nil
128 "Mail group commands."
129 :link '(custom-manual "(gnus)Mail Group Commands")
130 :group 'gnus-summary)
132 (defgroup gnus-summary-sort nil
133 "Sorting the summary buffer."
134 :link '(custom-manual "(gnus)Sorting")
135 :group 'gnus-summary)
137 (defgroup gnus-summary-visual nil
138 "Highlighting and menus in the summary buffer."
139 :link '(custom-manual "(gnus)Summary Highlighting")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-various nil
144 "Various summary buffer options."
145 :link '(custom-manual "(gnus)Various Summary Stuff")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-pick nil
149 "Pick mode in the summary buffer."
150 :link '(custom-manual "(gnus)Pick and Read")
152 :group 'gnus-summary)
154 (defgroup gnus-summary-tree nil
155 "Tree display of threads in the summary buffer."
156 :link '(custom-manual "(gnus)Tree Display")
158 :group 'gnus-summary)
160 ;; Belongs to gnus-uu.el
161 (defgroup gnus-extract-view nil
162 "Viewing extracted files."
163 :link '(custom-manual "(gnus)Viewing Files")
164 :group 'gnus-extract)
166 ;; Belongs to gnus-score.el
167 (defgroup gnus-score nil
168 "Score and kill file handling."
171 (defgroup gnus-score-kill nil
175 (defgroup gnus-score-adapt nil
176 "Adaptive score files."
179 (defgroup gnus-score-default nil
180 "Default values for score files."
183 (defgroup gnus-score-expire nil
184 "Expiring score rules."
187 (defgroup gnus-score-decay nil
188 "Decaying score rules."
191 (defgroup gnus-score-files nil
192 "Score and kill file names."
196 (defgroup gnus-score-various nil
197 "Various scoring and killing options."
201 (defgroup gnus-visual nil
202 "Options controling the visual fluff."
206 (defgroup gnus-agent nil
207 "Offline support for Gnus."
210 (defgroup gnus-files nil
211 "Files used by Gnus."
214 (defgroup gnus-dribble-file nil
216 :link '(custom-manual "(gnus)Auto Save")
219 (defgroup gnus-newsrc nil
220 "Storing Gnus state."
223 (defgroup gnus-server nil
224 "Options related to newsservers and other servers used by Gnus."
227 (defgroup gnus-message '((message custom-group))
228 "Composing replies and followups in Gnus."
231 (defgroup gnus-meta nil
232 "Meta variables controling major portions of Gnus.
233 In general, modifying these variables does not take affect until Gnus
234 is restarted, and sometimes reloaded."
237 (defgroup gnus-various nil
238 "Other Gnus options."
239 :link '(custom-manual "(gnus)Various Various")
242 (defgroup gnus-exit nil
244 :link '(custom-manual "(gnus)Exiting Gnus")
247 (defconst gnus-version-number "0.6"
248 "Version number for this version of Gnus.")
250 (defconst gnus-version (format "Quassia Gnus v%s" gnus-version-number)
251 "Version string for this version of Gnus.")
253 (defcustom gnus-inhibit-startup-message nil
254 "If non-nil, the startup message will not be displayed.
255 This variable is used before `.gnus.el' is loaded, so it should
256 be set in `.emacs' instead."
260 (defcustom gnus-play-startup-jingle nil
261 "If non-nil, play the Gnus jingle at startup."
265 ;;; Kludges to help the transition from the old `custom.el'.
267 (unless (featurep 'gnus-xmas)
268 (defalias 'gnus-make-overlay 'make-overlay)
269 (defalias 'gnus-overlay-put 'overlay-put)
270 (defalias 'gnus-move-overlay 'move-overlay)
271 (defalias 'gnus-overlay-end 'overlay-end)
272 (defalias 'gnus-extent-detached-p 'ignore)
273 (defalias 'gnus-extent-start-open 'ignore)
274 (defalias 'gnus-set-text-properties 'set-text-properties)
275 (defalias 'gnus-group-remove-excess-properties 'ignore)
276 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
277 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
278 (defalias 'gnus-character-to-event 'identity)
279 (defalias 'gnus-add-text-properties 'add-text-properties)
280 (defalias 'gnus-put-text-property 'put-text-property)
281 (defalias 'gnus-mode-line-buffer-identification 'identity)
282 (defalias 'gnus-characterp 'numberp)
283 (defalias 'gnus-key-press-event-p 'numberp))
285 ;; The XEmacs people think this is evil, so it must go.
286 (defun custom-face-lookup (&optional fg bg stipple bold italic underline)
287 "Lookup or create a face with specified attributes."
288 (let ((name (intern (format "custom-face-%s-%s-%s-%S-%S-%S"
291 (or stipple "default")
292 bold italic underline))))
293 (if (and (custom-facep name)
294 (fboundp 'make-face))
296 (copy-face 'default name)
298 (not (string-equal fg "default")))
300 (set-face-foreground name fg)))
302 (not (string-equal bg "default")))
304 (set-face-background name bg)))
306 (not (string-equal stipple "default"))
307 (not (eq stipple 'custom:asis))
308 (fboundp 'set-face-stipple))
309 (set-face-stipple name stipple))
311 (not (eq bold 'custom:asis)))
313 (make-face-bold name)))
315 (not (eq italic 'custom:asis)))
317 (make-face-italic name)))
319 (not (eq underline 'custom:asis)))
321 (set-face-underline-p name t))))
324 ;; We define these group faces here to avoid the display
325 ;; update forced when creating new faces.
327 (defface gnus-group-news-1-face
330 (:foreground "PaleTurquoise" :bold t))
333 (:foreground "ForestGreen" :bold t))
336 "Level 1 newsgroup face.")
338 (defface gnus-group-news-1-empty-face
341 (:foreground "PaleTurquoise"))
344 (:foreground "ForestGreen"))
347 "Level 1 empty newsgroup face.")
349 (defface gnus-group-news-2-face
352 (:foreground "turquoise" :bold t))
355 (:foreground "CadetBlue4" :bold t))
358 "Level 2 newsgroup face.")
360 (defface gnus-group-news-2-empty-face
363 (:foreground "turquoise"))
366 (:foreground "CadetBlue4"))
369 "Level 2 empty newsgroup face.")
371 (defface gnus-group-news-3-face
380 "Level 3 newsgroup face.")
382 (defface gnus-group-news-3-empty-face
391 "Level 3 empty newsgroup face.")
393 (defface gnus-group-news-low-face
396 (:foreground "DarkTurquoise" :bold t))
399 (:foreground "DarkGreen" :bold t))
402 "Low level newsgroup face.")
404 (defface gnus-group-news-low-empty-face
407 (:foreground "DarkTurquoise"))
410 (:foreground "DarkGreen"))
413 "Low level empty newsgroup face.")
415 (defface gnus-group-mail-1-face
418 (:foreground "aquamarine1" :bold t))
421 (:foreground "DeepPink3" :bold t))
424 "Level 1 mailgroup face.")
426 (defface gnus-group-mail-1-empty-face
429 (:foreground "aquamarine1"))
432 (:foreground "DeepPink3"))
434 (:italic t :bold t)))
435 "Level 1 empty mailgroup face.")
437 (defface gnus-group-mail-2-face
440 (:foreground "aquamarine2" :bold t))
443 (:foreground "HotPink3" :bold t))
446 "Level 2 mailgroup face.")
448 (defface gnus-group-mail-2-empty-face
451 (:foreground "aquamarine2"))
454 (:foreground "HotPink3"))
457 "Level 2 empty mailgroup face.")
459 (defface gnus-group-mail-3-face
462 (:foreground "aquamarine3" :bold t))
465 (:foreground "magenta4" :bold t))
468 "Level 3 mailgroup face.")
470 (defface gnus-group-mail-3-empty-face
473 (:foreground "aquamarine3"))
476 (:foreground "magenta4"))
479 "Level 3 empty mailgroup face.")
481 (defface gnus-group-mail-low-face
484 (:foreground "aquamarine4" :bold t))
487 (:foreground "DeepPink4" :bold t))
490 "Low level mailgroup face.")
492 (defface gnus-group-mail-low-empty-face
495 (:foreground "aquamarine4"))
498 (:foreground "DeepPink4"))
501 "Low level empty mailgroup face.")
503 ;; Summary mode faces.
505 (defface gnus-summary-selected-face '((t
507 "Face used for selected articles.")
509 (defface gnus-summary-cancelled-face
511 (:foreground "yellow" :background "black")))
512 "Face used for cancelled articles.")
514 (defface gnus-summary-high-ticked-face
517 (:foreground "pink" :bold t))
520 (:foreground "firebrick" :bold t))
523 "Face used for high interest ticked articles.")
525 (defface gnus-summary-low-ticked-face
528 (:foreground "pink" :italic t))
531 (:foreground "firebrick" :italic t))
534 "Face used for low interest ticked articles.")
536 (defface gnus-summary-normal-ticked-face
539 (:foreground "pink"))
542 (:foreground "firebrick"))
545 "Face used for normal interest ticked articles.")
547 (defface gnus-summary-high-ancient-face
550 (:foreground "SkyBlue" :bold t))
553 (:foreground "RoyalBlue" :bold t))
556 "Face used for high interest ancient articles.")
558 (defface gnus-summary-low-ancient-face
561 (:foreground "SkyBlue" :italic t))
564 (:foreground "RoyalBlue" :italic t))
567 "Face used for low interest ancient articles.")
569 (defface gnus-summary-normal-ancient-face
572 (:foreground "SkyBlue"))
575 (:foreground "RoyalBlue"))
578 "Face used for normal interest ancient articles.")
580 (defface gnus-summary-high-unread-face
583 "Face used for high interest unread articles.")
585 (defface gnus-summary-low-unread-face
588 "Face used for low interest unread articles.")
590 (defface gnus-summary-normal-unread-face
593 "Face used for normal interest unread articles.")
595 (defface gnus-summary-high-read-face
598 (:foreground "PaleGreen"
602 (:foreground "DarkGreen"
606 "Face used for high interest read articles.")
608 (defface gnus-summary-low-read-face
611 (:foreground "PaleGreen"
615 (:foreground "DarkGreen"
619 "Face used for low interest read articles.")
621 (defface gnus-summary-normal-read-face
624 (:foreground "PaleGreen"))
627 (:foreground "DarkGreen"))
630 "Face used for normal interest read articles.")
635 (defvar gnus-group-buffer "*Group*")
638 (autoload 'gnus-play-jingle "gnus-audio"))
640 (defface gnus-splash-face
643 (:foreground "green"))
646 (:foreground "green"))
649 "Level 1 newsgroup face.")
651 (defun gnus-splash ()
653 (switch-to-buffer gnus-group-buffer)
654 (let ((buffer-read-only nil))
656 (unless gnus-inhibit-startup-message
657 (gnus-group-startup-message)
659 (when gnus-play-startup-jingle
660 (gnus-play-jingle))))))
662 (defun gnus-indent-rigidly (start end arg)
663 "Indent rigidly using only spaces and no tabs."
666 (narrow-to-region start end)
668 (indent-rigidly start end arg)
669 ;; We translate tabs into spaces -- not everybody uses
670 ;; an 8-character tab.
671 (goto-char (point-min))
672 (while (search-forward "\t" nil t)
673 (replace-match " " t t))))))
675 (defvar gnus-simple-splash nil)
677 (defun gnus-group-startup-message (&optional x y)
678 "Insert startup message in current buffer."
679 ;; Insert the message.
684 _ ___ __ ___ __ _ ___
704 (gnus-indent-rigidly (point-min) (point-max)
705 (/ (max (- (window-width) (or x 46)) 0) 2))
706 (goto-char (point-min))
708 (let* ((pheight (count-lines (point-min) (point-max)))
709 (wheight (window-height))
710 (rest (- wheight pheight)))
711 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
713 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
714 (goto-char (point-min))
715 (setq mode-line-buffer-identification (concat " " gnus-version))
716 (setq gnus-simple-splash t)
717 (set-buffer-modified-p t))
720 (let ((command (format "%s" this-command)))
721 (when (and (string-match "gnus" command)
722 (not (string-match "gnus-other-frame" command)))
731 (defcustom gnus-home-directory "~/"
732 "Directory variable that specifies the \"home\" directory.
733 All other Gnus path variables are initialized from this variable."
737 (defcustom gnus-directory (or (getenv "SAVEDIR")
738 (nnheader-concat gnus-home-directory "News/"))
739 "Directory variable from which all other Gnus file variables are derived."
743 (defcustom gnus-default-directory nil
744 "*Default directory for all Gnus buffers."
746 :type '(choice (const :tag "current" nil)
749 ;; Site dependent variables. These variables should be defined in
752 (defvar gnus-default-nntp-server nil
753 "Specify a default NNTP server.
754 This variable should be defined in paths.el, and should never be set
756 If you want to change servers, you should use `gnus-select-method'.
757 See the documentation to that variable.")
759 ;; Don't touch this variable.
760 (defvar gnus-nntp-service "nntp"
761 "NNTP service name (\"nntp\" or 119).
762 This is an obsolete variable, which is scarcely used. If you use an
763 nntp server for your newsgroup and want to change the port number
764 used to 899, you would say something along these lines:
766 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
768 (defcustom gnus-nntpserver-file "/etc/nntpserver"
769 "A file with only the name of the nntp server in it."
774 ;; This function is used to check both the environment variable
775 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
776 ;; an nntp server name default.
777 (defun gnus-getenv-nntpserver ()
778 (or (getenv "NNTPSERVER")
779 (and (file-readable-p gnus-nntpserver-file)
781 (set-buffer (get-buffer-create " *gnus nntp*"))
782 (buffer-disable-undo (current-buffer))
783 (insert-file-contents gnus-nntpserver-file)
784 (let ((name (buffer-string)))
786 (if (string-match "^[ \t\n]*$" name)
789 (kill-buffer (current-buffer))))))))
791 (defcustom gnus-select-method
794 (list 'nntp (or (condition-case nil
795 (gnus-getenv-nntpserver)
797 (when (and gnus-default-nntp-server
798 (not (string= gnus-default-nntp-server "")))
799 gnus-default-nntp-server)
801 (if (or (null gnus-nntp-service)
802 (equal gnus-nntp-service "nntp"))
804 (list gnus-nntp-service)))
806 "Default method for selecting a newsgroup.
807 This variable should be a list, where the first element is how the
808 news is to be fetched, the second is the address.
810 For instance, if you want to get your news via NNTP from
811 \"flab.flab.edu\", you could say:
813 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
815 If you want to use your local spool, say:
817 \(setq gnus-select-method (list 'nnspool (system-name)))
819 If you use this variable, you must set `gnus-nntp-server' to nil.
821 There is a lot more to know about select methods and virtual servers -
822 see the manual for details."
824 :type 'gnus-select-method)
826 (defcustom gnus-message-archive-method
829 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
830 (nnfolder-active-file
831 ,(nnheader-concat message-directory "archive/active"))
832 (nnfolder-get-new-mail nil)
833 (nnfolder-inhibit-expiry t))
834 "Method used for archiving messages you've sent.
835 This should be a mail method.
837 It's probably not a very effective to change this variable once you've
838 run Gnus once. After doing that, you must edit this server from the
842 :type 'gnus-select-method)
844 (defcustom gnus-message-archive-group nil
845 "*Name of the group in which to save the messages you've written.
846 This can either be a string; a list of strings; or an alist
847 of regexps/functions/forms to be evaluated to return a string (or a list
848 of strings). The functions are called with the name of the current
849 group (or nil) as a parameter.
851 If you want to save your mail in one group and the news articles you
852 write in another group, you could say something like:
854 \(setq gnus-message-archive-group
855 '((if (message-news-p)
859 Normally the group names returned by this variable should be
860 unprefixed -- which implicitly means \"store on the archive server\".
861 However, you may wish to store the message on some other server. In
862 that case, just return a fully prefixed name of the group --
863 \"nnml+private:mail.misc\", for instance."
865 :type '(choice (const :tag "none" nil)
868 (defcustom gnus-secondary-servers nil
869 "List of NNTP servers that the user can choose between interactively.
870 To make Gnus query you for a server, you have to give `gnus' a
871 non-numeric prefix - `C-u M-x gnus', in short."
873 :type '(repeat string))
875 (defcustom gnus-nntp-server nil
876 "*The name of the host running the NNTP server.
877 This variable is semi-obsolete. Use the `gnus-select-method'
880 :type '(choice (const :tag "disable" nil)
883 (defcustom gnus-secondary-select-methods nil
884 "A list of secondary methods that will be used for reading news.
885 This is a list where each element is a complete select method (see
886 `gnus-select-method').
888 If, for instance, you want to read your mail with the nnml backend,
889 you could set this variable:
891 \(setq gnus-secondary-select-methods '((nnml \"\")))"
893 :type '(repeat gnus-select-method))
895 (defvar gnus-backup-default-subscribed-newsgroups
896 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
897 "Default default new newsgroups the first time Gnus is run.
898 Should be set in paths.el, and shouldn't be touched by the user.")
900 (defcustom gnus-local-domain nil
901 "Local domain name without a host name.
902 The DOMAINNAME environment variable is used instead if it is defined.
903 If the `system-name' function returns the full Internet name, there is
904 no need to set this variable."
906 :type '(choice (const :tag "default" nil)
909 (defvar gnus-local-organization nil
910 "String with a description of what organization (if any) the user belongs to.
911 Obsolete variable; use `message-user-organization' instead.")
913 ;; Customization variables
915 (defcustom gnus-refer-article-method nil
916 "Preferred method for fetching an article by Message-ID.
917 If you are reading news from the local spool (with nnspool), fetching
918 articles by Message-ID is painfully slow. By setting this method to an
919 nntp method, you might get acceptable results.
921 The value of this variable must be a valid select method as discussed
922 in the documentation of `gnus-select-method'."
924 :type '(choice (const :tag "default" nil)
927 (defcustom gnus-group-faq-directory
928 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
929 "/ftp@sunsite.auc.dk:/pub/usenet/"
930 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
931 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
932 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
933 "/ftp@rtfm.mit.edu:/pub/usenet/"
934 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
935 "/ftp@ftp.sunet.se:/pub/usenet/"
936 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
937 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
938 "/ftp@ftp.hk.super.net:/mirror/faqs/")
939 "Directory where the group FAQs are stored.
940 This will most commonly be on a remote machine, and the file will be
943 This variable can also be a list of directories. In that case, the
944 first element in the list will be used by default. The others can
945 be used when being prompted for a site.
947 Note that Gnus uses an aol machine as the default directory. If this
948 feels fundamentally unclean, just think of it as a way to finally get
949 something of value back from them.
951 If the default site is too slow, try one of these:
953 North America: mirrors.aol.com /pub/rtfm/usenet
954 ftp.seas.gwu.edu /pub/rtfm
955 rtfm.mit.edu /pub/usenet
956 Europe: ftp.uni-paderborn.de /pub/FAQ
957 src.doc.ic.ac.uk /usenet/news-FAQS
958 ftp.sunet.se /pub/usenet
959 sunsite.auc.dk /pub/usenet
960 Asia: nctuccca.edu.tw /USENET/FAQ
961 hwarang.postech.ac.kr /pub/usenet
962 ftp.hk.super.net /mirror/faqs"
963 :group 'gnus-group-various
964 :type '(choice directory
967 (defcustom gnus-use-cross-reference t
968 "*Non-nil means that cross referenced articles will be marked as read.
969 If nil, ignore cross references. If t, mark articles as read in
970 subscribed newsgroups. If neither t nor nil, mark as read in all
973 :type '(choice (const :tag "off" nil)
974 (const :tag "subscribed" t)
978 (defcustom gnus-process-mark ?#
980 :group 'gnus-group-visual
981 :group 'gnus-summary-marks
984 (defcustom gnus-asynchronous nil
985 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
986 :group 'gnus-asynchronous
989 (defcustom gnus-large-newsgroup 200
990 "*The number of articles which indicates a large newsgroup.
991 If the number of articles in a newsgroup is greater than this value,
992 confirmation is required for selecting the newsgroup."
993 :group 'gnus-group-select
996 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
997 "*Non-nil means that the default name of a file to save articles in is the group name.
998 If it's nil, the directory form of the group name is used instead.
1000 If this variable is a list, and the list contains the element
1001 `not-score', long file names will not be used for score files; if it
1002 contains the element `not-save', long file names will not be used for
1003 saving; and if it contains the element `not-kill', long file names
1004 will not be used for kill files.
1006 Note that the default for this variable varies according to what system
1007 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1008 to nil while on all other systems it defaults to t."
1012 (defcustom gnus-kill-files-directory gnus-directory
1013 "*Name of the directory where kill files will be stored (default \"~/News\")."
1014 :group 'gnus-score-files
1015 :group 'gnus-score-kill
1018 (defcustom gnus-save-score nil
1019 "*If non-nil, save group scoring info."
1020 :group 'gnus-score-various
1024 (defcustom gnus-use-undo t
1025 "*If non-nil, allow undoing in Gnus group mode buffers."
1029 (defcustom gnus-use-adaptive-scoring nil
1030 "*If non-nil, use some adaptive scoring scheme.
1031 If a list, then the values `word' and `line' are meaningful. The
1032 former will perform adaption on individual words in the subject
1033 header while `line' will perform adaption on several headers."
1035 :group 'gnus-score-adapt
1036 :type '(set (const word) (const line)))
1038 (defcustom gnus-use-cache 'passive
1039 "*If nil, Gnus will ignore the article cache.
1040 If `passive', it will allow entering (and reading) articles
1041 explicitly entered into the cache. If anything else, use the
1042 cache to the full extent of the law."
1045 :type '(choice (const :tag "off" nil)
1046 (const :tag "passive" passive)
1047 (const :tag "active" t)))
1049 (defcustom gnus-use-trees nil
1050 "*If non-nil, display a thread tree buffer."
1054 (defcustom gnus-use-grouplens nil
1055 "*If non-nil, use GroupLens ratings."
1059 (defcustom gnus-keep-backlog nil
1060 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1061 If it is a number N, then Gnus will only keep the last N articles
1062 read. If it is neither nil nor a number, Gnus will keep all read
1063 articles. This is not a good idea."
1065 :type '(choice (const :tag "off" nil)
1070 (defcustom gnus-use-nocem nil
1071 "*If non-nil, Gnus will read NoCeM cancel messages."
1075 (defcustom gnus-suppress-duplicates nil
1076 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1080 (defcustom gnus-use-demon nil
1081 "If non-nil, Gnus might use some demons."
1085 (defcustom gnus-use-scoring t
1086 "*If non-nil, enable scoring."
1090 (defcustom gnus-use-picons nil
1091 "*If non-nil, display picons."
1095 (defcustom gnus-summary-prepare-exit-hook
1096 '(gnus-summary-expire-articles)
1097 "A hook called when preparing to exit from the summary buffer.
1098 It calls `gnus-summary-expire-articles' by default."
1099 :group 'gnus-summary-exit
1102 (defcustom gnus-novice-user t
1103 "*Non-nil means that you are a usenet novice.
1104 If non-nil, verbose messages may be displayed and confirmations may be
1109 (defcustom gnus-expert-user nil
1110 "*Non-nil means that you will never be asked for confirmation about anything.
1111 And that means *anything*."
1115 (defcustom gnus-interactive-catchup t
1116 "*If non-nil, require your confirmation when catching up a group."
1117 :group 'gnus-group-select
1120 (defcustom gnus-interactive-exit t
1121 "*If non-nil, require your confirmation when exiting Gnus."
1125 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1126 "*Function for extracting address components from a From header.
1127 Two pre-defined function exist: `gnus-extract-address-components',
1128 which is the default, quite fast, and too simplistic solution, and
1129 `mail-extract-address-components', which works much better, but is
1131 :group 'gnus-summary-format
1132 :type '(radio (function-item gnus-extract-address-components)
1133 (function-item mail-extract-address-components)
1134 (function :tag "Other")))
1136 (defcustom gnus-carpal nil
1137 "*If non-nil, display clickable icons."
1141 (defcustom gnus-shell-command-separator ";"
1142 "String used to separate to shell commands."
1146 (defcustom gnus-valid-select-methods
1147 '(("nntp" post address prompt-address physical-address)
1148 ("nnspool" post address)
1149 ("nnvirtual" post-mail virtual prompt-address)
1150 ("nnmbox" mail respool address)
1151 ("nnml" mail respool address)
1152 ("nnmh" mail respool address)
1153 ("nndir" post-mail prompt-address physical-address)
1154 ("nneething" none address prompt-address physical-address)
1155 ("nndoc" none address prompt-address)
1156 ("nnbabyl" mail address respool)
1157 ("nnkiboze" post virtual)
1158 ("nnsoup" post-mail address)
1159 ("nndraft" post-mail)
1160 ("nnfolder" mail respool address)
1161 ("nngateway" none address prompt-address physical-address)
1163 ("nnagent" post-mail))
1164 "An alist of valid select methods.
1165 The first element of each list lists should be a string with the name
1166 of the select method. The other elements may be the category of
1167 this method (i. e., `post', `mail', `none' or whatever) or other
1168 properties that this method has (like being respoolable).
1169 If you implement a new select method, all you should have to change is
1170 this variable. I think."
1172 :type '(repeat (group (string :tag "Name")
1173 (radio-button-choice (const :format "%v " post)
1174 (const :format "%v " mail)
1175 (const :format "%v " none)
1177 (checklist :inline t
1178 (const :format "%v " address)
1179 (const :format "%v " prompt-address)
1180 (const :format "%v " virtual)
1183 (define-widget 'gnus-select-method 'list
1184 "Widget for entering a select method."
1185 :args `((choice :tag "Method"
1186 ,@(mapcar (lambda (entry)
1187 (list 'const :format "%v\n"
1188 (intern (car entry))))
1189 gnus-valid-select-methods))
1190 (string :tag "Address")
1191 (editable-list :inline t
1194 (sexp :tag "Value")))))
1196 (defcustom gnus-updated-mode-lines '(group article summary tree)
1197 "List of buffers that should update their mode lines.
1198 The list may contain the symbols `group', `article', `tree' and
1199 `summary'. If the corresponding symbol is present, Gnus will keep
1200 that mode line updated with information that may be pertinent.
1201 If this variable is nil, screen refresh may be quicker."
1202 :group 'gnus-various
1203 :type '(set (const group)
1208 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1209 (defcustom gnus-mode-non-string-length nil
1210 "*Max length of mode-line non-string contents.
1211 If this is nil, Gnus will take space as is needed, leaving the rest
1212 of the modeline intact. Note that the default of nil is unlikely
1213 to be desirable; see the manual for further details."
1214 :group 'gnus-various
1215 :type '(choice (const nil)
1218 (defcustom gnus-auto-expirable-newsgroups nil
1219 "*Groups in which to automatically mark read articles as expirable.
1220 If non-nil, this should be a regexp that should match all groups in
1221 which to perform auto-expiry. This only makes sense for mail groups."
1222 :group 'nnmail-expire
1223 :type '(choice (const nil)
1226 (defcustom gnus-total-expirable-newsgroups nil
1227 "*Groups in which to perform expiry of all read articles.
1228 Use with extreme caution. All groups that match this regexp will be
1229 expiring - which means that all read articles will be deleted after
1230 \(say) one week. (This only goes for mail groups and the like, of
1232 :group 'nnmail-expire
1233 :type '(choice (const nil)
1236 (defcustom gnus-group-uncollapsed-levels 1
1237 "Number of group name elements to leave alone when making a short group name."
1238 :group 'gnus-group-visual
1241 (defcustom gnus-group-use-permanent-levels nil
1242 "*If non-nil, once you set a level, Gnus will use this level."
1243 :group 'gnus-group-levels
1248 (defcustom gnus-load-hook nil
1249 "A hook run while Gnus is loaded."
1253 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1254 "A hook called to apply kill files to a group.
1255 This hook is intended to apply a kill file to the selected newsgroup.
1256 The function `gnus-apply-kill-file' is called by default.
1258 Since a general kill file is too heavy to use only for a few
1259 newsgroups, I recommend you to use a lighter hook function. For
1260 example, if you'd like to apply a kill file to articles which contains
1261 a string `rmgroup' in subject in newsgroup `control', you can use the
1264 (setq gnus-apply-kill-hook
1267 (cond ((string-match \"control\" gnus-newsgroup-name)
1268 (gnus-kill \"Subject\" \"rmgroup\")
1269 (gnus-expunge \"X\"))))))"
1270 :group 'gnus-score-kill
1271 :options '(gnus-apply-kill-file)
1274 (defcustom gnus-group-change-level-function nil
1275 "Function run when a group level is changed.
1276 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1277 :group 'gnus-group-level
1282 (defcustom gnus-visual
1283 '(summary-highlight group-highlight article-highlight
1285 summary-menu group-menu article-menu
1286 tree-highlight menu highlight
1287 browse-menu server-menu
1288 page-marker tree-menu binary-menu pick-menu
1290 "Enable visual features.
1291 If `visual' is disabled, there will be no menus and few faces. Most of
1292 the visual customization options below will be ignored. Gnus will use
1293 less space and be faster as a result.
1295 This variable can also be a list of visual elements to switch on. For
1296 instance, to switch off all visual things except menus, you can say:
1298 (setq gnus-visual '(menu))
1300 Valid elements include `summary-highlight', `group-highlight',
1301 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1302 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1303 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1304 and `grouplens-menu'."
1307 :type '(set (const summary-highlight)
1308 (const group-highlight)
1309 (const article-highlight)
1311 (const summary-menu)
1313 (const article-menu)
1314 (const tree-highlight)
1323 (const grouplens-menu)))
1325 (defcustom gnus-mouse-face
1327 (if (gnus-visual-p 'mouse-face 'highlight)
1328 (if (boundp 'gnus-mouse-face)
1329 (or gnus-mouse-face 'highlight)
1333 "Face used for group or summary buffer mouse highlighting.
1334 The line beneath the mouse pointer will be highlighted with this
1339 (defcustom gnus-article-display-hook
1340 (if (and (string-match "XEmacs" emacs-version)
1342 '(gnus-article-hide-headers-if-wanted
1343 gnus-article-hide-boring-headers
1344 gnus-article-treat-overstrike
1345 gnus-article-maybe-highlight
1346 gnus-article-display-x-face)
1347 '(gnus-article-hide-headers-if-wanted
1348 gnus-article-hide-boring-headers
1349 gnus-article-treat-overstrike
1350 gnus-article-maybe-highlight))
1351 "Controls how the article buffer will look.
1353 If you leave the list empty, the article will appear exactly as it is
1354 stored on the disk. The list entries will hide or highlight various
1355 parts of the article, making it easier to find the information you
1357 :group 'gnus-article-highlight
1360 :options '(gnus-article-add-buttons
1361 gnus-article-add-buttons-to-head
1362 gnus-article-emphasize
1363 gnus-article-fill-cited-article
1364 gnus-article-remove-cr
1365 gnus-article-de-quoted-unreadable
1366 gnus-summary-stop-page-breaking
1367 ;; gnus-summary-caesar-message
1368 ;; gnus-summary-verbose-headers
1369 gnus-summary-toggle-mime
1371 gnus-article-hide-headers
1372 gnus-article-hide-boring-headers
1373 gnus-article-hide-signature
1374 gnus-article-hide-citation
1375 gnus-article-hide-pgp
1376 gnus-article-hide-pem
1377 gnus-article-highlight
1378 gnus-article-highlight-headers
1379 gnus-article-highlight-citation
1380 gnus-article-highlight-signature
1381 gnus-article-date-ut
1382 gnus-article-date-local
1383 gnus-article-date-lapsed
1384 gnus-article-date-original
1385 gnus-article-remove-trailing-blank-lines
1386 gnus-article-strip-leading-blank-lines
1387 gnus-article-strip-multiple-blank-lines
1388 gnus-article-strip-blank-lines
1389 gnus-article-treat-overstrike
1390 gnus-article-display-x-face
1391 gnus-smiley-display))
1393 (defcustom gnus-article-save-directory gnus-directory
1394 "*Name of the directory articles will be saved in (default \"~/News\")."
1395 :group 'gnus-article-saving
1399 ;;; Internal variables
1401 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1402 (defvar gnus-original-article-buffer " *Original Article*")
1403 (defvar gnus-newsgroup-name nil)
1405 (defvar gnus-agent nil
1406 "Whether we want to use the Gnus agent or not.")
1408 (defvar gnus-command-method nil
1409 "Dynamically bound variable that says what the current backend is.")
1411 (defvar gnus-current-select-method nil
1412 "The current method for selecting a newsgroup.")
1414 (defvar gnus-tree-buffer "*Tree*"
1415 "Buffer where Gnus thread trees are displayed.")
1418 (defvar gnus-use-generic-from nil)
1420 ;; Variable holding the user answers to all method prompts.
1421 (defvar gnus-method-history nil)
1422 (defvar gnus-group-history nil)
1424 ;; Variable holding the user answers to all mail method prompts.
1425 (defvar gnus-mail-method-history nil)
1427 ;; Variable holding the user answers to all group prompts.
1428 (defvar gnus-group-history nil)
1430 (defvar gnus-server-alist nil
1431 "List of available servers.")
1433 (defvar gnus-predefined-server-alist
1436 (nnspool-spool-directory "~/News/cache/")
1437 (nnspool-nov-directory "~/News/cache/")
1438 (nnspool-active-file "~/News/cache/active"))))
1439 "List of predefined (convenience) servers.")
1441 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1443 (defconst gnus-article-mark-lists
1444 '((marked . tick) (replied . reply)
1445 (expirable . expire) (killed . killed)
1446 (bookmarks . bookmark) (dormant . dormant)
1447 (scored . score) (saved . save)
1448 (cached . cache) (downloadable . download)
1449 (unsendable . unsend)))
1451 (defvar gnus-headers-retrieved-by nil)
1452 (defvar gnus-article-reply nil)
1453 (defvar gnus-override-method nil)
1454 (defvar gnus-article-check-size nil)
1455 (defvar gnus-opened-servers nil)
1457 (defvar gnus-current-kill-article nil)
1459 (defvar gnus-have-read-active-file nil)
1461 (defconst gnus-maintainer
1462 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1463 "The mail address of the Gnus maintainers.")
1465 (defvar gnus-info-nodes
1466 '((gnus-group-mode "(gnus)The Group Buffer")
1467 (gnus-summary-mode "(gnus)The Summary Buffer")
1468 (gnus-article-mode "(gnus)The Article Buffer")
1469 (mime/viewer-mode "(gnus)The Article Buffer")
1470 (gnus-server-mode "(gnus)The Server Buffer")
1471 (gnus-browse-mode "(gnus)Browse Foreign Server")
1472 (gnus-tree-mode "(gnus)Tree Display"))
1473 "Alist of major modes and related Info nodes.")
1475 (defvar gnus-group-buffer "*Group*")
1476 (defvar gnus-summary-buffer "*Summary*")
1477 (defvar gnus-article-buffer "*Article*")
1478 (defvar gnus-server-buffer "*Server*")
1480 (defvar gnus-buffer-list nil
1481 "Gnus buffers that should be killed on exit.")
1483 (defvar gnus-slave nil
1484 "Whether this Gnus is a slave or not.")
1486 (defvar gnus-batch-mode nil
1487 "Whether this Gnus is running in batch mode or not.")
1489 (defvar gnus-variable-list
1490 '(gnus-newsrc-options gnus-newsrc-options-n
1491 gnus-newsrc-last-checked-date
1492 gnus-newsrc-alist gnus-server-alist
1493 gnus-killed-list gnus-zombie-list
1494 gnus-topic-topology gnus-topic-alist
1496 "Gnus variables saved in the quick startup file.")
1498 (defvar gnus-newsrc-alist nil
1499 "Assoc list of read articles.
1500 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1502 (defvar gnus-newsrc-hashtb nil
1503 "Hashtable of gnus-newsrc-alist.")
1505 (defvar gnus-killed-list nil
1506 "List of killed newsgroups.")
1508 (defvar gnus-killed-hashtb nil
1509 "Hash table equivalent of gnus-killed-list.")
1511 (defvar gnus-zombie-list nil
1512 "List of almost dead newsgroups.")
1514 (defvar gnus-description-hashtb nil
1515 "Descriptions of newsgroups.")
1517 (defvar gnus-list-of-killed-groups nil
1518 "List of newsgroups that have recently been killed by the user.")
1520 (defvar gnus-active-hashtb nil
1521 "Hashtable of active articles.")
1523 (defvar gnus-moderated-hashtb nil
1524 "Hashtable of moderated newsgroups.")
1526 ;; Save window configuration.
1527 (defvar gnus-prev-winconf nil)
1529 (defvar gnus-reffed-article-number nil)
1531 ;;; Let the byte-compiler know that we know about this variable.
1532 (defvar rmail-default-rmail-file)
1534 (defvar gnus-dead-summary nil)
1536 ;;; End of variables.
1538 ;; Define some autoload functions Gnus might use.
1541 ;; This little mapcar goes through the list below and marks the
1542 ;; symbols in question as autoloaded functions.
1545 (let ((interactive (nth 1 (memq ':interactive package))))
1549 (when (consp function)
1550 (setq keymap (car (memq 'keymap function)))
1551 (setq function (car function)))
1552 (autoload function (car package) nil interactive keymap)))
1553 (if (eq (nth 1 package) ':interactive)
1556 '(("metamail" metamail-buffer)
1557 ("info" Info-goto-node)
1558 ("hexl" hexl-hex-string-to-integer)
1559 ("pp" pp pp-to-string pp-eval-expression)
1560 ("ps-print" ps-print-preprint)
1561 ("mail-extr" mail-extract-address-components)
1562 ("message" :interactive t
1563 message-send-and-exit message-yank-original)
1564 ("nnmail" nnmail-split-fancy nnmail-article-group nnmail-date-to-time)
1565 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1566 ("timezone" timezone-make-date-arpa-standard timezone-fix-time
1567 timezone-make-sortable-date timezone-make-time-string)
1568 ("rmailout" rmail-output)
1569 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1571 ("gnus-audio" :interactive t gnus-audio-play)
1572 ("gnus-xmas" gnus-xmas-splash)
1573 ("gnus-soup" :interactive t
1574 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1575 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1576 ("nnsoup" nnsoup-pack-replies)
1577 ("score-mode" :interactive t gnus-score-mode)
1578 ("gnus-mh" gnus-summary-save-article-folder
1579 gnus-Folder-save-name gnus-folder-save-name)
1580 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1581 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1582 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1583 gnus-demon-add-disconnection gnus-demon-add-handler
1584 gnus-demon-remove-handler)
1585 ("gnus-demon" :interactive t
1586 gnus-demon-init gnus-demon-cancel)
1587 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1588 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1589 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1590 gnus-nocem-unwanted-article-p)
1591 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1592 gnus-server-server-name)
1593 ("gnus-srvr" gnus-browse-foreign-server)
1594 ("gnus-cite" :interactive t
1595 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1596 gnus-article-hide-citation gnus-article-fill-cited-article
1597 gnus-article-hide-citation-in-followups)
1598 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1599 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1600 gnus-execute gnus-expunge)
1601 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1602 gnus-cache-possibly-remove-articles gnus-cache-request-article
1603 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1604 gnus-cache-enter-remove-article gnus-cached-article-p
1605 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1606 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1607 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1608 ("gnus-score" :interactive t
1609 gnus-summary-increase-score gnus-summary-set-score
1610 gnus-summary-raise-thread gnus-summary-raise-same-subject
1611 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1612 gnus-summary-lower-thread gnus-summary-lower-same-subject
1613 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1614 gnus-summary-current-score gnus-score-default
1615 gnus-score-flush-cache gnus-score-close
1616 gnus-possibly-score-headers gnus-score-followup-article
1617 gnus-score-followup-thread)
1619 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1620 gnus-current-score-file-nondirectory gnus-score-adaptive
1621 gnus-score-find-trace gnus-score-file-name)
1622 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1623 ("gnus-topic" :interactive t gnus-topic-mode)
1624 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1625 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1626 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1627 ("gnus-uu" :interactive t
1628 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1629 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1630 gnus-uu-mark-by-regexp gnus-uu-mark-all
1631 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1632 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1633 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1634 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1635 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1636 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1637 gnus-uu-decode-binhex-view)
1638 ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh)
1639 ("gnus-msg" (gnus-summary-send-map keymap)
1640 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1641 ("gnus-msg" :interactive t
1642 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1643 gnus-summary-followup gnus-summary-followup-with-original
1644 gnus-summary-cancel-article gnus-summary-supersede-article
1645 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1646 gnus-summary-mail-forward gnus-summary-mail-other-window
1647 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1649 ("gnus-picon" :interactive t gnus-article-display-picons
1650 gnus-group-display-picons gnus-picons-article-display-x-face
1651 gnus-picons-display-x-face)
1652 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1653 gnus-grouplens-mode)
1654 ("smiley" :interactive t gnus-smiley-display)
1655 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1656 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1657 gnus-list-of-unread-articles gnus-list-of-read-articles
1658 gnus-offer-save-summaries gnus-make-thread-indent-array
1659 gnus-summary-exit gnus-update-read-articles)
1660 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1661 gnus-group-list-groups gnus-group-first-unread-group
1662 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1663 gnus-group-setup-buffer gnus-group-get-new-news
1664 gnus-group-make-help-group gnus-group-update-group)
1665 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1666 gnus-backlog-remove-article)
1667 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1668 gnus-article-prepare gnus-article-set-window-start
1669 gnus-article-next-page gnus-article-prev-page
1670 gnus-request-article-this-buffer gnus-article-mode
1671 gnus-article-setup-buffer gnus-narrow-to-page
1672 gnus-article-delete-invisible-text gnus-hack-decode-rfc1522)
1673 ("gnus-art" :interactive t
1674 gnus-article-hide-headers gnus-article-hide-boring-headers
1675 gnus-article-treat-overstrike gnus-article-word-wrap
1676 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1677 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1678 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1679 gnus-article-hide-pem gnus-article-hide-signature
1680 gnus-article-strip-leading-blank-lines gnus-article-date-local
1681 gnus-article-date-original gnus-article-date-lapsed
1682 gnus-article-show-all-headers
1683 gnus-article-edit-mode gnus-article-edit-article
1684 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522)
1685 ("gnus-int" gnus-request-type)
1686 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1688 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1689 gnus-dup-enter-articles)
1690 ("gnus-range" gnus-copy-sequence)
1691 ("gnus-eform" gnus-edit-form)
1692 ("gnus-move" :interactive t
1693 gnus-group-move-group-to-server gnus-change-server)
1694 ("gnus-logic" gnus-score-advanced)
1695 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1696 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1697 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1698 gnus-async-halt-prefetch)
1699 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1700 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p)
1701 ("gnus-agent" :interactive t
1702 gnus-unplugged gnus-agentize)
1703 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1704 gnus-summary-save-article-vm)
1705 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1707 ;;; gnus-sum.el thingies
1710 (defcustom gnus-summary-line-format "%U\%R\%z\%I\%(%[%4L: %-20,20n%]%) %s\n"
1711 "*The format specification of the lines in the summary buffer.
1713 It works along the same lines as a normal formatting string,
1714 with some simple extensions.
1716 %N Article number, left padded with spaces (string)
1718 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1719 %n Name of the poster (string)
1720 %a Extracted name of the poster (string)
1721 %A Extracted address of the poster (string)
1722 %F Contents of the From: header (string)
1723 %x Contents of the Xref: header (string)
1724 %D Date of the article (string)
1725 %d Date of the article (string) in DD-MMM format
1726 %M Message-id of the article (string)
1727 %r References of the article (string)
1728 %c Number of characters in the article (integer)
1729 %L Number of lines in the article (integer)
1730 %I Indentation based on thread level (a string of spaces)
1731 %T A string with two possible values: 80 spaces if the article
1732 is on thread level two or larger and 0 spaces on level one
1733 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1734 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1735 %[ Opening bracket (character, \"[\" or \"<\")
1736 %] Closing bracket (character, \"]\" or \">\")
1737 %> Spaces of length thread-level (string)
1738 %< Spaces of length (- 20 thread-level) (string)
1739 %i Article score (number)
1740 %z Article zcore (character)
1741 %t Number of articles under the current thread (number).
1742 %e Whether the thread is empty or not (character).
1743 %l GroupLens score (string).
1744 %V Total thread score (number).
1745 %P The line number (number).
1746 %O Download mark (character).
1747 %u User defined specifier. The next character in the format string should
1748 be a letter. Gnus will call the function gnus-user-format-function-X,
1749 where X is the letter following %u. The function will be passed the
1750 current header as argument. The function should return a string, which
1751 will be inserted into the summary just like information from any other
1754 Text between %( and %) will be highlighted with `gnus-mouse-face'
1755 when the mouse point is placed inside the area. There can only be one
1758 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1759 with care. For reasons of efficiency, Gnus will compute what column
1760 these characters will end up in, and \"hard-code\" that. This means that
1761 it is illegal to have these specs after a variable-length spec. Well,
1762 you might not be arrested, but your summary buffer will look strange,
1763 which is bad enough.
1765 The smart choice is to have these specs as for to the left as
1768 This restriction may disappear in later versions of Gnus."
1770 :group 'gnus-summary-format)
1773 ;;; Skeleton keymaps
1776 (defun gnus-suppress-keymap (keymap)
1777 (suppress-keymap keymap)
1778 (let ((keys `([delete] "\177" "\M-u"))) ;gnus-mouse-2
1780 (define-key keymap (pop keys) 'undefined))))
1782 (defvar gnus-article-mode-map
1783 (let ((keymap (make-keymap)))
1784 (gnus-suppress-keymap keymap)
1786 (defvar gnus-summary-mode-map
1787 (let ((keymap (make-keymap)))
1788 (gnus-suppress-keymap keymap)
1790 (defvar gnus-group-mode-map
1791 (let ((keymap (make-keymap)))
1792 (gnus-suppress-keymap keymap)
1797 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1798 ;; If you want the cursor to go somewhere else, set these two
1799 ;; functions in some startup hook to whatever you want.
1800 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1801 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1803 ;;; Various macros and substs.
1805 (defun gnus-header-from (header)
1806 (mail-header-from header))
1808 (defmacro gnus-gethash (string hashtable)
1809 "Get hash value of STRING in HASHTABLE."
1810 `(symbol-value (intern-soft ,string ,hashtable)))
1812 (defmacro gnus-sethash (string value hashtable)
1813 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1814 `(set (intern ,string ,hashtable) ,value))
1815 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1817 (defmacro gnus-group-unread (group)
1818 "Get the currently computed number of unread articles in GROUP."
1819 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1821 (defmacro gnus-group-entry (group)
1822 "Get the newsrc entry for GROUP."
1823 `(gnus-gethash ,group gnus-newsrc-hashtb))
1825 (defmacro gnus-active (group)
1826 "Get active info on GROUP."
1827 `(gnus-gethash ,group gnus-active-hashtb))
1829 (defmacro gnus-set-active (group active)
1830 "Set GROUP's active info."
1831 `(gnus-sethash ,group ,active gnus-active-hashtb))
1833 (defun gnus-alive-p ()
1834 "Say whether Gnus is running or not."
1835 (and gnus-group-buffer
1836 (get-buffer gnus-group-buffer)
1838 (set-buffer gnus-group-buffer)
1839 (eq major-mode 'gnus-group-mode))))
1841 ;; Info access macros.
1843 (defmacro gnus-info-group (info)
1845 (defmacro gnus-info-rank (info)
1847 (defmacro gnus-info-read (info)
1849 (defmacro gnus-info-marks (info)
1851 (defmacro gnus-info-method (info)
1853 (defmacro gnus-info-params (info)
1856 (defmacro gnus-info-level (info)
1857 `(let ((rank (gnus-info-rank ,info)))
1861 (defmacro gnus-info-score (info)
1862 `(let ((rank (gnus-info-rank ,info)))
1863 (or (and (consp rank) (cdr rank)) 0)))
1865 (defmacro gnus-info-set-group (info group)
1866 `(setcar ,info ,group))
1867 (defmacro gnus-info-set-rank (info rank)
1868 `(setcar (nthcdr 1 ,info) ,rank))
1869 (defmacro gnus-info-set-read (info read)
1870 `(setcar (nthcdr 2 ,info) ,read))
1871 (defmacro gnus-info-set-marks (info marks &optional extend)
1873 `(gnus-info-set-entry ,info ,marks 3)
1874 `(setcar (nthcdr 3 ,info) ,marks)))
1875 (defmacro gnus-info-set-method (info method &optional extend)
1877 `(gnus-info-set-entry ,info ,method 4)
1878 `(setcar (nthcdr 4 ,info) ,method)))
1879 (defmacro gnus-info-set-params (info params &optional extend)
1881 `(gnus-info-set-entry ,info ,params 5)
1882 `(setcar (nthcdr 5 ,info) ,params)))
1884 (defun gnus-info-set-entry (info entry number)
1885 ;; Extend the info until we have enough elements.
1886 (while (<= (length info) number)
1887 (nconc info (list nil)))
1889 (setcar (nthcdr number info) entry))
1891 (defmacro gnus-info-set-level (info level)
1892 `(let ((rank (cdr ,info)))
1893 (if (consp (car rank))
1894 (setcar (car rank) ,level)
1895 (setcar rank ,level))))
1896 (defmacro gnus-info-set-score (info score)
1897 `(let ((rank (cdr ,info)))
1898 (if (consp (car rank))
1899 (setcdr (car rank) ,score)
1900 (setcar rank (cons (car rank) ,score)))))
1902 (defmacro gnus-get-info (group)
1903 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1905 ;; Byte-compiler warning.
1906 (defvar gnus-visual)
1907 ;; Find out whether the gnus-visual TYPE is wanted.
1908 (defun gnus-visual-p (&optional type class)
1909 (and gnus-visual ; Has to be non-nil, at least.
1910 (if (not type) ; We don't care about type.
1912 (if (listp gnus-visual) ; It's a list, so we check it.
1913 (or (memq type gnus-visual)
1914 (memq class gnus-visual))
1917 ;;; Load the compatability functions.
1926 (defvar gnus-shutdown-alist nil)
1928 (defun gnus-add-shutdown (function &rest symbols)
1929 "Run FUNCTION whenever one of SYMBOLS is shut down."
1930 (push (cons function symbols) gnus-shutdown-alist))
1932 (defun gnus-shutdown (symbol)
1933 "Shut down everything that waits for SYMBOL."
1934 (let ((alist gnus-shutdown-alist)
1936 (while (setq entry (pop alist))
1937 (when (memq symbol (cdr entry))
1938 (funcall (car entry))))))
1942 ;;; Gnus Utility Functions
1945 (defmacro gnus-string-or (&rest strings)
1946 "Return the first element of STRINGS that is a non-blank string.
1947 STRINGS will be evaluated in normal `or' order."
1948 `(gnus-string-or-1 ',strings))
1950 (defun gnus-string-or-1 (strings)
1953 (setq string (eval (pop strings)))
1954 (if (string-match "^[ \t]*$" string)
1956 (setq strings nil)))
1959 ;; Add the current buffer to the list of buffers to be killed on exit.
1960 (defun gnus-add-current-to-buffer-list ()
1961 (or (memq (current-buffer) gnus-buffer-list)
1962 (push (current-buffer) gnus-buffer-list)))
1964 (defun gnus-version (&optional arg)
1965 "Version number of this version of Gnus.
1966 If ARG, insert string at point."
1968 (let ((methods gnus-valid-select-methods)
1971 ;; Go through all the legal select methods and add their version
1972 ;; numbers to the total version string. Only the backends that are
1973 ;; currently in use will have their message numbers taken into
1976 (setq meth (intern (concat (caar methods) "-version")))
1978 (stringp (symbol-value meth))
1979 (setq mess (concat mess "; " (symbol-value meth))))
1980 (setq methods (cdr methods)))
1982 (insert (message mess))
1985 (defun gnus-continuum-version (version)
1986 "Return VERSION as a floating point number."
1987 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
1988 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
1989 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1990 (number (match-string 2 version))
1992 (string-match "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
1993 (setq major (string-to-number (match-string 1 number)))
1994 (setq minor (string-to-number (match-string 2 number)))
1995 (setq least (if (match-beginning 3)
1996 (string-to-number (match-string 3 number))
2000 (format "%s00%02d%02d"
2002 ((member alpha '("(ding)" "d")) "4.99")
2003 ((member alpha '("September" "s")) "5.01")
2004 ((member alpha '("Red" "r")) "5.03"))
2006 (format "%d.%02d%02d" major minor least))))))
2008 (defun gnus-info-find-node ()
2009 "Find Info documentation of Gnus."
2011 ;; Enlarge info window if needed.
2012 (let (gnus-info-buffer)
2013 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2014 (setq gnus-info-buffer (current-buffer))
2015 (gnus-configure-windows 'info)))
2017 ;;; More various functions.
2019 (defsubst gnus-check-backend-function (func group)
2020 "Check whether GROUP supports function FUNC.
2021 GROUP can either be a string (a group name) or a select method."
2023 (let ((method (if (stringp group)
2024 (car (gnus-find-method-for-group group))
2026 (unless (featurep method)
2028 (fboundp (intern (format "%s-%s" method func))))))
2030 (defun gnus-group-read-only-p (&optional group)
2031 "Check whether GROUP supports editing or not.
2032 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2033 that that variable is buffer-local to the summary buffers."
2034 (let ((group (or group gnus-newsgroup-name)))
2035 (not (gnus-check-backend-function 'request-replace-article group))))
2037 (defun gnus-group-total-expirable-p (group)
2038 "Check whether GROUP is total-expirable or not."
2039 (let ((params (gnus-group-find-parameter group))
2042 ((memq 'total-expire params)
2044 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2046 (gnus-total-expirable-newsgroups ; Check var.
2047 (string-match gnus-total-expirable-newsgroups group)))))
2049 (defun gnus-group-auto-expirable-p (group)
2050 "Check whether GROUP is auto-expirable or not."
2051 (let ((params (gnus-group-find-parameter group))
2054 ((memq 'auto-expire params)
2056 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2058 (gnus-auto-expirable-newsgroups ; Check var.
2059 (string-match gnus-auto-expirable-newsgroups group)))))
2061 (defun gnus-virtual-group-p (group)
2062 "Say whether GROUP is virtual or not."
2063 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2064 gnus-valid-select-methods)))
2066 (defun gnus-news-group-p (group &optional article)
2067 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2068 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2069 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2070 (eq (gnus-request-type group article) 'news))))
2072 ;; Returns a list of writable groups.
2073 (defun gnus-writable-groups ()
2074 (let ((alist gnus-newsrc-alist)
2076 (while (setq group (car (pop alist)))
2077 (unless (gnus-group-read-only-p group)
2078 (push group groups)))
2081 ;; Check whether to use long file names.
2082 (defun gnus-use-long-file-name (symbol)
2083 ;; The variable has to be set...
2084 (and gnus-use-long-file-name
2085 ;; If it isn't a list, then we return t.
2086 (or (not (listp gnus-use-long-file-name))
2087 ;; If it is a list, and the list contains `symbol', we
2089 (not (memq symbol gnus-use-long-file-name)))))
2091 ;; Generate a unique new group name.
2092 (defun gnus-generate-new-group-name (leaf)
2095 (while (gnus-gethash name gnus-newsrc-hashtb)
2096 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2099 (defun gnus-ephemeral-group-p (group)
2100 "Say whether GROUP is ephemeral or not."
2101 (gnus-group-get-parameter group 'quit-config))
2103 (defun gnus-group-quit-config (group)
2104 "Return the quit-config of GROUP."
2105 (gnus-group-get-parameter group 'quit-config))
2107 (defun gnus-kill-ephemeral-group (group)
2108 "Remove ephemeral GROUP from relevant structures."
2109 (gnus-sethash group nil gnus-newsrc-hashtb))
2111 (defun gnus-simplify-mode-line ()
2112 "Make mode lines a bit simpler."
2113 (setq mode-line-modified (cdr gnus-mode-line-modified))
2114 (when (listp mode-line-format)
2115 (make-local-variable 'mode-line-format)
2116 (setq mode-line-format (copy-sequence mode-line-format))
2117 (when (equal (nth 3 mode-line-format) " ")
2118 (setcar (nthcdr 3 mode-line-format) " "))))
2120 ;;; Servers and groups.
2122 (defsubst gnus-server-add-address (method)
2123 (let ((method-name (symbol-name (car method))))
2124 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2125 (not (assq (intern (concat method-name "-address")) method))
2126 (memq 'physical-address (assq (car method)
2127 gnus-valid-select-methods)))
2128 (append method (list (list (intern (concat method-name "-address"))
2132 (defsubst gnus-server-get-method (group method)
2133 ;; Input either a server name, and extended server name, or a
2134 ;; select method, and return a select method.
2135 (cond ((stringp method)
2136 (gnus-server-to-method method))
2137 ((equal method gnus-select-method)
2139 ((and (stringp (car method)) group)
2140 (gnus-server-extend-method group method))
2141 ((and method (not group)
2142 (equal (cadr method) ""))
2145 (gnus-server-add-address method))))
2147 (defun gnus-server-to-method (server)
2148 "Map virtual server names to select methods."
2150 ;; Is this a method, perhaps?
2151 (and server (listp server) server)
2152 ;; Perhaps this is the native server?
2153 (and (equal server "native") gnus-select-method)
2154 ;; It should be in the server alist.
2155 (cdr (assoc server gnus-server-alist))
2156 ;; It could be in the predefined server alist.
2157 (cdr (assoc server gnus-predefined-server-alist))
2158 ;; If not, we look through all the opened server
2159 ;; to see whether we can find it there.
2160 (let ((opened gnus-opened-servers))
2162 (not (equal server (format "%s:%s" (caaar opened)
2167 (defmacro gnus-method-equal (ss1 ss2)
2168 "Say whether two servers are equal."
2172 (and (= (length s1) (length s2))
2174 (while (and s1 (member (car s1) s2))
2178 (defun gnus-server-equal (m1 m2)
2179 "Say whether two methods are equal."
2180 (let ((m1 (cond ((null m1) gnus-select-method)
2181 ((stringp m1) (gnus-server-to-method m1))
2183 (m2 (cond ((null m2) gnus-select-method)
2184 ((stringp m2) (gnus-server-to-method m2))
2186 (gnus-method-equal m1 m2)))
2188 (defun gnus-servers-using-backend (backend)
2189 "Return a list of known servers using BACKEND."
2190 (let ((opened gnus-opened-servers)
2193 (when (eq backend (caaar opened))
2194 (push (caar opened) out))
2198 (defun gnus-archive-server-wanted-p ()
2199 "Say whether the user wants to use the archive server."
2201 ((or (not gnus-message-archive-method)
2202 (not gnus-message-archive-group))
2204 ((and gnus-message-archive-method gnus-message-archive-group)
2207 (let ((active (cadr (assq 'nnfolder-active-file
2208 gnus-message-archive-method))))
2210 (file-exists-p active))))))
2212 (defun gnus-group-prefixed-name (group method)
2213 "Return the whole name from GROUP and METHOD."
2214 (and (stringp method) (setq method (gnus-server-to-method method)))
2217 (concat (format "%s" (car method))
2219 (or (assoc (format "%s" (car method))
2220 (gnus-methods-using 'address))
2221 (gnus-server-equal method gnus-message-archive-method))
2223 (not (string= (nth 1 method) "")))
2224 (concat "+" (nth 1 method)))
2227 (defun gnus-group-real-prefix (group)
2228 "Return the prefix of the current group name."
2229 (if (string-match "^[^:]+:" group)
2230 (substring group 0 (match-end 0))
2233 (defun gnus-group-method (group)
2234 "Return the server or method used for selecting GROUP.
2235 You should probably use `gnus-find-method-for-group' instead."
2236 (let ((prefix (gnus-group-real-prefix group)))
2237 (if (equal prefix "")
2239 (let ((servers gnus-opened-servers)
2241 backend possible found)
2242 (if (string-match "^[^\\+]+\\+" prefix)
2243 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2244 server (substring prefix (match-end 0) (1- (length prefix))))
2245 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2247 (when (eq (caaar servers) backend)
2248 (setq possible (caar servers))
2249 (when (equal (cadaar servers) server)
2250 (setq found (caar servers))))
2252 (or (car (rassoc found gnus-server-alist))
2254 (car (rassoc possible gnus-server-alist))
2256 (list backend server))))))
2258 (defsubst gnus-secondary-method-p (method)
2259 "Return whether METHOD is a secondary select method."
2260 (let ((methods gnus-secondary-select-methods)
2261 (gmethod (gnus-server-get-method nil method)))
2263 (not (equal (gnus-server-get-method nil (car methods))
2265 (setq methods (cdr methods)))
2268 (defun gnus-groups-from-server (server)
2269 "Return a list of all groups that are fetched from SERVER."
2270 (let ((alist (cdr gnus-newsrc-alist))
2272 (while (setq info (pop alist))
2273 (when (gnus-server-equal (gnus-info-method info) server)
2274 (push (gnus-info-group info) groups)))
2275 (sort groups 'string<)))
2277 (defun gnus-group-foreign-p (group)
2278 "Say whether a group is foreign or not."
2279 (and (not (gnus-group-native-p group))
2280 (not (gnus-group-secondary-p group))))
2282 (defun gnus-group-native-p (group)
2283 "Say whether the group is native or not."
2284 (not (string-match ":" group)))
2286 (defun gnus-group-secondary-p (group)
2287 "Say whether the group is secondary or not."
2288 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2290 (defun gnus-group-find-parameter (group &optional symbol)
2291 "Return the group parameters for GROUP.
2292 If SYMBOL, return the value of that symbol in the group parameters."
2294 (set-buffer gnus-group-buffer)
2295 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2297 (gnus-group-parameter-value parameters symbol)
2300 (defun gnus-group-get-parameter (group &optional symbol)
2301 "Return the group parameters for GROUP.
2302 If SYMBOL, return the value of that symbol in the group parameters."
2303 (let ((params (gnus-info-params (gnus-get-info group))))
2305 (gnus-group-parameter-value params symbol)
2308 (defun gnus-group-parameter-value (params symbol)
2309 "Return the value of SYMBOL in group PARAMS."
2310 (or (car (memq symbol params)) ; It's either a simple symbol
2311 (cdr (assq symbol params)))) ; or a cons.
2313 (defun gnus-group-add-parameter (group param)
2314 "Add parameter PARAM to GROUP."
2315 (let ((info (gnus-get-info group)))
2317 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2318 ;; Cons the new param to the old one and update.
2319 (gnus-group-set-info (cons param (gnus-info-params info))
2322 (defun gnus-group-set-parameter (group name value)
2323 "Set parameter NAME to VALUE in GROUP."
2324 (let ((info (gnus-get-info group)))
2326 (gnus-group-remove-parameter group name)
2327 (let ((old-params (gnus-info-params info))
2328 (new-params (list (cons name value))))
2330 (when (or (not (listp (car old-params)))
2331 (not (eq (caar old-params) name)))
2332 (setq new-params (append new-params (list (car old-params)))))
2333 (setq old-params (cdr old-params)))
2334 (gnus-group-set-info new-params group 'params)))))
2336 (defun gnus-group-remove-parameter (group name)
2337 "Remove parameter NAME from GROUP."
2338 (let ((info (gnus-get-info group)))
2340 (let ((params (gnus-info-params info)))
2342 (setq params (delq name params))
2343 (while (assq name params)
2344 (setq params (delq (assq name params) params)))
2345 (gnus-info-set-params info params))))))
2347 (defun gnus-group-add-score (group &optional score)
2348 "Add SCORE to the GROUP score.
2349 If SCORE is nil, add 1 to the score of GROUP."
2350 (let ((info (gnus-get-info group)))
2352 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2354 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2355 (defun gnus-short-group-name (group &optional levels)
2356 "Collapse GROUP name LEVELS.
2357 Select methods are stripped and any remote host name is stripped down to
2358 just the host name."
2359 (let* ((name "") (foreign "") (depth -1) (skip 1)
2362 (while (string-match "\\." group skip)
2363 (setq skip (match-end 0)
2366 ;; separate foreign select method from group name and collapse.
2367 ;; if method contains a server, collapse to non-domain server name,
2368 ;; otherwise collapse to select method
2369 (when (string-match ":" group)
2370 (cond ((string-match "+" group)
2371 (let* ((plus (string-match "+" group))
2372 (colon (string-match ":" group (or plus 0)))
2373 (dot (string-match "\\." group)))
2374 (setq foreign (concat
2375 (substring group (+ 1 plus)
2376 (cond ((null dot) colon)
2377 ((< colon dot) colon)
2378 ((< dot colon) dot)))
2380 group (substring group (+ 1 colon)))))
2382 (let* ((colon (string-match ":" group)))
2383 (setq foreign (concat (substring group 0 (+ 1 colon)))
2384 group (substring group (+ 1 colon)))))))
2385 ;; collapse group name leaving LEVELS uncollapsed elements
2387 (if (and (string-match "\\." group) (> levels 0))
2388 (setq name (concat name (substring group 0 1))
2389 group (substring group (match-end 0))
2391 name (concat name "."))
2392 (setq name (concat foreign name group)
2396 (defun gnus-narrow-to-body ()
2397 "Narrow to the body of an article."
2400 (goto-char (point-min))
2401 (or (search-forward "\n\n" nil t)
2407 ;;; Kill file handling.
2410 (defun gnus-apply-kill-file ()
2411 "Apply a kill file to the current newsgroup.
2412 Returns the number of articles marked as read."
2413 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2414 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2415 (gnus-apply-kill-file-internal)
2418 (defun gnus-kill-save-kill-buffer ()
2419 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2420 (when (get-file-buffer file)
2422 (set-buffer (get-file-buffer file))
2423 (when (buffer-modified-p)
2425 (kill-buffer (current-buffer))))))
2427 (defcustom gnus-kill-file-name "KILL"
2428 "Suffix of the kill files."
2429 :group 'gnus-score-kill
2430 :group 'gnus-score-files
2433 (defun gnus-newsgroup-kill-file (newsgroup)
2434 "Return the name of a kill file name for NEWSGROUP.
2435 If NEWSGROUP is nil, return the global kill file name instead."
2437 ;; The global KILL file is placed at top of the directory.
2438 ((or (null newsgroup)
2439 (string-equal newsgroup ""))
2440 (expand-file-name gnus-kill-file-name
2441 gnus-kill-files-directory))
2442 ;; Append ".KILL" to newsgroup name.
2443 ((gnus-use-long-file-name 'not-kill)
2444 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2445 "." gnus-kill-file-name)
2446 gnus-kill-files-directory))
2447 ;; Place "KILL" under the hierarchical directory.
2449 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2450 "/" gnus-kill-file-name)
2451 gnus-kill-files-directory))))
2455 (defun gnus-member-of-valid (symbol group)
2456 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2458 (symbol-name (car (gnus-find-method-for-group group)))
2459 gnus-valid-select-methods)))
2461 (defun gnus-method-option-p (method option)
2462 "Return non-nil if select METHOD has OPTION as a parameter."
2463 (when (stringp method)
2464 (setq method (gnus-server-to-method method)))
2465 (memq option (assoc (format "%s" (car method))
2466 gnus-valid-select-methods)))
2468 (defun gnus-similar-server-opened (method)
2469 (let ((opened gnus-opened-servers))
2470 (while (and method opened)
2471 (when (and (equal (cadr method) (cadaar opened))
2472 (not (equal method (caar opened))))
2477 (defun gnus-server-extend-method (group method)
2478 ;; This function "extends" a virtual server. If the server is
2479 ;; "hello", and the select method is ("hello" (my-var "something"))
2480 ;; in the group "alt.alt", this will result in a new virtual server
2481 ;; called "hello+alt.alt".
2482 (if (or (not (inline (gnus-similar-server-opened method)))
2483 (not (cddr method)))
2485 `(,(car method) ,(concat (cadr method) "+" group)
2486 (,(intern (format "%s-address" (car method))) ,(cadr method))
2489 (defun gnus-server-status (method)
2490 "Return the status of METHOD."
2491 (nth 1 (assoc method gnus-opened-servers)))
2493 (defun gnus-group-name-to-method (group)
2494 "Guess a select method based on GROUP."
2495 (if (string-match ":" group)
2496 (let ((server (substring group 0 (match-beginning 0))))
2497 (if (string-match "\\+" server)
2498 (list (intern (substring server 0 (match-beginning 0)))
2499 (substring server (match-end 0)))
2500 (list (intern server) "")))
2501 gnus-select-method))
2503 (defun gnus-find-method-for-group (group &optional info)
2504 "Find the select method that GROUP uses."
2505 (or gnus-override-method
2508 (let ((info (or info (gnus-get-info group)))
2511 (not (setq method (gnus-info-method info)))
2512 (equal method "native"))
2515 (cond ((stringp method)
2516 (inline (gnus-server-to-method method)))
2517 ((stringp (cadr method))
2518 (inline (gnus-server-extend-method group method)))
2521 (cond ((equal (cadr method) "")
2523 ((null (cadr method))
2524 (list (car method) ""))
2526 (gnus-server-add-address method)))))))
2528 (defun gnus-methods-using (feature)
2529 "Find all methods that have FEATURE."
2530 (let ((valids gnus-valid-select-methods)
2533 (when (memq feature (car valids))
2534 (push (car valids) outs))
2535 (setq valids (cdr valids)))
2538 (defun gnus-read-group (prompt &optional default)
2539 "Prompt the user for a group name.
2540 Disallow illegal group names."
2546 (setq group (read-string (concat prefix prompt)
2547 (cons (or default "") 0)
2548 'gnus-group-history)))
2549 (setq prefix (format "Illegal group name: \"%s\". " group)
2553 (defun gnus-read-method (prompt)
2554 "Prompt the user for a method.
2555 Allow completion over sensible values."
2558 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2560 nil t nil 'gnus-method-history)))
2563 (setq method gnus-select-method))
2564 ((assoc method gnus-valid-select-methods)
2565 (list (intern method)
2566 (if (memq 'prompt-address
2567 (assoc method gnus-valid-select-methods))
2568 (read-string "Address: ")
2570 ((assoc method gnus-server-alist)
2573 (list (intern method) "")))))
2575 ;;; User-level commands.
2578 (defun gnus-slave-no-server (&optional arg)
2579 "Read network news as a slave, without connecting to local server"
2581 (gnus-no-server arg t))
2584 (defun gnus-no-server (&optional arg slave)
2586 If ARG is a positive number, Gnus will use that as the
2587 startup level. If ARG is nil, Gnus will be started at level 2.
2588 If ARG is non-nil and not a positive number, Gnus will
2589 prompt the user for the name of an NNTP server to use.
2590 As opposed to `gnus', this command will not connect to the local server."
2592 (gnus-no-server-1 arg slave))
2595 (defun gnus-slave (&optional arg)
2596 "Read news as a slave."
2598 (gnus arg nil 'slave))
2601 (defun gnus-other-frame (&optional arg)
2602 "Pop up a frame to read news."
2604 (let ((window (get-buffer-window gnus-group-buffer)))
2606 (select-frame (window-frame window)))
2607 ((= (length (frame-list)) 1)
2608 (select-frame (make-frame)))
2614 (defun gnus (&optional arg dont-connect slave)
2616 If ARG is non-nil and a positive number, Gnus will use that as the
2617 startup level. If ARG is non-nil and not a positive number, Gnus will
2618 prompt the user for the name of an NNTP server to use."
2620 (gnus-1 arg dont-connect slave))
2622 ;; Allow redefinition of Gnus functions.
2628 ;;; gnus.el ends here