1 ;;; gnus.el --- a newsreader for GNU Emacs
2 ;; Copyright (C) 1987-1990,1993-1999 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-charset nil
45 "Group character set issues."
46 :link '(custom-manual "(gnus)Charsets")
49 (defgroup gnus-cache nil
53 (defgroup gnus-start nil
54 "Starting your favorite newsreader."
57 (defgroup gnus-start-server nil
58 "Server options at startup."
61 ;; These belong to gnus-group.el.
62 (defgroup gnus-group nil
64 :link '(custom-manual "(gnus)The Group Buffer")
67 (defgroup gnus-group-foreign nil
69 :link '(custom-manual "(gnus)Foreign Groups")
72 (defgroup gnus-group-new nil
73 "Automatic subscription of new groups."
76 (defgroup gnus-group-levels nil
78 :link '(custom-manual "(gnus)Group Levels")
81 (defgroup gnus-group-select nil
83 :link '(custom-manual "(gnus)Selecting a Group")
86 (defgroup gnus-group-listing nil
87 "Showing slices of the group list."
88 :link '(custom-manual "(gnus)Listing Groups")
91 (defgroup gnus-group-visual nil
92 "Sorting the group buffer."
93 :link '(custom-manual "(gnus)Group Buffer Format")
97 (defgroup gnus-group-various nil
98 "Various group options."
99 :link '(custom-manual "(gnus)Scanning New Messages")
102 ;; These belong to gnus-sum.el.
103 (defgroup gnus-summary nil
105 :link '(custom-manual "(gnus)The Summary Buffer")
108 (defgroup gnus-summary-exit nil
109 "Leaving summary buffers."
110 :link '(custom-manual "(gnus)Exiting the Summary Buffer")
111 :group 'gnus-summary)
113 (defgroup gnus-summary-marks nil
114 "Marks used in summary buffers."
115 :link '(custom-manual "(gnus)Marking Articles")
116 :group 'gnus-summary)
118 (defgroup gnus-thread nil
119 "Ordering articles according to replies."
120 :link '(custom-manual "(gnus)Threading")
121 :group 'gnus-summary)
123 (defgroup gnus-summary-format nil
124 "Formatting of the summary buffer."
125 :link '(custom-manual "(gnus)Summary Buffer Format")
126 :group 'gnus-summary)
128 (defgroup gnus-summary-choose nil
130 :link '(custom-manual "(gnus)Choosing Articles")
131 :group 'gnus-summary)
133 (defgroup gnus-summary-maneuvering nil
134 "Summary movement commands."
135 :link '(custom-manual "(gnus)Summary Maneuvering")
136 :group 'gnus-summary)
138 (defgroup gnus-summary-mail nil
139 "Mail group commands."
140 :link '(custom-manual "(gnus)Mail Group Commands")
141 :group 'gnus-summary)
143 (defgroup gnus-summary-sort nil
144 "Sorting the summary buffer."
145 :link '(custom-manual "(gnus)Sorting")
146 :group 'gnus-summary)
148 (defgroup gnus-summary-visual nil
149 "Highlighting and menus in the summary buffer."
150 :link '(custom-manual "(gnus)Summary Highlighting")
152 :group 'gnus-summary)
154 (defgroup gnus-summary-various nil
155 "Various summary buffer options."
156 :link '(custom-manual "(gnus)Various Summary Stuff")
157 :group 'gnus-summary)
159 (defgroup gnus-summary-pick nil
160 "Pick mode in the summary buffer."
161 :link '(custom-manual "(gnus)Pick and Read")
163 :group 'gnus-summary)
165 (defgroup gnus-summary-tree nil
166 "Tree display of threads in the summary buffer."
167 :link '(custom-manual "(gnus)Tree Display")
169 :group 'gnus-summary)
171 ;; Belongs to gnus-uu.el
172 (defgroup gnus-extract-view nil
173 "Viewing extracted files."
174 :link '(custom-manual "(gnus)Viewing Files")
175 :group 'gnus-extract)
177 ;; Belongs to gnus-score.el
178 (defgroup gnus-score nil
179 "Score and kill file handling."
182 (defgroup gnus-score-kill nil
186 (defgroup gnus-score-adapt nil
187 "Adaptive score files."
190 (defgroup gnus-score-default nil
191 "Default values for score files."
194 (defgroup gnus-score-expire nil
195 "Expiring score rules."
198 (defgroup gnus-score-decay nil
199 "Decaying score rules."
202 (defgroup gnus-score-files nil
203 "Score and kill file names."
207 (defgroup gnus-score-various nil
208 "Various scoring and killing options."
212 (defgroup gnus-visual nil
213 "Options controling the visual fluff."
217 (defgroup gnus-agent nil
218 "Offline support for Gnus."
221 (defgroup gnus-files nil
222 "Files used by Gnus."
225 (defgroup gnus-dribble-file nil
227 :link '(custom-manual "(gnus)Auto Save")
230 (defgroup gnus-newsrc nil
231 "Storing Gnus state."
234 (defgroup gnus-server nil
235 "Options related to newsservers and other servers used by Gnus."
238 (defgroup gnus-message '((message custom-group))
239 "Composing replies and followups in Gnus."
242 (defgroup gnus-meta nil
243 "Meta variables controling major portions of Gnus.
244 In general, modifying these variables does not take affect until Gnus
245 is restarted, and sometimes reloaded."
248 (defgroup gnus-various nil
249 "Other Gnus options."
250 :link '(custom-manual "(gnus)Various Various")
253 (defgroup gnus-mime nil
254 "Variables for controlling the Gnus MIME interface."
257 (defgroup gnus-exit nil
259 :link '(custom-manual "(gnus)Exiting Gnus")
262 (defconst gnus-version-number "0.76"
263 "Version number for this version of Gnus.")
265 (defconst gnus-version (format "Pterodactyl Gnus v%s" gnus-version-number)
266 "Version string for this version of Gnus.")
268 (defcustom gnus-inhibit-startup-message nil
269 "If non-nil, the startup message will not be displayed.
270 This variable is used before `.gnus.el' is loaded, so it should
271 be set in `.emacs' instead."
275 (defcustom gnus-play-startup-jingle nil
276 "If non-nil, play the Gnus jingle at startup."
280 (unless (featurep 'gnus-xmas)
281 (defalias 'gnus-make-overlay 'make-overlay)
282 (defalias 'gnus-delete-overlay 'delete-overlay)
283 (defalias 'gnus-overlay-put 'overlay-put)
284 (defalias 'gnus-move-overlay 'move-overlay)
285 (defalias 'gnus-overlay-end 'overlay-end)
286 (defalias 'gnus-extent-detached-p 'ignore)
287 (defalias 'gnus-extent-start-open 'ignore)
288 (defalias 'gnus-set-text-properties 'set-text-properties)
289 (defalias 'gnus-group-remove-excess-properties 'ignore)
290 (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
291 (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
292 (defalias 'gnus-character-to-event 'identity)
293 (defalias 'gnus-add-text-properties 'add-text-properties)
294 (defalias 'gnus-put-text-property 'put-text-property)
295 (defalias 'gnus-mode-line-buffer-identification 'identity)
296 (defalias 'gnus-characterp 'numberp)
297 (defalias 'gnus-deactivate-mark 'deactivate-mark)
298 (defalias 'gnus-window-edges 'window-edges)
299 (defalias 'gnus-key-press-event-p 'numberp)
300 (defalias 'gnus-decode-rfc1522 'ignore))
302 ;; We define these group faces here to avoid the display
303 ;; update forced when creating new faces.
305 (defface gnus-group-news-1-face
308 (:foreground "PaleTurquoise" :bold t))
311 (:foreground "ForestGreen" :bold t))
314 "Level 1 newsgroup face.")
316 (defface gnus-group-news-1-empty-face
319 (:foreground "PaleTurquoise"))
322 (:foreground "ForestGreen"))
325 "Level 1 empty newsgroup face.")
327 (defface gnus-group-news-2-face
330 (:foreground "turquoise" :bold t))
333 (:foreground "CadetBlue4" :bold t))
336 "Level 2 newsgroup face.")
338 (defface gnus-group-news-2-empty-face
341 (:foreground "turquoise"))
344 (:foreground "CadetBlue4"))
347 "Level 2 empty newsgroup face.")
349 (defface gnus-group-news-3-face
358 "Level 3 newsgroup face.")
360 (defface gnus-group-news-3-empty-face
369 "Level 3 empty newsgroup face.")
371 (defface gnus-group-news-4-face
380 "Level 4 newsgroup face.")
382 (defface gnus-group-news-4-empty-face
391 "Level 4 empty newsgroup face.")
393 (defface gnus-group-news-5-face
402 "Level 5 newsgroup face.")
404 (defface gnus-group-news-5-empty-face
413 "Level 5 empty newsgroup face.")
415 (defface gnus-group-news-6-face
424 "Level 6 newsgroup face.")
426 (defface gnus-group-news-6-empty-face
435 "Level 6 empty newsgroup face.")
437 (defface gnus-group-news-low-face
440 (:foreground "DarkTurquoise" :bold t))
443 (:foreground "DarkGreen" :bold t))
446 "Low level newsgroup face.")
448 (defface gnus-group-news-low-empty-face
451 (:foreground "DarkTurquoise"))
454 (:foreground "DarkGreen"))
457 "Low level empty newsgroup face.")
459 (defface gnus-group-mail-1-face
462 (:foreground "aquamarine1" :bold t))
465 (:foreground "DeepPink3" :bold t))
468 "Level 1 mailgroup face.")
470 (defface gnus-group-mail-1-empty-face
473 (:foreground "aquamarine1"))
476 (:foreground "DeepPink3"))
478 (:italic t :bold t)))
479 "Level 1 empty mailgroup face.")
481 (defface gnus-group-mail-2-face
484 (:foreground "aquamarine2" :bold t))
487 (:foreground "HotPink3" :bold t))
490 "Level 2 mailgroup face.")
492 (defface gnus-group-mail-2-empty-face
495 (:foreground "aquamarine2"))
498 (:foreground "HotPink3"))
501 "Level 2 empty mailgroup face.")
503 (defface gnus-group-mail-3-face
506 (:foreground "aquamarine3" :bold t))
509 (:foreground "magenta4" :bold t))
512 "Level 3 mailgroup face.")
514 (defface gnus-group-mail-3-empty-face
517 (:foreground "aquamarine3"))
520 (:foreground "magenta4"))
523 "Level 3 empty mailgroup face.")
525 (defface gnus-group-mail-low-face
528 (:foreground "aquamarine4" :bold t))
531 (:foreground "DeepPink4" :bold t))
534 "Low level mailgroup face.")
536 (defface gnus-group-mail-low-empty-face
539 (:foreground "aquamarine4"))
542 (:foreground "DeepPink4"))
545 "Low level empty mailgroup face.")
547 ;; Summary mode faces.
549 (defface gnus-summary-selected-face '((t
551 "Face used for selected articles.")
553 (defface gnus-summary-cancelled-face
555 (:foreground "yellow" :background "black")))
556 "Face used for cancelled articles.")
558 (defface gnus-summary-high-ticked-face
561 (:foreground "pink" :bold t))
564 (:foreground "firebrick" :bold t))
567 "Face used for high interest ticked articles.")
569 (defface gnus-summary-low-ticked-face
572 (:foreground "pink" :italic t))
575 (:foreground "firebrick" :italic t))
578 "Face used for low interest ticked articles.")
580 (defface gnus-summary-normal-ticked-face
583 (:foreground "pink"))
586 (:foreground "firebrick"))
589 "Face used for normal interest ticked articles.")
591 (defface gnus-summary-high-ancient-face
594 (:foreground "SkyBlue" :bold t))
597 (:foreground "RoyalBlue" :bold t))
600 "Face used for high interest ancient articles.")
602 (defface gnus-summary-low-ancient-face
605 (:foreground "SkyBlue" :italic t))
608 (:foreground "RoyalBlue" :italic t))
611 "Face used for low interest ancient articles.")
613 (defface gnus-summary-normal-ancient-face
616 (:foreground "SkyBlue"))
619 (:foreground "RoyalBlue"))
622 "Face used for normal interest ancient articles.")
624 (defface gnus-summary-high-unread-face
627 "Face used for high interest unread articles.")
629 (defface gnus-summary-low-unread-face
632 "Face used for low interest unread articles.")
634 (defface gnus-summary-normal-unread-face
637 "Face used for normal interest unread articles.")
639 (defface gnus-summary-high-read-face
642 (:foreground "PaleGreen"
646 (:foreground "DarkGreen"
650 "Face used for high interest read articles.")
652 (defface gnus-summary-low-read-face
655 (:foreground "PaleGreen"
659 (:foreground "DarkGreen"
663 "Face used for low interest read articles.")
665 (defface gnus-summary-normal-read-face
668 (:foreground "PaleGreen"))
671 (:foreground "DarkGreen"))
674 "Face used for normal interest read articles.")
681 (defvar gnus-buffers nil)
683 (defun gnus-get-buffer-create (name)
684 "Do the same as `get-buffer-create', but store the created buffer."
685 (or (get-buffer name)
686 (car (push (get-buffer-create name) gnus-buffers))))
688 (defun gnus-add-buffer ()
689 "Add the current buffer to the list of Gnus buffers."
690 (push (current-buffer) gnus-buffers))
692 (defun gnus-buffers ()
693 "Return a list of live Gnus buffers."
694 (while (and gnus-buffers
695 (not (buffer-name (car gnus-buffers))))
697 (let ((buffers gnus-buffers))
699 (if (buffer-name (cadr buffers))
701 (setcdr buffers (cddr buffers)))))
706 (defvar gnus-group-buffer "*Group*")
709 (autoload 'gnus-play-jingle "gnus-audio"))
711 (defface gnus-splash-face
714 (:foreground "Brown"))
717 (:foreground "Brown"))
720 "Face of the splash screen.")
722 (defun gnus-splash ()
724 (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
725 (let ((buffer-read-only nil))
727 (unless gnus-inhibit-startup-message
728 (gnus-group-startup-message)
730 (when gnus-play-startup-jingle
731 (gnus-play-jingle))))))
733 (defun gnus-indent-rigidly (start end arg)
734 "Indent rigidly using only spaces and no tabs."
737 (narrow-to-region start end)
739 (indent-rigidly start end arg)
740 ;; We translate tabs into spaces -- not everybody uses
741 ;; an 8-character tab.
742 (goto-char (point-min))
743 (while (search-forward "\t" nil t)
744 (replace-match " " t t))))))
746 (defvar gnus-simple-splash nil)
748 (defun gnus-group-startup-message (&optional x y)
749 "Insert startup message in current buffer."
750 ;; Insert the message.
755 _ ___ __ ___ __ _ ___
775 (gnus-indent-rigidly (point-min) (point-max)
776 (/ (max (- (window-width) (or x 46)) 0) 2))
777 (goto-char (point-min))
779 (let* ((pheight (count-lines (point-min) (point-max)))
780 (wheight (window-height))
781 (rest (- wheight pheight)))
782 (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
784 (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
785 (goto-char (point-min))
786 (setq mode-line-buffer-identification (concat " " gnus-version))
787 (setq gnus-simple-splash t)
788 (set-buffer-modified-p t))
791 (let ((command (format "%s" this-command)))
792 (if (and (string-match "gnus" command)
793 (not (string-match "gnus-other-frame" command)))
795 (gnus-get-buffer-create gnus-group-buffer))))
803 (defcustom gnus-home-directory "~/"
804 "Directory variable that specifies the \"home\" directory.
805 All other Gnus path variables are initialized from this variable."
809 (defcustom gnus-directory (or (getenv "SAVEDIR")
810 (nnheader-concat gnus-home-directory "News/"))
811 "*Directory variable from which all other Gnus file variables are derived.
813 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
814 This means that other directory variables that are initialized from
815 this variable won't be set properly if you set this variable in `.gnus.el'.
816 Set this variable in `.emacs' instead."
820 (defcustom gnus-default-directory nil
821 "*Default directory for all Gnus buffers."
823 :type '(choice (const :tag "current" nil)
826 ;; Site dependent variables. These variables should be defined in
829 (defvar gnus-default-nntp-server nil
830 "Specify a default NNTP server.
831 This variable should be defined in paths.el, and should never be set
833 If you want to change servers, you should use `gnus-select-method'.
834 See the documentation to that variable.")
836 ;; Don't touch this variable.
837 (defvar gnus-nntp-service "nntp"
838 "NNTP service name (\"nntp\" or 119).
839 This is an obsolete variable, which is scarcely used. If you use an
840 nntp server for your newsgroup and want to change the port number
841 used to 899, you would say something along these lines:
843 (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
845 (defcustom gnus-nntpserver-file "/etc/nntpserver"
846 "A file with only the name of the nntp server in it."
851 ;; This function is used to check both the environment variable
852 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
853 ;; an nntp server name default.
854 (defun gnus-getenv-nntpserver ()
855 (or (getenv "NNTPSERVER")
856 (and (file-readable-p gnus-nntpserver-file)
858 (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
859 (insert-file-contents gnus-nntpserver-file)
860 (let ((name (buffer-string)))
862 (if (string-match "\\'[ \t\n]*$" name)
865 (kill-buffer (current-buffer))))))))
867 (defcustom gnus-select-method
870 (list 'nntp (or (ignore-errors
871 (gnus-getenv-nntpserver))
872 (when (and gnus-default-nntp-server
873 (not (string= gnus-default-nntp-server "")))
874 gnus-default-nntp-server)
876 (if (or (null gnus-nntp-service)
877 (equal gnus-nntp-service "nntp"))
879 (list gnus-nntp-service))))
880 "*Default method for selecting a newsgroup.
881 This variable should be a list, where the first element is how the
882 news is to be fetched, the second is the address.
884 For instance, if you want to get your news via NNTP from
885 \"flab.flab.edu\", you could say:
887 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
889 If you want to use your local spool, say:
891 \(setq gnus-select-method (list 'nnspool (system-name)))
893 If you use this variable, you must set `gnus-nntp-server' to nil.
895 There is a lot more to know about select methods and virtual servers -
896 see the manual for details."
898 :type 'gnus-select-method)
900 (defcustom gnus-message-archive-method
903 (nnfolder-directory ,(nnheader-concat message-directory "archive"))
904 (nnfolder-active-file
905 ,(nnheader-concat message-directory "archive/active"))
906 (nnfolder-get-new-mail nil)
907 (nnfolder-inhibit-expiry t))
908 "*Method used for archiving messages you've sent.
909 This should be a mail method.
911 It's probably not a very effective to change this variable once you've
912 run Gnus once. After doing that, you must edit this server from the
916 :type 'gnus-select-method)
918 (defcustom gnus-message-archive-group nil
919 "*Name of the group in which to save the messages you've written.
920 This can either be a string; a list of strings; or an alist
921 of regexps/functions/forms to be evaluated to return a string (or a list
922 of strings). The functions are called with the name of the current
923 group (or nil) as a parameter.
925 If you want to save your mail in one group and the news articles you
926 write in another group, you could say something like:
928 \(setq gnus-message-archive-group
929 '((if (message-news-p)
933 Normally the group names returned by this variable should be
934 unprefixed -- which implicitly means \"store on the archive server\".
935 However, you may wish to store the message on some other server. In
936 that case, just return a fully prefixed name of the group --
937 \"nnml+private:mail.misc\", for instance."
939 :type '(choice (const :tag "none" nil)
944 (defcustom gnus-secondary-servers nil
945 "List of NNTP servers that the user can choose between interactively.
946 To make Gnus query you for a server, you have to give `gnus' a
947 non-numeric prefix - `C-u M-x gnus', in short."
949 :type '(repeat string))
951 (defcustom gnus-nntp-server nil
952 "*The name of the host running the NNTP server.
953 This variable is semi-obsolete. Use the `gnus-select-method'
956 :type '(choice (const :tag "disable" nil)
959 (defcustom gnus-secondary-select-methods nil
960 "A list of secondary methods that will be used for reading news.
961 This is a list where each element is a complete select method (see
962 `gnus-select-method').
964 If, for instance, you want to read your mail with the nnml backend,
965 you could set this variable:
967 \(setq gnus-secondary-select-methods '((nnml \"\")))"
969 :type '(repeat gnus-select-method))
971 (defvar gnus-backup-default-subscribed-newsgroups
972 '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
973 "Default default new newsgroups the first time Gnus is run.
974 Should be set in paths.el, and shouldn't be touched by the user.")
976 (defcustom gnus-local-domain nil
977 "Local domain name without a host name.
978 The DOMAINNAME environment variable is used instead if it is defined.
979 If the `system-name' function returns the full Internet name, there is
980 no need to set this variable."
982 :type '(choice (const :tag "default" nil)
985 (defvar gnus-local-organization nil
986 "String with a description of what organization (if any) the user belongs to.
987 Obsolete variable; use `message-user-organization' instead.")
989 ;; Customization variables
991 (defcustom gnus-refer-article-method nil
992 "Preferred method for fetching an article by Message-ID.
993 If you are reading news from the local spool (with nnspool), fetching
994 articles by Message-ID is painfully slow. By setting this method to an
995 nntp method, you might get acceptable results.
997 The value of this variable must be a valid select method as discussed
998 in the documentation of `gnus-select-method'."
1000 :type '(choice (const :tag "default" nil)
1001 gnus-select-method))
1003 (defcustom gnus-group-faq-directory
1004 '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1005 "/ftp@sunsite.auc.dk:/pub/usenet/"
1006 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1007 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1008 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1009 "/ftp@rtfm.mit.edu:/pub/usenet/"
1010 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1011 "/ftp@ftp.sunet.se:/pub/usenet/"
1012 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1013 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1014 "/ftp@ftp.hk.super.net:/mirror/faqs/")
1015 "*Directory where the group FAQs are stored.
1016 This will most commonly be on a remote machine, and the file will be
1017 fetched by ange-ftp.
1019 This variable can also be a list of directories. In that case, the
1020 first element in the list will be used by default. The others can
1021 be used when being prompted for a site.
1023 Note that Gnus uses an aol machine as the default directory. If this
1024 feels fundamentally unclean, just think of it as a way to finally get
1025 something of value back from them.
1027 If the default site is too slow, try one of these:
1029 North America: mirrors.aol.com /pub/rtfm/usenet
1030 ftp.seas.gwu.edu /pub/rtfm
1031 rtfm.mit.edu /pub/usenet
1032 Europe: ftp.uni-paderborn.de /pub/FAQ
1033 src.doc.ic.ac.uk /usenet/news-FAQS
1034 ftp.sunet.se /pub/usenet
1035 sunsite.auc.dk /pub/usenet
1036 Asia: nctuccca.edu.tw /USENET/FAQ
1037 hwarang.postech.ac.kr /pub/usenet
1038 ftp.hk.super.net /mirror/faqs"
1039 :group 'gnus-group-various
1040 :type '(choice directory
1041 (repeat directory)))
1043 (defcustom gnus-use-cross-reference t
1044 "*Non-nil means that cross referenced articles will be marked as read.
1045 If nil, ignore cross references. If t, mark articles as read in
1046 subscribed newsgroups. If neither t nor nil, mark as read in all
1049 :type '(choice (const :tag "off" nil)
1050 (const :tag "subscribed" t)
1054 (defcustom gnus-process-mark ?#
1056 :group 'gnus-group-visual
1057 :group 'gnus-summary-marks
1060 (defcustom gnus-asynchronous nil
1061 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1062 :group 'gnus-asynchronous
1065 (defcustom gnus-large-newsgroup 200
1066 "*The number of articles which indicates a large newsgroup.
1067 If the number of articles in a newsgroup is greater than this value,
1068 confirmation is required for selecting the newsgroup."
1069 :group 'gnus-group-select
1072 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1073 "*Non-nil means that the default name of a file to save articles in is the group name.
1074 If it's nil, the directory form of the group name is used instead.
1076 If this variable is a list, and the list contains the element
1077 `not-score', long file names will not be used for score files; if it
1078 contains the element `not-save', long file names will not be used for
1079 saving; and if it contains the element `not-kill', long file names
1080 will not be used for kill files.
1082 Note that the default for this variable varies according to what system
1083 type you're using. On `usg-unix-v' and `xenix' this variable defaults
1084 to nil while on all other systems it defaults to t."
1088 (defcustom gnus-kill-files-directory gnus-directory
1089 "*Name of the directory where kill files will be stored (default \"~/News\")."
1090 :group 'gnus-score-files
1091 :group 'gnus-score-kill
1094 (defcustom gnus-save-score nil
1095 "*If non-nil, save group scoring info."
1096 :group 'gnus-score-various
1100 (defcustom gnus-use-undo t
1101 "*If non-nil, allow undoing in Gnus group mode buffers."
1105 (defcustom gnus-use-adaptive-scoring nil
1106 "*If non-nil, use some adaptive scoring scheme.
1107 If a list, then the values `word' and `line' are meaningful. The
1108 former will perform adaption on individual words in the subject
1109 header while `line' will perform adaption on several headers."
1111 :group 'gnus-score-adapt
1112 :type '(set (const word) (const line)))
1114 (defcustom gnus-use-cache 'passive
1115 "*If nil, Gnus will ignore the article cache.
1116 If `passive', it will allow entering (and reading) articles
1117 explicitly entered into the cache. If anything else, use the
1118 cache to the full extent of the law."
1121 :type '(choice (const :tag "off" nil)
1122 (const :tag "passive" passive)
1123 (const :tag "active" t)))
1125 (defcustom gnus-use-trees nil
1126 "*If non-nil, display a thread tree buffer."
1130 (defcustom gnus-use-grouplens nil
1131 "*If non-nil, use GroupLens ratings."
1135 (defcustom gnus-keep-backlog nil
1136 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1137 If it is a number N, then Gnus will only keep the last N articles
1138 read. If it is neither nil nor a number, Gnus will keep all read
1139 articles. This is not a good idea."
1141 :type '(choice (const :tag "off" nil)
1146 (defcustom gnus-use-nocem nil
1147 "*If non-nil, Gnus will read NoCeM cancel messages."
1151 (defcustom gnus-suppress-duplicates nil
1152 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1156 (defcustom gnus-use-scoring t
1157 "*If non-nil, enable scoring."
1161 (defcustom gnus-use-picons nil
1162 "*If non-nil, display picons in a frame of their own."
1166 (defcustom gnus-summary-prepare-exit-hook
1167 '(gnus-summary-expire-articles)
1168 "*A hook called when preparing to exit from the summary buffer.
1169 It calls `gnus-summary-expire-articles' by default."
1170 :group 'gnus-summary-exit
1173 (defcustom gnus-novice-user t
1174 "*Non-nil means that you are a usenet novice.
1175 If non-nil, verbose messages may be displayed and confirmations may be
1180 (defcustom gnus-expert-user nil
1181 "*Non-nil means that you will never be asked for confirmation about anything.
1182 That doesn't mean *anything* anything; particularly destructive
1183 commands will still require prompting."
1187 (defcustom gnus-interactive-catchup t
1188 "*If non-nil, require your confirmation when catching up a group."
1189 :group 'gnus-group-select
1192 (defcustom gnus-interactive-exit t
1193 "*If non-nil, require your confirmation when exiting Gnus."
1197 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1198 "*Function for extracting address components from a From header.
1199 Two pre-defined function exist: `gnus-extract-address-components',
1200 which is the default, quite fast, and too simplistic solution, and
1201 `mail-extract-address-components', which works much better, but is
1203 :group 'gnus-summary-format
1204 :type '(radio (function-item gnus-extract-address-components)
1205 (function-item mail-extract-address-components)
1206 (function :tag "Other")))
1208 (defcustom gnus-carpal nil
1209 "*If non-nil, display clickable icons."
1213 (defcustom gnus-shell-command-separator ";"
1214 "String used to separate to shell commands."
1218 (defcustom gnus-valid-select-methods
1219 '(("nntp" post address prompt-address physical-address)
1220 ("nnspool" post address)
1221 ("nnvirtual" post-mail virtual prompt-address)
1222 ("nnmbox" mail respool address)
1223 ("nnml" mail respool address)
1224 ("nnmh" mail respool address)
1225 ("nndir" post-mail prompt-address physical-address)
1226 ("nneething" none address prompt-address physical-address)
1227 ("nndoc" none address prompt-address)
1228 ("nnbabyl" mail address respool)
1229 ("nnkiboze" post virtual)
1230 ("nnsoup" post-mail address)
1231 ("nndraft" post-mail)
1232 ("nnfolder" mail respool address)
1233 ("nngateway" post-mail address prompt-address physical-address)
1236 ("nnagent" post-mail))
1237 "*An alist of valid select methods.
1238 The first element of each list lists should be a string with the name
1239 of the select method. The other elements may be the category of
1240 this method (i. e., `post', `mail', `none' or whatever) or other
1241 properties that this method has (like being respoolable).
1242 If you implement a new select method, all you should have to change is
1243 this variable. I think."
1245 :type '(repeat (group (string :tag "Name")
1246 (radio-button-choice (const :format "%v " post)
1247 (const :format "%v " mail)
1248 (const :format "%v " none)
1250 (checklist :inline t
1251 (const :format "%v " address)
1252 (const :format "%v " prompt-address)
1253 (const :format "%v " physical-address)
1254 (const :format "%v " virtual)
1257 (define-widget 'gnus-select-method 'list
1258 "Widget for entering a select method."
1259 :args `((choice :tag "Method"
1260 ,@(mapcar (lambda (entry)
1261 (list 'const :format "%v\n"
1262 (intern (car entry))))
1263 gnus-valid-select-methods))
1264 (string :tag "Address")
1265 (editable-list :inline t
1268 (sexp :tag "Value")))))
1270 (defcustom gnus-updated-mode-lines '(group article summary tree)
1271 "List of buffers that should update their mode lines.
1272 The list may contain the symbols `group', `article', `tree' and
1273 `summary'. If the corresponding symbol is present, Gnus will keep
1274 that mode line updated with information that may be pertinent.
1275 If this variable is nil, screen refresh may be quicker."
1276 :group 'gnus-various
1277 :type '(set (const group)
1282 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1283 (defcustom gnus-mode-non-string-length nil
1284 "*Max length of mode-line non-string contents.
1285 If this is nil, Gnus will take space as is needed, leaving the rest
1286 of the modeline intact. Note that the default of nil is unlikely
1287 to be desirable; see the manual for further details."
1288 :group 'gnus-various
1289 :type '(choice (const nil)
1292 (defcustom gnus-auto-expirable-newsgroups nil
1293 "*Groups in which to automatically mark read articles as expirable.
1294 If non-nil, this should be a regexp that should match all groups in
1295 which to perform auto-expiry. This only makes sense for mail groups."
1296 :group 'nnmail-expire
1297 :type '(choice (const nil)
1300 (defcustom gnus-total-expirable-newsgroups nil
1301 "*Groups in which to perform expiry of all read articles.
1302 Use with extreme caution. All groups that match this regexp will be
1303 expiring - which means that all read articles will be deleted after
1304 \(say) one week. (This only goes for mail groups and the like, of
1306 :group 'nnmail-expire
1307 :type '(choice (const nil)
1310 (defcustom gnus-group-uncollapsed-levels 1
1311 "Number of group name elements to leave alone when making a short group name."
1312 :group 'gnus-group-visual
1315 (defcustom gnus-group-use-permanent-levels nil
1316 "*If non-nil, once you set a level, Gnus will use this level."
1317 :group 'gnus-group-levels
1322 (defcustom gnus-load-hook nil
1323 "A hook run while Gnus is loaded."
1327 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1328 "A hook called to apply kill files to a group.
1329 This hook is intended to apply a kill file to the selected newsgroup.
1330 The function `gnus-apply-kill-file' is called by default.
1332 Since a general kill file is too heavy to use only for a few
1333 newsgroups, I recommend you to use a lighter hook function. For
1334 example, if you'd like to apply a kill file to articles which contains
1335 a string `rmgroup' in subject in newsgroup `control', you can use the
1338 (setq gnus-apply-kill-hook
1341 (cond ((string-match \"control\" gnus-newsgroup-name)
1342 (gnus-kill \"Subject\" \"rmgroup\")
1343 (gnus-expunge \"X\"))))))"
1344 :group 'gnus-score-kill
1345 :options '(gnus-apply-kill-file)
1348 (defcustom gnus-group-change-level-function nil
1349 "Function run when a group level is changed.
1350 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1351 :group 'gnus-group-levels
1356 (defcustom gnus-visual
1357 '(summary-highlight group-highlight article-highlight
1359 summary-menu group-menu article-menu
1360 tree-highlight menu highlight
1361 browse-menu server-menu
1362 page-marker tree-menu binary-menu pick-menu
1364 "*Enable visual features.
1365 If `visual' is disabled, there will be no menus and few faces. Most of
1366 the visual customization options below will be ignored. Gnus will use
1367 less space and be faster as a result.
1369 This variable can also be a list of visual elements to switch on. For
1370 instance, to switch off all visual things except menus, you can say:
1372 (setq gnus-visual '(menu))
1374 Valid elements include `summary-highlight', `group-highlight',
1375 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1376 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1377 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1378 and `grouplens-menu'."
1381 :type '(set (const summary-highlight)
1382 (const group-highlight)
1383 (const article-highlight)
1385 (const summary-menu)
1387 (const article-menu)
1388 (const tree-highlight)
1397 (const grouplens-menu)))
1399 (defcustom gnus-mouse-face
1401 (if (gnus-visual-p 'mouse-face 'highlight)
1402 (if (boundp 'gnus-mouse-face)
1403 (or gnus-mouse-face 'highlight)
1407 "*Face used for group or summary buffer mouse highlighting.
1408 The line beneath the mouse pointer will be highlighted with this
1413 (defcustom gnus-article-save-directory gnus-directory
1414 "*Name of the directory articles will be saved in (default \"~/News\")."
1415 :group 'gnus-article-saving
1418 (defvar gnus-plugged t
1419 "Whether Gnus is plugged or not.")
1421 (defcustom gnus-default-charset 'iso-8859-1
1422 "Default charset assumed to be used when viewing non-ASCII characters.
1423 This variable is overridden on a group-to-group basis by the
1424 gnus-group-charset-alist variable and is only used on groups not
1425 covered by that variable."
1427 :group 'gnus-charset)
1429 (defcustom gnus-default-posting-charset nil
1430 "Default charset assumed to be used when posting non-ASCII characters.
1431 This variable is overridden on a group-to-group basis by the
1432 gnus-group-posting-charset-alist variable and is only used on groups not
1433 covered by that variable.
1434 If nil, no default charset is assumed when posting."
1436 :group 'gnus-charset)
1439 ;;; Internal variables
1441 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1442 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1443 (defvar gnus-original-article-buffer " *Original Article*")
1444 (defvar gnus-newsgroup-name nil)
1445 (defvar gnus-ephemeral-servers nil)
1447 (defvar gnus-agent nil
1448 "Whether we want to use the Gnus agent or not.")
1450 (defvar gnus-command-method nil
1451 "Dynamically bound variable that says what the current backend is.")
1453 (defvar gnus-current-select-method nil
1454 "The current method for selecting a newsgroup.")
1456 (defvar gnus-tree-buffer "*Tree*"
1457 "Buffer where Gnus thread trees are displayed.")
1460 (defvar gnus-use-generic-from nil)
1462 ;; Variable holding the user answers to all method prompts.
1463 (defvar gnus-method-history nil)
1465 ;; Variable holding the user answers to all mail method prompts.
1466 (defvar gnus-mail-method-history nil)
1468 ;; Variable holding the user answers to all group prompts.
1469 (defvar gnus-group-history nil)
1471 (defvar gnus-server-alist nil
1472 "List of available servers.")
1474 (defcustom gnus-cache-directory
1475 (nnheader-concat gnus-directory "cache/")
1476 "*The directory where cached articles will be stored."
1480 (defvar gnus-predefined-server-alist
1483 (nnspool-spool-directory ,gnus-cache-directory)
1484 (nnspool-nov-directory ,gnus-cache-directory)
1485 (nnspool-active-file
1486 ,(nnheader-concat gnus-cache-directory "active"))))
1487 "List of predefined (convenience) servers.")
1489 (defvar gnus-topic-indentation "");; Obsolete variable.
1491 (defconst gnus-article-mark-lists
1492 '((marked . tick) (replied . reply)
1493 (expirable . expire) (killed . killed)
1494 (bookmarks . bookmark) (dormant . dormant)
1495 (scored . score) (saved . save)
1496 (cached . cache) (downloadable . download)
1497 (unsendable . unsend)))
1499 (defvar gnus-headers-retrieved-by nil)
1500 (defvar gnus-article-reply nil)
1501 (defvar gnus-override-method nil)
1502 (defvar gnus-article-check-size nil)
1503 (defvar gnus-opened-servers nil)
1505 (defvar gnus-current-kill-article nil)
1507 (defvar gnus-have-read-active-file nil)
1509 (defconst gnus-maintainer
1510 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1511 "The mail address of the Gnus maintainers.")
1513 (defvar gnus-info-nodes
1514 '((gnus-group-mode "(gnus)The Group Buffer")
1515 (gnus-summary-mode "(gnus)The Summary Buffer")
1516 (gnus-article-mode "(gnus)The Article Buffer")
1517 (gnus-server-mode "(gnus)The Server Buffer")
1518 (gnus-browse-mode "(gnus)Browse Foreign Server")
1519 (gnus-tree-mode "(gnus)Tree Display"))
1520 "Alist of major modes and related Info nodes.")
1522 (defvar gnus-group-buffer "*Group*")
1523 (defvar gnus-summary-buffer "*Summary*")
1524 (defvar gnus-article-buffer "*Article*")
1525 (defvar gnus-server-buffer "*Server*")
1527 (defvar gnus-slave nil
1528 "Whether this Gnus is a slave or not.")
1530 (defvar gnus-batch-mode nil
1531 "Whether this Gnus is running in batch mode or not.")
1533 (defvar gnus-variable-list
1534 '(gnus-newsrc-options gnus-newsrc-options-n
1535 gnus-newsrc-last-checked-date
1536 gnus-newsrc-alist gnus-server-alist
1537 gnus-killed-list gnus-zombie-list
1538 gnus-topic-topology gnus-topic-alist
1540 "Gnus variables saved in the quick startup file.")
1542 (defvar gnus-newsrc-alist nil
1543 "Assoc list of read articles.
1544 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1546 (defvar gnus-newsrc-hashtb nil
1547 "Hashtable of gnus-newsrc-alist.")
1549 (defvar gnus-killed-list nil
1550 "List of killed newsgroups.")
1552 (defvar gnus-killed-hashtb nil
1553 "Hash table equivalent of gnus-killed-list.")
1555 (defvar gnus-zombie-list nil
1556 "List of almost dead newsgroups.")
1558 (defvar gnus-description-hashtb nil
1559 "Descriptions of newsgroups.")
1561 (defvar gnus-list-of-killed-groups nil
1562 "List of newsgroups that have recently been killed by the user.")
1564 (defvar gnus-active-hashtb nil
1565 "Hashtable of active articles.")
1567 (defvar gnus-moderated-hashtb nil
1568 "Hashtable of moderated newsgroups.")
1570 ;; Save window configuration.
1571 (defvar gnus-prev-winconf nil)
1573 (defvar gnus-reffed-article-number nil)
1575 ;;; Let the byte-compiler know that we know about this variable.
1576 (defvar rmail-default-rmail-file)
1578 (defvar gnus-dead-summary nil)
1580 ;;; End of variables.
1582 ;; Define some autoload functions Gnus might use.
1585 ;; This little mapcar goes through the list below and marks the
1586 ;; symbols in question as autoloaded functions.
1589 (let ((interactive (nth 1 (memq ':interactive package))))
1593 (when (consp function)
1594 (setq keymap (car (memq 'keymap function)))
1595 (setq function (car function)))
1596 (autoload function (car package) nil interactive keymap)))
1597 (if (eq (nth 1 package) ':interactive)
1600 '(("metamail" metamail-buffer)
1601 ("info" Info-goto-node)
1602 ("pp" pp pp-to-string pp-eval-expression)
1603 ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1604 ("ps-print" ps-print-preprint)
1605 ("mail-extr" mail-extract-address-components)
1606 ("browse-url" browse-url)
1607 ("message" :interactive t
1608 message-send-and-exit message-yank-original)
1609 ("nnmail" nnmail-split-fancy nnmail-article-group)
1610 ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1611 ("rmailout" rmail-output rmail-output-to-rmail-file)
1612 ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1613 rmail-show-message rmail-summary-exists
1614 rmail-select-summary rmail-update-summary)
1615 ("gnus-audio" :interactive t gnus-audio-play)
1616 ("gnus-xmas" gnus-xmas-splash)
1617 ("gnus-soup" :interactive t
1618 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1619 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1620 ("nnsoup" nnsoup-pack-replies)
1621 ("score-mode" :interactive t gnus-score-mode)
1622 ("gnus-mh" gnus-summary-save-article-folder
1623 gnus-Folder-save-name gnus-folder-save-name)
1624 ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1625 ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1626 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1627 gnus-demon-add-disconnection gnus-demon-add-handler
1628 gnus-demon-remove-handler)
1629 ("gnus-demon" :interactive t
1630 gnus-demon-init gnus-demon-cancel)
1631 ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1632 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1633 ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1634 gnus-nocem-unwanted-article-p)
1635 ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1636 gnus-server-server-name)
1637 ("gnus-srvr" gnus-browse-foreign-server)
1638 ("gnus-cite" :interactive t
1639 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1640 gnus-article-hide-citation gnus-article-fill-cited-article
1641 gnus-article-hide-citation-in-followups)
1642 ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1643 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1644 gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1645 ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1646 gnus-cache-possibly-remove-articles gnus-cache-request-article
1647 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1648 gnus-cache-enter-remove-article gnus-cached-article-p
1649 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1650 ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1651 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1652 ("gnus-score" :interactive t
1653 gnus-summary-increase-score gnus-summary-set-score
1654 gnus-summary-raise-thread gnus-summary-raise-same-subject
1655 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1656 gnus-summary-lower-thread gnus-summary-lower-same-subject
1657 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1658 gnus-summary-current-score gnus-score-default
1659 gnus-score-flush-cache gnus-score-close
1660 gnus-possibly-score-headers gnus-score-followup-article
1661 gnus-score-followup-thread)
1663 (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1664 gnus-current-score-file-nondirectory gnus-score-adaptive
1665 gnus-score-find-trace gnus-score-file-name)
1666 ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1667 ("gnus-topic" :interactive t gnus-topic-mode)
1668 ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1669 ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1670 ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1671 ("gnus-uu" :interactive t
1672 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1673 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1674 gnus-uu-mark-by-regexp gnus-uu-mark-all
1675 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1676 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1677 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1678 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1679 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1680 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1681 gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1682 gnus-uu-mark-over gnus-uu-post-news)
1683 ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1684 ("gnus-msg" (gnus-summary-send-map keymap)
1685 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1686 ("gnus-msg" :interactive t
1687 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1688 gnus-summary-followup gnus-summary-followup-with-original
1689 gnus-summary-cancel-article gnus-summary-supersede-article
1690 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1691 gnus-summary-mail-forward gnus-summary-mail-other-window
1692 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1693 gnus-summary-wide-reply gnus-summary-followup-to-mail
1694 gnus-summary-followup-to-mail-with-original gnus-bug
1695 gnus-summary-wide-reply-with-original
1696 gnus-summary-post-forward gnus-summary-wide-reply-with-original
1697 gnus-summary-post-forward)
1698 ("gnus-picon" :interactive t gnus-article-display-picons
1699 gnus-group-display-picons gnus-picons-article-display-x-face
1700 gnus-picons-display-x-face)
1701 ("gnus-picon" gnus-picons-buffer-name)
1702 ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1703 gnus-grouplens-mode)
1704 ("smiley" :interactive t gnus-smiley-display)
1705 ("gnus-win" gnus-configure-windows gnus-add-configuration)
1706 ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1707 gnus-list-of-unread-articles gnus-list-of-read-articles
1708 gnus-offer-save-summaries gnus-make-thread-indent-array
1709 gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1710 gnus-summary-skip-intangible gnus-summary-article-number
1711 gnus-data-header gnus-data-find)
1712 ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1713 gnus-group-list-groups gnus-group-first-unread-group
1714 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1715 gnus-group-setup-buffer gnus-group-get-new-news
1716 gnus-group-make-help-group gnus-group-update-group
1717 gnus-group-iterate gnus-group-group-name)
1718 ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1719 gnus-backlog-remove-article)
1720 ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1721 gnus-article-prepare gnus-article-set-window-start
1722 gnus-article-next-page gnus-article-prev-page
1723 gnus-request-article-this-buffer gnus-article-mode
1724 gnus-article-setup-buffer gnus-narrow-to-page
1725 gnus-article-delete-invisible-text gnus-treat-article)
1726 ("gnus-art" :interactive t
1727 gnus-article-hide-headers gnus-article-hide-boring-headers
1728 gnus-article-treat-overstrike gnus-article-word-wrap
1729 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1730 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1731 gnus-article-hide-pgp
1732 gnus-article-hide-pem gnus-article-hide-signature
1733 gnus-article-strip-leading-blank-lines gnus-article-date-local
1734 gnus-article-date-original gnus-article-date-lapsed
1735 gnus-article-show-all-headers
1736 gnus-article-edit-mode gnus-article-edit-article
1737 gnus-article-edit-done gnus-article-decode-encoded-words
1738 gnus-start-date-timer gnus-stop-date-timer
1739 gnus-mime-view-all-parts)
1740 ("gnus-int" gnus-request-type)
1741 ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1742 gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1743 ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1744 gnus-dup-enter-articles)
1745 ("gnus-range" gnus-copy-sequence)
1746 ("gnus-eform" gnus-edit-form)
1747 ("gnus-move" :interactive t
1748 gnus-group-move-group-to-server gnus-change-server)
1749 ("gnus-logic" gnus-score-advanced)
1750 ("gnus-undo" gnus-undo-mode gnus-undo-register)
1751 ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1752 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1753 gnus-async-halt-prefetch)
1754 ("gnus-agent" gnus-open-agent gnus-agent-get-function
1755 gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1756 gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1757 gnus-summary-set-agent-mark gnus-agent-save-group-info)
1758 ("gnus-agent" :interactive t
1759 gnus-unplugged gnus-agentize gnus-agent-batch)
1760 ("gnus-vm" :interactive t gnus-summary-save-in-vm
1761 gnus-summary-save-article-vm)
1762 ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1764 ;;; gnus-sum.el thingies
1767 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1768 "*The format specification of the lines in the summary buffer.
1770 It works along the same lines as a normal formatting string,
1771 with some simple extensions.
1773 %N Article number, left padded with spaces (string)
1775 %s Subject if it is at the root of a thread, and \"\" otherwise (string)
1776 %n Name of the poster (string)
1777 %a Extracted name of the poster (string)
1778 %A Extracted address of the poster (string)
1779 %F Contents of the From: header (string)
1780 %f Contents of the From: or To: headers (string)
1781 %x Contents of the Xref: header (string)
1782 %D Date of the article (string)
1783 %d Date of the article (string) in DD-MMM format
1784 %M Message-id of the article (string)
1785 %r References of the article (string)
1786 %c Number of characters in the article (integer)
1787 %L Number of lines in the article (integer)
1788 %I Indentation based on thread level (a string of spaces)
1789 %T A string with two possible values: 80 spaces if the article
1790 is on thread level two or larger and 0 spaces on level one
1791 %R \"A\" if this article has been replied to, \" \" otherwise (character)
1792 %U Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1793 %[ Opening bracket (character, \"[\" or \"<\")
1794 %] Closing bracket (character, \"]\" or \">\")
1795 %> Spaces of length thread-level (string)
1796 %< Spaces of length (- 20 thread-level) (string)
1797 %i Article score (number)
1798 %z Article zcore (character)
1799 %t Number of articles under the current thread (number).
1800 %e Whether the thread is empty or not (character).
1801 %l GroupLens score (string).
1802 %V Total thread score (number).
1803 %P The line number (number).
1804 %O Download mark (character).
1805 %u User defined specifier. The next character in the format string should
1806 be a letter. Gnus will call the function gnus-user-format-function-X,
1807 where X is the letter following %u. The function will be passed the
1808 current header as argument. The function should return a string, which
1809 will be inserted into the summary just like information from any other
1812 Text between %( and %) will be highlighted with `gnus-mouse-face'
1813 when the mouse point is placed inside the area. There can only be one
1816 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1817 with care. For reasons of efficiency, Gnus will compute what column
1818 these characters will end up in, and \"hard-code\" that. This means that
1819 it is invalid to have these specs after a variable-length spec. Well,
1820 you might not be arrested, but your summary buffer will look strange,
1821 which is bad enough.
1823 The smart choice is to have these specs as for to the left as
1826 This restriction may disappear in later versions of Gnus."
1828 :group 'gnus-summary-format)
1831 ;;; Skeleton keymaps
1834 (defun gnus-suppress-keymap (keymap)
1835 (suppress-keymap keymap)
1836 (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1838 (define-key keymap (pop keys) 'undefined))))
1840 (defvar gnus-article-mode-map
1841 (let ((keymap (make-sparse-keymap)))
1842 (gnus-suppress-keymap keymap)
1844 (defvar gnus-summary-mode-map
1845 (let ((keymap (make-keymap)))
1846 (gnus-suppress-keymap keymap)
1848 (defvar gnus-group-mode-map
1849 (let ((keymap (make-keymap)))
1850 (gnus-suppress-keymap keymap)
1855 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1856 ;; If you want the cursor to go somewhere else, set these two
1857 ;; functions in some startup hook to whatever you want.
1858 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1859 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1861 ;;; Various macros and substs.
1863 (defun gnus-header-from (header)
1864 (mail-header-from header))
1866 (defmacro gnus-gethash (string hashtable)
1867 "Get hash value of STRING in HASHTABLE."
1868 `(symbol-value (intern-soft ,string ,hashtable)))
1870 (defmacro gnus-sethash (string value hashtable)
1871 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1872 `(set (intern ,string ,hashtable) ,value))
1873 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1875 (defmacro gnus-group-unread (group)
1876 "Get the currently computed number of unread articles in GROUP."
1877 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1879 (defmacro gnus-group-entry (group)
1880 "Get the newsrc entry for GROUP."
1881 `(gnus-gethash ,group gnus-newsrc-hashtb))
1883 (defmacro gnus-active (group)
1884 "Get active info on GROUP."
1885 `(gnus-gethash ,group gnus-active-hashtb))
1887 (defmacro gnus-set-active (group active)
1888 "Set GROUP's active info."
1889 `(gnus-sethash ,group ,active gnus-active-hashtb))
1891 ;; Info access macros.
1893 (defmacro gnus-info-group (info)
1895 (defmacro gnus-info-rank (info)
1897 (defmacro gnus-info-read (info)
1899 (defmacro gnus-info-marks (info)
1901 (defmacro gnus-info-method (info)
1903 (defmacro gnus-info-params (info)
1906 (defmacro gnus-info-level (info)
1907 `(let ((rank (gnus-info-rank ,info)))
1911 (defmacro gnus-info-score (info)
1912 `(let ((rank (gnus-info-rank ,info)))
1913 (or (and (consp rank) (cdr rank)) 0)))
1915 (defmacro gnus-info-set-group (info group)
1916 `(setcar ,info ,group))
1917 (defmacro gnus-info-set-rank (info rank)
1918 `(setcar (nthcdr 1 ,info) ,rank))
1919 (defmacro gnus-info-set-read (info read)
1920 `(setcar (nthcdr 2 ,info) ,read))
1921 (defmacro gnus-info-set-marks (info marks &optional extend)
1923 `(gnus-info-set-entry ,info ,marks 3)
1924 `(setcar (nthcdr 3 ,info) ,marks)))
1925 (defmacro gnus-info-set-method (info method &optional extend)
1927 `(gnus-info-set-entry ,info ,method 4)
1928 `(setcar (nthcdr 4 ,info) ,method)))
1929 (defmacro gnus-info-set-params (info params &optional extend)
1931 `(gnus-info-set-entry ,info ,params 5)
1932 `(setcar (nthcdr 5 ,info) ,params)))
1934 (defun gnus-info-set-entry (info entry number)
1935 ;; Extend the info until we have enough elements.
1936 (while (<= (length info) number)
1937 (nconc info (list nil)))
1939 (setcar (nthcdr number info) entry))
1941 (defmacro gnus-info-set-level (info level)
1942 `(let ((rank (cdr ,info)))
1943 (if (consp (car rank))
1944 (setcar (car rank) ,level)
1945 (setcar rank ,level))))
1946 (defmacro gnus-info-set-score (info score)
1947 `(let ((rank (cdr ,info)))
1948 (if (consp (car rank))
1949 (setcdr (car rank) ,score)
1950 (setcar rank (cons (car rank) ,score)))))
1952 (defmacro gnus-get-info (group)
1953 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1955 ;; Byte-compiler warning.
1956 (defvar gnus-visual)
1957 ;; Find out whether the gnus-visual TYPE is wanted.
1958 (defun gnus-visual-p (&optional type class)
1959 (and gnus-visual ; Has to be non-nil, at least.
1960 (if (not type) ; We don't care about type.
1962 (if (listp gnus-visual) ; It's a list, so we check it.
1963 (or (memq type gnus-visual)
1964 (memq class gnus-visual))
1967 ;;; Load the compatability functions.
1976 (defvar gnus-shutdown-alist nil)
1978 (defun gnus-add-shutdown (function &rest symbols)
1979 "Run FUNCTION whenever one of SYMBOLS is shut down."
1980 (push (cons function symbols) gnus-shutdown-alist))
1982 (defun gnus-shutdown (symbol)
1983 "Shut down everything that waits for SYMBOL."
1984 (let ((alist gnus-shutdown-alist)
1986 (while (setq entry (pop alist))
1987 (when (memq symbol (cdr entry))
1988 (funcall (car entry))))))
1992 ;;; Gnus Utility Functions
1996 (defmacro gnus-string-or (&rest strings)
1997 "Return the first element of STRINGS that is a non-blank string.
1998 STRINGS will be evaluated in normal `or' order."
1999 `(gnus-string-or-1 ',strings))
2001 (defun gnus-string-or-1 (strings)
2004 (setq string (eval (pop strings)))
2005 (if (string-match "^[ \t]*$" string)
2007 (setq strings nil)))
2010 (defun gnus-version (&optional arg)
2011 "Version number of this version of Gnus.
2012 If ARG, insert string at point."
2015 (insert (message gnus-version))
2016 (message gnus-version)))
2018 (defun gnus-continuum-version (version)
2019 "Return VERSION as a floating point number."
2020 (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2021 (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2022 (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2023 (number (match-string 2 version))
2025 (unless (string-match
2026 "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2027 (error "Invalid version string: %s" version))
2028 (setq major (string-to-number (match-string 1 number))
2029 minor (string-to-number (match-string 2 number))
2030 least (if (match-beginning 3)
2031 (string-to-number (match-string 3 number))
2035 (format "%s00%02d%02d"
2036 (if (member alpha '("(ding)" "d"))
2040 (- (mm-char-int (aref (downcase alpha) 0))
2044 (format "%d.%02d%02d" major minor least))))))
2046 (defun gnus-info-find-node ()
2047 "Find Info documentation of Gnus."
2049 ;; Enlarge info window if needed.
2050 (let (gnus-info-buffer)
2051 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2052 (setq gnus-info-buffer (current-buffer))
2053 (gnus-configure-windows 'info)))
2056 ;;; gnus-interactive
2059 (defvar gnus-current-prefix-symbol nil
2060 "Current prefix symbol.")
2062 (defvar gnus-current-prefix-symbols nil
2063 "List of current prefix symbols.")
2065 (defun gnus-interactive (string &optional params)
2066 "Return a list that can be fed to `interactive'.
2067 See `interactive' for full documentation.
2069 Adds the following specs:
2071 y -- The current symbolic prefix.
2072 Y -- A list of the current symbolic prefix(es).
2073 A -- Article number.
2074 H -- Article header.
2078 (while (< i (length string))
2079 (string-match ".\\([^\n]*\\)\n?" string i)
2080 (setq c (aref string i))
2082 (setq prompt (match-string 1 string)))
2083 (setq i (match-end 0))
2084 ;; We basically emulate just about everything that
2085 ;; `interactive' does, but add the specs listed above.
2089 (completing-read prompt obarray 'fboundp t))
2091 (read-buffer prompt (current-buffer) t))
2093 (read-buffer prompt (other-buffer (current-buffer))))
2097 (completing-read prompt obarray 'commandp t))
2101 (read-file-name prompt nil default-directory 'lambda))
2103 (read-file-name prompt nil nil 'lambda))
2105 (read-file-name prompt))
2107 (read-key-sequence prompt))
2109 (error "Not implemented spec"))
2111 (error "Not implemented spec"))
2115 (error "Not implemented spec"))
2117 (string-to-number (read-from-minibuffer prompt)))
2119 (prefix-numeric-value current-prefix-arg))
2125 (read-string prompt))
2127 (intern (read-string prompt)))
2129 (read-variable prompt))
2131 (read-minibuffer prompt))
2133 (eval-minibuffer prompt))
2134 ;; And here the new specs come.
2136 gnus-current-prefix-symbol)
2138 gnus-current-prefix-symbols)
2140 (gnus-group-group-name))
2142 (gnus-summary-skip-intangible)
2143 (or (get-text-property (point) 'gnus-number)
2144 (gnus-summary-last-subject)))
2146 (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2148 (error "Non-implemented spec")))
2152 (push (if (< (point) (mark) (point) (mark))) out)
2153 (push (if (> (point) (mark) (point) (mark))) out))))
2154 (setq out (delq 'gnus-prefix-nil out))
2157 (defun gnus-symbolic-argument (&optional arg)
2158 "Read a symbolic argument and a command, and then execute command."
2160 (let* ((in-command (this-command-keys))
2161 (command in-command)
2162 gnus-current-prefix-symbols
2163 gnus-current-prefix-symbol
2165 (while (equal in-command command)
2166 (message "%s-" (key-description (this-command-keys)))
2167 (push (intern (char-to-string (read-char))) syms)
2168 (setq command (read-key-sequence nil t)))
2169 (setq gnus-current-prefix-symbols (nreverse syms)
2170 gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2171 (call-interactively (key-binding command t))))
2173 ;;; More various functions.
2175 (defsubst gnus-check-backend-function (func group)
2176 "Check whether GROUP supports function FUNC.
2177 GROUP can either be a string (a group name) or a select method."
2179 (let ((method (if (stringp group)
2180 (car (gnus-find-method-for-group group))
2182 (unless (featurep method)
2184 (fboundp (intern (format "%s-%s" method func))))))
2186 (defun gnus-group-read-only-p (&optional group)
2187 "Check whether GROUP supports editing or not.
2188 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
2189 that that variable is buffer-local to the summary buffers."
2190 (let ((group (or group gnus-newsgroup-name)))
2191 (not (gnus-check-backend-function 'request-replace-article group))))
2193 (defun gnus-group-total-expirable-p (group)
2194 "Check whether GROUP is total-expirable or not."
2195 (let ((params (gnus-group-find-parameter group))
2198 ((memq 'total-expire params)
2200 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2202 (gnus-total-expirable-newsgroups ; Check var.
2203 (string-match gnus-total-expirable-newsgroups group)))))
2205 (defun gnus-group-auto-expirable-p (group)
2206 "Check whether GROUP is auto-expirable or not."
2207 (let ((params (gnus-group-find-parameter group))
2210 ((memq 'auto-expire params)
2212 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2214 (gnus-auto-expirable-newsgroups ; Check var.
2215 (string-match gnus-auto-expirable-newsgroups group)))))
2217 (defun gnus-virtual-group-p (group)
2218 "Say whether GROUP is virtual or not."
2219 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2220 gnus-valid-select-methods)))
2222 (defun gnus-news-group-p (group &optional article)
2223 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2224 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2225 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2226 (if (or (null article)
2227 (not (< article 0)))
2228 (eq (gnus-request-type group article) 'news)
2229 (if (not (vectorp article))
2231 ;; It's a real article.
2232 (eq (gnus-request-type group (mail-header-id article))
2235 ;; Returns a list of writable groups.
2236 (defun gnus-writable-groups ()
2237 (let ((alist gnus-newsrc-alist)
2239 (while (setq group (car (pop alist)))
2240 (unless (gnus-group-read-only-p group)
2241 (push group groups)))
2244 ;; Check whether to use long file names.
2245 (defun gnus-use-long-file-name (symbol)
2246 ;; The variable has to be set...
2247 (and gnus-use-long-file-name
2248 ;; If it isn't a list, then we return t.
2249 (or (not (listp gnus-use-long-file-name))
2250 ;; If it is a list, and the list contains `symbol', we
2252 (not (memq symbol gnus-use-long-file-name)))))
2254 ;; Generate a unique new group name.
2255 (defun gnus-generate-new-group-name (leaf)
2258 (while (gnus-gethash name gnus-newsrc-hashtb)
2259 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2262 (defun gnus-ephemeral-group-p (group)
2263 "Say whether GROUP is ephemeral or not."
2264 (gnus-group-get-parameter group 'quit-config t))
2266 (defun gnus-group-quit-config (group)
2267 "Return the quit-config of GROUP."
2268 (gnus-group-get-parameter group 'quit-config t))
2270 (defun gnus-kill-ephemeral-group (group)
2271 "Remove ephemeral GROUP from relevant structures."
2272 (gnus-sethash group nil gnus-newsrc-hashtb))
2274 (defun gnus-simplify-mode-line ()
2275 "Make mode lines a bit simpler."
2276 (setq mode-line-modified (cdr gnus-mode-line-modified))
2277 (when (listp mode-line-format)
2278 (make-local-variable 'mode-line-format)
2279 (setq mode-line-format (copy-sequence mode-line-format))
2280 (when (equal (nth 3 mode-line-format) " ")
2281 (setcar (nthcdr 3 mode-line-format) " "))))
2283 ;;; Servers and groups.
2285 (defsubst gnus-server-add-address (method)
2286 (let ((method-name (symbol-name (car method))))
2287 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2288 (not (assq (intern (concat method-name "-address")) method))
2289 (memq 'physical-address (assq (car method)
2290 gnus-valid-select-methods)))
2291 (append method (list (list (intern (concat method-name "-address"))
2295 (defsubst gnus-server-get-method (group method)
2296 ;; Input either a server name, and extended server name, or a
2297 ;; select method, and return a select method.
2298 (cond ((stringp method)
2299 (gnus-server-to-method method))
2300 ((equal method gnus-select-method)
2302 ((and (stringp (car method))
2304 (gnus-server-extend-method group method))
2307 (equal (cadr method) ""))
2310 (gnus-server-add-address method))))
2312 (defun gnus-server-to-method (server)
2313 "Map virtual server names to select methods."
2315 ;; Is this a method, perhaps?
2316 (and server (listp server) server)
2317 ;; Perhaps this is the native server?
2318 (and (equal server "native") gnus-select-method)
2319 ;; It should be in the server alist.
2320 (cdr (assoc server gnus-server-alist))
2321 ;; It could be in the predefined server alist.
2322 (cdr (assoc server gnus-predefined-server-alist))
2323 ;; If not, we look through all the opened server
2324 ;; to see whether we can find it there.
2325 (let ((opened gnus-opened-servers))
2327 (not (equal server (format "%s:%s" (caaar opened)
2331 ;; It could be a named method, search all servers
2332 (let ((servers gnus-secondary-select-methods))
2334 (not (equal server (format "%s:%s" (caar servers)
2339 (defmacro gnus-method-equal (ss1 ss2)
2340 "Say whether two servers are equal."
2344 (and (= (length s1) (length s2))
2346 (while (and s1 (member (car s1) s2))
2350 (defun gnus-server-equal (m1 m2)
2351 "Say whether two methods are equal."
2352 (let ((m1 (cond ((null m1) gnus-select-method)
2353 ((stringp m1) (gnus-server-to-method m1))
2355 (m2 (cond ((null m2) gnus-select-method)
2356 ((stringp m2) (gnus-server-to-method m2))
2358 (gnus-method-equal m1 m2)))
2360 (defun gnus-servers-using-backend (backend)
2361 "Return a list of known servers using BACKEND."
2362 (let ((opened gnus-opened-servers)
2365 (when (eq backend (caaar opened))
2366 (push (caar opened) out))
2370 (defun gnus-archive-server-wanted-p ()
2371 "Say whether the user wants to use the archive server."
2373 ((or (not gnus-message-archive-method)
2374 (not gnus-message-archive-group))
2376 ((and gnus-message-archive-method gnus-message-archive-group)
2379 (let ((active (cadr (assq 'nnfolder-active-file
2380 gnus-message-archive-method))))
2382 (file-exists-p active))))))
2384 (defun gnus-group-prefixed-name (group method)
2385 "Return the whole name from GROUP and METHOD."
2386 (and (stringp method) (setq method (gnus-server-to-method method)))
2387 (if (or (not method)
2388 (gnus-server-equal method "native"))
2390 (concat (format "%s" (car method))
2392 (or (assoc (format "%s" (car method))
2393 (gnus-methods-using 'address))
2394 (gnus-server-equal method gnus-message-archive-method))
2396 (not (string= (nth 1 method) "")))
2397 (concat "+" (nth 1 method)))
2400 (defun gnus-group-real-prefix (group)
2401 "Return the prefix of the current group name."
2402 (if (string-match "^[^:]+:" group)
2403 (substring group 0 (match-end 0))
2406 (defun gnus-group-method (group)
2407 "Return the server or method used for selecting GROUP.
2408 You should probably use `gnus-find-method-for-group' instead."
2409 (let ((prefix (gnus-group-real-prefix group)))
2410 (if (equal prefix "")
2412 (let ((servers gnus-opened-servers)
2414 backend possible found)
2415 (if (string-match "^[^\\+]+\\+" prefix)
2416 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2417 server (substring prefix (match-end 0) (1- (length prefix))))
2418 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2420 (when (eq (caaar servers) backend)
2421 (setq possible (caar servers))
2422 (when (equal (cadaar servers) server)
2423 (setq found (caar servers))))
2425 (or (car (rassoc found gnus-server-alist))
2427 (car (rassoc possible gnus-server-alist))
2429 (list backend server))))))
2431 (defsubst gnus-native-method-p (method)
2432 "Return whether METHOD is the native select method."
2433 (gnus-method-equal method gnus-select-method))
2435 (defsubst gnus-secondary-method-p (method)
2436 "Return whether METHOD is a secondary select method."
2437 (let ((methods gnus-secondary-select-methods)
2438 (gmethod (gnus-server-get-method nil method)))
2440 (not (gnus-method-equal
2441 (gnus-server-get-method nil (car methods))
2443 (setq methods (cdr methods)))
2446 (defun gnus-method-simplify (method)
2447 "Return the shortest uniquely identifying string or method for METHOD."
2448 (cond ((gnus-native-method-p method)
2450 ((gnus-secondary-method-p method)
2451 (format "%s:%s" (nth 0 method) (nth 1 method)))
2455 (defun gnus-groups-from-server (server)
2456 "Return a list of all groups that are fetched from SERVER."
2457 (let ((alist (cdr gnus-newsrc-alist))
2459 (while (setq info (pop alist))
2460 (when (gnus-server-equal (gnus-info-method info) server)
2461 (push (gnus-info-group info) groups)))
2462 (sort groups 'string<)))
2464 (defun gnus-group-foreign-p (group)
2465 "Say whether a group is foreign or not."
2466 (and (not (gnus-group-native-p group))
2467 (not (gnus-group-secondary-p group))))
2469 (defun gnus-group-native-p (group)
2470 "Say whether the group is native or not."
2471 (not (string-match ":" group)))
2473 (defun gnus-group-secondary-p (group)
2474 "Say whether the group is secondary or not."
2475 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2477 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2478 "Return the group parameters for GROUP.
2479 If SYMBOL, return the value of that symbol in the group parameters."
2481 (set-buffer gnus-group-buffer)
2482 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2484 (gnus-group-parameter-value parameters symbol allow-list)
2487 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2488 "Return the group parameters for GROUP.
2489 If SYMBOL, return the value of that symbol in the group parameters.
2490 Most functions should use `gnus-group-find-parameter', which
2491 also examines the topic parameters."
2492 (let ((params (gnus-info-params (gnus-get-info group))))
2494 (gnus-group-parameter-value params symbol allow-list)
2497 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2498 "Return the value of SYMBOL in group PARAMS."
2499 ;; We only wish to return group parameters (dotted lists) and
2500 ;; not local variables, which may have the same names.
2501 ;; But first we handle single elements...
2502 (or (car (memq symbol params))
2506 (while (setq elem (pop params))
2507 (when (and (consp elem)
2508 (eq (car elem) symbol)
2511 (throw 'found (cdr elem))))))))
2513 (defun gnus-group-add-parameter (group param)
2514 "Add parameter PARAM to GROUP."
2515 (let ((info (gnus-get-info group)))
2517 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2518 ;; Cons the new param to the old one and update.
2519 (gnus-group-set-info (cons param (gnus-info-params info))
2522 (defun gnus-group-set-parameter (group name value)
2523 "Set parameter NAME to VALUE in GROUP."
2524 (let ((info (gnus-get-info group)))
2526 (gnus-group-remove-parameter group name)
2527 (let ((old-params (gnus-info-params info))
2528 (new-params (list (cons name value))))
2530 (when (or (not (listp (car old-params)))
2531 (not (eq (caar old-params) name)))
2532 (setq new-params (append new-params (list (car old-params)))))
2533 (setq old-params (cdr old-params)))
2534 (gnus-group-set-info new-params group 'params)))))
2536 (defun gnus-group-remove-parameter (group name)
2537 "Remove parameter NAME from GROUP."
2538 (let ((info (gnus-get-info group)))
2540 (let ((params (gnus-info-params info)))
2542 (setq params (delq name params))
2543 (while (assq name params)
2544 (gnus-pull name params))
2545 (gnus-info-set-params info params))))))
2547 (defun gnus-group-add-score (group &optional score)
2548 "Add SCORE to the GROUP score.
2549 If SCORE is nil, add 1 to the score of GROUP."
2550 (let ((info (gnus-get-info group)))
2552 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2554 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2555 (defun gnus-short-group-name (group &optional levels)
2556 "Collapse GROUP name LEVELS.
2557 Select methods are stripped and any remote host name is stripped down to
2558 just the host name."
2565 (while (string-match "\\." group skip)
2566 (setq skip (match-end 0)
2569 ;; separate foreign select method from group name and collapse.
2570 ;; if method contains a server, collapse to non-domain server name,
2571 ;; otherwise collapse to select method
2572 (let* ((colon (string-match ":" group))
2573 (server (and colon (substring group 0 colon)))
2574 (plus (and server (string-match "+" server))))
2577 (setq foreign (substring server (+ 1 plus)
2578 (string-match "\\." server))
2579 group (substring group (+ 1 colon))))
2581 (setq foreign server
2582 group (substring group (+ 1 colon)))))
2583 (setq foreign (concat foreign ":"))))
2584 ;; collapse group name leaving LEVELS uncollapsed elements
2586 (if (and (string-match "\\." group) (> levels 0))
2587 (setq name (concat name (substring group 0 1))
2588 group (substring group (match-end 0))
2590 name (concat name "."))
2591 (setq name (concat foreign name group)
2595 (defun gnus-narrow-to-body ()
2596 "Narrow to the body of an article."
2599 (goto-char (point-min))
2600 (or (search-forward "\n\n" nil t)
2606 ;;; Kill file handling.
2609 (defun gnus-apply-kill-file ()
2610 "Apply a kill file to the current newsgroup.
2611 Returns the number of articles marked as read."
2612 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2613 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2614 (gnus-apply-kill-file-internal)
2617 (defun gnus-kill-save-kill-buffer ()
2618 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2619 (when (get-file-buffer file)
2621 (set-buffer (get-file-buffer file))
2622 (when (buffer-modified-p)
2624 (kill-buffer (current-buffer))))))
2626 (defcustom gnus-kill-file-name "KILL"
2627 "Suffix of the kill files."
2628 :group 'gnus-score-kill
2629 :group 'gnus-score-files
2632 (defun gnus-newsgroup-kill-file (newsgroup)
2633 "Return the name of a kill file name for NEWSGROUP.
2634 If NEWSGROUP is nil, return the global kill file name instead."
2636 ;; The global KILL file is placed at top of the directory.
2637 ((or (null newsgroup)
2638 (string-equal newsgroup ""))
2639 (expand-file-name gnus-kill-file-name
2640 gnus-kill-files-directory))
2641 ;; Append ".KILL" to newsgroup name.
2642 ((gnus-use-long-file-name 'not-kill)
2643 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2644 "." gnus-kill-file-name)
2645 gnus-kill-files-directory))
2646 ;; Place "KILL" under the hierarchical directory.
2648 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2649 "/" gnus-kill-file-name)
2650 gnus-kill-files-directory))))
2654 (defun gnus-member-of-valid (symbol group)
2655 "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2657 (symbol-name (car (gnus-find-method-for-group group)))
2658 gnus-valid-select-methods)))
2660 (defun gnus-method-option-p (method option)
2661 "Return non-nil if select METHOD has OPTION as a parameter."
2662 (when (stringp method)
2663 (setq method (gnus-server-to-method method)))
2664 (memq option (assoc (format "%s" (car method))
2665 gnus-valid-select-methods)))
2667 (defun gnus-similar-server-opened (method)
2668 (let ((opened gnus-opened-servers))
2669 (while (and method opened)
2670 (when (and (equal (cadr method) (cadaar opened))
2671 (equal (car method) (caaar opened))
2672 (not (equal method (caar opened))))
2677 (defun gnus-server-extend-method (group method)
2678 ;; This function "extends" a virtual server. If the server is
2679 ;; "hello", and the select method is ("hello" (my-var "something"))
2680 ;; in the group "alt.alt", this will result in a new virtual server
2681 ;; called "hello+alt.alt".
2682 (if (or (not (inline (gnus-similar-server-opened method)))
2683 (not (cddr method)))
2685 `(,(car method) ,(concat (cadr method) "+" group)
2686 (,(intern (format "%s-address" (car method))) ,(cadr method))
2689 (defun gnus-server-status (method)
2690 "Return the status of METHOD."
2691 (nth 1 (assoc method gnus-opened-servers)))
2693 (defun gnus-group-name-to-method (group)
2694 "Guess a select method based on GROUP."
2695 (if (string-match ":" group)
2696 (let ((server (substring group 0 (match-beginning 0))))
2697 (if (string-match "\\+" server)
2698 (list (intern (substring server 0 (match-beginning 0)))
2699 (substring server (match-end 0)))
2700 (list (intern server) "")))
2701 gnus-select-method))
2703 (defun gnus-find-method-for-group (group &optional info)
2704 "Find the select method that GROUP uses."
2705 (or gnus-override-method
2708 (let ((info (or info (gnus-get-info group)))
2711 (not (setq method (gnus-info-method info)))
2712 (equal method "native"))
2715 (cond ((stringp method)
2716 (inline (gnus-server-to-method method)))
2717 ((stringp (cadr method))
2718 (inline (gnus-server-extend-method group method)))
2721 (cond ((equal (cadr method) "")
2723 ((null (cadr method))
2724 (list (car method) ""))
2726 (gnus-server-add-address method)))))))
2728 (defun gnus-methods-using (feature)
2729 "Find all methods that have FEATURE."
2730 (let ((valids gnus-valid-select-methods)
2733 (when (memq feature (car valids))
2734 (push (car valids) outs))
2735 (setq valids (cdr valids)))
2738 (defun gnus-read-group (prompt &optional default)
2739 "Prompt the user for a group name.
2740 Disallow invalid group names."
2746 (setq group (read-string (concat prefix prompt)
2747 (cons (or default "") 0)
2748 'gnus-group-history)))
2749 (setq prefix (format "Invalid group name: \"%s\". " group)
2753 (defun gnus-read-method (prompt)
2754 "Prompt the user for a method.
2755 Allow completion over sensible values."
2757 (append gnus-valid-select-methods
2758 gnus-predefined-server-alist
2763 nil t nil 'gnus-method-history)))
2766 (setq method gnus-select-method))
2767 ((assoc method gnus-valid-select-methods)
2768 (list (intern method)
2769 (if (memq 'prompt-address
2770 (assoc method gnus-valid-select-methods))
2771 (read-string "Address: ")
2773 ((assoc method servers)
2776 (list (intern method) "")))))
2778 ;;; User-level commands.
2781 (defun gnus-slave-no-server (&optional arg)
2782 "Read network news as a slave, without connecting to local server."
2784 (gnus-no-server arg t))
2787 (defun gnus-no-server (&optional arg slave)
2789 If ARG is a positive number, Gnus will use that as the
2790 startup level. If ARG is nil, Gnus will be started at level 2.
2791 If ARG is non-nil and not a positive number, Gnus will
2792 prompt the user for the name of an NNTP server to use.
2793 As opposed to `gnus', this command will not connect to the local server."
2795 (gnus-no-server-1 arg slave))
2798 (defun gnus-slave (&optional arg)
2799 "Read news as a slave."
2801 (gnus arg nil 'slave))
2804 (defun gnus-other-frame (&optional arg)
2805 "Pop up a frame to read news."
2807 (let ((window (get-buffer-window gnus-group-buffer)))
2809 (select-frame (window-frame window)))
2815 (defun gnus (&optional arg dont-connect slave)
2817 If ARG is non-nil and a positive number, Gnus will use that as the
2818 startup level. If ARG is non-nil and not a positive number, Gnus will
2819 prompt the user for the name of an NNTP server to use."
2821 (gnus-1 arg dont-connect slave))
2823 ;; Allow redefinition of Gnus functions.
2829 ;;; gnus.el ends here