| blob | 0d73ceecbfe586e2ab79c3bc7cca5784e7bfb72f |
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)
13 ;; any later version.
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.
25 ;;; Commentary:
27 ;;; Code:
38 "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
43 "Starting your favorite newsreader."
47 "Server options at startup."
50 ;; These belong to gnus-group.el.
52 "Group buffers."
57 "Foreign groups."
62 "Automatic subscription of new groups."
66 "Group levels."
71 "Selecting a Group."
76 "Showing slices of the group list."
81 "Sorting the group buffer."
87 "Various group options."
91 ;; These belong to gnus-sum.el.
93 "Summary buffers."
98 "Leaving summary buffers."
103 "Marks used in summary buffers."
108 "Ordering articles according to replies."
113 "Formatting of the summary buffer."
118 "Choosing Articles."
123 "Summary movement commands."
128 "Mail group commands."
133 "Sorting the summary buffer."
138 "Highlighting and menus in the summary buffer."
144 "Various summary buffer options."
148 ;; Belongs to gnus-uu.el
150 "Viewing extracted files."
154 ;; Belongs to gnus-score.el
156 "Score and kill file handling."
160 "Kill files."
164 "Adaptive score files."
168 "Default values for score files."
172 "Expiring score rules."
176 "Decaying score rules."
180 "Score and kill file names."
185 "Various scoring and killing options."
188 ;; Other
190 "Options controling the visual fluff."
195 "Files used by Gnus."
199 "Auto save file."
204 "Storing Gnus state."
208 "Options related to newsservers and other servers used by Gnus."
212 "Composing replies and followups in Gnus."
216 "Meta variables controling major portions of Gnus.
217 In general, modifying these variables does not take affect until Gnus
218 is restarted, and sometimes reloaded."
222 "Other Gnus options."
227 "Exiting gnus."
238 "If non-nil, the startup message will not be displayed.
239 This variable is used before `.gnus.el' is loaded, so it should
240 be set in `.emacs' instead."
245 "If non-nil, play the Gnus jingle at startup."
249 ;;; Kludges to help the transition from the old `custom.el'.
270 ;; The XEmacs people think this is evil, so it must go.
272 "Lookup or create a face with specified attributes."
277 bold italic underline))))
280 ()
307 name))
309 ;; We define these group faces here to avoid the display
310 ;; update forced when creating new faces.
320 ()))
331 ()))
342 ()))
353 ()))
364 ()))
370 ())
373 ())
375 ()))
386 ()))
397 ()))
463 ()))
488 ;; Summary mode faces.
529 ()))
562 ()))
577 ()))
614 ()))
618 ;;; Splash screen.
633 ()))
648 "Indent rigidly using only spaces and no tabs."
653 ;; We translate tabs into spaces -- not everybody uses
654 ;; an 8-character tab.
662 "Insert startup message in current buffer."
663 ;; Insert the message.
667 _ ___ _ _
668 _ ___ __ ___ __ _ ___
669 __ _ ___ __ ___
670 _ ___ _
671 _ _ __ _
672 ___ __ _
673 __ _
674 _ _ _
675 _ _ _
676 _ _ _
677 __ ___
678 _ _ _ _
679 _ _
680 _ _
681 _ _
682 _
683 __
685 "
687 ;; And then hack it.
696 ;; Fontify some.
709 ;;; Do the rest.
717 All other Gnus path variables are initialized from this variable."
723 "Directory variable from which all other Gnus file variables are derived."
728 "*Default directory for all Gnus buffers."
731 directory))
733 ;; Site dependent variables. These variables should be defined in
734 ;; paths.el.
737 "Specify a default NNTP server.
738 This variable should be defined in paths.el, and should never be set
739 by the user.
740 If you want to change servers, you should use `gnus-select-method'.
743 ;; Don't touch this variable.
746 This is an obsolete variable, which is scarcely used. If you use an
747 nntp server for your newsgroup and want to change the port number
748 used to 899, you would say something along these lines:
753 "A file with only the name of the nntp server in it."
758 ;; This function is used to check both the environment variable
759 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
760 ;; an nntp server name default.
771 nil
772 name)
783 gnus-default-nntp-server)
787 nil
790 "Default method for selecting a newsgroup.
791 This variable should be a list, where the first element is how the
792 news is to be fetched, the second is the address.
794 For instance, if you want to get your news via NNTP from
799 If you want to use your local spool, say:
801 \(setq gnus-select-method (list 'nnspool (system-name)))
803 If you use this variable, you must set `gnus-nntp-server' to nil.
805 There is a lot more to know about select methods and virtual servers -
806 see the manual for details."
812 "archive"
818 "Method used for archiving messages you've sent.
819 This should be a mail method.
821 It's probably not a very effective to change this variable once you've
822 run Gnus once. After doing that, you must edit this server from the
823 server buffer."
829 "*Name of the group in which to save the messages you've written.
830 This can either be a string; a list of strings; or an alist
831 of regexps/functions/forms to be evaluated to return a string (or a list
832 of strings). The functions are called with the name of the current
833 group (or nil) as a parameter.
835 If you want to save your mail in one group and the news articles you
836 write in another group, you could say something like:
838 \(setq gnus-message-archive-group
839 '((if (message-news-p)
843 Normally the group names returned by this variable should be
845 However, you may wish to store the message on some other server. In
846 that case, just return a fully prefixed name of the group --
850 string))
853 "List of NNTP servers that the user can choose between interactively.
854 To make Gnus query you for a server, you have to give `gnus' a
855 non-numeric prefix - `C-u M-x gnus', in short."
860 "*The name of the host running the NNTP server.
861 This variable is semi-obsolete. Use the `gnus-select-method'
862 variable instead."
865 string))
868 "A list of secondary methods that will be used for reading news.
869 This is a list where each element is a complete select method (see
870 `gnus-select-method').
872 If, for instance, you want to read your mail with the nnml backend,
873 you could set this variable:
881 "Default default new newsgroups the first time Gnus is run.
885 "Local domain name without a host name.
886 The DOMAINNAME environment variable is used instead if it is defined.
887 If the `system-name' function returns the full Internet name, there is
888 no need to set this variable."
891 string))
894 "String with a description of what organization (if any) the user belongs to.
897 ;; Customization variables
900 "Preferred method for fetching an article by Message-ID.
901 If you are reading news from the local spool (with nnspool), fetching
902 articles by Message-ID is painfully slow. By setting this method to an
903 nntp method, you might get acceptable results.
905 The value of this variable must be a valid select method as discussed
906 in the documentation of `gnus-select-method'."
909 gnus-select-method))
913 "/ftp@sunsite.auc.dk:/pub/usenet/"
914 "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
915 "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
916 "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
917 "/ftp@rtfm.mit.edu:/pub/usenet/"
918 "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
919 "/ftp@ftp.sunet.se:/pub/usenet/"
920 "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
921 "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
923 "Directory where the group FAQs are stored.
924 This will most commonly be on a remote machine, and the file will be
925 fetched by ange-ftp.
927 This variable can also be a list of directories. In that case, the
928 first element in the list will be used by default. The others can
929 be used when being prompted for a site.
931 Note that Gnus uses an aol machine as the default directory. If this
932 feels fundamentally unclean, just think of it as a way to finally get
933 something of value back from them.
935 If the default site is too slow, try one of these:
937 North America: mirrors.aol.com /pub/rtfm/usenet
938 ftp.seas.gwu.edu /pub/rtfm
939 rtfm.mit.edu /pub/usenet
940 Europe: ftp.uni-paderborn.de /pub/FAQ
941 src.doc.ic.ac.uk /usenet/news-FAQS
942 ftp.sunet.se /pub/usenet
943 sunsite.auc.dk /pub/usenet
944 Asia: nctuccca.edu.tw /USENET/FAQ
945 hwarang.postech.ac.kr /pub/usenet
946 ftp.hk.super.net /mirror/faqs"
952 "*Non-nil means that cross referenced articles will be marked as read.
953 If nil, ignore cross references. If t, mark articles as read in
954 subscribed newsgroups. If neither t nor nil, mark as read in all
955 newsgroups."
963 "*Process mark."
969 "*If non-nil, Gnus will supply backends with data needed for async article fetching."
974 "*The number of articles which indicates a large newsgroup.
975 If the number of articles in a newsgroup is greater than this value,
976 confirmation is required for selecting the newsgroup."
981 "*Non-nil means that the default name of a file to save articles in is the group name.
982 If it's nil, the directory form of the group name is used instead.
984 If this variable is a list, and the list contains the element
985 `not-score', long file names will not be used for score files; if it
986 contains the element `not-save', long file names will not be used for
987 saving; and if it contains the element `not-kill', long file names
988 will not be used for kill files.
990 Note that the default for this variable varies according to what system
991 type you're using. On `usg-unix-v' and `xenix' this variable defaults
992 to nil while on all other systems it defaults to t."
1003 "*If non-nil, save group scoring info."
1009 "*If non-nil, allow undoing in Gnus group mode buffers."
1014 "*If non-nil, use some adaptive scoring scheme.
1015 If a list, then the values `word' and `line' are meaningful. The
1016 former will perform adaption on individual words in the subject
1017 header while `line' will perform adaption on several headers."
1023 "*If nil, Gnus will ignore the article cache.
1024 If `passive', it will allow entering (and reading) articles
1025 explicitly entered into the cache. If anything else, use the
1026 cache to the full extent of the law."
1034 "*If non-nil, display a thread tree buffer."
1039 "*If non-nil, use GroupLens ratings."
1044 "*If non-nil, Gnus will keep read articles for later re-retrieval.
1045 If it is a number N, then Gnus will only keep the last N articles
1046 read. If it is neither nil nor a number, Gnus will keep all read
1047 articles. This is not a good idea."
1050 integer
1055 "*If non-nil, Gnus will read NoCeM cancel messages."
1060 "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1065 "If non-nil, Gnus might use some demons."
1070 "*If non-nil, enable scoring."
1075 "*If non-nil, display picons."
1081 "A hook called when preparing to exit from the summary buffer.
1082 It calls `gnus-summary-expire-articles' by default."
1087 "*Non-nil means that you are a usenet novice.
1088 If non-nil, verbose messages may be displayed and confirmations may be
1089 required."
1094 "*Non-nil means that you will never be asked for confirmation about anything.
1095 And that means *anything*."
1100 "*If non-nil, require your confirmation when catching up a group."
1105 "*If non-nil, require your confirmation when exiting Gnus."
1110 "*Function for extracting address components from a From header.
1111 Two pre-defined function exist: `gnus-extract-address-components',
1112 which is the default, quite fast, and too simplistic solution, and
1113 `mail-extract-address-components', which works much better, but is
1114 slower."
1121 "*If non-nil, display clickable icons."
1126 "String used to separate to shell commands."
1147 "An alist of valid select methods.
1148 The first element of each list lists should be a string with the name
1149 of the select method. The other elements may be the category of
1150 this method (i. e., `post', `mail', `none' or whatever) or other
1151 properties that this method has (like being respoolable).
1152 If you implement a new select method, all you should have to change is
1153 this variable. I think."
1167 "Widget for entering a select method."
1172 gnus-valid-select-methods))
1176 variable
1180 "List of buffers that should update their mode lines.
1181 The list may contain the symbols `group', `article', `tree' and
1182 `summary'. If the corresponding symbol is present, Gnus will keep
1183 that mode line updated with information that may be pertinent.
1184 If this variable is nil, screen refresh may be quicker."
1191 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1193 "*Max length of mode-line non-string contents.
1194 If this is nil, Gnus will take space as is needed, leaving the rest
1195 of the modeline intact. Note that the default of nil is unlikely
1196 to be desirable; see the manual for further details."
1199 integer))
1202 "*Groups in which to automatically mark read articles as expirable.
1203 If non-nil, this should be a regexp that should match all groups in
1204 which to perform auto-expiry. This only makes sense for mail groups."
1207 regexp))
1210 "*Groups in which to perform expiry of all read articles.
1211 Use with extreme caution. All groups that match this regexp will be
1212 expiring - which means that all read articles will be deleted after
1213 \(say) one week. (This only goes for mail groups and the like, of
1214 course.)"
1217 regexp))
1220 "Number of group name elements to leave alone when making a short group name."
1225 "*If non-nil, once you set a level, Gnus will use this level."
1229 ;; Hooks.
1232 "A hook run while Gnus is loaded."
1237 "A hook called to apply kill files to a group.
1238 This hook is intended to apply a kill file to the selected newsgroup.
1239 The function `gnus-apply-kill-file' is called by default.
1241 Since a general kill file is too heavy to use only for a few
1242 newsgroups, I recommend you to use a lighter hook function. For
1243 example, if you'd like to apply a kill file to articles which contains
1244 a string `rmgroup' in subject in newsgroup `control', you can use the
1245 following hook:
1247 (setq gnus-apply-kill-hook
1248 (list
1249 (lambda ()
1258 "Function run when a group level is changed.
1259 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1263 ;;; Face thingies.
1267 mouse-face
1268 summary-menu group-menu article-menu
1269 tree-highlight menu highlight
1270 browse-menu server-menu
1271 page-marker tree-menu binary-menu pick-menu
1272 grouplens-menu)
1273 "Enable visual features.
1274 If `visual' is disabled, there will be no menus and few faces. Most of
1275 the visual customization options below will be ignored. Gnus will use
1276 less space and be faster as a result.
1278 This variable can also be a list of visual elements to switch on. For
1279 instance, to switch off all visual things except menus, you can say:
1281 (setq gnus-visual '(menu))
1283 Valid elements include `summary-highlight', `group-highlight',
1284 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1285 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1286 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1287 and `grouplens-menu'."
1316 "Face used for group or summary buffer mouse highlighting.
1317 The line beneath the mouse pointer will be highlighted with this
1318 face."
1326 gnus-article-hide-boring-headers
1327 gnus-article-treat-overstrike
1328 gnus-article-maybe-highlight
1329 gnus-article-display-x-face)
1331 gnus-article-hide-boring-headers
1332 gnus-article-treat-overstrike
1333 gnus-article-maybe-highlight))
1334 "Controls how the article buffer will look.
1336 If you leave the list empty, the article will appear exactly as it is
1337 stored on the disk. The list entries will hide or highlight various
1338 parts of the article, making it easier to find the information you
1339 want."
1344 gnus-article-add-buttons-to-head
1345 gnus-article-emphasize
1346 gnus-article-fill-cited-article
1347 gnus-article-remove-cr
1348 gnus-article-de-quoted-unreadable
1349 gnus-article-display-x-face
1350 gnus-summary-stop-page-breaking
1351 ;; gnus-summary-caesar-message
1352 ;; gnus-summary-verbose-headers
1353 gnus-summary-toggle-mime
1354 gnus-article-hide
1355 gnus-article-hide-headers
1356 gnus-article-hide-boring-headers
1357 gnus-article-hide-signature
1358 gnus-article-hide-citation
1359 gnus-article-hide-pgp
1360 gnus-article-hide-pem
1361 gnus-article-highlight
1362 gnus-article-highlight-headers
1363 gnus-article-highlight-citation
1364 gnus-article-highlight-signature
1365 gnus-article-date-ut
1366 gnus-article-date-local
1367 gnus-article-date-lapsed
1368 gnus-article-date-original
1369 gnus-article-remove-trailing-blank-lines
1370 gnus-article-strip-leading-blank-lines
1371 gnus-article-strip-multiple-blank-lines
1372 gnus-article-strip-blank-lines
1373 gnus-article-treat-overstrike))
1380 \f
1381 ;;; Internal variables
1393 ;; Dummy variable.
1396 ;; Variable holding the user answers to all method prompts.
1400 ;; Variable holding the user answers to all mail method prompts.
1403 ;; Variable holding the user answers to all group prompts.
1437 "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1466 gnus-newsrc-last-checked-date
1467 gnus-newsrc-alist gnus-server-alist
1468 gnus-killed-list gnus-zombie-list
1469 gnus-topic-topology gnus-topic-alist
1470 gnus-format-specs)
1474 "Assoc list of read articles.
1501 ;; Save window configuration.
1506 ;;; Let the byte-compiler know that we know about this variable.
1511 ;;; End of variables.
1513 ;; Define some autoload functions Gnus might use.
1516 ;; This little mapcar goes through the list below and marks the
1517 ;; symbols in question as autoloaded functions.
1538 message-send-and-exit message-yank-original)
1542 timezone-make-sortable-date timezone-make-time-string)
1545 rmail-show-message)
1549 gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1550 gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1554 gnus-Folder-save-name gnus-folder-save-name)
1557 gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1558 gnus-demon-add-disconnection gnus-demon-add-handler
1559 gnus-demon-remove-handler)
1561 gnus-demon-init gnus-demon-cancel)
1563 gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1565 gnus-nocem-unwanted-article-p)
1569 gnus-article-highlight-citation gnus-article-hide-citation-maybe
1570 gnus-article-hide-citation gnus-article-fill-cited-article
1571 gnus-article-hide-citation-in-followups)
1573 gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1574 gnus-execute gnus-expunge)
1576 gnus-cache-possibly-remove-articles gnus-cache-request-article
1577 gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1578 gnus-cache-enter-remove-article gnus-cached-article-p
1579 gnus-cache-open gnus-cache-close gnus-cache-update-article)
1581 gnus-cache-remove-article gnus-summary-insert-cached-articles)
1583 gnus-summary-increase-score gnus-summary-set-score
1584 gnus-summary-raise-thread gnus-summary-raise-same-subject
1585 gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1586 gnus-summary-lower-thread gnus-summary-lower-same-subject
1587 gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1588 gnus-summary-current-score gnus-score-default
1589 gnus-score-flush-cache gnus-score-close
1590 gnus-possibly-score-headers gnus-score-followup-article
1591 gnus-score-followup-thread)
1594 gnus-current-score-file-nondirectory gnus-score-adaptive
1595 gnus-score-find-trace gnus-score-file-name)
1602 gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1603 gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1604 gnus-uu-mark-by-regexp gnus-uu-mark-all
1605 gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1606 gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1607 gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1608 gnus-uu-decode-binhex gnus-uu-decode-uu-view
1609 gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1610 gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1611 gnus-uu-decode-binhex-view)
1614 gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1616 gnus-group-post-news gnus-group-mail gnus-summary-post-news
1617 gnus-summary-followup gnus-summary-followup-with-original
1618 gnus-summary-cancel-article gnus-summary-supersede-article
1619 gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1620 gnus-summary-mail-forward gnus-summary-mail-other-window
1621 gnus-summary-resend-message gnus-summary-resend-bounced-mail
1622 gnus-bug)
1624 gnus-group-display-picons gnus-picons-article-display-x-face
1625 gnus-picons-display-x-face)
1627 gnus-grouplens-mode)
1631 gnus-list-of-unread-articles gnus-list-of-read-articles
1632 gnus-offer-save-summaries gnus-make-thread-indent-array
1633 gnus-summary-exit gnus-update-read-articles)
1635 gnus-group-list-groups gnus-group-first-unread-group
1636 gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1637 gnus-group-setup-buffer gnus-group-get-new-news
1638 gnus-group-make-help-group gnus-group-update-group)
1640 gnus-backlog-remove-article)
1642 gnus-article-prepare gnus-article-set-window-start
1643 gnus-article-next-page gnus-article-prev-page
1644 gnus-request-article-this-buffer gnus-article-mode
1645 gnus-article-setup-buffer gnus-narrow-to-page
1646 gnus-article-delete-invisible-text)
1648 gnus-article-hide-headers gnus-article-hide-boring-headers
1649 gnus-article-treat-overstrike gnus-article-word-wrap
1650 gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1651 gnus-article-display-x-face gnus-article-de-quoted-unreadable
1652 gnus-article-mime-decode-quoted-printable gnus-article-hide-pgp
1653 gnus-article-hide-pem gnus-article-hide-signature
1654 gnus-article-strip-leading-blank-lines gnus-article-date-local
1655 gnus-article-date-original gnus-article-date-lapsed
1656 gnus-article-show-all-headers
1657 gnus-article-edit-mode gnus-article-edit-article
1658 gnus-article-edit-done gnus-decode-rfc1522 article-decode-rfc1522)
1661 gnus-dribble-enter)
1663 gnus-dup-enter-articles)
1667 gnus-group-move-group-to-server gnus-change-server)
1671 gnus-async-prefetch-article gnus-async-prefetch-remove-group
1672 gnus-async-halt-prefetch)
1674 gnus-summary-save-article-vm))))
1676 ;;; gnus-sum.el thingies
1680 "*The format specification of the lines in the summary buffer.
1682 It works along the same lines as a normal formatting string,
1683 with some simple extensions.
1685 %N Article number, left padded with spaces (string)
1686 %S Subject (string)
1688 %n Name of the poster (string)
1689 %a Extracted name of the poster (string)
1690 %A Extracted address of the poster (string)
1691 %F Contents of the From: header (string)
1692 %x Contents of the Xref: header (string)
1693 %D Date of the article (string)
1694 %d Date of the article (string) in DD-MMM format
1695 %M Message-id of the article (string)
1696 %r References of the article (string)
1697 %c Number of characters in the article (integer)
1698 %L Number of lines in the article (integer)
1699 %I Indentation based on thread level (a string of spaces)
1700 %T A string with two possible values: 80 spaces if the article
1701 is on thread level two or larger and 0 spaces on level one
1706 %> Spaces of length thread-level (string)
1707 %< Spaces of length (- 20 thread-level) (string)
1708 %i Article score (number)
1709 %z Article zcore (character)
1710 %t Number of articles under the current thread (number).
1711 %e Whether the thread is empty or not (character).
1712 %l GroupLens score (string).
1713 %V Total thread score (number).
1714 %P The line number (number).
1715 %u User defined specifier. The next character in the format string should
1716 be a letter. Gnus will call the function gnus-user-format-function-X,
1717 where X is the letter following %u. The function will be passed the
1718 current header as argument. The function should return a string, which
1719 will be inserted into the summary just like information from any other
1720 summary specifier.
1722 Text between %( and %) will be highlighted with `gnus-mouse-face'
1723 when the mouse point is placed inside the area. There can only be one
1724 such area.
1726 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1727 with care. For reasons of efficiency, Gnus will compute what column
1729 it is illegal to have these specs after a variable-length spec. Well,
1730 you might not be arrested, but your summary buffer will look strange,
1731 which is bad enough.
1733 The smart choice is to have these specs as for to the left as
1734 possible.
1736 This restriction may disappear in later versions of Gnus."
1740 ;;;
1741 ;;; Skeleton keymaps
1742 ;;;
1747 (while keys
1748 (define-key keymap (pop keys) 'undefined))))
1750 (defvar gnus-article-mode-map
1751 (let ((keymap (make-keymap)))
1752 (gnus-suppress-keymap keymap)
1753 keymap))
1754 (defvar gnus-summary-mode-map
1755 (let ((keymap (make-keymap)))
1756 (gnus-suppress-keymap keymap)
1757 keymap))
1758 (defvar gnus-group-mode-map
1759 (let ((keymap (make-keymap)))
1760 (gnus-suppress-keymap keymap)
1761 keymap))
1763 \f
1765 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1766 ;; If you want the cursor to go somewhere else, set these two
1767 ;; functions in some startup hook to whatever you want.
1768 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1769 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1771 ;;; Various macros and substs.
1773 (defun gnus-header-from (header)
1774 (mail-header-from header))
1776 (defmacro gnus-gethash (string hashtable)
1777 "Get hash value of STRING in HASHTABLE."
1778 `(symbol-value (intern-soft ,string ,hashtable)))
1780 (defmacro gnus-sethash (string value hashtable)
1781 "Set hash value. Arguments are STRING, VALUE, and HASHTABLE."
1782 `(set (intern ,string ,hashtable) ,value))
1783 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1785 (defmacro gnus-group-unread (group)
1786 "Get the currently computed number of unread articles in GROUP."
1787 `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1789 (defmacro gnus-group-entry (group)
1790 "Get the newsrc entry for GROUP."
1791 `(gnus-gethash ,group gnus-newsrc-hashtb))
1793 (defmacro gnus-active (group)
1794 "Get active info on GROUP."
1795 `(gnus-gethash ,group gnus-active-hashtb))
1797 (defmacro gnus-set-active (group active)
1798 "Set GROUP's active info."
1799 `(gnus-sethash ,group ,active gnus-active-hashtb))
1801 (defun gnus-alive-p ()
1802 "Say whether Gnus is running or not."
1803 (and gnus-group-buffer
1804 (get-buffer gnus-group-buffer)
1805 (save-excursion
1806 (set-buffer gnus-group-buffer)
1807 (eq major-mode 'gnus-group-mode))))
1809 ;; Info access macros.
1811 (defmacro gnus-info-group (info)
1812 `(nth 0 ,info))
1813 (defmacro gnus-info-rank (info)
1814 `(nth 1 ,info))
1815 (defmacro gnus-info-read (info)
1816 `(nth 2 ,info))
1817 (defmacro gnus-info-marks (info)
1818 `(nth 3 ,info))
1819 (defmacro gnus-info-method (info)
1820 `(nth 4 ,info))
1821 (defmacro gnus-info-params (info)
1822 `(nth 5 ,info))
1824 (defmacro gnus-info-level (info)
1825 `(let ((rank (gnus-info-rank ,info)))
1826 (if (consp rank)
1827 (car rank)
1828 rank)))
1829 (defmacro gnus-info-score (info)
1830 `(let ((rank (gnus-info-rank ,info)))
1831 (or (and (consp rank) (cdr rank)) 0)))
1833 (defmacro gnus-info-set-group (info group)
1834 `(setcar ,info ,group))
1835 (defmacro gnus-info-set-rank (info rank)
1836 `(setcar (nthcdr 1 ,info) ,rank))
1837 (defmacro gnus-info-set-read (info read)
1838 `(setcar (nthcdr 2 ,info) ,read))
1839 (defmacro gnus-info-set-marks (info marks &optional extend)
1840 (if extend
1841 `(gnus-info-set-entry ,info ,marks 3)
1842 `(setcar (nthcdr 3 ,info) ,marks)))
1843 (defmacro gnus-info-set-method (info method &optional extend)
1844 (if extend
1845 `(gnus-info-set-entry ,info ,method 4)
1846 `(setcar (nthcdr 4 ,info) ,method)))
1847 (defmacro gnus-info-set-params (info params &optional extend)
1848 (if extend
1849 `(gnus-info-set-entry ,info ,params 5)
1850 `(setcar (nthcdr 5 ,info) ,params)))
1852 (defun gnus-info-set-entry (info entry number)
1853 ;; Extend the info until we have enough elements.
1854 (while (<= (length info) number)
1855 (nconc info (list nil)))
1856 ;; Set the entry.
1857 (setcar (nthcdr number info) entry))
1859 (defmacro gnus-info-set-level (info level)
1860 `(let ((rank (cdr ,info)))
1861 (if (consp (car rank))
1862 (setcar (car rank) ,level)
1863 (setcar rank ,level))))
1864 (defmacro gnus-info-set-score (info score)
1865 `(let ((rank (cdr ,info)))
1866 (if (consp (car rank))
1867 (setcdr (car rank) ,score)
1868 (setcar rank (cons (car rank) ,score)))))
1870 (defmacro gnus-get-info (group)
1871 `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1873 ;; Byte-compiler warning.
1874 (defvar gnus-visual)
1875 ;; Find out whether the gnus-visual TYPE is wanted.
1876 (defun gnus-visual-p (&optional type class)
1877 (and gnus-visual ; Has to be non-nil, at least.
1878 (if (not type) ; We don't care about type.
1879 gnus-visual
1880 (if (listp gnus-visual) ; It's a list, so we check it.
1881 (or (memq type gnus-visual)
1882 (memq class gnus-visual))
1883 t))))
1885 ;;; Load the compatability functions.
1887 (require 'gnus-ems)
1889 \f
1890 ;;;
1891 ;;; Shutdown
1892 ;;;
1894 (defvar gnus-shutdown-alist nil)
1896 (defun gnus-add-shutdown (function &rest symbols)
1897 "Run FUNCTION whenever one of SYMBOLS is shut down."
1898 (push (cons function symbols) gnus-shutdown-alist))
1900 (defun gnus-shutdown (symbol)
1901 "Shut down everything that waits for SYMBOL."
1902 (let ((alist gnus-shutdown-alist)
1903 entry)
1904 (while (setq entry (pop alist))
1905 (when (memq symbol (cdr entry))
1906 (funcall (car entry))))))
1908 \f
1909 ;;;
1910 ;;; Gnus Utility Functions
1911 ;;;
1913 ;; Add the current buffer to the list of buffers to be killed on exit.
1914 (defun gnus-add-current-to-buffer-list ()
1915 (or (memq (current-buffer) gnus-buffer-list)
1916 (push (current-buffer) gnus-buffer-list)))
1918 (defun gnus-version (&optional arg)
1919 "Version number of this version of Gnus.
1920 If ARG, insert string at point."
1921 (interactive "P")
1922 (let ((methods gnus-valid-select-methods)
1923 (mess gnus-version)
1924 meth)
1925 ;; Go through all the legal select methods and add their version
1926 ;; numbers to the total version string. Only the backends that are
1927 ;; currently in use will have their message numbers taken into
1928 ;; consideration.
1929 (while methods
1930 (setq meth (intern (concat (caar methods) "-version")))
1931 (and (boundp meth)
1932 (stringp (symbol-value meth))
1933 (setq mess (concat mess "; " (symbol-value meth))))
1934 (setq methods (cdr methods)))
1935 (if arg
1936 (insert (message mess))
1937 (message mess))))
1939 (defun gnus-continuum-version (version)
1940 "Return VERSION as a floating point number."
1943 (let* ((alpha (and (match-beginning 1) (match-string 1 version)))
1944 (number (match-string 2 version))
1945 major minor least)
1947 (setq major (string-to-number (match-string 1 number)))
1948 (setq minor (string-to-number (match-string 2 number)))
1949 (setq least (if (match-beginning 3)
1950 (string-to-number (match-string 3 number))
1951 0))
1952 (string-to-number
1953 (if (zerop major)
1954 (format "%s00%02d%02d"
1955 (cond
1956 ((member alpha '("(ding)" "d")) "4.99")
1957 ((member alpha '("September" "s")) "5.01")
1958 ((member alpha '("Red" "r")) "5.03"))
1959 minor least)
1960 (format "%d.%02d%02d" major minor least))))))
1962 (defun gnus-info-find-node ()
1963 "Find Info documentation of Gnus."
1964 (interactive)
1965 ;; Enlarge info window if needed.
1966 (let (gnus-info-buffer)
1967 (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
1968 (setq gnus-info-buffer (current-buffer))
1969 (gnus-configure-windows 'info)))
1971 ;;; More various functions.
1973 (defsubst gnus-check-backend-function (func group)
1974 "Check whether GROUP supports function FUNC.
1975 GROUP can either be a string (a group name) or a select method."
1976 (ignore-errors
1977 (let ((method (if (stringp group)
1978 (car (gnus-find-method-for-group group))
1979 group)))
1980 (unless (featurep method)
1981 (require method))
1982 (fboundp (intern (format "%s-%s" method func))))))
1984 (defun gnus-group-read-only-p (&optional group)
1985 "Check whether GROUP supports editing or not.
1986 If GROUP is nil, `gnus-newsgroup-name' will be checked instead. Note
1987 that that variable is buffer-local to the summary buffers."
1988 (let ((group (or group gnus-newsgroup-name)))
1989 (not (gnus-check-backend-function 'request-replace-article group))))
1991 (defun gnus-group-total-expirable-p (group)
1992 "Check whether GROUP is total-expirable or not."
1993 (let ((params (gnus-group-find-parameter group))
1994 val)
1995 (cond
1996 ((memq 'total-expire params)
1997 t)
1998 ((setq val (assq 'total-expire params)) ; (auto-expire . t)
1999 (cdr val))
2000 (gnus-total-expirable-newsgroups ; Check var.
2001 (string-match gnus-total-expirable-newsgroups group)))))
2003 (defun gnus-group-auto-expirable-p (group)
2004 "Check whether GROUP is total-expirable or not."
2005 (let ((params (gnus-group-find-parameter group))
2006 val)
2007 (cond
2008 ((memq 'auto-expire params)
2009 t)
2010 ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2011 (cdr val))
2012 (gnus-auto-expirable-newsgroups ; Check var.
2013 (string-match gnus-auto-expirable-newsgroups group)))))
2015 (defun gnus-virtual-group-p (group)
2016 "Say whether GROUP is virtual or not."
2017 (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2018 gnus-valid-select-methods)))
2020 (defun gnus-news-group-p (group &optional article)
2021 "Return non-nil if GROUP (and ARTICLE) come from a news server."
2022 (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2023 (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2024 (eq (gnus-request-type group article) 'news))))
2026 ;; Returns a list of writable groups.
2027 (defun gnus-writable-groups ()
2028 (let ((alist gnus-newsrc-alist)
2029 groups group)
2030 (while (setq group (car (pop alist)))
2031 (unless (gnus-group-read-only-p group)
2032 (push group groups)))
2033 (nreverse groups)))
2035 ;; Check whether to use long file names.
2036 (defun gnus-use-long-file-name (symbol)
2037 ;; The variable has to be set...
2038 (and gnus-use-long-file-name
2039 ;; If it isn't a list, then we return t.
2040 (or (not (listp gnus-use-long-file-name))
2041 ;; If it is a list, and the list contains `symbol', we
2042 ;; return nil.
2043 (not (memq symbol gnus-use-long-file-name)))))
2045 ;; Generate a unique new group name.
2046 (defun gnus-generate-new-group-name (leaf)
2047 (let ((name leaf)
2048 (num 0))
2049 (while (gnus-gethash name gnus-newsrc-hashtb)
2050 (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2051 name))
2053 (defun gnus-ephemeral-group-p (group)
2054 "Say whether GROUP is ephemeral or not."
2055 (gnus-group-get-parameter group 'quit-config))
2057 (defun gnus-group-quit-config (group)
2058 "Return the quit-config of GROUP."
2059 (gnus-group-get-parameter group 'quit-config))
2061 (defun gnus-kill-ephemeral-group (group)
2062 "Remove ephemeral GROUP from relevant structures."
2063 (gnus-sethash group nil gnus-newsrc-hashtb))
2065 (defun gnus-simplify-mode-line ()
2066 "Make mode lines a bit simpler."
2067 (setq mode-line-modified "-- ")
2068 (when (listp mode-line-format)
2069 (make-local-variable 'mode-line-format)
2070 (setq mode-line-format (copy-sequence mode-line-format))
2071 (when (equal (nth 3 mode-line-format) " ")
2072 (setcar (nthcdr 3 mode-line-format) " "))))
2074 ;;; Servers and groups.
2076 (defsubst gnus-server-add-address (method)
2077 (let ((method-name (symbol-name (car method))))
2078 (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2079 (not (assq (intern (concat method-name "-address")) method))
2080 (memq 'physical-address (assq (car method)
2081 gnus-valid-select-methods)))
2082 (append method (list (list (intern (concat method-name "-address"))
2083 (nth 1 method))))
2084 method)))
2086 (defsubst gnus-server-get-method (group method)
2087 ;; Input either a server name, and extended server name, or a
2088 ;; select method, and return a select method.
2089 (cond ((stringp method)
2090 (gnus-server-to-method method))
2091 ((equal method gnus-select-method)
2092 gnus-select-method)
2093 ((and (stringp (car method)) group)
2094 (gnus-server-extend-method group method))
2095 ((and method (not group)
2096 (equal (cadr method) ""))
2097 method)
2098 (t
2099 (gnus-server-add-address method))))
2101 (defun gnus-server-to-method (server)
2102 "Map virtual server names to select methods."
2103 (or
2104 ;; Is this a method, perhaps?
2105 (and server (listp server) server)
2106 ;; Perhaps this is the native server?
2107 (and (equal server "native") gnus-select-method)
2108 ;; It should be in the server alist.
2109 (cdr (assoc server gnus-server-alist))
2110 ;; It could be in the predefined server alist.
2111 (cdr (assoc server gnus-predefined-server-alist))
2112 ;; If not, we look through all the opened server
2113 ;; to see whether we can find it there.
2114 (let ((opened gnus-opened-servers))
2115 (while (and opened
2116 (not (equal server (format "%s:%s" (caaar opened)
2117 (cadaar opened)))))
2118 (pop opened))
2119 (caar opened))))
2121 (defmacro gnus-method-equal (ss1 ss2)
2122 "Say whether two servers are equal."
2123 `(let ((s1 ,ss1)
2124 (s2 ,ss2))
2125 (or (equal s1 s2)
2126 (and (= (length s1) (length s2))
2127 (progn
2128 (while (and s1 (member (car s1) s2))
2129 (setq s1 (cdr s1)))
2130 (null s1))))))
2132 (defun gnus-server-equal (m1 m2)
2133 "Say whether two methods are equal."
2134 (let ((m1 (cond ((null m1) gnus-select-method)
2135 ((stringp m1) (gnus-server-to-method m1))
2136 (t m1)))
2137 (m2 (cond ((null m2) gnus-select-method)
2138 ((stringp m2) (gnus-server-to-method m2))
2139 (t m2))))
2140 (gnus-method-equal m1 m2)))
2142 (defun gnus-servers-using-backend (backend)
2143 "Return a list of known servers using BACKEND."
2144 (let ((opened gnus-opened-servers)
2145 out)
2146 (while opened
2147 (when (eq backend (caaar opened))
2148 (push (caar opened) out))
2149 (pop opened))
2150 out))
2152 (defun gnus-archive-server-wanted-p ()
2153 "Say whether the user wants to use the archive server."
2154 (cond
2155 ((or (not gnus-message-archive-method)
2156 (not gnus-message-archive-group))
2157 nil)
2158 ((and gnus-message-archive-method gnus-message-archive-group)
2159 t)
2160 (t
2161 (let ((active (cadr (assq 'nnfolder-active-file
2162 gnus-message-archive-method))))
2163 (and active
2164 (file-exists-p active))))))
2166 (defun gnus-group-prefixed-name (group method)
2167 "Return the whole name from GROUP and METHOD."
2168 (and (stringp method) (setq method (gnus-server-to-method method)))
2169 (if (not method)
2170 group
2171 (concat (format "%s" (car method))
2172 (when (and
2173 (or (assoc (format "%s" (car method))
2174 (gnus-methods-using 'address))
2175 (gnus-server-equal method gnus-message-archive-method))
2176 (nth 1 method)
2177 (not (string= (nth 1 method) "")))
2178 (concat "+" (nth 1 method)))
2179 ":" group)))
2181 (defun gnus-group-real-prefix (group)
2182 "Return the prefix of the current group name."
2183 (if (string-match "^[^:]+:" group)
2184 (substring group 0 (match-end 0))
2185 ""))
2187 (defun gnus-group-method (group)
2188 "Return the server or method used for selecting GROUP.
2189 You should probably use `gnus-find-method-for-group' instead."
2190 (let ((prefix (gnus-group-real-prefix group)))
2191 (if (equal prefix "")
2192 gnus-select-method
2193 (let ((servers gnus-opened-servers)
2194 (server "")
2195 backend possible found)
2197 (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2198 server (substring prefix (match-end 0) (1- (length prefix))))
2199 (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2200 (while servers
2201 (when (eq (caaar servers) backend)
2202 (setq possible (caar servers))
2203 (when (equal (cadaar servers) server)
2204 (setq found (caar servers))))
2205 (pop servers))
2206 (or (car (rassoc found gnus-server-alist))
2207 found
2208 (car (rassoc possible gnus-server-alist))
2209 possible
2210 (list backend server))))))
2212 (defsubst gnus-secondary-method-p (method)
2213 "Return whether METHOD is a secondary select method."
2214 (let ((methods gnus-secondary-select-methods)
2215 (gmethod (gnus-server-get-method nil method)))
2216 (while (and methods
2217 (not (equal (gnus-server-get-method nil (car methods))
2218 gmethod)))
2219 (setq methods (cdr methods)))
2220 methods))
2222 (defun gnus-group-foreign-p (group)
2223 "Say whether a group is foreign or not."
2224 (and (not (gnus-group-native-p group))
2225 (not (gnus-group-secondary-p group))))
2227 (defun gnus-group-native-p (group)
2228 "Say whether the group is native or not."
2229 (not (string-match ":" group)))
2231 (defun gnus-group-secondary-p (group)
2232 "Say whether the group is secondary or not."
2233 (gnus-secondary-method-p (gnus-find-method-for-group group)))
2235 (defun gnus-group-find-parameter (group &optional symbol)
2236 "Return the group parameters for GROUP.
2237 If SYMBOL, return the value of that symbol in the group parameters."
2238 (save-excursion
2239 (set-buffer gnus-group-buffer)
2240 (let ((parameters (funcall gnus-group-get-parameter-function group)))
2241 (if symbol
2242 (gnus-group-parameter-value parameters symbol)
2243 parameters))))
2245 (defun gnus-group-get-parameter (group &optional symbol)
2246 "Return the group parameters for GROUP.
2247 If SYMBOL, return the value of that symbol in the group parameters."
2248 (let ((params (gnus-info-params (gnus-get-info group))))
2249 (if symbol
2250 (gnus-group-parameter-value params symbol)
2251 params)))
2253 (defun gnus-group-parameter-value (params symbol)
2254 "Return the value of SYMBOL in group PARAMS."
2255 (or (car (memq symbol params)) ; It's either a simple symbol
2256 (cdr (assq symbol params)))) ; or a cons.
2258 (defun gnus-group-add-parameter (group param)
2259 "Add parameter PARAM to GROUP."
2260 (let ((info (gnus-get-info group)))
2261 (when info
2262 (gnus-group-remove-parameter group (if (consp param) (car param) param))
2263 ;; Cons the new param to the old one and update.
2264 (gnus-group-set-info (cons param (gnus-info-params info))
2265 group 'params))))
2267 (defun gnus-group-set-parameter (group name value)
2268 "Set parameter NAME to VALUE in GROUP."
2269 (let ((info (gnus-get-info group)))
2270 (when info
2271 (gnus-group-remove-parameter group name)
2272 (let ((old-params (gnus-info-params info))
2273 (new-params (list (cons name value))))
2274 (while old-params
2275 (when (or (not (listp (car old-params)))
2276 (not (eq (caar old-params) name)))
2277 (setq new-params (append new-params (list (car old-params)))))
2278 (setq old-params (cdr old-params)))
2279 (gnus-group-set-info new-params group 'params)))))
2281 (defun gnus-group-remove-parameter (group name)
2282 "Remove parameter NAME from GROUP."
2283 (let ((info (gnus-get-info group)))
2284 (when info
2285 (let ((params (gnus-info-params info)))
2286 (when params
2287 (setq params (delq name params))
2288 (while (assq name params)
2289 (setq params (delq (assq name params) params)))
2290 (gnus-info-set-params info params))))))
2292 (defun gnus-group-add-score (group &optional score)
2293 "Add SCORE to the GROUP score.
2294 If SCORE is nil, add 1 to the score of GROUP."
2295 (let ((info (gnus-get-info group)))
2296 (when info
2297 (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2299 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2300 (defun gnus-short-group-name (group &optional levels)
2301 "Collapse GROUP name LEVELS.
2302 Select methods are stripped and any remote host name is stripped down to
2303 just the host name."
2304 (let* ((name "") (foreign "") (depth -1) (skip 1)
2305 (levels (or levels
2306 (progn
2308 (setq skip (match-end 0)
2309 depth (+ depth 1)))
2310 depth))))
2311 ;; separate foreign select method from group name and collapse.
2312 ;; if method contains a server, collapse to non-domain server name,
2313 ;; otherwise collapse to select method
2314 (when (string-match ":" group)
2315 (cond ((string-match "+" group)
2316 (let* ((plus (string-match "+" group))
2317 (colon (string-match ":" group (or plus 0)))
2319 (setq foreign (concat
2320 (substring group (+ 1 plus)
2321 (cond ((null dot) colon)
2322 ((< colon dot) colon)
2323 ((< dot colon) dot)))
2324 ":")
2325 group (substring group (+ 1 colon)))))
2326 (t
2327 (let* ((colon (string-match ":" group)))
2328 (setq foreign (concat (substring group 0 (+ 1 colon)))
2329 group (substring group (+ 1 colon)))))))
2330 ;; collapse group name leaving LEVELS uncollapsed elements
2331 (while group
2333 (setq name (concat name (substring group 0 1))
2334 group (substring group (match-end 0))
2335 levels (- levels 1)
2336 name (concat name "."))
2337 (setq name (concat foreign name group)
2338 group nil)))
2339 name))
2341 (defun gnus-narrow-to-body ()
2342 "Narrow to the body of an article."
2343 (narrow-to-region
2344 (progn
2345 (goto-char (point-min))
2347 (point-max)))
2348 (point-max)))
2350 \f
2351 ;;;
2352 ;;; Kill file handling.
2353 ;;;
2355 (defun gnus-apply-kill-file ()
2356 "Apply a kill file to the current newsgroup.
2357 Returns the number of articles marked as read."
2358 (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2359 (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2360 (gnus-apply-kill-file-internal)
2361 0))
2363 (defun gnus-kill-save-kill-buffer ()
2364 (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2365 (when (get-file-buffer file)
2366 (save-excursion
2367 (set-buffer (get-file-buffer file))
2368 (when (buffer-modified-p)
2369 (save-buffer))
2370 (kill-buffer (current-buffer))))))
2372 (defcustom gnus-kill-file-name "KILL"
2373 "Suffix of the kill files."
2374 :group 'gnus-score-kill
2375 :group 'gnus-score-files
2376 :type 'string)
2378 (defun gnus-newsgroup-kill-file (newsgroup)
2379 "Return the name of a kill file name for NEWSGROUP.
2380 If NEWSGROUP is nil, return the global kill file name instead."
2381 (cond
2382 ;; The global KILL file is placed at top of the directory.
2383 ((or (null newsgroup)
2384 (string-equal newsgroup ""))
2385 (expand-file-name gnus-kill-file-name
2386 gnus-kill-files-directory))
2387 ;; Append ".KILL" to newsgroup name.
2388 ((gnus-use-long-file-name 'not-kill)
2389 (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2390 "." gnus-kill-file-name)
2391 gnus-kill-files-directory))
2392 ;; Place "KILL" under the hierarchical directory.
2393 (t
2394 (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2395 "/" gnus-kill-file-name)
2396 gnus-kill-files-directory))))
2398 ;;; Server things.
2400 (defun gnus-member-of-valid (symbol group)
2402 (memq symbol (assoc
2403 (symbol-name (car (gnus-find-method-for-group group)))
2404 gnus-valid-select-methods)))
2406 (defun gnus-method-option-p (method option)
2407 "Return non-nil if select METHOD has OPTION as a parameter."
2408 (when (stringp method)
2409 (setq method (gnus-server-to-method method)))
2410 (memq option (assoc (format "%s" (car method))
2411 gnus-valid-select-methods)))
2413 (defun gnus-similar-server-opened (method)
2414 (let ((opened gnus-opened-servers))
2415 (while (and method opened)
2416 (when (and (equal (cadr method) (cadaar opened))
2417 (not (equal method (caar opened))))
2418 (setq method nil))
2419 (pop opened))
2420 (not method)))
2422 (defun gnus-server-extend-method (group method)
2423 ;; This function "extends" a virtual server. If the server is
2424 ;; "hello", and the select method is ("hello" (my-var "something"))
2425 ;; in the group "alt.alt", this will result in a new virtual server
2426 ;; called "hello+alt.alt".
2427 (if (or (not (inline (gnus-similar-server-opened method)))
2428 (not (cddr method)))
2429 method
2430 `(,(car method) ,(concat (cadr method) "+" group)
2431 (,(intern (format "%s-address" (car method))) ,(cadr method))
2432 ,@(cddr method))))
2434 (defun gnus-server-status (method)
2435 "Return the status of METHOD."
2436 (nth 1 (assoc method gnus-opened-servers)))
2438 (defun gnus-group-name-to-method (group)
2439 "Guess a select method based on GROUP."
2440 (if (string-match ":" group)
2441 (let ((server (substring group 0 (match-beginning 0))))
2443 (list (intern (substring server 0 (match-beginning 0)))
2444 (substring server (match-end 0)))
2445 (list (intern server) "")))
2446 gnus-select-method))
2448 (defun gnus-find-method-for-group (group &optional info)
2449 "Find the select method that GROUP uses."
2450 (or gnus-override-method
2451 (and (not group)
2452 gnus-select-method)
2453 (let ((info (or info (gnus-get-info group)))
2454 method)
2455 (if (or (not info)
2456 (not (setq method (gnus-info-method info)))
2457 (equal method "native"))
2458 gnus-select-method
2459 (setq method
2460 (cond ((stringp method)
2461 (inline (gnus-server-to-method method)))
2462 ((stringp (cadr method))
2463 (inline (gnus-server-extend-method group method)))
2464 (t
2465 method)))
2466 (cond ((equal (cadr method) "")
2467 method)
2468 ((null (cadr method))
2469 (list (car method) ""))
2470 (t
2471 (gnus-server-add-address method)))))))
2473 (defun gnus-methods-using (feature)
2474 "Find all methods that have FEATURE."
2475 (let ((valids gnus-valid-select-methods)
2476 outs)
2477 (while valids
2478 (when (memq feature (car valids))
2479 (push (car valids) outs))
2480 (setq valids (cdr valids)))
2481 outs))
2483 (defun gnus-read-group (prompt &optional default)
2484 "Prompt the user for a group name.
2485 Disallow illegal group names."
2486 (let ((prefix "")
2487 group)
2488 (while (not group)
2489 (when (string-match
2491 (setq group (read-string (concat prefix prompt)
2492 (cons (or default "") 0)
2493 'gnus-group-history)))
2495 group nil)))
2496 group))
2498 (defun gnus-read-method (prompt)
2499 "Prompt the user for a method.
2500 Allow completion over sensible values."
2501 (let ((method
2502 (completing-read
2503 prompt (append gnus-valid-select-methods gnus-predefined-server-alist
2504 gnus-server-alist)
2505 nil t nil 'gnus-method-history)))
2506 (cond
2507 ((equal method "")
2508 (setq method gnus-select-method))
2509 ((assoc method gnus-valid-select-methods)
2510 (list (intern method)
2511 (if (memq 'prompt-address
2512 (assoc method gnus-valid-select-methods))
2513 (read-string "Address: ")
2514 "")))
2515 ((assoc method gnus-server-alist)
2516 method)
2517 (t
2518 (list (intern method) "")))))
2520 ;;; User-level commands.
2522 ;;;###autoload
2523 (defun gnus-slave-no-server (&optional arg)
2524 "Read network news as a slave, without connecting to local server"
2525 (interactive "P")
2526 (gnus-no-server arg t))
2528 ;;;###autoload
2529 (defun gnus-no-server (&optional arg slave)
2530 "Read network news.
2531 If ARG is a positive number, Gnus will use that as the
2532 startup level. If ARG is nil, Gnus will be started at level 2.
2533 If ARG is non-nil and not a positive number, Gnus will
2534 prompt the user for the name of an NNTP server to use.
2535 As opposed to `gnus', this command will not connect to the local server."
2536 (interactive "P")
2537 (gnus-no-server-1 arg slave))
2539 ;;;###autoload
2540 (defun gnus-slave (&optional arg)
2541 "Read news as a slave."
2542 (interactive "P")
2543 (gnus arg nil 'slave))
2545 ;;;###autoload
2546 (defun gnus-other-frame (&optional arg)
2547 "Pop up a frame to read news."
2548 (interactive "P")
2549 (let ((window (get-buffer-window gnus-group-buffer)))
2550 (cond (window
2551 (select-frame (window-frame window)))
2552 ((= (length (frame-list)) 1)
2553 (select-frame (make-frame)))
2554 (t
2555 (other-frame 1))))
2556 (gnus arg))
2558 ;;;###autoload
2559 (defun gnus (&optional arg dont-connect slave)
2560 "Read network news.
2561 If ARG is non-nil and a positive number, Gnus will use that as the
2562 startup level. If ARG is non-nil and not a positive number, Gnus will
2563 prompt the user for the name of an NNTP server to use."
2564 (interactive "P")
2565 (gnus-1 arg dont-connect slave))
2567 ;; Allow redefinition of Gnus functions.
2569 (gnus-ems-redefine)
2571 (provide 'gnus)
2573 ;;; gnus.el ends here